Skip to content

Commit

Permalink
Create README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
@brokedba
brokedba authored Nov 5, 2023
1 parent 5a72864 commit 3e65dc1
Showing 1 changed file with 80 additions and 0 deletions.
80 changes: 80 additions & 0 deletions terraform-provider-alicloud/launch-instance/README.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
## Requirements

| Name | Version |
|------|---------|
| <a name="requirement_alicloud"></a> [alicloud](#requirement\_alicloud) | 1.211.2 |

## Providers

| Name | Version |
|------|---------|
| <a name="provider_alicloud"></a> [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 |
|------|-------------|------|---------|:--------:|
| <a name="input_OS"></a> [OS](#input\_OS) | the selected ami based OS | `string` | `"CENTOS7"` | no |
| <a name="input_ali_access_key"></a> [ali\_access\_key](#input\_ali\_access\_key) | AliCloud account region and autehntication | `any` | n/a | yes |
| <a name="input_ali_region"></a> [ali\_region](#input\_ali\_region) | n/a | `string` | `"us-east-1"` | no |
| <a name="input_ali_secret_key"></a> [ali\_secret\_key](#input\_ali\_secret\_key) | n/a | `any` | n/a | yes |
| <a name="input_ali_zone"></a> [ali\_zone](#input\_ali\_zone) | n/a | `map` | <pre>{<br> "UK": "eu-west-1a",<br> "germany": "eu-central-1a",<br> "hongkong": "cn-hongkong-b",<br> "us-east-1": "us-east-1a",<br> "us-west-1": "us-west-1a"<br>}</pre> | no |
| <a name="input_boot_volume_size"></a> [boot\_volume\_size](#input\_boot\_volume\_size) | n/a | `string` | `"20"` | no |
| <a name="input_data_diks_size"></a> [data\_diks\_size](#input\_data\_diks\_size) | n/a | `string` | `"20"` | no |
| <a name="input_hostname"></a> [hostname](#input\_hostname) | COMPUTE INSTANCE INFO | `string` | `"TerraHost"` | no |
| <a name="input_igw_name"></a> [igw\_name](#input\_igw\_name) | IGW INFO | `string` | `"terra-igw"` | no |
| <a name="input_img_id"></a> [img\_id](#input\_img\_id) | n/a | `map` | <pre>{<br> "Aliyun": "aliyun_3_x64_20G_qboot_alibase_20230727.vhd",<br> "CENTOS7": "centos_7_9_uefi_x64_20G_alibase_20230816.vhd",<br> "CENTOS8": "centos_8_5_uefi_x64_20G_alibase_20220328.vhd",<br> "RHEL8": "m-t4n1vfii5zftauvd5axj",<br> "ROCKY9": "rockylinux_9_2_x64_20G_alibase_20230613.vhd",<br> "SUSE": "sles_12_sp4_x64_20G_alibase_20200319.vhd",<br> "UBUNTU": "ubuntu_22_04_uefi_x64_20G_alibase_20230515.vhd",<br> "WINDOWS": "win2022_21H2_x64_dtc_en-us_40G_alibase_20230915.vhd"<br>}</pre> | no |
| <a name="input_instance_name"></a> [instance\_name](#input\_instance\_name) | n/a | `string` | `"TerraCompute"` | no |
| <a name="input_instance_type"></a> [instance\_type](#input\_instance\_type) | n/a | `string` | `"ecs.c5.large"` | no |
| <a name="input_key_name"></a> [key\_name](#input\_key\_name) | n/a | `string` | `"demo_ali_KeyPair"` | no |
| <a name="input_map_public_ip_on_launch"></a> [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 |
| <a name="input_prefix"></a> [prefix](#input\_prefix) | The prefix used for the resources group in this example | `string` | `"TerraDemo"` | no |
| <a name="input_preserve_boot_volume"></a> [preserve\_boot\_volume](#input\_preserve\_boot\_volume) | BOOT INFO | `bool` | `false` | no |
| <a name="input_private_ip"></a> [private\_ip](#input\_private\_ip) | VNIC INFO | `string` | `"192.168.10.51"` | no |
| <a name="input_rt_name"></a> [rt\_name](#input\_rt\_name) | ROUTE TABLE INFO | `string` | `"terra-rt"` | no |
| <a name="input_sg_name"></a> [sg\_name](#input\_sg\_name) | ROUTE TABLE INFO | `string` | `"terra-sg"` | no |
| <a name="input_ssh_public_key"></a> [ssh\_public\_key](#input\_ssh\_public\_key) | n/a | `string` | `"~/.ssh/id_rsa_ali.pub"` | no |
| <a name="input_user_data"></a> [user\_data](#input\_user\_data) | user data | `string` | `"./cloud-init/centos_userdata.txt"` | no |
| <a name="input_vpc_cidr"></a> [vpc\_cidr](#input\_vpc\_cidr) | n/a | `string` | `"192.168.0.0/16"` | no |
| <a name="input_vpc_name"></a> [vpc\_name](#input\_vpc\_name) | VPC INFO | `string` | `"Terravpc"` | no |
| <a name="input_vswitch_cidr"></a> [vswitch\_cidr](#input\_vswitch\_cidr) | n/a | `string` | `"192.168.10.0/24"` | no |
| <a name="input_vswitch_name"></a> [vswitch\_name](#input\_vswitch\_name) | SUBNET/VSWITCH INFO | `string` | `"terrasub"` | no |

## Outputs

| Name | Description |
|------|-------------|
| <a name="output_SSH_Connection"></a> [SSH\_Connection](#output\_SSH\_Connection) | n/a |
| <a name="output_Subnet_CIDR"></a> [Subnet\_CIDR](#output\_Subnet\_CIDR) | cidr block of VPC's VSwitch. |
| <a name="output_Subnet_Name"></a> [Subnet\_Name](#output\_Subnet\_Name) | Name of created VPC's Subnet. |
| <a name="output_instance_id"></a> [instance\_id](#output\_instance\_id) | id of created instances. |
| <a name="output_private_ip"></a> [private\_ip](#output\_private\_ip) | Private IPs of created instances. |
| <a name="output_public_ip"></a> [public\_ip](#output\_public\_ip) | Public IPs of created instances. |
| <a name="output_vpc_CIDR"></a> [vpc\_CIDR](#output\_vpc\_CIDR) | cidr block of created VPC. |
| <a name="output_vpc_dedicated_security_group_Name"></a> [vpc\_dedicated\_security\_group\_Name](#output\_vpc\_dedicated\_security\_group\_Name) | Security Group Name. |
| <a name="output_vpc_dedicated_security_ingress_rules"></a> [vpc\_dedicated\_security\_ingress\_rules](#output\_vpc\_dedicated\_security\_ingress\_rules) | Shows ingress rules of the Security group |
| <a name="output_vpc_id"></a> [vpc\_id](#output\_vpc\_id) | ID of created VPC. |
| <a name="output_vpc_name"></a> [vpc\_name](#output\_vpc\_name) | Name of created VPC. |

0 comments on commit 3e65dc1

Please sign in to comment.