From 3e65dc1971708646be7ea693c2225321fa490c9e Mon Sep 17 00:00:00 2001 From: BrokeDBA Date: Sun, 5 Nov 2023 03:17:58 -0500 Subject: [PATCH] Create README.md --- .../launch-instance/README.md | 80 +++++++++++++++++++ 1 file changed, 80 insertions(+) create mode 100644 terraform-provider-alicloud/launch-instance/README.md diff --git a/terraform-provider-alicloud/launch-instance/README.md b/terraform-provider-alicloud/launch-instance/README.md new file mode 100644 index 0000000..b9e0e79 --- /dev/null +++ b/terraform-provider-alicloud/launch-instance/README.md @@ -0,0 +1,80 @@ +## Requirements + +| Name | Version | +|------|---------| +| [alicloud](#requirement\_alicloud) | 1.211.2 | + +## Providers + +| Name | Version | +|------|---------| +| [alicloud](#provider\_alicloud) | 1.211.2 | + +## Modules + +No modules. + +## Resources + +| Name | Type | +|------|------| +| [alicloud_instance.terra_inst](https://registry.terraform.io/providers/aliyun/alicloud/1.211.2/docs/resources/instance) | resource | +| [alicloud_key_pair.key_pair](https://registry.terraform.io/providers/aliyun/alicloud/1.211.2/docs/resources/key_pair) | resource | +| [alicloud_resource_manager_resource_group.rg](https://registry.terraform.io/providers/aliyun/alicloud/1.211.2/docs/resources/resource_manager_resource_group) | resource | +| [alicloud_security_group.terra_sg](https://registry.terraform.io/providers/aliyun/alicloud/1.211.2/docs/resources/security_group) | resource | +| [alicloud_security_group_rule.allow_http_80](https://registry.terraform.io/providers/aliyun/alicloud/1.211.2/docs/resources/security_group_rule) | resource | +| [alicloud_security_group_rule.allow_https_22](https://registry.terraform.io/providers/aliyun/alicloud/1.211.2/docs/resources/security_group_rule) | resource | +| [alicloud_security_group_rule.allow_https_443](https://registry.terraform.io/providers/aliyun/alicloud/1.211.2/docs/resources/security_group_rule) | resource | +| [alicloud_vpc.terra_vpc](https://registry.terraform.io/providers/aliyun/alicloud/1.211.2/docs/resources/vpc) | resource | +| [alicloud_vswitch.terra_sub](https://registry.terraform.io/providers/aliyun/alicloud/1.211.2/docs/resources/vswitch) | resource | +| [alicloud_images.centos7](https://registry.terraform.io/providers/aliyun/alicloud/1.211.2/docs/data-sources/images) | data source | +| [alicloud_security_group_rules.ingress_rules](https://registry.terraform.io/providers/aliyun/alicloud/1.211.2/docs/data-sources/security_group_rules) | data source | +| [alicloud_security_groups.terra_sgs](https://registry.terraform.io/providers/aliyun/alicloud/1.211.2/docs/data-sources/security_groups) | data source | +| [alicloud_vpcs.terra_vpcs](https://registry.terraform.io/providers/aliyun/alicloud/1.211.2/docs/data-sources/vpcs) | data source | +| [alicloud_vswitches.terra_subs](https://registry.terraform.io/providers/aliyun/alicloud/1.211.2/docs/data-sources/vswitches) | data source | + +## Inputs + +| Name | Description | Type | Default | Required | +|------|-------------|------|---------|:--------:| +| [OS](#input\_OS) | the selected ami based OS | `string` | `"CENTOS7"` | no | +| [ali\_access\_key](#input\_ali\_access\_key) | AliCloud account region and autehntication | `any` | n/a | yes | +| [ali\_region](#input\_ali\_region) | n/a | `string` | `"us-east-1"` | no | +| [ali\_secret\_key](#input\_ali\_secret\_key) | n/a | `any` | n/a | yes | +| [ali\_zone](#input\_ali\_zone) | n/a | `map` | 
{
  "UK": "eu-west-1a",
  "germany": "eu-central-1a",
  "hongkong": "cn-hongkong-b",
  "us-east-1": "us-east-1a",
  "us-west-1": "us-west-1a"
}
| no | +| [boot\_volume\_size](#input\_boot\_volume\_size) | n/a | `string` | `"20"` | no | +| [data\_diks\_size](#input\_data\_diks\_size) | n/a | `string` | `"20"` | no | +| [hostname](#input\_hostname) | COMPUTE INSTANCE INFO | `string` | `"TerraHost"` | no | +| [igw\_name](#input\_igw\_name) | IGW INFO | `string` | `"terra-igw"` | no | +| [img\_id](#input\_img\_id) | n/a | `map` | 
{
  "Aliyun": "aliyun_3_x64_20G_qboot_alibase_20230727.vhd",
  "CENTOS7": "centos_7_9_uefi_x64_20G_alibase_20230816.vhd",
  "CENTOS8": "centos_8_5_uefi_x64_20G_alibase_20220328.vhd",
  "RHEL8": "m-t4n1vfii5zftauvd5axj",
  "ROCKY9": "rockylinux_9_2_x64_20G_alibase_20230613.vhd",
  "SUSE": "sles_12_sp4_x64_20G_alibase_20200319.vhd",
  "UBUNTU": "ubuntu_22_04_uefi_x64_20G_alibase_20230515.vhd",
  "WINDOWS": "win2022_21H2_x64_dtc_en-us_40G_alibase_20230915.vhd"
}
| no | +| [instance\_name](#input\_instance\_name) | n/a | `string` | `"TerraCompute"` | no | +| [instance\_type](#input\_instance\_type) | n/a | `string` | `"ecs.c5.large"` | no | +| [key\_name](#input\_key\_name) | n/a | `string` | `"demo_ali_KeyPair"` | no | +| [map\_public\_ip\_on\_launch](#input\_map\_public\_ip\_on\_launch) | Indicate if instances launched into the VPC's Subnet will be assigned a public IP address . | `bool` | `true` | no | +| [prefix](#input\_prefix) | The prefix used for the resources group in this example | `string` | `"TerraDemo"` | no | +| [preserve\_boot\_volume](#input\_preserve\_boot\_volume) | BOOT INFO | `bool` | `false` | no | +| [private\_ip](#input\_private\_ip) | VNIC INFO | `string` | `"192.168.10.51"` | no | +| [rt\_name](#input\_rt\_name) | ROUTE TABLE INFO | `string` | `"terra-rt"` | no | +| [sg\_name](#input\_sg\_name) | ROUTE TABLE INFO | `string` | `"terra-sg"` | no | +| [ssh\_public\_key](#input\_ssh\_public\_key) | n/a | `string` | `"~/.ssh/id_rsa_ali.pub"` | no | +| [user\_data](#input\_user\_data) | user data | `string` | `"./cloud-init/centos_userdata.txt"` | no | +| [vpc\_cidr](#input\_vpc\_cidr) | n/a | `string` | `"192.168.0.0/16"` | no | +| [vpc\_name](#input\_vpc\_name) | VPC INFO | `string` | `"Terravpc"` | no | +| [vswitch\_cidr](#input\_vswitch\_cidr) | n/a | `string` | `"192.168.10.0/24"` | no | +| [vswitch\_name](#input\_vswitch\_name) | SUBNET/VSWITCH INFO | `string` | `"terrasub"` | no | + +## Outputs + +| Name | Description | +|------|-------------| +| [SSH\_Connection](#output\_SSH\_Connection) | n/a | +| [Subnet\_CIDR](#output\_Subnet\_CIDR) | cidr block of VPC's VSwitch. | +| [Subnet\_Name](#output\_Subnet\_Name) | Name of created VPC's Subnet. | +| [instance\_id](#output\_instance\_id) | id of created instances. | +| [private\_ip](#output\_private\_ip) | Private IPs of created instances. | +| [public\_ip](#output\_public\_ip) | Public IPs of created instances. | +| [vpc\_CIDR](#output\_vpc\_CIDR) | cidr block of created VPC. | +| [vpc\_dedicated\_security\_group\_Name](#output\_vpc\_dedicated\_security\_group\_Name) | Security Group Name. | +| [vpc\_dedicated\_security\_ingress\_rules](#output\_vpc\_dedicated\_security\_ingress\_rules) | Shows ingress rules of the Security group | +| [vpc\_id](#output\_vpc\_id) | ID of created VPC. | +| [vpc\_name](#output\_vpc\_name) | Name of created VPC. |