Generate Terraform cloud resources reference docs (#496)

Generated reference docs for Terraform cloud resources. Also updated
provision-and-consume-cloud-services docs

Signed-off-by: Zheng Xi Zhou <zzxwill@gmail.com>
This commit is contained in:
Zheng Xi Zhou 2022-02-09 16:33:43 +08:00 committed by GitHub
parent c162e18bae
commit 654b4f92e0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
109 changed files with 1982 additions and 498 deletions

View File

@ -33,8 +33,17 @@ This tutorial will talk about how to provision and consume Cloud Resources by Te
| | | [VPC](./terraform/alibaba-vpc) | Terraform configuration for Alibaba Cloud VPC |
| | | [VSwitch](./terraform/alibaba-vswitch) | Terraform configuration for Alibaba Cloud VSwitch |
| | AWS | [S3](./terraform/aws-s3) | Terraform configuration for AWS S3 bucket |
| | | [S3](./terraform/aws-rds) | Terraform configuration for AWS RDS |
| | | [S3](./terraform/aws-security-group) | Terraform configuration for AWS Security Group |
| | | [S3](./terraform/aws-subnet) | Terraform configuration for AWS S3 Subnet |
| | | [S3](./terraform/aws-vpc) | Terraform configuration for AWS S3 VPC |
| | Azure | [Mariadb](./terraform/azure-database-mariadb) | Terraform configuration for Azure Database Mariadb |
| | | [Storage Account](./terraform/azure-storage-account) | Terraform configuration for Azure Storage Account |
| | | [Storage Account](./terraform/azure-resource-group) | Terraform configuration for Azure Resource group |
| | | [Storage Account](./terraform/azure-subnet) | Terraform configuration for Azure Subnet |
| | | [Storage Account](./terraform/azure-virtual-network) | Terraform configuration for Azure Virtual network |
| | Tencent Cloud | [Mariadb](./terraform/tencent-vpc) | Terraform configuration for Tencent Cloud VPC |
| | | [Mariadb](./terraform/tencent-subnet) | Terraform configuration for Tencent Cloud Subnet |
## Terraform

View File

@ -30,29 +30,29 @@ spec:
Name | Description | Type | Required | Default
------------ | ------------- | ------------- | ------------- | -------------
number_format | The number format used to output. | string | true |
k8s_name_prefix | The name prefix used to create several kubernetes clusters. Default to variable `example_name` | string | true |
master_instance_types | The ecs instance types used to launch master nodes. | list(any) | true |
install_cloud_monitor | Install cloud monitor agent on ECS. | bool | true |
k8s_service_cidr | The kubernetes service cidr block. It cannot be equals to vpc's or vswitch's or pod's and cannot be in them. | string | true |
vpc_name | The vpc name used to create a new vpc when 'vpc_id' is not specified. Default to variable `example_name` | string | true |
vswitch_cidrs | List of cidr blocks used to create several new vswitches when 'vswitch_ids' is not specified. | list(any) | true |
password | The password of ECS instance. | string | true |
k8s_worker_number | The number of worker nodes in kubernetes cluster. | number | true |
k8s_pod_cidr | The kubernetes pod cidr block. It cannot be equals to vpc's or vswitch's and cannot be in them. | string | true |
k8s_version | The version of the kubernetes version. Valid values: '1.16.6-aliyun.1','1.14.8-aliyun.1'. Default to '1.16.6-aliyun.1'. | string | true |
cpu_core_count | CPU core count is used to fetch instance types. | number | true |
memory_size | Memory size used to fetch instance types. | number | true |
new_nat_gateway | Whether to create a new nat gateway. In this template, a new nat gateway will create a nat gateway, eip and server snat entries. | bool | true |
worker_instance_types | The ecs instance types used to launch worker nodes. | list(any) | true |
zone_id | Availability Zone ID | string | true |
vpc_cidr | The cidr block used to launch a new vpc when 'vpc_id' is not specified. | string | true |
vswitch_name_prefix | The vswitch name prefix used to create several new vswitches. Default to variable 'example_name'. | string | true |
vswitch_ids | List of existing vswitch id. | list(any) | true |
node_cidr_mask | The node cidr block to specific how many pods can run on single node. Valid values: [24-28]. | number | true |
enable_ssh | Enable login to the node through SSH. | bool | true |
cpu_policy | kubelet cpu policy. Valid values: 'none','static'. Default to 'none'. | string | true |
proxy_mode | Proxy mode is option of kube-proxy. Valid values: 'ipvs','iptables'. Default to 'iptables'. | string | true |
install_cloud_monitor | Install cloud monitor agent on ECS. | bool | false |
k8s_service_cidr | The kubernetes service cidr block. It cannot be equals to vpc's or vswitch's or pod's and cannot be in them. | string | false |
cpu_core_count | CPU core count is used to fetch instance types. | number | false |
vswitch_name_prefix | The vswitch name prefix used to create several new vswitches. Default to variable 'example_name'. | string | false |
vswitch_ids | List of existing vswitch id. | list(any) | false |
master_instance_types | The ecs instance types used to launch master nodes. | list(any) | false |
node_cidr_mask | The node cidr block to specific how many pods can run on single node. Valid values: [24-28]. | number | false |
enable_ssh | Enable login to the node through SSH. | bool | false |
k8s_version | The version of the kubernetes version. Valid values: '1.16.6-aliyun.1','1.14.8-aliyun.1'. Default to '1.16.6-aliyun.1'. | string | false |
vpc_cidr | The cidr block used to launch a new vpc when 'vpc_id' is not specified. | string | false |
vswitch_cidrs | List of cidr blocks used to create several new vswitches when 'vswitch_ids' is not specified. | list(any) | false |
worker_instance_types | The ecs instance types used to launch worker nodes. | list(any) | false |
cpu_policy | kubelet cpu policy. Valid values: 'none','static'. Default to 'none'. | string | false |
password | The password of ECS instance. | string | false |
k8s_worker_number | The number of worker nodes in kubernetes cluster. | number | false |
zone_id | Availability Zone ID | string | false |
k8s_pod_cidr | The kubernetes pod cidr block. It cannot be equals to vpc's or vswitch's and cannot be in them. | string | false |
memory_size | Memory size used to fetch instance types. | number | false |
vpc_name | The vpc name used to create a new vpc when 'vpc_id' is not specified. Default to variable `example_name` | string | false |
number_format | The number format used to output. | string | false |
k8s_name_prefix | The name prefix used to create several kubernetes clusters. Default to variable `example_name` | string | false |
new_nat_gateway | Whether to create a new nat gateway. In this template, a new nat gateway will create a nat gateway, eip and server snat entries. | bool | false |
proxy_mode | Proxy mode is option of kube-proxy. Valid values: 'ipvs','iptables'. Default to 'iptables'. | string | false |
writeConnectionSecretToRef | The secret which the cloud resource connection will be written to | [writeConnectionSecretToRef](#writeConnectionSecretToRef) | false |
@ -70,11 +70,11 @@ If `writeConnectionSecretToRef` is set, a secret will be generated with these ke
Name | Description
------------ | -------------
CLUSTER_ID | The ID of the cluster
NAME | The name of the kubernetes cluster.
KUBECONFIG | The KubeConfig string of the kubernetes cluster.
CLUSTER_CA_CERT | The CA certificate of the kubernetes cluster.
CLIENT_CERT | The client certificate of the kubernetes cluster.
CLIENT_KEY | The client key of the kubernetes cluster.
API_SERVER_INTERNET | The internet access of the kubernetes api server.
RESOURCE_IDENTIFIER | The identifier of the resource
CLUSTER_ID | The ID of the cluster
NAME | The name of the kubernetes cluster.
KUBECONFIG | The KubeConfig string of the kubernetes cluster.
CLUSTER_CA_CERT | The CA certificate of the kubernetes cluster.

View File

@ -13,21 +13,21 @@ Terraform configuration for Alibaba Cloud AMQP(RabbitMQ)
Name | Description | Type | Required | Default
------------ | ------------- | ------------- | ------------- | -------------
max_tps | The specification of the peak TPS traffic. The smallest valid value is 1000 and the largest value is 100,000. | number | false |
create | Whether to create instance. If false, you can specify an existing instance by setting 'instance_id'. | bool | false |
support_eip | The specification of support EIP. | bool | false |
auto_delete_state | Specifies whether the Auto Delete attribute is configured. Valid values: true: The Auto Delete attributeis configured. If the last queue that is bound to an exchange is unbound, the exchange is automatically deleted. false: The Auto Delete attribute is not configured. If the last queue that is bound to an exchange is unbound, the exchange is not automatically deleted. | bool | false |
internal | The specification of the internal. | bool | false |
binding_type | The specification of the binding type. Valid values: EXCHANGE, QUEUE. | string | false |
max_eip_tps | The specification of the max eip tps. It is valid when support_eip is true. The valid value is [128, 45000] with the step size 128 | number | false |
name | The specification of module name. | string | false |
instance_type | The specification of the instance type. Valid values: professional, vip. | string | false |
queue_capacity | The specification of the queue capacity. The smallest value is 50 and the step size 5. | number | false |
period | The specification of the period. Valid values: 1, 12, 2, 24, 3, 6. | number | false |
create | Whether to create instance. If false, you can specify an existing instance by setting 'instance_id'. | bool | false |
max_tps | The specification of the peak TPS traffic. The smallest valid value is 1000 and the largest value is 100,000. | number | false |
max_eip_tps | The specification of the max eip tps. It is valid when support_eip is true. The valid value is [128, 45000] with the step size 128 | number | false |
instance_id | The instance_id used to RabbitMQ. If set, the 'create' will be ignored. | string | false |
argument | The specification of the argument. | string | false |
binding_type | The specification of the binding type. Valid values: EXCHANGE, QUEUE. | string | false |
name | The specification of module name. | string | false |
payment_type | The specification of the payment type. | string | false |
auto_delete_state | Specifies whether the Auto Delete attribute is configured. Valid values: true: The Auto Delete attributeis configured. If the last queue that is bound to an exchange is unbound, the exchange is automatically deleted. false: The Auto Delete attribute is not configured. If the last queue that is bound to an exchange is unbound, the exchange is not automatically deleted. | bool | false |
exchange_type | The specification of the exchange type. Valid values: FANOUT, DIRECT, TOPIC, HEADERS | string | false |
internal | The specification of the internal. | bool | false |
argument | The specification of the argument. | string | false |
payment_type | The specification of the payment type. | string | false |
period | The specification of the period. Valid values: 1, 12, 2, 24, 3, 6. | number | false |
instance_id | The instance_id used to RabbitMQ. If set, the 'create' will be ignored. | string | false |
writeConnectionSecretToRef | The secret which the cloud resource connection will be written to | [writeConnectionSecretToRef](#writeConnectionSecretToRef) | false |

View File

@ -13,7 +13,7 @@ Terraform configuration for Alibaba Cloud Serverless Kubernetes (ASK)
Name | Description | Type | Required | Default
------------ | ------------- | ------------- | ------------- | -------------
name | ASK name | string | true |
name | ASK name | string | false |
writeConnectionSecretToRef | The secret which the cloud resource connection will be written to | [writeConnectionSecretToRef](#writeConnectionSecretToRef) | false |
@ -31,8 +31,8 @@ If `writeConnectionSecretToRef` is set, a secret will be generated with these ke
Name | Description
------------ | -------------
RESOURCE_IDENTIFIER | The identifier of the resource
Name | Cluster Name
API_SERVER_INTRANET | The API server intranet address of the kubernetes cluster.
API_SERVER_INTERNET | The API server internet address of the kubernetes cluster.
KUBECONFIG | The KubeConfig string of the kubernetes cluster.
RESOURCE_IDENTIFIER | The identifier of the resource
Name | Cluster Name

View File

@ -29,8 +29,8 @@ spec:
Name | Description | Type | Required | Default
------------ | ------------- | ------------- | ------------- | -------------
name | Name to be used on all resources as prefix. Default to 'TF-Module-EIP'. | string | true |
bandwidth | Maximum bandwidth to the elastic public network, measured in Mbps (Mega bit per second). | number | true |
name | Name to be used on all resources as prefix. Default to 'TF-Module-EIP'. | string | false |
bandwidth | Maximum bandwidth to the elastic public network, measured in Mbps (Mega bit per second). | number | false |
writeConnectionSecretToRef | The secret which the cloud resource connection will be written to | [writeConnectionSecretToRef](#writeConnectionSecretToRef) | false |

View File

@ -14,27 +14,27 @@ Alibaba Cloud MongoDB
Name | Description | Type | Required | Default
------------ | ------------- | ------------- | ------------- | -------------
skip_region_validation | (Deprecated from version 1.4.0) Skip static validation of region ID. Used by users of alternative AlibabaCloud-like APIs or users w/ access to regions that are not public (yet). | bool | false |
db_instance_class | The specification of the instance. For more information about the value, see https://www.alibabacloud.com/help/doc-detail/57141.htm | string | true |
storage_engine | The MongoDB storage engine, WiredTiger or RocksDB. Default value: WiredTiger. | string | false |
period | The duration that you will buy DB instance (in month). It is valid when instance_charge_type is PrePaid. Valid values: [1~9], 12, 24, 36. Default to 1 | | false |
engine_version | The version number of the database. Valid value: 3.4, 4.0, 4.2, 4.4, 5.0 | string | true |
zone_id | The ID of the zone. You can refer to https://www.alibabacloud.com/help/doc-detail/61933.htm. | string | false |
security_ip_list | List of IP addresses allowed to access all databases of an instance. The list contains up to 1,000 IP addresses, separated by commas. Supported formats include 0.0.0.0/0, 10.23.12.24 (IP), and 10.23.12.24/24 (Classless Inter-Domain Routing (CIDR) mode. /24 represents the length of the prefix in an IP address. The range of the prefix length is [1,32]). | list(string) | false |
existing_instance_id | The Id of an existing Mongodb instance. If set, the `create` will be ignored. | string | false |
tags | A mapping of tags to assign to the mongodb instance resource. | map(string) | false |
instance_id | `(Deprecated)` It has been deprecated from version 1.2.0 and use `existing_instance_id` instead. | string | false |
create | Whether to use an existing MongoDB. If false, you can use a existing Mongodb instance by setting `existing_instance_id`. | bool | false |
shared_credentials_file | (Deprecated from version 1.4.0) This is the path to the shared credentials file. If this is not set and a profile is specified, $HOME/.aliyun/config.json will be used. | string | false |
name | The name of DB instance. It a string of 2 to 256 characters | string | true |
storage_engine | The MongoDB storage engine, WiredTiger or RocksDB. Default value: WiredTiger. | string | false |
instance_charge_type | The billing method of the instance. Valid values are Prepaid, PostPaid, Default to PostPaid | string | false |
vswitch_id | The virtual switch ID to launch DB instances in one VPC. | string | false |
backup_time | MongoDB instance backup time. It is required when backup_period was existed. In the format of HH:mmZ- HH:mmZ. Time setting interval is one hour. Default to a random time, like '23:00Z-24:00Z'. | string | false |
existing_instance_id | The Id of an existing Mongodb instance. If set, the `create` will be ignored. | string | false |
region | (Deprecated from version 1.4.0) The region used to launch this module resources. | string | false |
engine_version | The version number of the database. Valid value: 3.4, 4.0, 4.2, 4.4, 5.0 | string | true |
account_password | Password of the root account. It is a string of 6 to 32 characters and is composed of letters, numbers, and underlines | string | true |
replication_factor | The number of nodes in the replica set instance. Valid values: 3, 5, 7. Default value: 3. | number | false |
profile | (Deprecated from version 1.4.0) The profile name as set in the shared credentials file. If not set, it will be sourced from the ALICLOUD_PROFILE environment variable. | string | false |
db_instance_storage | The storage space of the instance. Valid values: 10 to 3000. Unit: GB. You can only specify this value in 10 GB increments. | number | false |
security_ip_list | List of IP addresses allowed to access all databases of an instance. The list contains up to 1,000 IP addresses, separated by commas. Supported formats include 0.0.0.0/0, 10.23.12.24 (IP), and 10.23.12.24/24 (Classless Inter-Domain Routing (CIDR) mode. /24 represents the length of the prefix in an IP address. The range of the prefix length is [1,32]). | list(string) | false |
backup_period | MongoDB Instance backup period. It is required when backup_time was existed. Valid values: [Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday]. Default to [Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday]. | list(string) | true |
create | Whether to use an existing MongoDB. If false, you can use a existing Mongodb instance by setting `existing_instance_id`. | bool | false |
account_password | Password of the root account. It is a string of 6 to 32 characters and is composed of letters, numbers, and underlines | string | true |
instance_id | `(Deprecated)` It has been deprecated from version 1.2.0 and use `existing_instance_id` instead. | string | false |
profile | (Deprecated from version 1.4.0) The profile name as set in the shared credentials file. If not set, it will be sourced from the ALICLOUD_PROFILE environment variable. | string | false |
region | (Deprecated from version 1.4.0) The region used to launch this module resources. | string | false |
db_instance_storage | The storage space of the instance. Valid values: 10 to 3000. Unit: GB. You can only specify this value in 10 GB increments. | number | false |
db_instance_class | The specification of the instance. For more information about the value, see https://www.alibabacloud.com/help/doc-detail/57141.htm | string | true |
period | The duration that you will buy DB instance (in month). It is valid when instance_charge_type is PrePaid. Valid values: [1~9], 12, 24, 36. Default to 1 | | false |
name | The name of DB instance. It a string of 2 to 256 characters | string | true |
replication_factor | The number of nodes in the replica set instance. Valid values: 3, 5, 7. Default value: 3. | number | false |
backup_time | MongoDB instance backup time. It is required when backup_period was existed. In the format of HH:mmZ- HH:mmZ. Time setting interval is one hour. Default to a random time, like '23:00Z-24:00Z'. | string | false |
writeConnectionSecretToRef | The secret which the cloud resource connection will be written to | [writeConnectionSecretToRef](#writeConnectionSecretToRef) | false |

View File

@ -4,7 +4,7 @@ title: Alibaba Cloud MSE
## Description
Alibaba Cloud MSE
Terraform configuration for Alibaba Cloud MSE
## Specification

View File

@ -31,8 +31,8 @@ spec:
Name | Description | Type | Required | Default
------------ | ------------- | ------------- | ------------- | -------------
bucket | OSS bucket name | string | true |
acl | OSS bucket ACL, supported 'private', 'public-read', 'public-read-write' | string | true |
bucket | OSS bucket name | string | false |
acl | OSS bucket ACL, supported 'private', 'public-read', 'public-read-write' | string | false |
writeConnectionSecretToRef | The secret which the cloud resource connection will be written to | [writeConnectionSecretToRef](#writeConnectionSecretToRef) | false |

View File

@ -32,15 +32,15 @@ spec:
Name | Description | Type | Required | Default
------------ | ------------- | ------------- | ------------- | -------------
security_ips | List of IP addresses allowed to access all databases of an instance | list(any) | false |
privilege | The privilege of one account access database. | string | false |
sql_file | The name of SQL file in the bucket, like `db.sql` | string | false |
instance_name | RDS instance name | string | false |
account_name | RDS instance user account name | string | false |
password | RDS instance account password | string | false |
security_ips | List of IP addresses allowed to access all databases of an instance | list(any) | false |
privilege | The privilege of one account access database. | string | false |
sql_bucket_name | The bucket name of the SQL file. like `oss://example` | string | false |
instance_name | RDS instance name | string | false |
allocate_public_connection | Whether to allocate public connection for a RDS instance. | bool | false |
database_name | Database name | string | false |
sql_bucket_name | The bucket name of the SQL file. like `oss://example` | string | false |
sql_file | The name of SQL file in the bucket, like `db.sql` | string | false |
sql_bucket_endpoint | The endpoint of the bucket. like `oss-cn-hangzhou.aliyuncs.com` | string | false |
writeConnectionSecretToRef | The secret which the cloud resource connection will be written to | [writeConnectionSecretToRef](#writeConnectionSecretToRef) | false |
@ -59,12 +59,12 @@ If `writeConnectionSecretToRef` is set, a secret will be generated with these ke
Name | Description
------------ | -------------
DB_NAME | RDS Instance Name
DB_USER | RDS Instance User
DB_HOST | RDS Instance Host
DATABASE_NAME | RDS Database Name
RESOURCE_IDENTIFIER | The identifier of the resource
DB_ID | RDS Instance ID
DB_PORT | RDS Instance Port
DB_HOST | RDS Instance Host
DB_PASSWORD | RDS Instance Password
DB_PUBLIC_HOST | RDS Instance Public Host
DATABASE_NAME | RDS Database Name
DB_ID | RDS Instance ID
DB_NAME | RDS Instance Name
DB_USER | RDS Instance User

View File

@ -32,9 +32,9 @@ spec:
Name | Description | Type | Required | Default
------------ | ------------- | ------------- | ------------- | -------------
instance_name | Redis instance name | string | true |
account_name | Redis instance user account name | string | true |
password | RDS instance account password | string | true |
instance_name | Redis instance name | string | false |
account_name | Redis instance user account name | string | false |
password | RDS instance account password | string | false |
writeConnectionSecretToRef | The secret which the cloud resource connection will be written to | [writeConnectionSecretToRef](#writeConnectionSecretToRef) | false |
@ -52,8 +52,8 @@ If `writeConnectionSecretToRef` is set, a secret will be generated with these ke
Name | Description
------------ | -------------
REDIS_CONNECT_ADDRESS | Redis connect address
REDIS_USER | Redis user
REDIS_PASSWORD | Redis password
RESOURCE_IDENTIFIER | The identifier of the resource
REDIS_NAME | Redis instance name
REDIS_CONNECT_ADDRESS | Redis connect address

View File

@ -38,9 +38,9 @@ If `writeConnectionSecretToRef` is set, a secret will be generated with these ke
Name | Description
------------ | -------------
TOPIC_ID | The id of ons topic
GROUP_ID | The id of ons group
HTTP_ENDPOINT_INTERNET | The internet http endpoint of ons instance
HTTP_ENDPOINT_INTERNAL | The internal http endpoint of ons instance
TCP_ENDPOINT | The tcp endpoint of ons instance
INSTANCE_ID | The id of ons instance
TOPIC_ID | The id of ons topic

View File

@ -32,8 +32,8 @@ spec:
Name | Description | Type | Required | Default
------------ | ------------- | ------------- | ------------- | -------------
name | Name of security group. It is used to create a new security group. | string | true |
description | Description of security group | string | true |
name | Name of security group. It is used to create a new security group. | string | false |
description | Description of security group | string | false |
writeConnectionSecretToRef | The secret which the cloud resource connection will be written to | [writeConnectionSecretToRef](#writeConnectionSecretToRef) | false |

View File

@ -34,15 +34,15 @@ spec:
Name | Description | Type | Required | Default
------------ | ------------- | ------------- | ------------- | -------------
project_name | Name of security group. It is used to create a new security group. | string | true |
store_shard_count | The number of shards in this log store. Default to 2. You can modify it by 'Split' or 'Merge' operations. | number | true |
store_max_split_shard_count | The maximum number of shards for automatic split, which is in the range of 1 to 64. You must specify this parameter when autoSplit is true. | number | true |
store_append_meta | Determines whether to append log meta automatically. The meta includes log receive time and client IP address. Default to true. | bool | true |
description | Description of security group | string | true |
create_project | Whether to create log resources | string | true |
store_name | Log store name. | string | true |
store_retention_period | The data retention time (in days). Valid values: [1-3650]. Default to 30. Log store data will be stored permanently when the value is '3650'. | number | true |
store_auto_split | Determines whether to automatically split a shard. Default to true. | bool | true |
store_auto_split | Determines whether to automatically split a shard. Default to true. | bool | false |
store_max_split_shard_count | The maximum number of shards for automatic split, which is in the range of 1 to 64. You must specify this parameter when autoSplit is true. | number | false |
store_append_meta | Determines whether to append log meta automatically. The meta includes log receive time and client IP address. Default to true. | bool | false |
project_name | Name of security group. It is used to create a new security group. | string | false |
description | Description of security group | string | false |
store_shard_count | The number of shards in this log store. Default to 2. You can modify it by 'Split' or 'Merge' operations. | number | false |
create_project | Whether to create log resources | string | false |
store_name | Log store name. | string | false |
store_retention_period | The data retention time (in days). Valid values: [1-3650]. Default to 30. Log store data will be stored permanently when the value is '3650'. | number | false |
writeConnectionSecretToRef | The secret which the cloud resource connection will be written to | [writeConnectionSecretToRef](#writeConnectionSecretToRef) | false |

View File

@ -31,9 +31,9 @@ spec:
Name | Description | Type | Required | Default
------------ | ------------- | ------------- | ------------- | -------------
vpc_name | The vpc name used to launch a new vpc. | string | true |
vpc_description | The vpc description used to launch a new vpc. | string | true |
vpc_cidr | The cidr block used to launch a new vpc. | string | true |
vpc_name | The vpc name used to launch a new vpc. | string | false |
vpc_description | The vpc description used to launch a new vpc. | string | false |
vpc_cidr | The cidr block used to launch a new vpc. | string | false |
writeConnectionSecretToRef | The secret which the cloud resource connection will be written to | [writeConnectionSecretToRef](#writeConnectionSecretToRef) | false |

View File

@ -13,15 +13,15 @@ Terraform configuration for Alibaba Cloud VSwitch
Name | Description | Type | Required | Default
------------ | ------------- | ------------- | ------------- | -------------
create_vpc | Whether to create vpc. If false, you can specify an existing vpc by setting 'vpc_id'. | bool | true |
vpc_description | The vpc description used to launch a new vpc. | string | true |
vpc_name | The vpc name used to launch a new vpc. | string | true |
vpc_cidr | The cidr block used to launch a new vpc. | string | true |
vpc_id | The vpc id used to launch several vswitches. If set, the 'create' will be ignored. | string | true |
vswitch_cidr | cidr blocks used to launch a new vswitch. | string | true |
vswitch_description | The vswitch description used to launch several new vswitch. | string | true |
zone_id | Availability Zone ID | string | true |
vswitch_name | The vswitch name prefix used to launch several new vswitches. | | true |
vswitch_description | The vswitch description used to launch several new vswitch. | string | false |
vpc_name | The vpc name used to launch a new vpc. | string | false |
vpc_description | The vpc description used to launch a new vpc. | string | false |
vpc_cidr | The cidr block used to launch a new vpc. | string | false |
vswitch_cidr | cidr blocks used to launch a new vswitch. | string | false |
create_vpc | Whether to create vpc. If false, you can specify an existing vpc by setting 'vpc_id'. | bool | false |
vpc_id | The vpc id used to launch several vswitches. If set, the 'create' will be ignored. | string | false |
zone_id | Availability Zone ID | string | false |
vswitch_name | The vswitch name prefix used to launch several new vswitches. | | false |
writeConnectionSecretToRef | The secret which the cloud resource connection will be written to | [writeConnectionSecretToRef](#writeConnectionSecretToRef) | false |

View File

@ -0,0 +1,102 @@
---
title: AWS RDS
---
## Description
AWS RDS
## Specification
### Properties
Name | Description | Type | Required | Default
------------ | ------------- | ------------- | ------------- | -------------
port | The port on which the DB accepts connections | string | false |
availability_zone | The Availability Zone of the RDS instance | string | false |
tags | A mapping of tags to assign to all resources | map(string) | false |
parameter_group_description | Description of the DB parameter group to create | string | false |
performance_insights_retention_period | The amount of time in days to retain Performance Insights data. Either 7 (7 days) or 731 (2 years). | number | false |
allocated_storage | The allocated storage in gigabytes | string | false |
s3_import | Restore from a Percona Xtrabackup in S3 (only MySQL is supported) | map(string) | false |
create_db_subnet_group | Whether to create a database subnet group | bool | false |
parameter_group_name | Name of the DB parameter group to associate or create | string | false |
deletion_protection | The database can't be deleted when this value is set to true. | bool | false |
performance_insights_kms_key_id | The ARN for the KMS key to encrypt Performance Insights data. | string | false |
monitoring_role_name | Name of the IAM role which will be created when create_monitoring_role is enabled. | string | false |
restore_to_point_in_time | Restore to a point in time (MySQL is NOT supported) | map(string) | false |
db_subnet_group_name | Name of DB subnet group. DB instance will be created in the VPC associated with the DB subnet group. If unspecified, will be created in the default VPC | string | false |
create_db_parameter_group | Whether to create a database parameter group | bool | false |
create_db_instance | Whether to create a database instance | bool | false |
replicate_source_db | Specifies that this resource is a Replicate database, and to use this value as the source database. This correlates to the identifier of another Amazon RDS Database to replicate. | string | false |
domain | The ID of the Directory Service Active Directory domain to create the instance in | string | false |
snapshot_identifier | Specifies whether or not to create this database from a snapshot. This correlates to the snapshot ID you'd find in the RDS console, e.g: rds:production-2015-06-26-06-05. | string | false |
options | A list of Options to apply. | any | false |
domain_iam_role_name | (Required if domain is provided) The name of the IAM role to be used when making API calls to the Directory Service | string | false |
copy_tags_to_snapshot | On delete, copy all Instance tags to the final snapshot (if final_snapshot_identifier is specified) | bool | false |
name | The DB name to create. If omitted, no database is created initially | string | false |
timeouts | (Optional) Updated Terraform resource management timeouts. Applies to `aws_db_instance` in particular to permit resource management times | map(string) | false |
engine_version | The engine version to use | string | false |
skip_final_snapshot | Determines whether a final DB snapshot is created before the DB instance is deleted. If true is specified, no DBSnapshot is created. If false is specified, a DB snapshot is created before the DB instance is deleted, using the value from final_snapshot_identifier | bool | false |
db_subnet_group_description | Description of the DB subnet group to create | string | false |
create_random_password | Whether to create random password for RDS primary cluster | bool | false |
monitoring_role_description | Description of the monitoring IAM role | string | false |
kms_key_id | The ARN for the KMS encryption key. If creating an encrypted replica, set this to the destination KMS ARN. If storage_encrypted is set to true and kms_key_id is not specified the default KMS key created in your account will be used | string | false |
iam_database_authentication_enabled | Specifies whether or not the mappings of AWS Identity and Access Management (IAM) accounts to database accounts are enabled | bool | false |
final_snapshot_identifier_prefix | The name which is prefixed to the final snapshot on cluster destroy | string | false |
instance_class | The instance type of the RDS instance | string | false |
monitoring_interval | The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. Valid Values: 0, 1, 5, 10, 15, 30, 60. | number | false |
monitoring_role_arn | The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. Must be specified if monitoring_interval is non-zero. | string | false |
password | Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file | string | false |
vpc_security_group_ids | List of VPC security groups to associate | list(string) | false |
subnet_ids | A list of VPC subnet IDs | list(string) | false |
character_set_name | (Optional) The character set name to use for DB encoding in Oracle instances. This can't be changed. See Oracle Character Sets Supported in Amazon RDS and Collations and Character Sets for Microsoft SQL Server for more information. This can only be set on creation. | string | false |
ca_cert_identifier | Specifies the identifier of the CA certificate for the DB instance | string | false |
parameter_group_use_name_prefix | Determines whether to use `parameter_group_name` as is or create a unique name beginning with the `parameter_group_name` as the prefix | bool | false |
identifier | The name of the RDS instance, if omitted, Terraform will assign a random, unique identifier | string | true |
final_snapshot_identifier | The name of your final DB snapshot when this DB instance is deleted. | string | false |
iops | The amount of provisioned IOPS. Setting this implies a storage_type of 'io1' | number | false |
allow_major_version_upgrade | Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible | bool | false |
backup_retention_period | The days to retain backups for | number | false |
backup_window | The daily time range (in UTC) during which automated backups are created if they are enabled. Example: '09:46-10:16'. Must not overlap with maintenance_window | string | false |
performance_insights_enabled | Specifies whether Performance Insights are enabled | bool | false |
max_allocated_storage | Specifies the value for Storage Autoscaling | number | false |
license_model | License model information for this DB instance. Optional, but required for some DB engines, i.e. Oracle SE1 | string | false |
multi_az | Specifies if the RDS instance is multi-AZ | bool | false |
publicly_accessible | Bool to control if instance is publicly accessible | bool | false |
db_instance_tags | Additional tags for the DB instance | map(string) | false |
db_subnet_group_use_name_prefix | Determines whether to use `subnet_group_name` as is or create a unique name beginning with the `subnet_group_name` as the prefix | bool | false |
timezone | (Optional) Time zone of the DB instance. timezone is currently only supported by Microsoft SQL Server. The timezone can only be set on creation. See MSSQL User Guide for more information. | string | false |
create_monitoring_role | Create IAM role with a defined name that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. | bool | false |
auto_minor_version_upgrade | Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window | bool | false |
major_engine_version | Specifies the major version of the engine that this option group should be associated with | string | false |
maintenance_window | The window to perform maintenance in. Syntax: 'ddd:hh24:mi-ddd:hh24:mi'. Eg: 'Mon:00:00-Mon:03:00' | string | false |
db_option_group_tags | Additional tags for the DB option group | map(string) | false |
db_subnet_group_tags | Additional tags for the DB subnet group | map(string) | false |
random_password_length | (Optional) Length of random password to create. (default: 10) | number | false |
storage_type | One of 'standard' (magnetic), 'gp2' (general purpose SSD), or 'io1' (provisioned IOPS SSD). The default is 'io1' if iops is specified, 'gp2' if not. | string | false |
family | The family of the DB parameter group | string | false |
storage_encrypted | Specifies whether the DB instance is encrypted | bool | false |
username | Username for the master DB user | string | false |
parameters | A list of DB parameters (map) to apply | list(map(string)) | false |
option_group_name | Name of the option group | string | false |
enabled_cloudwatch_logs_exports | List of log types to enable for exporting to CloudWatch logs. If omitted, no logs will be exported. Valid values (depending on engine): alert, audit, error, general, listener, slowquery, trace, postgresql (PostgreSQL), upgrade (PostgreSQL). | list(string) | false |
delete_automated_backups | Specifies whether to remove automated backups immediately after the DB instance is deleted | bool | false |
apply_immediately | Specifies whether any database modifications are applied immediately, or during the next maintenance window | bool | false |
db_parameter_group_tags | Additional tags for the DB parameter group | map(string) | false |
create_db_option_group | (Optional) Create a database option group | bool | false |
option_group_use_name_prefix | Determines whether to use `option_group_name` as is or create a unique name beginning with the `option_group_name` as the prefix | bool | false |
cross_region_replica | Specifies if the replica should be cross region. It allows the use of a subnet group in a region different than the master instance | bool | false |
engine | The database engine to use | string | false |
option_group_description | The description of the option group | string | false |
option_group_timeouts | Define maximum timeout for deletion of `aws_db_option_group` resource | map(string) | false |
writeConnectionSecretToRef | The secret which the cloud resource connection will be written to | [writeConnectionSecretToRef](#writeConnectionSecretToRef) | false |
#### writeConnectionSecretToRef
Name | Description | Type | Required | Default
------------ | ------------- | ------------- | ------------- | -------------
name | The secret name which the cloud resource connection will be written to | string | true |
namespace | The secret namespace which the cloud resource connection will be written to | string | false |

View File

@ -32,8 +32,8 @@ spec:
Name | Description | Type | Required | Default
------------ | ------------- | ------------- | ------------- | -------------
bucket | S3 bucket name | string | true |
acl | S3 bucket ACL | string | true |
bucket | S3 bucket name | string | false |
acl | S3 bucket ACL | string | false |
writeConnectionSecretToRef | The secret which the cloud resource connection will be written to | [writeConnectionSecretToRef](#writeConnectionSecretToRef) | false |

View File

@ -0,0 +1,71 @@
---
title: AWS SECURITY-GROUP
---
## Description
AWS Security Group
## Specification
### Properties
Name | Description | Type | Required | Default
------------ | ------------- | ------------- | ------------- | -------------
egress_with_self | List of egress rules to create where 'self' is defined | list(map(string)) | false |
egress_with_ipv6_cidr_blocks | List of egress rules to create where 'ipv6_cidr_blocks' is used | list(map(string)) | false |
number_of_computed_egress_with_source_security_group_id | Number of computed egress rules to create where 'source_security_group_id' is used | number | false |
create | Whether to create security group and all rules | bool | false |
ingress_cidr_blocks | List of IPv4 CIDR ranges to use on all ingress rules | list(string) | false |
delete_timeout | Time to wait for a security group to be deleted | string | false |
ingress_prefix_list_ids | List of prefix list IDs (for allowing access to VPC endpoints) to use on all ingress rules | list(string) | false |
computed_ingress_with_cidr_blocks | List of computed ingress rules to create where 'cidr_blocks' is used | list(map(string)) | false |
number_of_computed_ingress_with_cidr_blocks | Number of computed ingress rules to create where 'cidr_blocks' is used | number | false |
egress_rules | List of egress rules to create by name | list(string) | false |
egress_with_source_security_group_id | List of egress rules to create where 'source_security_group_id' is used | list(map(string)) | false |
revoke_rules_on_delete | Instruct Terraform to revoke all of the Security Groups attached ingress and egress rules before deleting the rule itself. Enable for EMR. | bool | false |
tags | A mapping of tags to assign to security group | map(string) | false |
egress_ipv6_cidr_blocks | List of IPv6 CIDR ranges to use on all egress rules | list(string) | false |
number_of_computed_egress_rules | Number of computed egress rules to create by name | number | false |
computed_ingress_rules | List of computed ingress rules to create by name | list(string) | false |
number_of_computed_ingress_rules | Number of computed ingress rules to create by name | number | false |
number_of_computed_ingress_with_ipv6_cidr_blocks | Number of computed ingress rules to create where 'ipv6_cidr_blocks' is used | number | false |
computed_egress_rules | List of computed egress rules to create by name | list(string) | false |
ingress_with_self | List of ingress rules to create where 'self' is defined | list(map(string)) | false |
ingress_with_source_security_group_id | List of ingress rules to create where 'source_security_group_id' is used | list(map(string)) | false |
egress_cidr_blocks | List of IPv4 CIDR ranges to use on all egress rules | list(string) | false |
number_of_computed_egress_with_self | Number of computed egress rules to create where 'self' is defined | number | false |
number_of_computed_egress_with_ipv6_cidr_blocks | Number of computed egress rules to create where 'ipv6_cidr_blocks' is used | number | false |
create_sg | Whether to create security group | bool | false |
description | Description of security group | string | false |
computed_ingress_with_ipv6_cidr_blocks | List of computed ingress rules to create where 'ipv6_cidr_blocks' is used | list(map(string)) | false |
computed_ingress_with_source_security_group_id | List of computed ingress rules to create where 'source_security_group_id' is used | list(map(string)) | false |
number_of_computed_ingress_with_source_security_group_id | Number of computed ingress rules to create where 'source_security_group_id' is used | number | false |
computed_egress_with_source_security_group_id | List of computed egress rules to create where 'source_security_group_id' is used | list(map(string)) | false |
ingress_rules | List of ingress rules to create by name | list(string) | false |
ingress_ipv6_cidr_blocks | List of IPv6 CIDR ranges to use on all ingress rules | list(string) | false |
egress_prefix_list_ids | List of prefix list IDs (for allowing access to VPC endpoints) to use on all egress rules | list(string) | false |
name | Name of security group - not required if create_sg is false | string | false |
ingress_with_ipv6_cidr_blocks | List of ingress rules to create where 'ipv6_cidr_blocks' is used | list(map(string)) | false |
computed_egress_with_self | List of computed egress rules to create where 'self' is defined | list(map(string)) | false |
computed_egress_with_ipv6_cidr_blocks | List of computed egress rules to create where 'ipv6_cidr_blocks' is used | list(map(string)) | false |
ingress_with_cidr_blocks | List of ingress rules to create where 'cidr_blocks' is used | list(map(string)) | false |
egress_with_cidr_blocks | List of egress rules to create where 'cidr_blocks' is used | list(map(string)) | false |
use_name_prefix | Whether to use name_prefix or fixed name. Should be true to able to update security group name after initial creation | bool | false |
create_timeout | Time to wait for a security group to be created | string | false |
computed_ingress_with_self | List of computed ingress rules to create where 'self' is defined | list(map(string)) | false |
number_of_computed_ingress_with_self | Number of computed ingress rules to create where 'self' is defined | number | false |
computed_egress_with_cidr_blocks | List of computed egress rules to create where 'cidr_blocks' is used | list(map(string)) | false |
number_of_computed_egress_with_cidr_blocks | Number of computed egress rules to create where 'cidr_blocks' is used | number | false |
security_group_id | ID of existing security group whose rules we will manage | string | false |
vpc_id | ID of the VPC where to create security group | string | false |
writeConnectionSecretToRef | The secret which the cloud resource connection will be written to | [writeConnectionSecretToRef](#writeConnectionSecretToRef) | false |
#### writeConnectionSecretToRef
Name | Description | Type | Required | Default
------------ | ------------- | ------------- | ------------- | -------------
name | The secret name which the cloud resource connection will be written to | string | true |
namespace | The secret namespace which the cloud resource connection will be written to | string | false |

View File

@ -0,0 +1,41 @@
---
title: AWS SUBNET
---
## Description
AWS Subnet
## Specification
### Properties
Name | Description | Type | Required | Default
------------ | ------------- | ------------- | ------------- | -------------
create_vpc | Controls if VPC should be created (it affects almost all resources) | bool | false |
name | Name to be used on all the resources as identifier | string | false |
cidr | The CIDR block for the VPC. Default value is a valid CIDR, but not acceptable by AWS and should be overridden | string | false |
enable_classiclink | Should be true to enable ClassicLink for the VPC. Only valid in regions and accounts that support EC2 Classic. | bool | false |
enable_classiclink_dns_support | Should be true to enable ClassicLink DNS Support for the VPC. Only valid in regions and accounts that support EC2 Classic. | bool | false |
vpc_tags | Additional tags for the VPC | map(string) | false |
subnet_tags | A map of tags for the Subnet | map(string) | false |
enable_ipv6 | Requests an Amazon-provided IPv6 CIDR block with a /56 prefix length for the VPC. You cannot specify the range of IP addresses, or the size of the CIDR block. | bool | false |
instance_tenancy | A tenancy option for instances launched into the VPC | string | false |
enable_dns_hostnames | Should be true to enable DNS hostnames in the VPC | bool | false |
subnet_cidr | A list of subnets cidrs inside the VPC | string | false |
ipv6_cidr_block | The IPv6 CIDR block for the VPC. | string | false |
assign_ipv6_address_on_creation | Assign IPv6 address on subnet, must be disabled to change IPv6 CIDRs. This is the IPv6 equivalent of map_public_ip_on_launch | bool | false |
enable_dns_support | Should be true to enable DNS support in the VPC | bool | false |
map_public_ip_on_launch | Should be false if you do not want to auto-assign public IP on launch | bool | false |
availability_zone | An availability zone name in the region | string | false |
vpc_id | The ID of the VPC | string | false |
writeConnectionSecretToRef | The secret which the cloud resource connection will be written to | [writeConnectionSecretToRef](#writeConnectionSecretToRef) | false |
#### writeConnectionSecretToRef
Name | Description | Type | Required | Default
------------ | ------------- | ------------- | ------------- | -------------
name | The secret name which the cloud resource connection will be written to | string | true |
namespace | The secret namespace which the cloud resource connection will be written to | string | false |

View File

@ -0,0 +1,35 @@
---
title: AWS VPC
---
## Description
AWS VPC
## Specification
### Properties
Name | Description | Type | Required | Default
------------ | ------------- | ------------- | ------------- | -------------
name | Name to be used on all the resources as identifier | string | false |
cidr | The CIDR block for the VPC. Default value is a valid CIDR, but not acceptable by AWS and should be overridden | string | false |
instance_tenancy | A tenancy option for instances launched into the VPC | string | false |
enable_dns_hostnames | Should be true to enable DNS hostnames in the VPC | bool | false |
enable_classiclink_dns_support | Should be true to enable ClassicLink DNS Support for the VPC. Only valid in regions and accounts that support EC2 Classic. | bool | false |
tags | A map of tags to add to all resources | map(string) | false |
create_vpc | Controls if VPC should be created (it affects almost all resources) | bool | false |
enable_dns_support | Should be true to enable DNS support in the VPC | bool | false |
enable_classiclink | Should be true to enable ClassicLink for the VPC. Only valid in regions and accounts that support EC2 Classic. | bool | false |
vpc_tags | Additional tags for the VPC | map(string) | false |
enable_ipv6 | Requests an Amazon-provided IPv6 CIDR block with a /56 prefix length for the VPC. You cannot specify the range of IP addresses, or the size of the CIDR block. | bool | false |
writeConnectionSecretToRef | The secret which the cloud resource connection will be written to | [writeConnectionSecretToRef](#writeConnectionSecretToRef) | false |
#### writeConnectionSecretToRef
Name | Description | Type | Required | Default
------------ | ------------- | ------------- | ------------- | -------------
name | The secret name which the cloud resource connection will be written to | string | true |
namespace | The secret namespace which the cloud resource connection will be written to | string | false |

View File

@ -36,12 +36,12 @@ spec:
Name | Description | Type | Required | Default
------------ | ------------- | ------------- | ------------- | -------------
db_name | Database instance name | string | true |
username | Database instance username | string | true |
password | Database instance password | string | true |
location | Azure location | string | true |
resource_group | Resource group | string | true |
server_name | mariadb server name | string | true |
username | Database instance username | string | false |
password | Database instance password | string | false |
location | Azure location | string | false |
resource_group | Resource group | string | false |
server_name | mariadb server name | string | false |
db_name | Database instance name | string | false |
writeConnectionSecretToRef | The secret which the cloud resource connection will be written to | [writeConnectionSecretToRef](#writeConnectionSecretToRef) | false |
@ -59,9 +59,9 @@ If `writeConnectionSecretToRef` is set, a secret will be generated with these ke
Name | Description
------------ | -------------
DB_NAME | Database instance name
DB_USER | Database instance username
DB_PASSWORD | Database instance password
DB_PORT | Database instance port
DB_HOST | Database instance host
SERVER_NAME | mariadb server name
DB_NAME | Database instance name

View File

@ -0,0 +1,35 @@
---
title: Azure RESOURCE-GROUP
---
## Description
Azure Resource Group
## Specification
### Properties
Name | Description | Type | Required | Default
------------ | ------------- | ------------- | ------------- | -------------
name | The name of the resource group | string | false |
location | The location of the resource group | string | false |
writeConnectionSecretToRef | The secret which the cloud resource connection will be written to | [writeConnectionSecretToRef](#writeConnectionSecretToRef) | false |
#### writeConnectionSecretToRef
Name | Description | Type | Required | Default
------------ | ------------- | ------------- | ------------- | -------------
name | The secret name which the cloud resource connection will be written to | string | true |
namespace | The secret namespace which the cloud resource connection will be written to | string | false |
### Outputs
If `writeConnectionSecretToRef` is set, a secret will be generated with these keys as below:
Name | Description
------------ | -------------
resource_group_name | The name of the resource group

View File

@ -45,12 +45,12 @@ spec:
Name | Description | Type | Required | Default
------------ | ------------- | ------------- | ------------- | -------------
create_rsg | Conditional if resource group should be created. Defaults to 'true'. | bool | true |
resource_group_name | Name of resource group. Defaults to 'rsg'. | string | true |
name | Name of storage account. Defaults to 'storageaccount'. | string | true |
location | Location of storage account. Defaults to 'West Europe'. | string | true |
tags | Tags for storage account. Defaults to '{}'. | map(string) | true |
static_website | Static website configuration. Defaults to disabled. | list(map(string)) | true |
static_website | Static website configuration. Defaults to disabled. | list(map(string)) | false |
create_rsg | Conditional if resource group should be created. Defaults to 'true'. | bool | false |
resource_group_name | Name of resource group. Defaults to 'rsg'. | string | false |
name | Name of storage account. Defaults to 'storageaccount'. | string | false |
location | Location of storage account. Defaults to 'West Europe'. | string | false |
tags | Tags for storage account. Defaults to '{}'. | map(string) | false |
writeConnectionSecretToRef | The secret which the cloud resource connection will be written to | [writeConnectionSecretToRef](#writeConnectionSecretToRef) | false |

View File

@ -0,0 +1,34 @@
---
title: Azure SUBNET
---
## Description
Azure Subnet
## Specification
### Properties
Name | Description | Type | Required | Default
------------ | ------------- | ------------- | ------------- | -------------
subnet_enforce_private_link_endpoint_network_policies | A map with key (string) `subnet name`, value (bool) `true` or `false` to indicate enable or disable network policies for the private link endpoint on the subnet. Default value is false. | map(bool) | false |
subnet_service_endpoints | A map with key (string) `subnet name`, value (list(string)) to indicate enabled service endpoints on the subnet. Default value is []. | map(list(string)) | false |
subnet_prefixes | The address prefix to use for the subnet. | list(string) | false |
subnet_names | A list of public subnets inside the vNet. | list(string) | false |
tags | The tags to associate with your network and subnets. | map(string) | false |
vnet_name | Name of the vnet to create. | string | false |
resource_group_name | The name of an existing resource group to be imported. | string | true |
address_space | The address space that is used by the virtual network. | string | false |
address_spaces | The list of the address spaces that is used by the virtual network. | list(string) | false |
dns_servers | The DNS servers to be used with vNet. | list(string) | false |
writeConnectionSecretToRef | The secret which the cloud resource connection will be written to | [writeConnectionSecretToRef](#writeConnectionSecretToRef) | false |
#### writeConnectionSecretToRef
Name | Description | Type | Required | Default
------------ | ------------- | ------------- | ------------- | -------------
name | The secret name which the cloud resource connection will be written to | string | true |
namespace | The secret namespace which the cloud resource connection will be written to | string | false |

View File

@ -0,0 +1,30 @@
---
title: Azure VIRTUAL-NETWORK
---
## Description
Azure Virtual Network
## Specification
### Properties
Name | Description | Type | Required | Default
------------ | ------------- | ------------- | ------------- | -------------
resource_group_name | The name of an existing resource group to be imported. | string | true |
address_space | The address space that is used by the virtual network. | string | false |
address_spaces | The list of the address spaces that is used by the virtual network. | list(string) | false |
dns_servers | The DNS servers to be used with vNet. | list(string) | false |
tags | The tags to associate with your network and subnets. | map(string) | false |
vnet_name | Name of the vnet to create. | string | false |
writeConnectionSecretToRef | The secret which the cloud resource connection will be written to | [writeConnectionSecretToRef](#writeConnectionSecretToRef) | false |
#### writeConnectionSecretToRef
Name | Description | Type | Required | Default
------------ | ------------- | ------------- | ------------- | -------------
name | The secret name which the cloud resource connection will be written to | string | true |
namespace | The secret namespace which the cloud resource connection will be written to | string | false |

View File

@ -13,11 +13,11 @@ Terraform configuration for Tencent Cloud VPC
Name | Description | Type | Required | Default
------------ | ------------- | ------------- | ------------- | -------------
vpc_dns_servers | Specify the vpc dns servers when 'vpc_id' is not specified. | list(string) | false |
vpc_tags | Additional tags for the vpc. | map(string) | false |
vpc_name | The vpc name used to launch a new vpc when 'vpc_id' is not specified. | string | false |
vpc_cidr | The cidr block used to launch a new vpc when 'vpc_id' is not specified. | string | false |
vpc_is_multicast | Specify the vpc is multicast when 'vpc_id' is not specified. | bool | false |
vpc_dns_servers | Specify the vpc dns servers when 'vpc_id' is not specified. | list(string) | false |
vpc_tags | Additional tags for the vpc. | map(string) | false |
writeConnectionSecretToRef | The secret which the cloud resource connection will be written to | [writeConnectionSecretToRef](#writeConnectionSecretToRef) | false |

View File

@ -48,7 +48,7 @@ KubeVela supports the following types of resources and more later on:
| Orchestration Type | Cloud Provider | Cloud Resource | Description |
|--------------------|----------------|------------------------------------------------------------------------------------------|-----------------------------------------------------------------------|
| Terraform | Alibaba Cloud | [ACK](../end-user/components/cloud-services/terraform/alibaba-ack) | Terraform configuration for Alibaba Cloud ACK cluster |
| | | [ASK](../end-user/components/cloud-services/terraform/alibaba-amqp) | Terraform configuration for Alibaba Cloud AMQP (RabbitMQ) |
| | | [AMQP](../end-user/components/cloud-services/terraform/alibaba-amqp) | Terraform configuration for Alibaba Cloud AMQP (RabbitMQ) |
| | | [ASK](../end-user/components/cloud-services/terraform/alibaba-ask) | Terraform configuration for Alibaba Cloud Serverless Kubernetes (ASK) |
| | | [EIP](../end-user/components/cloud-services/terraform/alibaba-eip) | Terraform configuration for Alibaba Cloud EIP |
| | | [MSE](../end-user/components/cloud-services/terraform/alibaba-mse) | Terraform configuration for Alibaba Cloud MSE |
@ -61,8 +61,17 @@ KubeVela supports the following types of resources and more later on:
| | | [VPC](../end-user/components/cloud-services/terraform/alibaba-vpc) | Terraform configuration for Alibaba Cloud VPC |
| | | [VSwitch](../end-user/components/cloud-services/terraform/alibaba-vswitch) | Terraform configuration for Alibaba Cloud VSwitch |
| | AWS | [S3](../end-user/components/cloud-services/terraform/aws-s3) | Terraform configuration for AWS S3 bucket |
| | | [S3](../end-user/components/cloud-services/terraform/aws-rds) | Terraform configuration for AWS RDS |
| | | [S3](../end-user/components/cloud-services/terraform/aws-security-group) | Terraform configuration for AWS Security Group |
| | | [S3](../end-user/components/cloud-services/terraform/aws-subnet) | Terraform configuration for AWS S3 Subnet |
| | | [S3](../end-user/components/cloud-services/terraform/aws-vpc) | Terraform configuration for AWS S3 VPC |
| | Azure | [Mariadb](../end-user/components/cloud-services/terraform/azure-database-mariadb) | Terraform configuration for Azure Database Mariadb |
| | | [Storage Account](../end-user/components/cloud-services/terraform/azure-storage-account) | Terraform configuration for Azure Storage Account |
| | | [Storage Account](../end-user/components/cloud-services/terraform/azure-resource-group) | Terraform configuration for Azure Resource group |
| | | [Storage Account](../end-user/components/cloud-services/terraform/azure-subnet) | Terraform configuration for Azure Subnet |
| | | [Storage Account](../end-user/components/cloud-services/terraform/azure-virtual-network) | Terraform configuration for Azure Virtual network |
| | Tencent Cloud | [Mariadb](../end-user/components/cloud-services/terraform/tencent-vpc) | Terraform configuration for Tencent Cloud VPC |
| | | [Mariadb](../end-user/components/cloud-services/terraform/tencent-subnet) | Terraform configuration for Tencent Cloud Subnet |
## Creating your cloud service

View File

@ -28,8 +28,18 @@ KubeVela 通过云资源组件Component和运维特征Trait里的资
| | | [VPC](./terraform/alibaba-vpc) | Terraform configuration for Alibaba Cloud VPC |
| | | [VSwitch](./terraform/alibaba-vswitch) | Terraform configuration for Alibaba Cloud VSwitch |
| | AWS | [S3](./terraform/aws-s3) | Terraform configuration for AWS S3 bucket |
| | | [S3](./terraform/aws-rds) | Terraform configuration for AWS RDS |
| | | [S3](./terraform/aws-security-group) | Terraform configuration for AWS Security Group |
| | | [S3](./terraform/aws-subnet) | Terraform configuration for AWS S3 Subnet |
| | | [S3](./terraform/aws-vpc) | Terraform configuration for AWS S3 VPC |
| | Azure | [Mariadb](./terraform/azure-database-mariadb) | Terraform configuration for Azure Database Mariadb |
| | | [Storage Account](./terraform/azure-storage-account) | Terraform configuration for Azure Storage Account |
| | | [Storage Account](./terraform/azure-resource-group) | Terraform configuration for Azure Resource group |
| | | [Storage Account](./terraform/azure-subnet) | Terraform configuration for Azure Subnet |
| | | [Storage Account](./terraform/azure-virtual-network) | Terraform configuration for Azure Virtual network |
| | | [Storage Account](./terraform/azure-storage-account) | Terraform configuration for Azure Storage Account |
| | 腾讯云 | [Mariadb](./terraform/tencent-vpc) | Terraform configuration for Tencent Cloud VPC |
| | | [Mariadb](./terraform/tencent-subnet) | Terraform configuration for Tencent Cloud Subnet |
## Terraform

View File

@ -30,29 +30,29 @@ spec:
名称 | 描述 | 类型 | 是否必须 | 默认值
------------ | ------------- | ------------- | ------------- | -------------
k8s_version | The version of the kubernetes version. Valid values: '1.16.6-aliyun.1','1.14.8-aliyun.1'. Default to '1.16.6-aliyun.1'. | string | true |
zone_id | Availability Zone ID | string | true |
cpu_core_count | CPU core count is used to fetch instance types. | number | true |
vpc_name | The vpc name used to create a new vpc when 'vpc_id' is not specified. Default to variable `example_name` | string | true |
enable_ssh | Enable login to the node through SSH. | bool | true |
cpu_policy | kubelet cpu policy. Valid values: 'none','static'. Default to 'none'. | string | true |
proxy_mode | Proxy mode is option of kube-proxy. Valid values: 'ipvs','iptables'. Default to 'iptables'. | string | true |
k8s_service_cidr | The kubernetes service cidr block. It cannot be equals to vpc's or vswitch's or pod's and cannot be in them. | string | true |
vpc_cidr | The cidr block used to launch a new vpc when 'vpc_id' is not specified. | string | true |
password | The password of ECS instance. | string | true |
k8s_pod_cidr | The kubernetes pod cidr block. It cannot be equals to vpc's or vswitch's and cannot be in them. | string | true |
vswitch_ids | List of existing vswitch id. | list(any) | true |
vswitch_cidrs | List of cidr blocks used to create several new vswitches when 'vswitch_ids' is not specified. | list(any) | true |
new_nat_gateway | Whether to create a new nat gateway. In this template, a new nat gateway will create a nat gateway, eip and server snat entries. | bool | true |
node_cidr_mask | The node cidr block to specific how many pods can run on single node. Valid values: [24-28]. | number | true |
k8s_worker_number | The number of worker nodes in kubernetes cluster. | number | true |
install_cloud_monitor | Install cloud monitor agent on ECS. | bool | true |
memory_size | Memory size used to fetch instance types. | number | true |
vswitch_name_prefix | The vswitch name prefix used to create several new vswitches. Default to variable 'example_name'. | string | true |
number_format | The number format used to output. | string | true |
k8s_name_prefix | The name prefix used to create several kubernetes clusters. Default to variable `example_name` | string | true |
master_instance_types | The ecs instance types used to launch master nodes. | list(any) | true |
worker_instance_types | The ecs instance types used to launch worker nodes. | list(any) | true |
vpc_name | The vpc name used to create a new vpc when 'vpc_id' is not specified. Default to variable `example_name` | string | false |
enable_ssh | Enable login to the node through SSH. | bool | false |
install_cloud_monitor | Install cloud monitor agent on ECS. | bool | false |
k8s_worker_number | The number of worker nodes in kubernetes cluster. | number | false |
k8s_service_cidr | The kubernetes service cidr block. It cannot be equals to vpc's or vswitch's or pod's and cannot be in them. | string | false |
k8s_pod_cidr | The kubernetes pod cidr block. It cannot be equals to vpc's or vswitch's and cannot be in them. | string | false |
zone_id | Availability Zone ID | string | false |
vpc_cidr | The cidr block used to launch a new vpc when 'vpc_id' is not specified. | string | false |
vswitch_cidrs | List of cidr blocks used to create several new vswitches when 'vswitch_ids' is not specified. | list(any) | false |
k8s_name_prefix | The name prefix used to create several kubernetes clusters. Default to variable `example_name` | string | false |
new_nat_gateway | Whether to create a new nat gateway. In this template, a new nat gateway will create a nat gateway, eip and server snat entries. | bool | false |
worker_instance_types | The ecs instance types used to launch worker nodes. | list(any) | false |
cpu_policy | kubelet cpu policy. Valid values: 'none','static'. Default to 'none'. | string | false |
proxy_mode | Proxy mode is option of kube-proxy. Valid values: 'ipvs','iptables'. Default to 'iptables'. | string | false |
cpu_core_count | CPU core count is used to fetch instance types. | number | false |
memory_size | Memory size used to fetch instance types. | number | false |
vswitch_name_prefix | The vswitch name prefix used to create several new vswitches. Default to variable 'example_name'. | string | false |
number_format | The number format used to output. | string | false |
vswitch_ids | List of existing vswitch id. | list(any) | false |
master_instance_types | The ecs instance types used to launch master nodes. | list(any) | false |
node_cidr_mask | The node cidr block to specific how many pods can run on single node. Valid values: [24-28]. | number | false |
password | The password of ECS instance. | string | false |
k8s_version | The version of the kubernetes version. Valid values: '1.16.6-aliyun.1','1.14.8-aliyun.1'. Default to '1.16.6-aliyun.1'. | string | false |
writeConnectionSecretToRef | The secret which the cloud resource connection will be written to | [writeConnectionSecretToRef](#writeConnectionSecretToRef) | false |

View File

@ -13,21 +13,21 @@ Terraform configuration for Alibaba Cloud AMQP(RabbitMQ)
名称 | 描述 | 类型 | 是否必须 | 默认值
------------ | ------------- | ------------- | ------------- | -------------
create | Whether to create instance. If false, you can specify an existing instance by setting 'instance_id'. | bool | false |
payment_type | The specification of the payment type. | string | false |
auto_delete_state | Specifies whether the Auto Delete attribute is configured. Valid values: true: The Auto Delete attributeis configured. If the last queue that is bound to an exchange is unbound, the exchange is automatically deleted. false: The Auto Delete attribute is not configured. If the last queue that is bound to an exchange is unbound, the exchange is not automatically deleted. | bool | false |
internal | The specification of the internal. | bool | false |
instance_type | The specification of the instance type. Valid values: professional, vip. | string | false |
queue_capacity | The specification of the queue capacity. The smallest value is 50 and the step size 5. | number | false |
support_eip | The specification of support EIP. | bool | false |
max_eip_tps | The specification of the max eip tps. It is valid when support_eip is true. The valid value is [128, 45000] with the step size 128 | number | false |
period | The specification of the period. Valid values: 1, 12, 2, 24, 3, 6. | number | false |
argument | The specification of the argument. | string | false |
binding_type | The specification of the binding type. Valid values: EXCHANGE, QUEUE. | string | false |
name | The specification of module name. | string | false |
max_tps | The specification of the peak TPS traffic. The smallest valid value is 1000 and the largest value is 100,000. | number | false |
instance_id | The instance_id used to RabbitMQ. If set, the 'create' will be ignored. | string | false |
payment_type | The specification of the payment type. | string | false |
exchange_type | The specification of the exchange type. Valid values: FANOUT, DIRECT, TOPIC, HEADERS | string | false |
internal | The specification of the internal. | bool | false |
name | The specification of module name. | string | false |
argument | The specification of the argument. | string | false |
instance_type | The specification of the instance type. Valid values: professional, vip. | string | false |
max_tps | The specification of the peak TPS traffic. The smallest valid value is 1000 and the largest value is 100,000. | number | false |
period | The specification of the period. Valid values: 1, 12, 2, 24, 3, 6. | number | false |
create | Whether to create instance. If false, you can specify an existing instance by setting 'instance_id'. | bool | false |
binding_type | The specification of the binding type. Valid values: EXCHANGE, QUEUE. | string | false |
support_eip | The specification of support EIP. | bool | false |
instance_id | The instance_id used to RabbitMQ. If set, the 'create' will be ignored. | string | false |
auto_delete_state | Specifies whether the Auto Delete attribute is configured. Valid values: true: The Auto Delete attributeis configured. If the last queue that is bound to an exchange is unbound, the exchange is automatically deleted. false: The Auto Delete attribute is not configured. If the last queue that is bound to an exchange is unbound, the exchange is not automatically deleted. | bool | false |
writeConnectionSecretToRef | The secret which the cloud resource connection will be written to | [writeConnectionSecretToRef](#writeConnectionSecretToRef) | false |

View File

@ -13,7 +13,7 @@ title: 阿里云 ASK
名称 | 描述 | 类型 | 是否必须 | 默认值
------------ | ------------- | ------------- | ------------- | -------------
name | ASK name | string | true |
name | ASK name | string | false |
writeConnectionSecretToRef | The secret which the cloud resource connection will be written to | [writeConnectionSecretToRef](#writeConnectionSecretToRef) | false |
@ -31,8 +31,8 @@ title: 阿里云 ASK
名称 | 描述
------------ | -------------
KUBECONFIG | The KubeConfig string of the kubernetes cluster.
RESOURCE_IDENTIFIER | The identifier of the resource
Name | Cluster Name
API_SERVER_INTRANET | The API server intranet address of the kubernetes cluster.
API_SERVER_INTERNET | The API server internet address of the kubernetes cluster.
KUBECONFIG | The KubeConfig string of the kubernetes cluster.

View File

@ -4,7 +4,7 @@ title: 阿里云 EIP
## 描述
用于部署阿里云 Elastic IP 的组件说明
用于部署阿里云弹性 IP 的组件说明
## 示例
@ -29,8 +29,8 @@ spec:
名称 | 描述 | 类型 | 是否必须 | 默认值
------------ | ------------- | ------------- | ------------- | -------------
name | Name to be used on all resources as prefix. Default to 'TF-Module-EIP'. | string | true |
bandwidth | Maximum bandwidth to the elastic public network, measured in Mbps (Mega bit per second). | number | true |
name | Name to be used on all resources as prefix. Default to 'TF-Module-EIP'. | string | false |
bandwidth | Maximum bandwidth to the elastic public network, measured in Mbps (Mega bit per second). | number | false |
writeConnectionSecretToRef | The secret which the cloud resource connection will be written to | [writeConnectionSecretToRef](#writeConnectionSecretToRef) | false |

View File

@ -13,28 +13,28 @@ Alibaba Cloud MongoDB
名称 | 描述 | 类型 | 是否必须 | 默认值
------------ | ------------- | ------------- | ------------- | -------------
instance_charge_type | The billing method of the instance. Valid values are Prepaid, PostPaid, Default to PostPaid | string | false |
period | The duration that you will buy DB instance (in month). It is valid when instance_charge_type is PrePaid. Valid values: [1~9], 12, 24, 36. Default to 1 | | false |
db_instance_storage | The storage space of the instance. Valid values: 10 to 3000. Unit: GB. You can only specify this value in 10 GB increments. | number | false |
existing_instance_id | The Id of an existing Mongodb instance. If set, the `create` will be ignored. | string | false |
instance_id | `(Deprecated)` It has been deprecated from version 1.2.0 and use `existing_instance_id` instead. | string | false |
replication_factor | The number of nodes in the replica set instance. Valid values: 3, 5, 7. Default value: 3. | number | false |
region | (Deprecated from version 1.4.0) The region used to launch this module resources. | string | false |
storage_engine | The MongoDB storage engine, WiredTiger or RocksDB. Default value: WiredTiger. | string | false |
name | The name of DB instance. It a string of 2 to 256 characters | string | true |
account_password | Password of the root account. It is a string of 6 to 32 characters and is composed of letters, numbers, and underlines | string | true |
backup_period | MongoDB Instance backup period. It is required when backup_time was existed. Valid values: [Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday]. Default to [Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday]. | list(string) | true |
backup_time | MongoDB instance backup time. It is required when backup_period was existed. In the format of HH:mmZ- HH:mmZ. Time setting interval is one hour. Default to a random time, like '23:00Z-24:00Z'. | string | false |
tags | A mapping of tags to assign to the mongodb instance resource. | map(string) | false |
engine_version | The version number of the database. Valid value: 3.4, 4.0, 4.2, 4.4, 5.0 | string | true |
shared_credentials_file | (Deprecated from version 1.4.0) This is the path to the shared credentials file. If this is not set and a profile is specified, $HOME/.aliyun/config.json will be used. | string | false |
skip_region_validation | (Deprecated from version 1.4.0) Skip static validation of region ID. Used by users of alternative AlibabaCloud-like APIs or users w/ access to regions that are not public (yet). | bool | false |
engine_version | The version number of the database. Valid value: 3.4, 4.0, 4.2, 4.4, 5.0 | string | true |
db_instance_class | The specification of the instance. For more information about the value, see https://www.alibabacloud.com/help/doc-detail/57141.htm | string | true |
zone_id | The ID of the zone. You can refer to https://www.alibabacloud.com/help/doc-detail/61933.htm. | string | false |
instance_charge_type | The billing method of the instance. Valid values are Prepaid, PostPaid, Default to PostPaid | string | false |
period | The duration that you will buy DB instance (in month). It is valid when instance_charge_type is PrePaid. Valid values: [1~9], 12, 24, 36. Default to 1 | | false |
vswitch_id | The virtual switch ID to launch DB instances in one VPC. | string | false |
security_ip_list | List of IP addresses allowed to access all databases of an instance. The list contains up to 1,000 IP addresses, separated by commas. Supported formats include 0.0.0.0/0, 10.23.12.24 (IP), and 10.23.12.24/24 (Classless Inter-Domain Routing (CIDR) mode. /24 represents the length of the prefix in an IP address. The range of the prefix length is [1,32]). | list(string) | false |
create | Whether to use an existing MongoDB. If false, you can use a existing Mongodb instance by setting `existing_instance_id`. | bool | false |
backup_time | MongoDB instance backup time. It is required when backup_period was existed. In the format of HH:mmZ- HH:mmZ. Time setting interval is one hour. Default to a random time, like '23:00Z-24:00Z'. | string | false |
profile | (Deprecated from version 1.4.0) The profile name as set in the shared credentials file. If not set, it will be sourced from the ALICLOUD_PROFILE environment variable. | string | false |
db_instance_class | The specification of the instance. For more information about the value, see https://www.alibabacloud.com/help/doc-detail/57141.htm | string | true |
storage_engine | The MongoDB storage engine, WiredTiger or RocksDB. Default value: WiredTiger. | string | false |
security_ip_list | List of IP addresses allowed to access all databases of an instance. The list contains up to 1,000 IP addresses, separated by commas. Supported formats include 0.0.0.0/0, 10.23.12.24 (IP), and 10.23.12.24/24 (Classless Inter-Domain Routing (CIDR) mode. /24 represents the length of the prefix in an IP address. The range of the prefix length is [1,32]). | list(string) | false |
replication_factor | The number of nodes in the replica set instance. Valid values: 3, 5, 7. Default value: 3. | number | false |
tags | A mapping of tags to assign to the mongodb instance resource. | map(string) | false |
region | (Deprecated from version 1.4.0) The region used to launch this module resources. | string | false |
name | The name of DB instance. It a string of 2 to 256 characters | string | true |
zone_id | The ID of the zone. You can refer to https://www.alibabacloud.com/help/doc-detail/61933.htm. | string | false |
account_password | Password of the root account. It is a string of 6 to 32 characters and is composed of letters, numbers, and underlines | string | true |
backup_period | MongoDB Instance backup period. It is required when backup_time was existed. Valid values: [Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday]. Default to [Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday]. | list(string) | true |
existing_instance_id | The Id of an existing Mongodb instance. If set, the `create` will be ignored. | string | false |
create | Whether to use an existing MongoDB. If false, you can use a existing Mongodb instance by setting `existing_instance_id`. | bool | false |
instance_id | `(Deprecated)` It has been deprecated from version 1.2.0 and use `existing_instance_id` instead. | string | false |
db_instance_storage | The storage space of the instance. Valid values: 10 to 3000. Unit: GB. You can only specify this value in 10 GB increments. | number | false |
writeConnectionSecretToRef | The secret which the cloud resource connection will be written to | [writeConnectionSecretToRef](#writeConnectionSecretToRef) | false |

View File

@ -4,7 +4,7 @@ title: 阿里云 MSE
## 描述
Alibaba Cloud MSE
Terraform configuration for Alibaba Cloud MSE
## 参数说明
@ -13,12 +13,12 @@ Alibaba Cloud MSE
名称 | 描述 | 类型 | 是否必须 | 默认值
------------ | ------------- | ------------- | ------------- | -------------
cluster_specification | The engine specification of MSE Cluster. Valid values: MSE_SC_1_2_200_c1C2G MSE_SC_2_4_200_c2C4G MSE_SC_4_8_200_c4C8G MSE_SC_8_16_200_c8C16G | string | false |
cluster_type | The type of MSE Cluster. Valid values: ZooKeeper、Nacos-Ans and Eureka | string | false |
cluster_version | The version of MSE Cluster. Valid values: ZooKeeper_3_4_14, ZooKeeper_3_5_5, NACOS_ANS_1_1_3, NACOS_ANS_1_2_1, EUREKA_1_9_3 | string | false |
net_type | The type of network. Valid values: privatenet and pubnet | string | false |
acl_entry_list | The whitelist | list(any) | false |
cluster_alias_name | The alias name of MSE Cluster | string | false |
cluster_specification | The engine specification of MSE Cluster. Valid values: MSE_SC_1_2_200_c1C2G MSE_SC_2_4_200_c2C4G MSE_SC_4_8_200_c4C8G MSE_SC_8_16_200_c8C16G | string | false |
cluster_type | The type of MSE Cluster. Valid values: ZooKeeper、Nacos-Ans and Eureka | string | false |
writeConnectionSecretToRef | The secret which the cloud resource connection will be written to | [writeConnectionSecretToRef](#writeConnectionSecretToRef) | false |

View File

@ -31,8 +31,8 @@ spec:
名称 | 描述 | 类型 | 是否必须 | 默认值
------------ | ------------- | ------------- | ------------- | -------------
acl | OSS bucket ACL, supported 'private', 'public-read', 'public-read-write' | string | true |
bucket | OSS bucket name | string | true |
bucket | OSS bucket name | string | false |
acl | OSS bucket ACL, supported 'private', 'public-read', 'public-read-write' | string | false |
writeConnectionSecretToRef | The secret which the cloud resource connection will be written to | [writeConnectionSecretToRef](#writeConnectionSecretToRef) | false |

View File

@ -32,16 +32,16 @@ spec:
名称 | 描述 | 类型 | 是否必须 | 默认值
------------ | ------------- | ------------- | ------------- | -------------
privilege | The privilege of one account access database. | string | false |
sql_bucket_name | The bucket name of the SQL file. like `oss://example` | string | false |
instance_name | RDS instance name | string | false |
account_name | RDS instance user account name | string | false |
password | RDS instance account password | string | false |
sql_file | The name of SQL file in the bucket, like `db.sql` | string | false |
sql_bucket_endpoint | The endpoint of the bucket. like `oss-cn-hangzhou.aliyuncs.com` | string | false |
allocate_public_connection | Whether to allocate public connection for a RDS instance. | bool | false |
security_ips | List of IP addresses allowed to access all databases of an instance | list(any) | false |
privilege | The privilege of one account access database. | string | false |
sql_file | The name of SQL file in the bucket, like `db.sql` | string | false |
sql_bucket_name | The bucket name of the SQL file. like `oss://example` | string | false |
password | RDS instance account password | string | false |
account_name | RDS instance user account name | string | false |
allocate_public_connection | Whether to allocate public connection for a RDS instance. | bool | false |
database_name | Database name | string | false |
sql_bucket_endpoint | The endpoint of the bucket. like `oss-cn-hangzhou.aliyuncs.com` | string | false |
instance_name | RDS instance name | string | false |
writeConnectionSecretToRef | The secret which the cloud resource connection will be written to | [writeConnectionSecretToRef](#writeConnectionSecretToRef) | false |
@ -59,12 +59,12 @@ spec:
名称 | 描述
------------ | -------------
DB_ID | RDS Instance ID
DB_USER | RDS Instance User
DB_PASSWORD | RDS Instance Password
DATABASE_NAME | RDS Database Name
RESOURCE_IDENTIFIER | The identifier of the resource
DB_NAME | RDS Instance Name
DB_PORT | RDS Instance Port
DB_HOST | RDS Instance Host
DB_PUBLIC_HOST | RDS Instance Public Host
RESOURCE_IDENTIFIER | The identifier of the resource
DB_USER | RDS Instance User
DB_PASSWORD | RDS Instance Password
DATABASE_NAME | RDS Database Name
DB_ID | RDS Instance ID

View File

@ -32,9 +32,9 @@ spec:
名称 | 描述 | 类型 | 是否必须 | 默认值
------------ | ------------- | ------------- | ------------- | -------------
instance_name | Redis instance name | string | true |
account_name | Redis instance user account name | string | true |
password | RDS instance account password | string | true |
instance_name | Redis instance name | string | false |
account_name | Redis instance user account name | string | false |
password | RDS instance account password | string | false |
writeConnectionSecretToRef | The secret which the cloud resource connection will be written to | [writeConnectionSecretToRef](#writeConnectionSecretToRef) | false |

View File

@ -13,14 +13,14 @@ Terraform configuration for Alibaba Cloud RocketMQ
名称 | 描述 | 类型 | 是否必须 | 默认值
------------ | ------------- | ------------- | ------------- | -------------
ons_instance_name | The name of ons instance. The length must be 3 to 64 characters. Chinese characters, English letters digits and hyphen are allowed. | string | false |
topic | The specification of ons topic name. Two topics on a single instance cannot have the same name and the name cannot start with 'GID' or 'CID'. The length cannot exceed 64 characters. | string | false |
ons_instance_remark | The specification of ons instance remark. | string | false |
ons_topic_remark | The specification of ons topic remark. | string | false |
message_type | The type of the message. Read [Ons Topic Create](https://www.alibabacloud.com/help/doc-detail/29591.html) for further details. | number | false |
group_name | The name of MQ group | string | false |
group_type | Specify the protocol applicable to the created Group ID. Valid values: tcp, http. Default to tcp | string | false |
perm | The permission of MQ topic | string | false |
ons_instance_name | The name of ons instance. The length must be 3 to 64 characters. Chinese characters, English letters digits and hyphen are allowed. | string | false |
topic | The specification of ons topic name. Two topics on a single instance cannot have the same name and the name cannot start with 'GID' or 'CID'. The length cannot exceed 64 characters. | string | false |
writeConnectionSecretToRef | The secret which the cloud resource connection will be written to | [writeConnectionSecretToRef](#writeConnectionSecretToRef) | false |
@ -38,9 +38,9 @@ Terraform configuration for Alibaba Cloud RocketMQ
名称 | 描述
------------ | -------------
INSTANCE_ID | The id of ons instance
TOPIC_ID | The id of ons topic
GROUP_ID | The id of ons group
HTTP_ENDPOINT_INTERNET | The internet http endpoint of ons instance
HTTP_ENDPOINT_INTERNAL | The internal http endpoint of ons instance
TCP_ENDPOINT | The tcp endpoint of ons instance
INSTANCE_ID | The id of ons instance
TOPIC_ID | The id of ons topic

View File

@ -32,8 +32,8 @@ spec:
名称 | 描述 | 类型 | 是否必须 | 默认值
------------ | ------------- | ------------- | ------------- | -------------
name | Name of security group. It is used to create a new security group. | string | true |
description | Description of security group | string | true |
name | Name of security group. It is used to create a new security group. | string | false |
description | Description of security group | string | false |
writeConnectionSecretToRef | The secret which the cloud resource connection will be written to | [writeConnectionSecretToRef](#writeConnectionSecretToRef) | false |

View File

@ -34,15 +34,15 @@ spec:
名称 | 描述 | 类型 | 是否必须 | 默认值
------------ | ------------- | ------------- | ------------- | -------------
store_append_meta | Determines whether to append log meta automatically. The meta includes log receive time and client IP address. Default to true. | bool | true |
project_name | Name of security group. It is used to create a new security group. | string | true |
description | Description of security group | string | true |
store_name | Log store name. | string | true |
store_retention_period | The data retention time (in days). Valid values: [1-3650]. Default to 30. Log store data will be stored permanently when the value is '3650'. | number | true |
store_auto_split | Determines whether to automatically split a shard. Default to true. | bool | true |
create_project | Whether to create log resources | string | true |
store_shard_count | The number of shards in this log store. Default to 2. You can modify it by 'Split' or 'Merge' operations. | number | true |
store_max_split_shard_count | The maximum number of shards for automatic split, which is in the range of 1 to 64. You must specify this parameter when autoSplit is true. | number | true |
project_name | Name of security group. It is used to create a new security group. | string | false |
description | Description of security group | string | false |
store_shard_count | The number of shards in this log store. Default to 2. You can modify it by 'Split' or 'Merge' operations. | number | false |
create_project | Whether to create log resources | string | false |
store_name | Log store name. | string | false |
store_retention_period | The data retention time (in days). Valid values: [1-3650]. Default to 30. Log store data will be stored permanently when the value is '3650'. | number | false |
store_auto_split | Determines whether to automatically split a shard. Default to true. | bool | false |
store_max_split_shard_count | The maximum number of shards for automatic split, which is in the range of 1 to 64. You must specify this parameter when autoSplit is true. | number | false |
store_append_meta | Determines whether to append log meta automatically. The meta includes log receive time and client IP address. Default to true. | bool | false |
writeConnectionSecretToRef | The secret which the cloud resource connection will be written to | [writeConnectionSecretToRef](#writeConnectionSecretToRef) | false |

View File

@ -31,9 +31,9 @@ spec:
名称 | 描述 | 类型 | 是否必须 | 默认值
------------ | ------------- | ------------- | ------------- | -------------
vpc_name | The vpc name used to launch a new vpc. | string | true |
vpc_description | The vpc description used to launch a new vpc. | string | true |
vpc_cidr | The cidr block used to launch a new vpc. | string | true |
vpc_name | The vpc name used to launch a new vpc. | string | false |
vpc_description | The vpc description used to launch a new vpc. | string | false |
vpc_cidr | The cidr block used to launch a new vpc. | string | false |
writeConnectionSecretToRef | The secret which the cloud resource connection will be written to | [writeConnectionSecretToRef](#writeConnectionSecretToRef) | false |

View File

@ -13,15 +13,15 @@ title: 阿里云 VSWITCH
名称 | 描述 | 类型 | 是否必须 | 默认值
------------ | ------------- | ------------- | ------------- | -------------
vpc_id | The vpc id used to launch several vswitches. If set, the 'create' will be ignored. | string | true |
vswitch_cidr | cidr blocks used to launch a new vswitch. | string | true |
vswitch_description | The vswitch description used to launch several new vswitch. | string | true |
vpc_description | The vpc description used to launch a new vpc. | string | true |
vpc_name | The vpc name used to launch a new vpc. | string | true |
vpc_cidr | The cidr block used to launch a new vpc. | string | true |
zone_id | Availability Zone ID | string | true |
vswitch_name | The vswitch name prefix used to launch several new vswitches. | | true |
create_vpc | Whether to create vpc. If false, you can specify an existing vpc by setting 'vpc_id'. | bool | true |
vswitch_description | The vswitch description used to launch several new vswitch. | string | false |
zone_id | Availability Zone ID | string | false |
vswitch_name | The vswitch name prefix used to launch several new vswitches. | | false |
create_vpc | Whether to create vpc. If false, you can specify an existing vpc by setting 'vpc_id'. | bool | false |
vpc_name | The vpc name used to launch a new vpc. | string | false |
vpc_cidr | The cidr block used to launch a new vpc. | string | false |
vpc_description | The vpc description used to launch a new vpc. | string | false |
vpc_id | The vpc id used to launch several vswitches. If set, the 'create' will be ignored. | string | false |
vswitch_cidr | cidr blocks used to launch a new vswitch. | string | false |
writeConnectionSecretToRef | The secret which the cloud resource connection will be written to | [writeConnectionSecretToRef](#writeConnectionSecretToRef) | false |

View File

@ -0,0 +1,102 @@
---
title: AWS RDS
---
## 描述
AWS RDS
## 参数说明
### 属性
名称 | 描述 | 类型 | 是否必须 | 默认值
------------ | ------------- | ------------- | ------------- | -------------
storage_type | One of 'standard' (magnetic), 'gp2' (general purpose SSD), or 'io1' (provisioned IOPS SSD). The default is 'io1' if iops is specified, 'gp2' if not. | string | false |
vpc_security_group_ids | List of VPC security groups to associate | list(string) | false |
allow_major_version_upgrade | Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible | bool | false |
character_set_name | (Optional) The character set name to use for DB encoding in Oracle instances. This can't be changed. See Oracle Character Sets Supported in Amazon RDS and Collations and Character Sets for Microsoft SQL Server for more information. This can only be set on creation. | string | false |
option_group_timeouts | Define maximum timeout for deletion of `aws_db_option_group` resource | map(string) | false |
kms_key_id | The ARN for the KMS encryption key. If creating an encrypted replica, set this to the destination KMS ARN. If storage_encrypted is set to true and kms_key_id is not specified the default KMS key created in your account will be used | string | false |
s3_import | Restore from a Percona Xtrabackup in S3 (only MySQL is supported) | map(string) | false |
parameter_group_name | Name of the DB parameter group to associate or create | string | false |
parameter_group_use_name_prefix | Determines whether to use `parameter_group_name` as is or create a unique name beginning with the `parameter_group_name` as the prefix | bool | false |
timezone | (Optional) Time zone of the DB instance. timezone is currently only supported by Microsoft SQL Server. The timezone can only be set on creation. See MSSQL User Guide for more information. | string | false |
max_allocated_storage | Specifies the value for Storage Autoscaling | number | false |
snapshot_identifier | Specifies whether or not to create this database from a snapshot. This correlates to the snapshot ID you'd find in the RDS console, e.g: rds:production-2015-06-26-06-05. | string | false |
copy_tags_to_snapshot | On delete, copy all Instance tags to the final snapshot (if final_snapshot_identifier is specified) | bool | false |
password | Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file | string | false |
option_group_use_name_prefix | Determines whether to use `option_group_name` as is or create a unique name beginning with the `option_group_name` as the prefix | bool | false |
performance_insights_enabled | Specifies whether Performance Insights are enabled | bool | false |
port | The port on which the DB accepts connections | string | false |
publicly_accessible | Bool to control if instance is publicly accessible | bool | false |
create_db_subnet_group | Whether to create a database subnet group | bool | false |
db_subnet_group_name | Name of DB subnet group. DB instance will be created in the VPC associated with the DB subnet group. If unspecified, will be created in the default VPC | string | false |
enabled_cloudwatch_logs_exports | List of log types to enable for exporting to CloudWatch logs. If omitted, no logs will be exported. Valid values (depending on engine): alert, audit, error, general, listener, slowquery, trace, postgresql (PostgreSQL), upgrade (PostgreSQL). | list(string) | false |
name | The DB name to create. If omitted, no database is created initially | string | false |
username | Username for the master DB user | string | false |
multi_az | Specifies if the RDS instance is multi-AZ | bool | false |
monitoring_role_description | Description of the monitoring IAM role | string | false |
subnet_ids | A list of VPC subnet IDs | list(string) | false |
identifier | The name of the RDS instance, if omitted, Terraform will assign a random, unique identifier | string | true |
db_subnet_group_description | Description of the DB subnet group to create | string | false |
option_group_name | Name of the option group | string | false |
create_db_instance | Whether to create a database instance | bool | false |
storage_encrypted | Specifies whether the DB instance is encrypted | bool | false |
db_instance_tags | Additional tags for the DB instance | map(string) | false |
db_subnet_group_tags | Additional tags for the DB subnet group | map(string) | false |
db_subnet_group_use_name_prefix | Determines whether to use `subnet_group_name` as is or create a unique name beginning with the `subnet_group_name` as the prefix | bool | false |
family | The family of the DB parameter group | string | false |
monitoring_interval | The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. Valid Values: 0, 1, 5, 10, 15, 30, 60. | number | false |
auto_minor_version_upgrade | Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window | bool | false |
apply_immediately | Specifies whether any database modifications are applied immediately, or during the next maintenance window | bool | false |
performance_insights_kms_key_id | The ARN for the KMS key to encrypt Performance Insights data. | string | false |
create_random_password | Whether to create random password for RDS primary cluster | bool | false |
allocated_storage | The allocated storage in gigabytes | string | false |
replicate_source_db | Specifies that this resource is a Replicate database, and to use this value as the source database. This correlates to the identifier of another Amazon RDS Database to replicate. | string | false |
domain | The ID of the Directory Service Active Directory domain to create the instance in | string | false |
tags | A mapping of tags to assign to all resources | map(string) | false |
options | A list of Options to apply. | any | false |
backup_retention_period | The days to retain backups for | number | false |
db_parameter_group_tags | Additional tags for the DB parameter group | map(string) | false |
performance_insights_retention_period | The amount of time in days to retain Performance Insights data. Either 7 (7 days) or 731 (2 years). | number | false |
engine_version | The engine version to use | string | false |
monitoring_role_arn | The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. Must be specified if monitoring_interval is non-zero. | string | false |
db_option_group_tags | Additional tags for the DB option group | map(string) | false |
parameters | A list of DB parameters (map) to apply | list(map(string)) | false |
timeouts | (Optional) Updated Terraform resource management timeouts. Applies to `aws_db_instance` in particular to permit resource management times | map(string) | false |
ca_cert_identifier | Specifies the identifier of the CA certificate for the DB instance | string | false |
delete_automated_backups | Specifies whether to remove automated backups immediately after the DB instance is deleted | bool | false |
random_password_length | (Optional) Length of random password to create. (default: 10) | number | false |
cross_region_replica | Specifies if the replica should be cross region. It allows the use of a subnet group in a region different than the master instance | bool | false |
domain_iam_role_name | (Required if domain is provided) The name of the IAM role to be used when making API calls to the Directory Service | string | false |
engine | The database engine to use | string | false |
backup_window | The daily time range (in UTC) during which automated backups are created if they are enabled. Example: '09:46-10:16'. Must not overlap with maintenance_window | string | false |
create_db_option_group | (Optional) Create a database option group | bool | false |
deletion_protection | The database can't be deleted when this value is set to true. | bool | false |
license_model | License model information for this DB instance. Optional, but required for some DB engines, i.e. Oracle SE1 | string | false |
final_snapshot_identifier | The name of your final DB snapshot when this DB instance is deleted. | string | false |
create_monitoring_role | Create IAM role with a defined name that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. | bool | false |
parameter_group_description | Description of the DB parameter group to create | string | false |
major_engine_version | Specifies the major version of the engine that this option group should be associated with | string | false |
maintenance_window | The window to perform maintenance in. Syntax: 'ddd:hh24:mi-ddd:hh24:mi'. Eg: 'Mon:00:00-Mon:03:00' | string | false |
skip_final_snapshot | Determines whether a final DB snapshot is created before the DB instance is deleted. If true is specified, no DBSnapshot is created. If false is specified, a DB snapshot is created before the DB instance is deleted, using the value from final_snapshot_identifier | bool | false |
instance_class | The instance type of the RDS instance | string | false |
availability_zone | The Availability Zone of the RDS instance | string | false |
monitoring_role_name | Name of the IAM role which will be created when create_monitoring_role is enabled. | string | false |
option_group_description | The description of the option group | string | false |
iam_database_authentication_enabled | Specifies whether or not the mappings of AWS Identity and Access Management (IAM) accounts to database accounts are enabled | bool | false |
final_snapshot_identifier_prefix | The name which is prefixed to the final snapshot on cluster destroy | string | false |
iops | The amount of provisioned IOPS. Setting this implies a storage_type of 'io1' | number | false |
restore_to_point_in_time | Restore to a point in time (MySQL is NOT supported) | map(string) | false |
create_db_parameter_group | Whether to create a database parameter group | bool | false |
writeConnectionSecretToRef | The secret which the cloud resource connection will be written to | [writeConnectionSecretToRef](#writeConnectionSecretToRef) | false |
#### writeConnectionSecretToRef
名称 | 描述 | 类型 | 是否必须 | 默认值
------------ | ------------- | ------------- | ------------- | -------------
name | The secret name which the cloud resource connection will be written to | string | true |
namespace | The secret namespace which the cloud resource connection will be written to | string | false |

View File

@ -4,7 +4,7 @@ title: AWS S3
## 描述
Terraform configuration for AWS S3
用于部署 AWS S3 的组件说明
## 示例
@ -32,8 +32,8 @@ spec:
名称 | 描述 | 类型 | 是否必须 | 默认值
------------ | ------------- | ------------- | ------------- | -------------
bucket | S3 bucket name | string | true |
acl | S3 bucket ACL | string | true |
bucket | S3 bucket name | string | false |
acl | S3 bucket ACL | string | false |
writeConnectionSecretToRef | The secret which the cloud resource connection will be written to | [writeConnectionSecretToRef](#writeConnectionSecretToRef) | false |

View File

@ -0,0 +1,71 @@
---
title: AWS SECURITY-GROUP
---
## 描述
AWS Security Group
## 参数说明
### 属性
名称 | 描述 | 类型 | 是否必须 | 默认值
------------ | ------------- | ------------- | ------------- | -------------
egress_rules | List of egress rules to create by name | list(string) | false |
create_sg | Whether to create security group | bool | false |
vpc_id | ID of the VPC where to create security group | string | false |
description | Description of security group | string | false |
ingress_rules | List of ingress rules to create by name | list(string) | false |
ingress_with_self | List of ingress rules to create where 'self' is defined | list(map(string)) | false |
ingress_with_source_security_group_id | List of ingress rules to create where 'source_security_group_id' is used | list(map(string)) | false |
computed_ingress_with_self | List of computed ingress rules to create where 'self' is defined | list(map(string)) | false |
number_of_computed_egress_rules | Number of computed egress rules to create by name | number | false |
number_of_computed_egress_with_self | Number of computed egress rules to create where 'self' is defined | number | false |
number_of_computed_egress_with_source_security_group_id | Number of computed egress rules to create where 'source_security_group_id' is used | number | false |
use_name_prefix | Whether to use name_prefix or fixed name. Should be true to able to update security group name after initial creation | bool | false |
ingress_with_cidr_blocks | List of ingress rules to create where 'cidr_blocks' is used | list(map(string)) | false |
computed_ingress_rules | List of computed ingress rules to create by name | list(string) | false |
egress_cidr_blocks | List of IPv4 CIDR ranges to use on all egress rules | list(string) | false |
egress_ipv6_cidr_blocks | List of IPv6 CIDR ranges to use on all egress rules | list(string) | false |
computed_egress_with_self | List of computed egress rules to create where 'self' is defined | list(map(string)) | false |
number_of_computed_egress_with_ipv6_cidr_blocks | Number of computed egress rules to create where 'ipv6_cidr_blocks' is used | number | false |
security_group_id | ID of existing security group whose rules we will manage | string | false |
computed_ingress_with_cidr_blocks | List of computed ingress rules to create where 'cidr_blocks' is used | list(map(string)) | false |
egress_prefix_list_ids | List of prefix list IDs (for allowing access to VPC endpoints) to use on all egress rules | list(string) | false |
create_timeout | Time to wait for a security group to be created | string | false |
delete_timeout | Time to wait for a security group to be deleted | string | false |
ingress_prefix_list_ids | List of prefix list IDs (for allowing access to VPC endpoints) to use on all ingress rules | list(string) | false |
number_of_computed_ingress_with_self | Number of computed ingress rules to create where 'self' is defined | number | false |
egress_with_self | List of egress rules to create where 'self' is defined | list(map(string)) | false |
egress_with_source_security_group_id | List of egress rules to create where 'source_security_group_id' is used | list(map(string)) | false |
name | Name of security group - not required if create_sg is false | string | false |
revoke_rules_on_delete | Instruct Terraform to revoke all of the Security Groups attached ingress and egress rules before deleting the rule itself. Enable for EMR. | bool | false |
ingress_ipv6_cidr_blocks | List of IPv6 CIDR ranges to use on all ingress rules | list(string) | false |
number_of_computed_ingress_with_cidr_blocks | Number of computed ingress rules to create where 'cidr_blocks' is used | number | false |
number_of_computed_ingress_with_source_security_group_id | Number of computed ingress rules to create where 'source_security_group_id' is used | number | false |
ingress_with_ipv6_cidr_blocks | List of ingress rules to create where 'ipv6_cidr_blocks' is used | list(map(string)) | false |
number_of_computed_ingress_with_ipv6_cidr_blocks | Number of computed ingress rules to create where 'ipv6_cidr_blocks' is used | number | false |
computed_ingress_with_ipv6_cidr_blocks | List of computed ingress rules to create where 'ipv6_cidr_blocks' is used | list(map(string)) | false |
number_of_computed_ingress_rules | Number of computed ingress rules to create by name | number | false |
computed_egress_with_cidr_blocks | List of computed egress rules to create where 'cidr_blocks' is used | list(map(string)) | false |
computed_egress_with_ipv6_cidr_blocks | List of computed egress rules to create where 'ipv6_cidr_blocks' is used | list(map(string)) | false |
computed_egress_with_source_security_group_id | List of computed egress rules to create where 'source_security_group_id' is used | list(map(string)) | false |
create | Whether to create security group and all rules | bool | false |
tags | A mapping of tags to assign to security group | map(string) | false |
ingress_cidr_blocks | List of IPv4 CIDR ranges to use on all ingress rules | list(string) | false |
computed_ingress_with_source_security_group_id | List of computed ingress rules to create where 'source_security_group_id' is used | list(map(string)) | false |
egress_with_cidr_blocks | List of egress rules to create where 'cidr_blocks' is used | list(map(string)) | false |
egress_with_ipv6_cidr_blocks | List of egress rules to create where 'ipv6_cidr_blocks' is used | list(map(string)) | false |
computed_egress_rules | List of computed egress rules to create by name | list(string) | false |
number_of_computed_egress_with_cidr_blocks | Number of computed egress rules to create where 'cidr_blocks' is used | number | false |
writeConnectionSecretToRef | The secret which the cloud resource connection will be written to | [writeConnectionSecretToRef](#writeConnectionSecretToRef) | false |
#### writeConnectionSecretToRef
名称 | 描述 | 类型 | 是否必须 | 默认值
------------ | ------------- | ------------- | ------------- | -------------
name | The secret name which the cloud resource connection will be written to | string | true |
namespace | The secret namespace which the cloud resource connection will be written to | string | false |

View File

@ -0,0 +1,41 @@
---
title: AWS SUBNET
---
## 描述
AWS Subnet
## 参数说明
### 属性
名称 | 描述 | 类型 | 是否必须 | 默认值
------------ | ------------- | ------------- | ------------- | -------------
name | Name to be used on all the resources as identifier | string | false |
instance_tenancy | A tenancy option for instances launched into the VPC | string | false |
enable_dns_hostnames | Should be true to enable DNS hostnames in the VPC | bool | false |
enable_classiclink_dns_support | Should be true to enable ClassicLink DNS Support for the VPC. Only valid in regions and accounts that support EC2 Classic. | bool | false |
subnet_tags | A map of tags for the Subnet | map(string) | false |
vpc_tags | Additional tags for the VPC | map(string) | false |
cidr | The CIDR block for the VPC. Default value is a valid CIDR, but not acceptable by AWS and should be overridden | string | false |
enable_classiclink | Should be true to enable ClassicLink for the VPC. Only valid in regions and accounts that support EC2 Classic. | bool | false |
availability_zone | An availability zone name in the region | string | false |
assign_ipv6_address_on_creation | Assign IPv6 address on subnet, must be disabled to change IPv6 CIDRs. This is the IPv6 equivalent of map_public_ip_on_launch | bool | false |
vpc_id | The ID of the VPC | string | false |
create_vpc | Controls if VPC should be created (it affects almost all resources) | bool | false |
map_public_ip_on_launch | Should be false if you do not want to auto-assign public IP on launch | bool | false |
subnet_cidr | A list of subnets cidrs inside the VPC | string | false |
ipv6_cidr_block | The IPv6 CIDR block for the VPC. | string | false |
enable_ipv6 | Requests an Amazon-provided IPv6 CIDR block with a /56 prefix length for the VPC. You cannot specify the range of IP addresses, or the size of the CIDR block. | bool | false |
enable_dns_support | Should be true to enable DNS support in the VPC | bool | false |
writeConnectionSecretToRef | The secret which the cloud resource connection will be written to | [writeConnectionSecretToRef](#writeConnectionSecretToRef) | false |
#### writeConnectionSecretToRef
名称 | 描述 | 类型 | 是否必须 | 默认值
------------ | ------------- | ------------- | ------------- | -------------
name | The secret name which the cloud resource connection will be written to | string | true |
namespace | The secret namespace which the cloud resource connection will be written to | string | false |

View File

@ -0,0 +1,35 @@
---
title: AWS VPC
---
## 描述
AWS VPC
## 参数说明
### 属性
名称 | 描述 | 类型 | 是否必须 | 默认值
------------ | ------------- | ------------- | ------------- | -------------
tags | A map of tags to add to all resources | map(string) | false |
vpc_tags | Additional tags for the VPC | map(string) | false |
create_vpc | Controls if VPC should be created (it affects almost all resources) | bool | false |
enable_ipv6 | Requests an Amazon-provided IPv6 CIDR block with a /56 prefix length for the VPC. You cannot specify the range of IP addresses, or the size of the CIDR block. | bool | false |
instance_tenancy | A tenancy option for instances launched into the VPC | string | false |
enable_dns_hostnames | Should be true to enable DNS hostnames in the VPC | bool | false |
enable_dns_support | Should be true to enable DNS support in the VPC | bool | false |
enable_classiclink | Should be true to enable ClassicLink for the VPC. Only valid in regions and accounts that support EC2 Classic. | bool | false |
name | Name to be used on all the resources as identifier | string | false |
cidr | The CIDR block for the VPC. Default value is a valid CIDR, but not acceptable by AWS and should be overridden | string | false |
enable_classiclink_dns_support | Should be true to enable ClassicLink DNS Support for the VPC. Only valid in regions and accounts that support EC2 Classic. | bool | false |
writeConnectionSecretToRef | The secret which the cloud resource connection will be written to | [writeConnectionSecretToRef](#writeConnectionSecretToRef) | false |
#### writeConnectionSecretToRef
名称 | 描述 | 类型 | 是否必须 | 默认值
------------ | ------------- | ------------- | ------------- | -------------
name | The secret name which the cloud resource connection will be written to | string | true |
namespace | The secret namespace which the cloud resource connection will be written to | string | false |

View File

@ -36,12 +36,12 @@ spec:
名称 | 描述 | 类型 | 是否必须 | 默认值
------------ | ------------- | ------------- | ------------- | -------------
password | Database instance password | string | true |
location | Azure location | string | true |
resource_group | Resource group | string | true |
server_name | mariadb server name | string | true |
db_name | Database instance name | string | true |
username | Database instance username | string | true |
resource_group | Resource group | string | false |
server_name | mariadb server name | string | false |
db_name | Database instance name | string | false |
username | Database instance username | string | false |
password | Database instance password | string | false |
location | Azure location | string | false |
writeConnectionSecretToRef | The secret which the cloud resource connection will be written to | [writeConnectionSecretToRef](#writeConnectionSecretToRef) | false |
@ -59,9 +59,9 @@ spec:
名称 | 描述
------------ | -------------
DB_USER | Database instance username
DB_PASSWORD | Database instance password
DB_PORT | Database instance port
DB_HOST | Database instance host
SERVER_NAME | mariadb server name
DB_NAME | Database instance name
DB_USER | Database instance username

View File

@ -0,0 +1,35 @@
---
title: Azure RESOURCE-GROUP
---
## 描述
Azure Resource Group
## 参数说明
### 属性
名称 | 描述 | 类型 | 是否必须 | 默认值
------------ | ------------- | ------------- | ------------- | -------------
name | The name of the resource group | string | false |
location | The location of the resource group | string | false |
writeConnectionSecretToRef | The secret which the cloud resource connection will be written to | [writeConnectionSecretToRef](#writeConnectionSecretToRef) | false |
#### writeConnectionSecretToRef
名称 | 描述 | 类型 | 是否必须 | 默认值
------------ | ------------- | ------------- | ------------- | -------------
name | The secret name which the cloud resource connection will be written to | string | true |
namespace | The secret namespace which the cloud resource connection will be written to | string | false |
### 输出
如果设置了 `writeConnectionSecretToRef`,一个 Kubernetes Secret 将会被创建并且它的数据里有这些键key
名称 | 描述
------------ | -------------
resource_group_name | The name of the resource group

View File

@ -45,12 +45,12 @@ spec:
名称 | 描述 | 类型 | 是否必须 | 默认值
------------ | ------------- | ------------- | ------------- | -------------
resource_group_name | Name of resource group. Defaults to 'rsg'. | string | true |
name | Name of storage account. Defaults to 'storageaccount'. | string | true |
location | Location of storage account. Defaults to 'West Europe'. | string | true |
tags | Tags for storage account. Defaults to '{}'. | map(string) | true |
static_website | Static website configuration. Defaults to disabled. | list(map(string)) | true |
create_rsg | Conditional if resource group should be created. Defaults to 'true'. | bool | true |
name | Name of storage account. Defaults to 'storageaccount'. | string | false |
location | Location of storage account. Defaults to 'West Europe'. | string | false |
tags | Tags for storage account. Defaults to '{}'. | map(string) | false |
static_website | Static website configuration. Defaults to disabled. | list(map(string)) | false |
create_rsg | Conditional if resource group should be created. Defaults to 'true'. | bool | false |
resource_group_name | Name of resource group. Defaults to 'rsg'. | string | false |
writeConnectionSecretToRef | The secret which the cloud resource connection will be written to | [writeConnectionSecretToRef](#writeConnectionSecretToRef) | false |

View File

@ -0,0 +1,34 @@
---
title: Azure SUBNET
---
## 描述
Azure Subnet
## 参数说明
### 属性
名称 | 描述 | 类型 | 是否必须 | 默认值
------------ | ------------- | ------------- | ------------- | -------------
resource_group_name | The name of an existing resource group to be imported. | string | true |
address_space | The address space that is used by the virtual network. | string | false |
address_spaces | The list of the address spaces that is used by the virtual network. | list(string) | false |
subnet_prefixes | The address prefix to use for the subnet. | list(string) | false |
subnet_names | A list of public subnets inside the vNet. | list(string) | false |
vnet_name | Name of the vnet to create. | string | false |
dns_servers | The DNS servers to be used with vNet. | list(string) | false |
tags | The tags to associate with your network and subnets. | map(string) | false |
subnet_enforce_private_link_endpoint_network_policies | A map with key (string) `subnet name`, value (bool) `true` or `false` to indicate enable or disable network policies for the private link endpoint on the subnet. Default value is false. | map(bool) | false |
subnet_service_endpoints | A map with key (string) `subnet name`, value (list(string)) to indicate enabled service endpoints on the subnet. Default value is []. | map(list(string)) | false |
writeConnectionSecretToRef | The secret which the cloud resource connection will be written to | [writeConnectionSecretToRef](#writeConnectionSecretToRef) | false |
#### writeConnectionSecretToRef
名称 | 描述 | 类型 | 是否必须 | 默认值
------------ | ------------- | ------------- | ------------- | -------------
name | The secret name which the cloud resource connection will be written to | string | true |
namespace | The secret namespace which the cloud resource connection will be written to | string | false |

View File

@ -0,0 +1,30 @@
---
title: Azure VIRTUAL-NETWORK
---
## 描述
Azure Virtual Network
## 参数说明
### 属性
名称 | 描述 | 类型 | 是否必须 | 默认值
------------ | ------------- | ------------- | ------------- | -------------
address_space | The address space that is used by the virtual network. | string | false |
address_spaces | The list of the address spaces that is used by the virtual network. | list(string) | false |
dns_servers | The DNS servers to be used with vNet. | list(string) | false |
tags | The tags to associate with your network and subnets. | map(string) | false |
vnet_name | Name of the vnet to create. | string | false |
resource_group_name | The name of an existing resource group to be imported. | string | true |
writeConnectionSecretToRef | The secret which the cloud resource connection will be written to | [writeConnectionSecretToRef](#writeConnectionSecretToRef) | false |
#### writeConnectionSecretToRef
名称 | 描述 | 类型 | 是否必须 | 默认值
------------ | ------------- | ------------- | ------------- | -------------
name | The secret name which the cloud resource connection will be written to | string | true |
namespace | The secret namespace which the cloud resource connection will be written to | string | false |

View File

@ -13,11 +13,11 @@ Terraform configuration for Tencent Cloud VPC
名称 | 描述 | 类型 | 是否必须 | 默认值
------------ | ------------- | ------------- | ------------- | -------------
vpc_name | The vpc name used to launch a new vpc when 'vpc_id' is not specified. | string | false |
vpc_cidr | The cidr block used to launch a new vpc when 'vpc_id' is not specified. | string | false |
vpc_is_multicast | Specify the vpc is multicast when 'vpc_id' is not specified. | bool | false |
vpc_dns_servers | Specify the vpc dns servers when 'vpc_id' is not specified. | list(string) | false |
vpc_tags | Additional tags for the vpc. | map(string) | false |
vpc_name | The vpc name used to launch a new vpc when 'vpc_id' is not specified. | string | false |
vpc_cidr | The cidr block used to launch a new vpc when 'vpc_id' is not specified. | string | false |
writeConnectionSecretToRef | The secret which the cloud resource connection will be written to | [writeConnectionSecretToRef](#writeConnectionSecretToRef) | false |

View File

@ -43,7 +43,7 @@ KubeVela支持以下类型的资源以后还会有更多
| 编排类型 | 云服务商 | 云资源 | 描述 |
|-----------|-------|------------------------------------------------------------------------------------------|-----------------------------------------------------------------------|
| Terraform | 阿里云 | [ACK](../end-user/components/cloud-services/terraform/alibaba-ack) | Terraform configuration for Alibaba Cloud ACK cluster |
| | | [ASK](../end-user/components/cloud-services/terraform/alibaba-amqp) | Terraform configuration for Alibaba Cloud AMQP (RabbitMQ) |
| | | [AMQP](../end-user/components/cloud-services/terraform/alibaba-amqp) | Terraform configuration for Alibaba Cloud AMQP (RabbitMQ) |
| | | [ASK](../end-user/components/cloud-services/terraform/alibaba-ask) | Terraform configuration for Alibaba Cloud Serverless Kubernetes (ASK) |
| | | [EIP](../end-user/components/cloud-services/terraform/alibaba-eip) | Terraform configuration for Alibaba Cloud EIP |
| | | [MSE](../end-user/components/cloud-services/terraform/alibaba-mse) | Terraform configuration for Alibaba Cloud MSE |
@ -56,8 +56,17 @@ KubeVela支持以下类型的资源以后还会有更多
| | | [VPC](../end-user/components/cloud-services/terraform/alibaba-vpc) | Terraform configuration for Alibaba Cloud VPC |
| | | [VSwitch](../end-user/components/cloud-services/terraform/alibaba-vswitch) | Terraform configuration for Alibaba Cloud VSwitch |
| | AWS | [S3](../end-user/components/cloud-services/terraform/aws-s3) | Terraform configuration for AWS S3 bucket |
| | | [S3](../end-user/components/cloud-services/terraform/aws-rds) | Terraform configuration for AWS RDS |
| | | [S3](../end-user/components/cloud-services/terraform/aws-security-group) | Terraform configuration for AWS Security Group |
| | | [S3](../end-user/components/cloud-services/terraform/aws-subnet) | Terraform configuration for AWS S3 Subnet |
| | | [S3](../end-user/components/cloud-services/terraform/aws-vpc) | Terraform configuration for AWS S3 VPC |
| | Azure | [Mariadb](../end-user/components/cloud-services/terraform/azure-database-mariadb) | Terraform configuration for Azure Database Mariadb |
| | | [Storage Account](../end-user/components/cloud-services/terraform/azure-storage-account) | Terraform configuration for Azure Storage Account |
| | | [Storage Account](../end-user/components/cloud-services/terraform/azure-resource-group) | Terraform configuration for Azure Resource group |
| | | [Storage Account](../end-user/components/cloud-services/terraform/azure-subnet) | Terraform configuration for Azure Subnet |
| | | [Storage Account](../end-user/components/cloud-services/terraform/azure-virtual-network) | Terraform configuration for Azure Virtual network |
| | 腾讯云 | [Mariadb](../end-user/components/cloud-services/terraform/tencent-vpc) | Terraform configuration for Tencent Cloud VPC |
| | | [Mariadb](../end-user/components/cloud-services/terraform/tencent-subnet) | Terraform configuration for Tencent Cloud Subnet |
## 创建你的云服务

View File

@ -13,20 +13,33 @@ KubeVela 通过云资源组件Component和运维特征Trait里的资
## 支持的云资源列表
| 编排类型 | 云服务商 | 云资源 | 描述 |
|-----------|-------|------------------------------------------------------|----------------------------------------------------------------------------|
| Terraform | 阿里云 | [ACK](./terraform/alibaba-ack) | 用于部署阿里云 ACK 的 Terraform Configuration 的 ComponentDefinition |
| | | [ASK](./terraform/alibaba-ask) | 用于部署阿里云 ASK 的 Terraform Configuration 的 ComponentDefinition |
| | | [EIP](./terraform/alibaba-eip) | 用于部署阿里云 EIP 的 Terraform Configuration 的 ComponentDefinition |
| | | [OSS](./terraform/alibaba-oss) | 用于部署阿里云 OSS 的 Terraform Configuration 的 ComponentDefinition |
| | | [RDS](./terraform/alibaba-rds) | 用于部署阿里云 RDS 的 Terraform Configuration 的 ComponentDefinition |
| | | [Redis](./terraform/alibaba-redis) | 用于部署阿里云 Redis 的 Terraform Configuration 的 ComponentDefinition |
| | | [SLS Project](./terraform/alibaba-sls-project) | 用于部署阿里云 SLS project 的 Terraform Configuration 的 ComponentDefinition |
| | | [SLS Store](./terraform/alibaba-sls-store) | 用于部署阿里云 SLS store 的 Terraform Configuration 的 ComponentDefinition |
| | | [VPC](./terraform/alibaba-vpc) | 用于部署阿里云 VPC 的 Terraform Configuration 的 ComponentDefinition |
| | | [VSwitch](./terraform/alibaba-vswitch) | 用于部署阿里云 VSwitch 的 Terraform Configuration 的 ComponentDefinition |
| | AWS | [S3](./terraform/aws-s3) | 用于部署 AWS S3 的 Terraform Configuration 的 ComponentDefinition |
| | Azure | [Mariadb](./terraform/azure-database-mariadb) | 用于部署 Azure mariadb 数据库的 Terraform Configuration 的 ComponentDefinition |
| | | [Storage Account](./terraform/azure-storage-account) | 用于部署 Azure Storage account 的 Terraform Configuration 的 ComponentDefinition |
|-----------|-------|------------------------------------------------------|-----------------------------------------------------------------------|
| Terraform | 阿里云 | [ACK](./terraform/alibaba-ack) | Terraform configuration for Alibaba Cloud ACK cluster |
| | | [ASK](./terraform/alibaba-amqp) | Terraform configuration for Alibaba Cloud AMQP (RabbitMQ) |
| | | [ASK](./terraform/alibaba-ask) | Terraform configuration for Alibaba Cloud Serverless Kubernetes (ASK) |
| | | [EIP](./terraform/alibaba-eip) | Terraform configuration for Alibaba Cloud EIP |
| | | [MSE](./terraform/alibaba-mse) | Terraform configuration for Alibaba Cloud MSE |
| | | [OSS](./terraform/alibaba-oss) | Terraform configuration for Alibaba Cloud OSS |
| | | [RDS](./terraform/alibaba-rds) | Terraform configuration for Alibaba Cloud RDS |
| | | [Redis](./terraform/alibaba-redis) | Terraform configuration for Alibaba Cloud Redis |
| | | [RocketMQ](./terraform/alibaba-rocketmq) | Terraform configuration for Alibaba Cloud RocketMQ |
| | | [SLS Project](./terraform/alibaba-sls-project) | Terraform configuration for Alibaba Cloud SLS Project |
| | | [SLS Store](./terraform/alibaba-sls-store) | Terraform configuration for Alibaba Cloud SLS Store |
| | | [VPC](./terraform/alibaba-vpc) | Terraform configuration for Alibaba Cloud VPC |
| | | [VSwitch](./terraform/alibaba-vswitch) | Terraform configuration for Alibaba Cloud VSwitch |
| | AWS | [S3](./terraform/aws-s3) | Terraform configuration for AWS S3 bucket |
| | | [S3](./terraform/aws-rds) | Terraform configuration for AWS RDS |
| | | [S3](./terraform/aws-security-group) | Terraform configuration for AWS Security Group |
| | | [S3](./terraform/aws-subnet) | Terraform configuration for AWS S3 Subnet |
| | | [S3](./terraform/aws-vpc) | Terraform configuration for AWS S3 VPC |
| | Azure | [Mariadb](./terraform/azure-database-mariadb) | Terraform configuration for Azure Database Mariadb |
| | | [Storage Account](./terraform/azure-storage-account) | Terraform configuration for Azure Storage Account |
| | | [Storage Account](./terraform/azure-resource-group) | Terraform configuration for Azure Resource group |
| | | [Storage Account](./terraform/azure-subnet) | Terraform configuration for Azure Subnet |
| | | [Storage Account](./terraform/azure-virtual-network) | Terraform configuration for Azure Virtual network |
| | | [Storage Account](./terraform/azure-storage-account) | Terraform configuration for Azure Storage Account |
| | 腾讯云 | [Mariadb](./terraform/tencent-vpc) | Terraform configuration for Tencent Cloud VPC |
| | | [Mariadb](./terraform/tencent-subnet) | Terraform configuration for Tencent Cloud Subnet |
## Terraform

View File

@ -30,29 +30,29 @@ spec:
名称 | 描述 | 类型 | 是否必须 | 默认值
------------ | ------------- | ------------- | ------------- | -------------
k8s_version | The version of the kubernetes version. Valid values: '1.16.6-aliyun.1','1.14.8-aliyun.1'. Default to '1.16.6-aliyun.1'. | string | true |
zone_id | Availability Zone ID | string | true |
cpu_core_count | CPU core count is used to fetch instance types. | number | true |
vpc_name | The vpc name used to create a new vpc when 'vpc_id' is not specified. Default to variable `example_name` | string | true |
enable_ssh | Enable login to the node through SSH. | bool | true |
cpu_policy | kubelet cpu policy. Valid values: 'none','static'. Default to 'none'. | string | true |
proxy_mode | Proxy mode is option of kube-proxy. Valid values: 'ipvs','iptables'. Default to 'iptables'. | string | true |
k8s_service_cidr | The kubernetes service cidr block. It cannot be equals to vpc's or vswitch's or pod's and cannot be in them. | string | true |
vpc_cidr | The cidr block used to launch a new vpc when 'vpc_id' is not specified. | string | true |
password | The password of ECS instance. | string | true |
k8s_pod_cidr | The kubernetes pod cidr block. It cannot be equals to vpc's or vswitch's and cannot be in them. | string | true |
vswitch_ids | List of existing vswitch id. | list(any) | true |
vswitch_cidrs | List of cidr blocks used to create several new vswitches when 'vswitch_ids' is not specified. | list(any) | true |
new_nat_gateway | Whether to create a new nat gateway. In this template, a new nat gateway will create a nat gateway, eip and server snat entries. | bool | true |
node_cidr_mask | The node cidr block to specific how many pods can run on single node. Valid values: [24-28]. | number | true |
k8s_worker_number | The number of worker nodes in kubernetes cluster. | number | true |
install_cloud_monitor | Install cloud monitor agent on ECS. | bool | true |
memory_size | Memory size used to fetch instance types. | number | true |
vswitch_name_prefix | The vswitch name prefix used to create several new vswitches. Default to variable 'example_name'. | string | true |
number_format | The number format used to output. | string | true |
k8s_name_prefix | The name prefix used to create several kubernetes clusters. Default to variable `example_name` | string | true |
master_instance_types | The ecs instance types used to launch master nodes. | list(any) | true |
worker_instance_types | The ecs instance types used to launch worker nodes. | list(any) | true |
vpc_name | The vpc name used to create a new vpc when 'vpc_id' is not specified. Default to variable `example_name` | string | false |
enable_ssh | Enable login to the node through SSH. | bool | false |
install_cloud_monitor | Install cloud monitor agent on ECS. | bool | false |
k8s_worker_number | The number of worker nodes in kubernetes cluster. | number | false |
k8s_service_cidr | The kubernetes service cidr block. It cannot be equals to vpc's or vswitch's or pod's and cannot be in them. | string | false |
k8s_pod_cidr | The kubernetes pod cidr block. It cannot be equals to vpc's or vswitch's and cannot be in them. | string | false |
zone_id | Availability Zone ID | string | false |
vpc_cidr | The cidr block used to launch a new vpc when 'vpc_id' is not specified. | string | false |
vswitch_cidrs | List of cidr blocks used to create several new vswitches when 'vswitch_ids' is not specified. | list(any) | false |
k8s_name_prefix | The name prefix used to create several kubernetes clusters. Default to variable `example_name` | string | false |
new_nat_gateway | Whether to create a new nat gateway. In this template, a new nat gateway will create a nat gateway, eip and server snat entries. | bool | false |
worker_instance_types | The ecs instance types used to launch worker nodes. | list(any) | false |
cpu_policy | kubelet cpu policy. Valid values: 'none','static'. Default to 'none'. | string | false |
proxy_mode | Proxy mode is option of kube-proxy. Valid values: 'ipvs','iptables'. Default to 'iptables'. | string | false |
cpu_core_count | CPU core count is used to fetch instance types. | number | false |
memory_size | Memory size used to fetch instance types. | number | false |
vswitch_name_prefix | The vswitch name prefix used to create several new vswitches. Default to variable 'example_name'. | string | false |
number_format | The number format used to output. | string | false |
vswitch_ids | List of existing vswitch id. | list(any) | false |
master_instance_types | The ecs instance types used to launch master nodes. | list(any) | false |
node_cidr_mask | The node cidr block to specific how many pods can run on single node. Valid values: [24-28]. | number | false |
password | The password of ECS instance. | string | false |
k8s_version | The version of the kubernetes version. Valid values: '1.16.6-aliyun.1','1.14.8-aliyun.1'. Default to '1.16.6-aliyun.1'. | string | false |
writeConnectionSecretToRef | The secret which the cloud resource connection will be written to | [writeConnectionSecretToRef](#writeConnectionSecretToRef) | false |

View File

@ -13,21 +13,21 @@ Terraform configuration for Alibaba Cloud AMQP(RabbitMQ)
名称 | 描述 | 类型 | 是否必须 | 默认值
------------ | ------------- | ------------- | ------------- | -------------
create | Whether to create instance. If false, you can specify an existing instance by setting 'instance_id'. | bool | false |
payment_type | The specification of the payment type. | string | false |
auto_delete_state | Specifies whether the Auto Delete attribute is configured. Valid values: true: The Auto Delete attributeis configured. If the last queue that is bound to an exchange is unbound, the exchange is automatically deleted. false: The Auto Delete attribute is not configured. If the last queue that is bound to an exchange is unbound, the exchange is not automatically deleted. | bool | false |
internal | The specification of the internal. | bool | false |
instance_type | The specification of the instance type. Valid values: professional, vip. | string | false |
queue_capacity | The specification of the queue capacity. The smallest value is 50 and the step size 5. | number | false |
support_eip | The specification of support EIP. | bool | false |
max_eip_tps | The specification of the max eip tps. It is valid when support_eip is true. The valid value is [128, 45000] with the step size 128 | number | false |
period | The specification of the period. Valid values: 1, 12, 2, 24, 3, 6. | number | false |
argument | The specification of the argument. | string | false |
binding_type | The specification of the binding type. Valid values: EXCHANGE, QUEUE. | string | false |
name | The specification of module name. | string | false |
max_tps | The specification of the peak TPS traffic. The smallest valid value is 1000 and the largest value is 100,000. | number | false |
instance_id | The instance_id used to RabbitMQ. If set, the 'create' will be ignored. | string | false |
payment_type | The specification of the payment type. | string | false |
exchange_type | The specification of the exchange type. Valid values: FANOUT, DIRECT, TOPIC, HEADERS | string | false |
internal | The specification of the internal. | bool | false |
name | The specification of module name. | string | false |
argument | The specification of the argument. | string | false |
instance_type | The specification of the instance type. Valid values: professional, vip. | string | false |
max_tps | The specification of the peak TPS traffic. The smallest valid value is 1000 and the largest value is 100,000. | number | false |
period | The specification of the period. Valid values: 1, 12, 2, 24, 3, 6. | number | false |
create | Whether to create instance. If false, you can specify an existing instance by setting 'instance_id'. | bool | false |
binding_type | The specification of the binding type. Valid values: EXCHANGE, QUEUE. | string | false |
support_eip | The specification of support EIP. | bool | false |
instance_id | The instance_id used to RabbitMQ. If set, the 'create' will be ignored. | string | false |
auto_delete_state | Specifies whether the Auto Delete attribute is configured. Valid values: true: The Auto Delete attributeis configured. If the last queue that is bound to an exchange is unbound, the exchange is automatically deleted. false: The Auto Delete attribute is not configured. If the last queue that is bound to an exchange is unbound, the exchange is not automatically deleted. | bool | false |
writeConnectionSecretToRef | The secret which the cloud resource connection will be written to | [writeConnectionSecretToRef](#writeConnectionSecretToRef) | false |

View File

@ -13,7 +13,7 @@ title: 阿里云 ASK
名称 | 描述 | 类型 | 是否必须 | 默认值
------------ | ------------- | ------------- | ------------- | -------------
name | ASK name | string | true |
name | ASK name | string | false |
writeConnectionSecretToRef | The secret which the cloud resource connection will be written to | [writeConnectionSecretToRef](#writeConnectionSecretToRef) | false |
@ -31,8 +31,8 @@ title: 阿里云 ASK
名称 | 描述
------------ | -------------
KUBECONFIG | The KubeConfig string of the kubernetes cluster.
RESOURCE_IDENTIFIER | The identifier of the resource
Name | Cluster Name
API_SERVER_INTRANET | The API server intranet address of the kubernetes cluster.
API_SERVER_INTERNET | The API server internet address of the kubernetes cluster.
KUBECONFIG | The KubeConfig string of the kubernetes cluster.

View File

@ -4,7 +4,7 @@ title: 阿里云 EIP
## 描述
用于部署阿里云 Elastic IP 的组件说明
用于部署阿里云弹性 IP 的组件说明
## 示例
@ -29,8 +29,8 @@ spec:
名称 | 描述 | 类型 | 是否必须 | 默认值
------------ | ------------- | ------------- | ------------- | -------------
name | Name to be used on all resources as prefix. Default to 'TF-Module-EIP'. | string | true |
bandwidth | Maximum bandwidth to the elastic public network, measured in Mbps (Mega bit per second). | number | true |
name | Name to be used on all resources as prefix. Default to 'TF-Module-EIP'. | string | false |
bandwidth | Maximum bandwidth to the elastic public network, measured in Mbps (Mega bit per second). | number | false |
writeConnectionSecretToRef | The secret which the cloud resource connection will be written to | [writeConnectionSecretToRef](#writeConnectionSecretToRef) | false |

View File

@ -13,28 +13,28 @@ Alibaba Cloud MongoDB
名称 | 描述 | 类型 | 是否必须 | 默认值
------------ | ------------- | ------------- | ------------- | -------------
instance_charge_type | The billing method of the instance. Valid values are Prepaid, PostPaid, Default to PostPaid | string | false |
period | The duration that you will buy DB instance (in month). It is valid when instance_charge_type is PrePaid. Valid values: [1~9], 12, 24, 36. Default to 1 | | false |
db_instance_storage | The storage space of the instance. Valid values: 10 to 3000. Unit: GB. You can only specify this value in 10 GB increments. | number | false |
existing_instance_id | The Id of an existing Mongodb instance. If set, the `create` will be ignored. | string | false |
instance_id | `(Deprecated)` It has been deprecated from version 1.2.0 and use `existing_instance_id` instead. | string | false |
replication_factor | The number of nodes in the replica set instance. Valid values: 3, 5, 7. Default value: 3. | number | false |
region | (Deprecated from version 1.4.0) The region used to launch this module resources. | string | false |
storage_engine | The MongoDB storage engine, WiredTiger or RocksDB. Default value: WiredTiger. | string | false |
name | The name of DB instance. It a string of 2 to 256 characters | string | true |
account_password | Password of the root account. It is a string of 6 to 32 characters and is composed of letters, numbers, and underlines | string | true |
backup_period | MongoDB Instance backup period. It is required when backup_time was existed. Valid values: [Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday]. Default to [Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday]. | list(string) | true |
backup_time | MongoDB instance backup time. It is required when backup_period was existed. In the format of HH:mmZ- HH:mmZ. Time setting interval is one hour. Default to a random time, like '23:00Z-24:00Z'. | string | false |
tags | A mapping of tags to assign to the mongodb instance resource. | map(string) | false |
engine_version | The version number of the database. Valid value: 3.4, 4.0, 4.2, 4.4, 5.0 | string | true |
shared_credentials_file | (Deprecated from version 1.4.0) This is the path to the shared credentials file. If this is not set and a profile is specified, $HOME/.aliyun/config.json will be used. | string | false |
skip_region_validation | (Deprecated from version 1.4.0) Skip static validation of region ID. Used by users of alternative AlibabaCloud-like APIs or users w/ access to regions that are not public (yet). | bool | false |
engine_version | The version number of the database. Valid value: 3.4, 4.0, 4.2, 4.4, 5.0 | string | true |
db_instance_class | The specification of the instance. For more information about the value, see https://www.alibabacloud.com/help/doc-detail/57141.htm | string | true |
zone_id | The ID of the zone. You can refer to https://www.alibabacloud.com/help/doc-detail/61933.htm. | string | false |
instance_charge_type | The billing method of the instance. Valid values are Prepaid, PostPaid, Default to PostPaid | string | false |
period | The duration that you will buy DB instance (in month). It is valid when instance_charge_type is PrePaid. Valid values: [1~9], 12, 24, 36. Default to 1 | | false |
vswitch_id | The virtual switch ID to launch DB instances in one VPC. | string | false |
security_ip_list | List of IP addresses allowed to access all databases of an instance. The list contains up to 1,000 IP addresses, separated by commas. Supported formats include 0.0.0.0/0, 10.23.12.24 (IP), and 10.23.12.24/24 (Classless Inter-Domain Routing (CIDR) mode. /24 represents the length of the prefix in an IP address. The range of the prefix length is [1,32]). | list(string) | false |
create | Whether to use an existing MongoDB. If false, you can use a existing Mongodb instance by setting `existing_instance_id`. | bool | false |
backup_time | MongoDB instance backup time. It is required when backup_period was existed. In the format of HH:mmZ- HH:mmZ. Time setting interval is one hour. Default to a random time, like '23:00Z-24:00Z'. | string | false |
profile | (Deprecated from version 1.4.0) The profile name as set in the shared credentials file. If not set, it will be sourced from the ALICLOUD_PROFILE environment variable. | string | false |
db_instance_class | The specification of the instance. For more information about the value, see https://www.alibabacloud.com/help/doc-detail/57141.htm | string | true |
storage_engine | The MongoDB storage engine, WiredTiger or RocksDB. Default value: WiredTiger. | string | false |
security_ip_list | List of IP addresses allowed to access all databases of an instance. The list contains up to 1,000 IP addresses, separated by commas. Supported formats include 0.0.0.0/0, 10.23.12.24 (IP), and 10.23.12.24/24 (Classless Inter-Domain Routing (CIDR) mode. /24 represents the length of the prefix in an IP address. The range of the prefix length is [1,32]). | list(string) | false |
replication_factor | The number of nodes in the replica set instance. Valid values: 3, 5, 7. Default value: 3. | number | false |
tags | A mapping of tags to assign to the mongodb instance resource. | map(string) | false |
region | (Deprecated from version 1.4.0) The region used to launch this module resources. | string | false |
name | The name of DB instance. It a string of 2 to 256 characters | string | true |
zone_id | The ID of the zone. You can refer to https://www.alibabacloud.com/help/doc-detail/61933.htm. | string | false |
account_password | Password of the root account. It is a string of 6 to 32 characters and is composed of letters, numbers, and underlines | string | true |
backup_period | MongoDB Instance backup period. It is required when backup_time was existed. Valid values: [Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday]. Default to [Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday]. | list(string) | true |
existing_instance_id | The Id of an existing Mongodb instance. If set, the `create` will be ignored. | string | false |
create | Whether to use an existing MongoDB. If false, you can use a existing Mongodb instance by setting `existing_instance_id`. | bool | false |
instance_id | `(Deprecated)` It has been deprecated from version 1.2.0 and use `existing_instance_id` instead. | string | false |
db_instance_storage | The storage space of the instance. Valid values: 10 to 3000. Unit: GB. You can only specify this value in 10 GB increments. | number | false |
writeConnectionSecretToRef | The secret which the cloud resource connection will be written to | [writeConnectionSecretToRef](#writeConnectionSecretToRef) | false |

View File

@ -4,7 +4,7 @@ title: 阿里云 MSE
## 描述
Alibaba Cloud MSE
Terraform configuration for Alibaba Cloud MSE
## 参数说明
@ -13,12 +13,12 @@ Alibaba Cloud MSE
名称 | 描述 | 类型 | 是否必须 | 默认值
------------ | ------------- | ------------- | ------------- | -------------
cluster_specification | The engine specification of MSE Cluster. Valid values: MSE_SC_1_2_200_c1C2G MSE_SC_2_4_200_c2C4G MSE_SC_4_8_200_c4C8G MSE_SC_8_16_200_c8C16G | string | false |
cluster_type | The type of MSE Cluster. Valid values: ZooKeeper、Nacos-Ans and Eureka | string | false |
cluster_version | The version of MSE Cluster. Valid values: ZooKeeper_3_4_14, ZooKeeper_3_5_5, NACOS_ANS_1_1_3, NACOS_ANS_1_2_1, EUREKA_1_9_3 | string | false |
net_type | The type of network. Valid values: privatenet and pubnet | string | false |
acl_entry_list | The whitelist | list(any) | false |
cluster_alias_name | The alias name of MSE Cluster | string | false |
cluster_specification | The engine specification of MSE Cluster. Valid values: MSE_SC_1_2_200_c1C2G MSE_SC_2_4_200_c2C4G MSE_SC_4_8_200_c4C8G MSE_SC_8_16_200_c8C16G | string | false |
cluster_type | The type of MSE Cluster. Valid values: ZooKeeper、Nacos-Ans and Eureka | string | false |
writeConnectionSecretToRef | The secret which the cloud resource connection will be written to | [writeConnectionSecretToRef](#writeConnectionSecretToRef) | false |

View File

@ -31,8 +31,8 @@ spec:
名称 | 描述 | 类型 | 是否必须 | 默认值
------------ | ------------- | ------------- | ------------- | -------------
acl | OSS bucket ACL, supported 'private', 'public-read', 'public-read-write' | string | true |
bucket | OSS bucket name | string | true |
bucket | OSS bucket name | string | false |
acl | OSS bucket ACL, supported 'private', 'public-read', 'public-read-write' | string | false |
writeConnectionSecretToRef | The secret which the cloud resource connection will be written to | [writeConnectionSecretToRef](#writeConnectionSecretToRef) | false |

View File

@ -32,16 +32,16 @@ spec:
名称 | 描述 | 类型 | 是否必须 | 默认值
------------ | ------------- | ------------- | ------------- | -------------
privilege | The privilege of one account access database. | string | false |
sql_bucket_name | The bucket name of the SQL file. like `oss://example` | string | false |
instance_name | RDS instance name | string | false |
account_name | RDS instance user account name | string | false |
password | RDS instance account password | string | false |
sql_file | The name of SQL file in the bucket, like `db.sql` | string | false |
sql_bucket_endpoint | The endpoint of the bucket. like `oss-cn-hangzhou.aliyuncs.com` | string | false |
allocate_public_connection | Whether to allocate public connection for a RDS instance. | bool | false |
security_ips | List of IP addresses allowed to access all databases of an instance | list(any) | false |
privilege | The privilege of one account access database. | string | false |
sql_file | The name of SQL file in the bucket, like `db.sql` | string | false |
sql_bucket_name | The bucket name of the SQL file. like `oss://example` | string | false |
password | RDS instance account password | string | false |
account_name | RDS instance user account name | string | false |
allocate_public_connection | Whether to allocate public connection for a RDS instance. | bool | false |
database_name | Database name | string | false |
sql_bucket_endpoint | The endpoint of the bucket. like `oss-cn-hangzhou.aliyuncs.com` | string | false |
instance_name | RDS instance name | string | false |
writeConnectionSecretToRef | The secret which the cloud resource connection will be written to | [writeConnectionSecretToRef](#writeConnectionSecretToRef) | false |
@ -59,12 +59,12 @@ spec:
名称 | 描述
------------ | -------------
DB_ID | RDS Instance ID
DB_USER | RDS Instance User
DB_PASSWORD | RDS Instance Password
DATABASE_NAME | RDS Database Name
RESOURCE_IDENTIFIER | The identifier of the resource
DB_NAME | RDS Instance Name
DB_PORT | RDS Instance Port
DB_HOST | RDS Instance Host
DB_PUBLIC_HOST | RDS Instance Public Host
RESOURCE_IDENTIFIER | The identifier of the resource
DB_USER | RDS Instance User
DB_PASSWORD | RDS Instance Password
DATABASE_NAME | RDS Database Name
DB_ID | RDS Instance ID

View File

@ -32,9 +32,9 @@ spec:
名称 | 描述 | 类型 | 是否必须 | 默认值
------------ | ------------- | ------------- | ------------- | -------------
instance_name | Redis instance name | string | true |
account_name | Redis instance user account name | string | true |
password | RDS instance account password | string | true |
instance_name | Redis instance name | string | false |
account_name | Redis instance user account name | string | false |
password | RDS instance account password | string | false |
writeConnectionSecretToRef | The secret which the cloud resource connection will be written to | [writeConnectionSecretToRef](#writeConnectionSecretToRef) | false |

View File

@ -13,14 +13,14 @@ Terraform configuration for Alibaba Cloud RocketMQ
名称 | 描述 | 类型 | 是否必须 | 默认值
------------ | ------------- | ------------- | ------------- | -------------
ons_instance_name | The name of ons instance. The length must be 3 to 64 characters. Chinese characters, English letters digits and hyphen are allowed. | string | false |
topic | The specification of ons topic name. Two topics on a single instance cannot have the same name and the name cannot start with 'GID' or 'CID'. The length cannot exceed 64 characters. | string | false |
ons_instance_remark | The specification of ons instance remark. | string | false |
ons_topic_remark | The specification of ons topic remark. | string | false |
message_type | The type of the message. Read [Ons Topic Create](https://www.alibabacloud.com/help/doc-detail/29591.html) for further details. | number | false |
group_name | The name of MQ group | string | false |
group_type | Specify the protocol applicable to the created Group ID. Valid values: tcp, http. Default to tcp | string | false |
perm | The permission of MQ topic | string | false |
ons_instance_name | The name of ons instance. The length must be 3 to 64 characters. Chinese characters, English letters digits and hyphen are allowed. | string | false |
topic | The specification of ons topic name. Two topics on a single instance cannot have the same name and the name cannot start with 'GID' or 'CID'. The length cannot exceed 64 characters. | string | false |
writeConnectionSecretToRef | The secret which the cloud resource connection will be written to | [writeConnectionSecretToRef](#writeConnectionSecretToRef) | false |
@ -38,9 +38,9 @@ Terraform configuration for Alibaba Cloud RocketMQ
名称 | 描述
------------ | -------------
INSTANCE_ID | The id of ons instance
TOPIC_ID | The id of ons topic
GROUP_ID | The id of ons group
HTTP_ENDPOINT_INTERNET | The internet http endpoint of ons instance
HTTP_ENDPOINT_INTERNAL | The internal http endpoint of ons instance
TCP_ENDPOINT | The tcp endpoint of ons instance
INSTANCE_ID | The id of ons instance
TOPIC_ID | The id of ons topic

View File

@ -32,8 +32,8 @@ spec:
名称 | 描述 | 类型 | 是否必须 | 默认值
------------ | ------------- | ------------- | ------------- | -------------
name | Name of security group. It is used to create a new security group. | string | true |
description | Description of security group | string | true |
name | Name of security group. It is used to create a new security group. | string | false |
description | Description of security group | string | false |
writeConnectionSecretToRef | The secret which the cloud resource connection will be written to | [writeConnectionSecretToRef](#writeConnectionSecretToRef) | false |

View File

@ -34,15 +34,15 @@ spec:
名称 | 描述 | 类型 | 是否必须 | 默认值
------------ | ------------- | ------------- | ------------- | -------------
store_append_meta | Determines whether to append log meta automatically. The meta includes log receive time and client IP address. Default to true. | bool | true |
project_name | Name of security group. It is used to create a new security group. | string | true |
description | Description of security group | string | true |
store_name | Log store name. | string | true |
store_retention_period | The data retention time (in days). Valid values: [1-3650]. Default to 30. Log store data will be stored permanently when the value is '3650'. | number | true |
store_auto_split | Determines whether to automatically split a shard. Default to true. | bool | true |
create_project | Whether to create log resources | string | true |
store_shard_count | The number of shards in this log store. Default to 2. You can modify it by 'Split' or 'Merge' operations. | number | true |
store_max_split_shard_count | The maximum number of shards for automatic split, which is in the range of 1 to 64. You must specify this parameter when autoSplit is true. | number | true |
project_name | Name of security group. It is used to create a new security group. | string | false |
description | Description of security group | string | false |
store_shard_count | The number of shards in this log store. Default to 2. You can modify it by 'Split' or 'Merge' operations. | number | false |
create_project | Whether to create log resources | string | false |
store_name | Log store name. | string | false |
store_retention_period | The data retention time (in days). Valid values: [1-3650]. Default to 30. Log store data will be stored permanently when the value is '3650'. | number | false |
store_auto_split | Determines whether to automatically split a shard. Default to true. | bool | false |
store_max_split_shard_count | The maximum number of shards for automatic split, which is in the range of 1 to 64. You must specify this parameter when autoSplit is true. | number | false |
store_append_meta | Determines whether to append log meta automatically. The meta includes log receive time and client IP address. Default to true. | bool | false |
writeConnectionSecretToRef | The secret which the cloud resource connection will be written to | [writeConnectionSecretToRef](#writeConnectionSecretToRef) | false |

View File

@ -31,9 +31,9 @@ spec:
名称 | 描述 | 类型 | 是否必须 | 默认值
------------ | ------------- | ------------- | ------------- | -------------
vpc_name | The vpc name used to launch a new vpc. | string | true |
vpc_description | The vpc description used to launch a new vpc. | string | true |
vpc_cidr | The cidr block used to launch a new vpc. | string | true |
vpc_name | The vpc name used to launch a new vpc. | string | false |
vpc_description | The vpc description used to launch a new vpc. | string | false |
vpc_cidr | The cidr block used to launch a new vpc. | string | false |
writeConnectionSecretToRef | The secret which the cloud resource connection will be written to | [writeConnectionSecretToRef](#writeConnectionSecretToRef) | false |

View File

@ -13,15 +13,15 @@ title: 阿里云 VSWITCH
名称 | 描述 | 类型 | 是否必须 | 默认值
------------ | ------------- | ------------- | ------------- | -------------
vpc_id | The vpc id used to launch several vswitches. If set, the 'create' will be ignored. | string | true |
vswitch_cidr | cidr blocks used to launch a new vswitch. | string | true |
vswitch_description | The vswitch description used to launch several new vswitch. | string | true |
vpc_description | The vpc description used to launch a new vpc. | string | true |
vpc_name | The vpc name used to launch a new vpc. | string | true |
vpc_cidr | The cidr block used to launch a new vpc. | string | true |
zone_id | Availability Zone ID | string | true |
vswitch_name | The vswitch name prefix used to launch several new vswitches. | | true |
create_vpc | Whether to create vpc. If false, you can specify an existing vpc by setting 'vpc_id'. | bool | true |
vswitch_description | The vswitch description used to launch several new vswitch. | string | false |
zone_id | Availability Zone ID | string | false |
vswitch_name | The vswitch name prefix used to launch several new vswitches. | | false |
create_vpc | Whether to create vpc. If false, you can specify an existing vpc by setting 'vpc_id'. | bool | false |
vpc_name | The vpc name used to launch a new vpc. | string | false |
vpc_cidr | The cidr block used to launch a new vpc. | string | false |
vpc_description | The vpc description used to launch a new vpc. | string | false |
vpc_id | The vpc id used to launch several vswitches. If set, the 'create' will be ignored. | string | false |
vswitch_cidr | cidr blocks used to launch a new vswitch. | string | false |
writeConnectionSecretToRef | The secret which the cloud resource connection will be written to | [writeConnectionSecretToRef](#writeConnectionSecretToRef) | false |

View File

@ -0,0 +1,102 @@
---
title: AWS RDS
---
## 描述
AWS RDS
## 参数说明
### 属性
名称 | 描述 | 类型 | 是否必须 | 默认值
------------ | ------------- | ------------- | ------------- | -------------
storage_type | One of 'standard' (magnetic), 'gp2' (general purpose SSD), or 'io1' (provisioned IOPS SSD). The default is 'io1' if iops is specified, 'gp2' if not. | string | false |
vpc_security_group_ids | List of VPC security groups to associate | list(string) | false |
allow_major_version_upgrade | Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible | bool | false |
character_set_name | (Optional) The character set name to use for DB encoding in Oracle instances. This can't be changed. See Oracle Character Sets Supported in Amazon RDS and Collations and Character Sets for Microsoft SQL Server for more information. This can only be set on creation. | string | false |
option_group_timeouts | Define maximum timeout for deletion of `aws_db_option_group` resource | map(string) | false |
kms_key_id | The ARN for the KMS encryption key. If creating an encrypted replica, set this to the destination KMS ARN. If storage_encrypted is set to true and kms_key_id is not specified the default KMS key created in your account will be used | string | false |
s3_import | Restore from a Percona Xtrabackup in S3 (only MySQL is supported) | map(string) | false |
parameter_group_name | Name of the DB parameter group to associate or create | string | false |
parameter_group_use_name_prefix | Determines whether to use `parameter_group_name` as is or create a unique name beginning with the `parameter_group_name` as the prefix | bool | false |
timezone | (Optional) Time zone of the DB instance. timezone is currently only supported by Microsoft SQL Server. The timezone can only be set on creation. See MSSQL User Guide for more information. | string | false |
max_allocated_storage | Specifies the value for Storage Autoscaling | number | false |
snapshot_identifier | Specifies whether or not to create this database from a snapshot. This correlates to the snapshot ID you'd find in the RDS console, e.g: rds:production-2015-06-26-06-05. | string | false |
copy_tags_to_snapshot | On delete, copy all Instance tags to the final snapshot (if final_snapshot_identifier is specified) | bool | false |
password | Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file | string | false |
option_group_use_name_prefix | Determines whether to use `option_group_name` as is or create a unique name beginning with the `option_group_name` as the prefix | bool | false |
performance_insights_enabled | Specifies whether Performance Insights are enabled | bool | false |
port | The port on which the DB accepts connections | string | false |
publicly_accessible | Bool to control if instance is publicly accessible | bool | false |
create_db_subnet_group | Whether to create a database subnet group | bool | false |
db_subnet_group_name | Name of DB subnet group. DB instance will be created in the VPC associated with the DB subnet group. If unspecified, will be created in the default VPC | string | false |
enabled_cloudwatch_logs_exports | List of log types to enable for exporting to CloudWatch logs. If omitted, no logs will be exported. Valid values (depending on engine): alert, audit, error, general, listener, slowquery, trace, postgresql (PostgreSQL), upgrade (PostgreSQL). | list(string) | false |
name | The DB name to create. If omitted, no database is created initially | string | false |
username | Username for the master DB user | string | false |
multi_az | Specifies if the RDS instance is multi-AZ | bool | false |
monitoring_role_description | Description of the monitoring IAM role | string | false |
subnet_ids | A list of VPC subnet IDs | list(string) | false |
identifier | The name of the RDS instance, if omitted, Terraform will assign a random, unique identifier | string | true |
db_subnet_group_description | Description of the DB subnet group to create | string | false |
option_group_name | Name of the option group | string | false |
create_db_instance | Whether to create a database instance | bool | false |
storage_encrypted | Specifies whether the DB instance is encrypted | bool | false |
db_instance_tags | Additional tags for the DB instance | map(string) | false |
db_subnet_group_tags | Additional tags for the DB subnet group | map(string) | false |
db_subnet_group_use_name_prefix | Determines whether to use `subnet_group_name` as is or create a unique name beginning with the `subnet_group_name` as the prefix | bool | false |
family | The family of the DB parameter group | string | false |
monitoring_interval | The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. Valid Values: 0, 1, 5, 10, 15, 30, 60. | number | false |
auto_minor_version_upgrade | Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window | bool | false |
apply_immediately | Specifies whether any database modifications are applied immediately, or during the next maintenance window | bool | false |
performance_insights_kms_key_id | The ARN for the KMS key to encrypt Performance Insights data. | string | false |
create_random_password | Whether to create random password for RDS primary cluster | bool | false |
allocated_storage | The allocated storage in gigabytes | string | false |
replicate_source_db | Specifies that this resource is a Replicate database, and to use this value as the source database. This correlates to the identifier of another Amazon RDS Database to replicate. | string | false |
domain | The ID of the Directory Service Active Directory domain to create the instance in | string | false |
tags | A mapping of tags to assign to all resources | map(string) | false |
options | A list of Options to apply. | any | false |
backup_retention_period | The days to retain backups for | number | false |
db_parameter_group_tags | Additional tags for the DB parameter group | map(string) | false |
performance_insights_retention_period | The amount of time in days to retain Performance Insights data. Either 7 (7 days) or 731 (2 years). | number | false |
engine_version | The engine version to use | string | false |
monitoring_role_arn | The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. Must be specified if monitoring_interval is non-zero. | string | false |
db_option_group_tags | Additional tags for the DB option group | map(string) | false |
parameters | A list of DB parameters (map) to apply | list(map(string)) | false |
timeouts | (Optional) Updated Terraform resource management timeouts. Applies to `aws_db_instance` in particular to permit resource management times | map(string) | false |
ca_cert_identifier | Specifies the identifier of the CA certificate for the DB instance | string | false |
delete_automated_backups | Specifies whether to remove automated backups immediately after the DB instance is deleted | bool | false |
random_password_length | (Optional) Length of random password to create. (default: 10) | number | false |
cross_region_replica | Specifies if the replica should be cross region. It allows the use of a subnet group in a region different than the master instance | bool | false |
domain_iam_role_name | (Required if domain is provided) The name of the IAM role to be used when making API calls to the Directory Service | string | false |
engine | The database engine to use | string | false |
backup_window | The daily time range (in UTC) during which automated backups are created if they are enabled. Example: '09:46-10:16'. Must not overlap with maintenance_window | string | false |
create_db_option_group | (Optional) Create a database option group | bool | false |
deletion_protection | The database can't be deleted when this value is set to true. | bool | false |
license_model | License model information for this DB instance. Optional, but required for some DB engines, i.e. Oracle SE1 | string | false |
final_snapshot_identifier | The name of your final DB snapshot when this DB instance is deleted. | string | false |
create_monitoring_role | Create IAM role with a defined name that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. | bool | false |
parameter_group_description | Description of the DB parameter group to create | string | false |
major_engine_version | Specifies the major version of the engine that this option group should be associated with | string | false |
maintenance_window | The window to perform maintenance in. Syntax: 'ddd:hh24:mi-ddd:hh24:mi'. Eg: 'Mon:00:00-Mon:03:00' | string | false |
skip_final_snapshot | Determines whether a final DB snapshot is created before the DB instance is deleted. If true is specified, no DBSnapshot is created. If false is specified, a DB snapshot is created before the DB instance is deleted, using the value from final_snapshot_identifier | bool | false |
instance_class | The instance type of the RDS instance | string | false |
availability_zone | The Availability Zone of the RDS instance | string | false |
monitoring_role_name | Name of the IAM role which will be created when create_monitoring_role is enabled. | string | false |
option_group_description | The description of the option group | string | false |
iam_database_authentication_enabled | Specifies whether or not the mappings of AWS Identity and Access Management (IAM) accounts to database accounts are enabled | bool | false |
final_snapshot_identifier_prefix | The name which is prefixed to the final snapshot on cluster destroy | string | false |
iops | The amount of provisioned IOPS. Setting this implies a storage_type of 'io1' | number | false |
restore_to_point_in_time | Restore to a point in time (MySQL is NOT supported) | map(string) | false |
create_db_parameter_group | Whether to create a database parameter group | bool | false |
writeConnectionSecretToRef | The secret which the cloud resource connection will be written to | [writeConnectionSecretToRef](#writeConnectionSecretToRef) | false |
#### writeConnectionSecretToRef
名称 | 描述 | 类型 | 是否必须 | 默认值
------------ | ------------- | ------------- | ------------- | -------------
name | The secret name which the cloud resource connection will be written to | string | true |
namespace | The secret namespace which the cloud resource connection will be written to | string | false |

View File

@ -4,7 +4,7 @@ title: AWS S3
## 描述
Terraform configuration for AWS S3
用于部署 AWS S3 的组件说明
## 示例
@ -32,8 +32,8 @@ spec:
名称 | 描述 | 类型 | 是否必须 | 默认值
------------ | ------------- | ------------- | ------------- | -------------
bucket | S3 bucket name | string | true |
acl | S3 bucket ACL | string | true |
bucket | S3 bucket name | string | false |
acl | S3 bucket ACL | string | false |
writeConnectionSecretToRef | The secret which the cloud resource connection will be written to | [writeConnectionSecretToRef](#writeConnectionSecretToRef) | false |

View File

@ -0,0 +1,71 @@
---
title: AWS SECURITY-GROUP
---
## 描述
AWS Security Group
## 参数说明
### 属性
名称 | 描述 | 类型 | 是否必须 | 默认值
------------ | ------------- | ------------- | ------------- | -------------
egress_rules | List of egress rules to create by name | list(string) | false |
create_sg | Whether to create security group | bool | false |
vpc_id | ID of the VPC where to create security group | string | false |
description | Description of security group | string | false |
ingress_rules | List of ingress rules to create by name | list(string) | false |
ingress_with_self | List of ingress rules to create where 'self' is defined | list(map(string)) | false |
ingress_with_source_security_group_id | List of ingress rules to create where 'source_security_group_id' is used | list(map(string)) | false |
computed_ingress_with_self | List of computed ingress rules to create where 'self' is defined | list(map(string)) | false |
number_of_computed_egress_rules | Number of computed egress rules to create by name | number | false |
number_of_computed_egress_with_self | Number of computed egress rules to create where 'self' is defined | number | false |
number_of_computed_egress_with_source_security_group_id | Number of computed egress rules to create where 'source_security_group_id' is used | number | false |
use_name_prefix | Whether to use name_prefix or fixed name. Should be true to able to update security group name after initial creation | bool | false |
ingress_with_cidr_blocks | List of ingress rules to create where 'cidr_blocks' is used | list(map(string)) | false |
computed_ingress_rules | List of computed ingress rules to create by name | list(string) | false |
egress_cidr_blocks | List of IPv4 CIDR ranges to use on all egress rules | list(string) | false |
egress_ipv6_cidr_blocks | List of IPv6 CIDR ranges to use on all egress rules | list(string) | false |
computed_egress_with_self | List of computed egress rules to create where 'self' is defined | list(map(string)) | false |
number_of_computed_egress_with_ipv6_cidr_blocks | Number of computed egress rules to create where 'ipv6_cidr_blocks' is used | number | false |
security_group_id | ID of existing security group whose rules we will manage | string | false |
computed_ingress_with_cidr_blocks | List of computed ingress rules to create where 'cidr_blocks' is used | list(map(string)) | false |
egress_prefix_list_ids | List of prefix list IDs (for allowing access to VPC endpoints) to use on all egress rules | list(string) | false |
create_timeout | Time to wait for a security group to be created | string | false |
delete_timeout | Time to wait for a security group to be deleted | string | false |
ingress_prefix_list_ids | List of prefix list IDs (for allowing access to VPC endpoints) to use on all ingress rules | list(string) | false |
number_of_computed_ingress_with_self | Number of computed ingress rules to create where 'self' is defined | number | false |
egress_with_self | List of egress rules to create where 'self' is defined | list(map(string)) | false |
egress_with_source_security_group_id | List of egress rules to create where 'source_security_group_id' is used | list(map(string)) | false |
name | Name of security group - not required if create_sg is false | string | false |
revoke_rules_on_delete | Instruct Terraform to revoke all of the Security Groups attached ingress and egress rules before deleting the rule itself. Enable for EMR. | bool | false |
ingress_ipv6_cidr_blocks | List of IPv6 CIDR ranges to use on all ingress rules | list(string) | false |
number_of_computed_ingress_with_cidr_blocks | Number of computed ingress rules to create where 'cidr_blocks' is used | number | false |
number_of_computed_ingress_with_source_security_group_id | Number of computed ingress rules to create where 'source_security_group_id' is used | number | false |
ingress_with_ipv6_cidr_blocks | List of ingress rules to create where 'ipv6_cidr_blocks' is used | list(map(string)) | false |
number_of_computed_ingress_with_ipv6_cidr_blocks | Number of computed ingress rules to create where 'ipv6_cidr_blocks' is used | number | false |
computed_ingress_with_ipv6_cidr_blocks | List of computed ingress rules to create where 'ipv6_cidr_blocks' is used | list(map(string)) | false |
number_of_computed_ingress_rules | Number of computed ingress rules to create by name | number | false |
computed_egress_with_cidr_blocks | List of computed egress rules to create where 'cidr_blocks' is used | list(map(string)) | false |
computed_egress_with_ipv6_cidr_blocks | List of computed egress rules to create where 'ipv6_cidr_blocks' is used | list(map(string)) | false |
computed_egress_with_source_security_group_id | List of computed egress rules to create where 'source_security_group_id' is used | list(map(string)) | false |
create | Whether to create security group and all rules | bool | false |
tags | A mapping of tags to assign to security group | map(string) | false |
ingress_cidr_blocks | List of IPv4 CIDR ranges to use on all ingress rules | list(string) | false |
computed_ingress_with_source_security_group_id | List of computed ingress rules to create where 'source_security_group_id' is used | list(map(string)) | false |
egress_with_cidr_blocks | List of egress rules to create where 'cidr_blocks' is used | list(map(string)) | false |
egress_with_ipv6_cidr_blocks | List of egress rules to create where 'ipv6_cidr_blocks' is used | list(map(string)) | false |
computed_egress_rules | List of computed egress rules to create by name | list(string) | false |
number_of_computed_egress_with_cidr_blocks | Number of computed egress rules to create where 'cidr_blocks' is used | number | false |
writeConnectionSecretToRef | The secret which the cloud resource connection will be written to | [writeConnectionSecretToRef](#writeConnectionSecretToRef) | false |
#### writeConnectionSecretToRef
名称 | 描述 | 类型 | 是否必须 | 默认值
------------ | ------------- | ------------- | ------------- | -------------
name | The secret name which the cloud resource connection will be written to | string | true |
namespace | The secret namespace which the cloud resource connection will be written to | string | false |

View File

@ -0,0 +1,41 @@
---
title: AWS SUBNET
---
## 描述
AWS Subnet
## 参数说明
### 属性
名称 | 描述 | 类型 | 是否必须 | 默认值
------------ | ------------- | ------------- | ------------- | -------------
name | Name to be used on all the resources as identifier | string | false |
instance_tenancy | A tenancy option for instances launched into the VPC | string | false |
enable_dns_hostnames | Should be true to enable DNS hostnames in the VPC | bool | false |
enable_classiclink_dns_support | Should be true to enable ClassicLink DNS Support for the VPC. Only valid in regions and accounts that support EC2 Classic. | bool | false |
subnet_tags | A map of tags for the Subnet | map(string) | false |
vpc_tags | Additional tags for the VPC | map(string) | false |
cidr | The CIDR block for the VPC. Default value is a valid CIDR, but not acceptable by AWS and should be overridden | string | false |
enable_classiclink | Should be true to enable ClassicLink for the VPC. Only valid in regions and accounts that support EC2 Classic. | bool | false |
availability_zone | An availability zone name in the region | string | false |
assign_ipv6_address_on_creation | Assign IPv6 address on subnet, must be disabled to change IPv6 CIDRs. This is the IPv6 equivalent of map_public_ip_on_launch | bool | false |
vpc_id | The ID of the VPC | string | false |
create_vpc | Controls if VPC should be created (it affects almost all resources) | bool | false |
map_public_ip_on_launch | Should be false if you do not want to auto-assign public IP on launch | bool | false |
subnet_cidr | A list of subnets cidrs inside the VPC | string | false |
ipv6_cidr_block | The IPv6 CIDR block for the VPC. | string | false |
enable_ipv6 | Requests an Amazon-provided IPv6 CIDR block with a /56 prefix length for the VPC. You cannot specify the range of IP addresses, or the size of the CIDR block. | bool | false |
enable_dns_support | Should be true to enable DNS support in the VPC | bool | false |
writeConnectionSecretToRef | The secret which the cloud resource connection will be written to | [writeConnectionSecretToRef](#writeConnectionSecretToRef) | false |
#### writeConnectionSecretToRef
名称 | 描述 | 类型 | 是否必须 | 默认值
------------ | ------------- | ------------- | ------------- | -------------
name | The secret name which the cloud resource connection will be written to | string | true |
namespace | The secret namespace which the cloud resource connection will be written to | string | false |

View File

@ -0,0 +1,35 @@
---
title: AWS VPC
---
## 描述
AWS VPC
## 参数说明
### 属性
名称 | 描述 | 类型 | 是否必须 | 默认值
------------ | ------------- | ------------- | ------------- | -------------
tags | A map of tags to add to all resources | map(string) | false |
vpc_tags | Additional tags for the VPC | map(string) | false |
create_vpc | Controls if VPC should be created (it affects almost all resources) | bool | false |
enable_ipv6 | Requests an Amazon-provided IPv6 CIDR block with a /56 prefix length for the VPC. You cannot specify the range of IP addresses, or the size of the CIDR block. | bool | false |
instance_tenancy | A tenancy option for instances launched into the VPC | string | false |
enable_dns_hostnames | Should be true to enable DNS hostnames in the VPC | bool | false |
enable_dns_support | Should be true to enable DNS support in the VPC | bool | false |
enable_classiclink | Should be true to enable ClassicLink for the VPC. Only valid in regions and accounts that support EC2 Classic. | bool | false |
name | Name to be used on all the resources as identifier | string | false |
cidr | The CIDR block for the VPC. Default value is a valid CIDR, but not acceptable by AWS and should be overridden | string | false |
enable_classiclink_dns_support | Should be true to enable ClassicLink DNS Support for the VPC. Only valid in regions and accounts that support EC2 Classic. | bool | false |
writeConnectionSecretToRef | The secret which the cloud resource connection will be written to | [writeConnectionSecretToRef](#writeConnectionSecretToRef) | false |
#### writeConnectionSecretToRef
名称 | 描述 | 类型 | 是否必须 | 默认值
------------ | ------------- | ------------- | ------------- | -------------
name | The secret name which the cloud resource connection will be written to | string | true |
namespace | The secret namespace which the cloud resource connection will be written to | string | false |

View File

@ -36,12 +36,12 @@ spec:
名称 | 描述 | 类型 | 是否必须 | 默认值
------------ | ------------- | ------------- | ------------- | -------------
password | Database instance password | string | true |
location | Azure location | string | true |
resource_group | Resource group | string | true |
server_name | mariadb server name | string | true |
db_name | Database instance name | string | true |
username | Database instance username | string | true |
resource_group | Resource group | string | false |
server_name | mariadb server name | string | false |
db_name | Database instance name | string | false |
username | Database instance username | string | false |
password | Database instance password | string | false |
location | Azure location | string | false |
writeConnectionSecretToRef | The secret which the cloud resource connection will be written to | [writeConnectionSecretToRef](#writeConnectionSecretToRef) | false |
@ -59,9 +59,9 @@ spec:
名称 | 描述
------------ | -------------
DB_USER | Database instance username
DB_PASSWORD | Database instance password
DB_PORT | Database instance port
DB_HOST | Database instance host
SERVER_NAME | mariadb server name
DB_NAME | Database instance name
DB_USER | Database instance username

View File

@ -0,0 +1,35 @@
---
title: Azure RESOURCE-GROUP
---
## 描述
Azure Resource Group
## 参数说明
### 属性
名称 | 描述 | 类型 | 是否必须 | 默认值
------------ | ------------- | ------------- | ------------- | -------------
name | The name of the resource group | string | false |
location | The location of the resource group | string | false |
writeConnectionSecretToRef | The secret which the cloud resource connection will be written to | [writeConnectionSecretToRef](#writeConnectionSecretToRef) | false |
#### writeConnectionSecretToRef
名称 | 描述 | 类型 | 是否必须 | 默认值
------------ | ------------- | ------------- | ------------- | -------------
name | The secret name which the cloud resource connection will be written to | string | true |
namespace | The secret namespace which the cloud resource connection will be written to | string | false |
### 输出
如果设置了 `writeConnectionSecretToRef`,一个 Kubernetes Secret 将会被创建并且它的数据里有这些键key
名称 | 描述
------------ | -------------
resource_group_name | The name of the resource group

View File

@ -45,12 +45,12 @@ spec:
名称 | 描述 | 类型 | 是否必须 | 默认值
------------ | ------------- | ------------- | ------------- | -------------
resource_group_name | Name of resource group. Defaults to 'rsg'. | string | true |
name | Name of storage account. Defaults to 'storageaccount'. | string | true |
location | Location of storage account. Defaults to 'West Europe'. | string | true |
tags | Tags for storage account. Defaults to '{}'. | map(string) | true |
static_website | Static website configuration. Defaults to disabled. | list(map(string)) | true |
create_rsg | Conditional if resource group should be created. Defaults to 'true'. | bool | true |
name | Name of storage account. Defaults to 'storageaccount'. | string | false |
location | Location of storage account. Defaults to 'West Europe'. | string | false |
tags | Tags for storage account. Defaults to '{}'. | map(string) | false |
static_website | Static website configuration. Defaults to disabled. | list(map(string)) | false |
create_rsg | Conditional if resource group should be created. Defaults to 'true'. | bool | false |
resource_group_name | Name of resource group. Defaults to 'rsg'. | string | false |
writeConnectionSecretToRef | The secret which the cloud resource connection will be written to | [writeConnectionSecretToRef](#writeConnectionSecretToRef) | false |

View File

@ -0,0 +1,34 @@
---
title: Azure SUBNET
---
## 描述
Azure Subnet
## 参数说明
### 属性
名称 | 描述 | 类型 | 是否必须 | 默认值
------------ | ------------- | ------------- | ------------- | -------------
resource_group_name | The name of an existing resource group to be imported. | string | true |
address_space | The address space that is used by the virtual network. | string | false |
address_spaces | The list of the address spaces that is used by the virtual network. | list(string) | false |
subnet_prefixes | The address prefix to use for the subnet. | list(string) | false |
subnet_names | A list of public subnets inside the vNet. | list(string) | false |
vnet_name | Name of the vnet to create. | string | false |
dns_servers | The DNS servers to be used with vNet. | list(string) | false |
tags | The tags to associate with your network and subnets. | map(string) | false |
subnet_enforce_private_link_endpoint_network_policies | A map with key (string) `subnet name`, value (bool) `true` or `false` to indicate enable or disable network policies for the private link endpoint on the subnet. Default value is false. | map(bool) | false |
subnet_service_endpoints | A map with key (string) `subnet name`, value (list(string)) to indicate enabled service endpoints on the subnet. Default value is []. | map(list(string)) | false |
writeConnectionSecretToRef | The secret which the cloud resource connection will be written to | [writeConnectionSecretToRef](#writeConnectionSecretToRef) | false |
#### writeConnectionSecretToRef
名称 | 描述 | 类型 | 是否必须 | 默认值
------------ | ------------- | ------------- | ------------- | -------------
name | The secret name which the cloud resource connection will be written to | string | true |
namespace | The secret namespace which the cloud resource connection will be written to | string | false |

View File

@ -0,0 +1,30 @@
---
title: Azure VIRTUAL-NETWORK
---
## 描述
Azure Virtual Network
## 参数说明
### 属性
名称 | 描述 | 类型 | 是否必须 | 默认值
------------ | ------------- | ------------- | ------------- | -------------
address_space | The address space that is used by the virtual network. | string | false |
address_spaces | The list of the address spaces that is used by the virtual network. | list(string) | false |
dns_servers | The DNS servers to be used with vNet. | list(string) | false |
tags | The tags to associate with your network and subnets. | map(string) | false |
vnet_name | Name of the vnet to create. | string | false |
resource_group_name | The name of an existing resource group to be imported. | string | true |
writeConnectionSecretToRef | The secret which the cloud resource connection will be written to | [writeConnectionSecretToRef](#writeConnectionSecretToRef) | false |
#### writeConnectionSecretToRef
名称 | 描述 | 类型 | 是否必须 | 默认值
------------ | ------------- | ------------- | ------------- | -------------
name | The secret name which the cloud resource connection will be written to | string | true |
namespace | The secret namespace which the cloud resource connection will be written to | string | false |

View File

@ -13,11 +13,11 @@ Terraform configuration for Tencent Cloud VPC
名称 | 描述 | 类型 | 是否必须 | 默认值
------------ | ------------- | ------------- | ------------- | -------------
vpc_name | The vpc name used to launch a new vpc when 'vpc_id' is not specified. | string | false |
vpc_cidr | The cidr block used to launch a new vpc when 'vpc_id' is not specified. | string | false |
vpc_is_multicast | Specify the vpc is multicast when 'vpc_id' is not specified. | bool | false |
vpc_dns_servers | Specify the vpc dns servers when 'vpc_id' is not specified. | list(string) | false |
vpc_tags | Additional tags for the vpc. | map(string) | false |
vpc_name | The vpc name used to launch a new vpc when 'vpc_id' is not specified. | string | false |
vpc_cidr | The cidr block used to launch a new vpc when 'vpc_id' is not specified. | string | false |
writeConnectionSecretToRef | The secret which the cloud resource connection will be written to | [writeConnectionSecretToRef](#writeConnectionSecretToRef) | false |

View File

@ -43,19 +43,30 @@ KubeVela支持以下类型的资源以后还会有更多
| 编排类型 | 云服务商 | 云资源 | 描述 |
|-----------|-------|------------------------------------------------------------------------------------------|-----------------------------------------------------------------------|
| Terraform | 阿里云 | [ACK](../end-user/components/cloud-services/terraform/alibaba-ack) | Terraform configuration for Alibaba Cloud ACK cluster |
| | | [AMQP](../end-user/components/cloud-services/terraform/alibaba-amqp) | Terraform configuration for Alibaba Cloud AMQP (RabbitMQ) |
| | | [ASK](../end-user/components/cloud-services/terraform/alibaba-ask) | Terraform configuration for Alibaba Cloud Serverless Kubernetes (ASK) |
| | | [EIP](../end-user/components/cloud-services/terraform/alibaba-eip) | Terraform configuration for Alibaba Cloud EIP |
| | | [MSE](../end-user/components/cloud-services/terraform/alibaba-mse) | Terraform configuration for Alibaba Cloud MSE |
| | | [OSS](../end-user/components/cloud-services/terraform/alibaba-oss) | Terraform configuration for Alibaba Cloud OSS |
| | | [RDS](../end-user/components/cloud-services/terraform/alibaba-rds) | Terraform configuration for Alibaba Cloud RDS |
| | | [Redis](../end-user/components/cloud-services/terraform/alibaba-redis) | Terraform configuration for Alibaba Cloud Redis |
| | | [RocketMQ](../end-user/components/cloud-services/terraform/alibaba-rocketmq) | Terraform configuration for Alibaba Cloud RocketMQ |
| | | [SLS Project](../end-user/components/cloud-services/terraform/alibaba-sls-project) | Terraform configuration for Alibaba Cloud SLS Project |
| | | [SLS Store](../end-user/components/cloud-services/terraform/alibaba-sls-store) | Terraform configuration for Alibaba Cloud SLS Store |
| | | [VPC](../end-user/components/cloud-services/terraform/alibaba-vpc) | Terraform configuration for Alibaba Cloud VPC |
| | | [VSwitch](../end-user/components/cloud-services/terraform/alibaba-vswitch) | Terraform configuration for Alibaba Cloud VSwitch |
| | AWS | [S3](../end-user/components/cloud-services/terraform/aws-s3) | Terraform configuration for AWS S3 bucket |
| | | [S3](../end-user/components/cloud-services/terraform/aws-rds) | Terraform configuration for AWS RDS |
| | | [S3](../end-user/components/cloud-services/terraform/aws-security-group) | Terraform configuration for AWS Security Group |
| | | [S3](../end-user/components/cloud-services/terraform/aws-subnet) | Terraform configuration for AWS S3 Subnet |
| | | [S3](../end-user/components/cloud-services/terraform/aws-vpc) | Terraform configuration for AWS S3 VPC |
| | Azure | [Mariadb](../end-user/components/cloud-services/terraform/azure-database-mariadb) | Terraform configuration for Azure Database Mariadb |
| | | [Storage Account](../end-user/components/cloud-services/terraform/azure-storage-account) | Terraform configuration for Azure Storage Account |
| | | [Storage Account](../end-user/components/cloud-services/terraform/azure-resource-group) | Terraform configuration for Azure Resource group |
| | | [Storage Account](../end-user/components/cloud-services/terraform/azure-subnet) | Terraform configuration for Azure Subnet |
| | | [Storage Account](../end-user/components/cloud-services/terraform/azure-virtual-network) | Terraform configuration for Azure Virtual network |
| | 腾讯云 | [Mariadb](../end-user/components/cloud-services/terraform/tencent-vpc) | Terraform configuration for Tencent Cloud VPC |
| | | [Mariadb](../end-user/components/cloud-services/terraform/tencent-subnet) | Terraform configuration for Tencent Cloud Subnet |
## 创建你的云服务

View File

@ -191,8 +191,15 @@ module.exports = {
"end-user/components/cloud-services/terraform/alibaba-amqp",
"end-user/components/cloud-services/terraform/alibaba-rocketmq",
"end-user/components/cloud-services/terraform/aws-s3",
"end-user/components/cloud-services/terraform/aws-rds",
"end-user/components/cloud-services/terraform/aws-security-group",
"end-user/components/cloud-services/terraform/aws-subnet",
"end-user/components/cloud-services/terraform/aws-vpc",
"end-user/components/cloud-services/terraform/azure-database-mariadb",
"end-user/components/cloud-services/terraform/azure-storage-account",
"end-user/components/cloud-services/terraform/azure-resource-group",
"end-user/components/cloud-services/terraform/azure-subnet",
"end-user/components/cloud-services/terraform/azure-virtual-network",
"end-user/components/cloud-services/terraform/tencent-vpc",
"end-user/components/cloud-services/terraform/tencent-subnet",
],

View File

@ -20,18 +20,30 @@ This tutorial will talk about how to provision and consume Cloud Resources by Te
| Orchestration Type | Cloud Provider | Cloud Resource | Description |
|--------------------|----------------|------------------------------------------------------|-----------------------------------------------------------------------|
| Terraform | Alibaba Cloud | [ACK](./terraform/alibaba-ack) | Terraform configuration for Alibaba Cloud ACK cluster |
| | | [ASK](./terraform/alibaba-amqp) | Terraform configuration for Alibaba Cloud AMQP (RabbitMQ) |
| | | [ASK](./terraform/alibaba-ask) | Terraform configuration for Alibaba Cloud Serverless Kubernetes (ASK) |
| | | [EIP](./terraform/alibaba-eip) | Terraform configuration for Alibaba Cloud EIP |
| | | [MSE](./terraform/alibaba-mse) | Terraform configuration for Alibaba Cloud MSE |
| | | [OSS](./terraform/alibaba-oss) | Terraform configuration for Alibaba Cloud OSS |
| | | [RDS](./terraform/alibaba-rds) | Terraform configuration for Alibaba Cloud RDS |
| | | [Redis](./terraform/alibaba-redis) | Terraform configuration for Alibaba Cloud Redis |
| | | [RocketMQ](./terraform/alibaba-rocketmq) | Terraform configuration for Alibaba Cloud RocketMQ |
| | | [SLS Project](./terraform/alibaba-sls-project) | Terraform configuration for Alibaba Cloud SLS Project |
| | | [SLS Store](./terraform/alibaba-sls-store) | Terraform configuration for Alibaba Cloud SLS Store |
| | | [VPC](./terraform/alibaba-vpc) | Terraform configuration for Alibaba Cloud VPC |
| | | [VSwitch](./terraform/alibaba-vswitch) | Terraform configuration for Alibaba Cloud VSwitch |
| | AWS | [S3](./terraform/aws-s3) | Terraform configuration for AWS S3 bucket |
| | | [S3](./terraform/aws-rds) | Terraform configuration for AWS RDS |
| | | [S3](./terraform/aws-security-group) | Terraform configuration for AWS Security Group |
| | | [S3](./terraform/aws-subnet) | Terraform configuration for AWS S3 Subnet |
| | | [S3](./terraform/aws-vpc) | Terraform configuration for AWS S3 VPC |
| | Azure | [Mariadb](./terraform/azure-database-mariadb) | Terraform configuration for Azure Database Mariadb |
| | | [Storage Account](./terraform/azure-storage-account) | Terraform configuration for Azure Storage Account |
| | | [Storage Account](./terraform/azure-resource-group) | Terraform configuration for Azure Resource group |
| | | [Storage Account](./terraform/azure-subnet) | Terraform configuration for Azure Subnet |
| | | [Storage Account](./terraform/azure-virtual-network) | Terraform configuration for Azure Virtual network |
| | Tencent Cloud | [Mariadb](./terraform/tencent-vpc) | Terraform configuration for Tencent Cloud VPC |
| | | [Mariadb](./terraform/tencent-subnet) | Terraform configuration for Tencent Cloud Subnet |
## Terraform

View File

@ -30,29 +30,29 @@ spec:
Name | Description | Type | Required | Default
------------ | ------------- | ------------- | ------------- | -------------
number_format | The number format used to output. | string | true |
k8s_name_prefix | The name prefix used to create several kubernetes clusters. Default to variable `example_name` | string | true |
master_instance_types | The ecs instance types used to launch master nodes. | list(any) | true |
install_cloud_monitor | Install cloud monitor agent on ECS. | bool | true |
k8s_service_cidr | The kubernetes service cidr block. It cannot be equals to vpc's or vswitch's or pod's and cannot be in them. | string | true |
vpc_name | The vpc name used to create a new vpc when 'vpc_id' is not specified. Default to variable `example_name` | string | true |
vswitch_cidrs | List of cidr blocks used to create several new vswitches when 'vswitch_ids' is not specified. | list(any) | true |
password | The password of ECS instance. | string | true |
k8s_worker_number | The number of worker nodes in kubernetes cluster. | number | true |
k8s_pod_cidr | The kubernetes pod cidr block. It cannot be equals to vpc's or vswitch's and cannot be in them. | string | true |
k8s_version | The version of the kubernetes version. Valid values: '1.16.6-aliyun.1','1.14.8-aliyun.1'. Default to '1.16.6-aliyun.1'. | string | true |
cpu_core_count | CPU core count is used to fetch instance types. | number | true |
memory_size | Memory size used to fetch instance types. | number | true |
new_nat_gateway | Whether to create a new nat gateway. In this template, a new nat gateway will create a nat gateway, eip and server snat entries. | bool | true |
worker_instance_types | The ecs instance types used to launch worker nodes. | list(any) | true |
zone_id | Availability Zone ID | string | true |
vpc_cidr | The cidr block used to launch a new vpc when 'vpc_id' is not specified. | string | true |
vswitch_name_prefix | The vswitch name prefix used to create several new vswitches. Default to variable 'example_name'. | string | true |
vswitch_ids | List of existing vswitch id. | list(any) | true |
node_cidr_mask | The node cidr block to specific how many pods can run on single node. Valid values: [24-28]. | number | true |
enable_ssh | Enable login to the node through SSH. | bool | true |
cpu_policy | kubelet cpu policy. Valid values: 'none','static'. Default to 'none'. | string | true |
proxy_mode | Proxy mode is option of kube-proxy. Valid values: 'ipvs','iptables'. Default to 'iptables'. | string | true |
install_cloud_monitor | Install cloud monitor agent on ECS. | bool | false |
k8s_service_cidr | The kubernetes service cidr block. It cannot be equals to vpc's or vswitch's or pod's and cannot be in them. | string | false |
cpu_core_count | CPU core count is used to fetch instance types. | number | false |
vswitch_name_prefix | The vswitch name prefix used to create several new vswitches. Default to variable 'example_name'. | string | false |
vswitch_ids | List of existing vswitch id. | list(any) | false |
master_instance_types | The ecs instance types used to launch master nodes. | list(any) | false |
node_cidr_mask | The node cidr block to specific how many pods can run on single node. Valid values: [24-28]. | number | false |
enable_ssh | Enable login to the node through SSH. | bool | false |
k8s_version | The version of the kubernetes version. Valid values: '1.16.6-aliyun.1','1.14.8-aliyun.1'. Default to '1.16.6-aliyun.1'. | string | false |
vpc_cidr | The cidr block used to launch a new vpc when 'vpc_id' is not specified. | string | false |
vswitch_cidrs | List of cidr blocks used to create several new vswitches when 'vswitch_ids' is not specified. | list(any) | false |
worker_instance_types | The ecs instance types used to launch worker nodes. | list(any) | false |
cpu_policy | kubelet cpu policy. Valid values: 'none','static'. Default to 'none'. | string | false |
password | The password of ECS instance. | string | false |
k8s_worker_number | The number of worker nodes in kubernetes cluster. | number | false |
zone_id | Availability Zone ID | string | false |
k8s_pod_cidr | The kubernetes pod cidr block. It cannot be equals to vpc's or vswitch's and cannot be in them. | string | false |
memory_size | Memory size used to fetch instance types. | number | false |
vpc_name | The vpc name used to create a new vpc when 'vpc_id' is not specified. Default to variable `example_name` | string | false |
number_format | The number format used to output. | string | false |
k8s_name_prefix | The name prefix used to create several kubernetes clusters. Default to variable `example_name` | string | false |
new_nat_gateway | Whether to create a new nat gateway. In this template, a new nat gateway will create a nat gateway, eip and server snat entries. | bool | false |
proxy_mode | Proxy mode is option of kube-proxy. Valid values: 'ipvs','iptables'. Default to 'iptables'. | string | false |
writeConnectionSecretToRef | The secret which the cloud resource connection will be written to | [writeConnectionSecretToRef](#writeConnectionSecretToRef) | false |
@ -70,11 +70,11 @@ If `writeConnectionSecretToRef` is set, a secret will be generated with these ke
Name | Description
------------ | -------------
CLUSTER_ID | The ID of the cluster
NAME | The name of the kubernetes cluster.
KUBECONFIG | The KubeConfig string of the kubernetes cluster.
CLUSTER_CA_CERT | The CA certificate of the kubernetes cluster.
CLIENT_CERT | The client certificate of the kubernetes cluster.
CLIENT_KEY | The client key of the kubernetes cluster.
API_SERVER_INTERNET | The internet access of the kubernetes api server.
RESOURCE_IDENTIFIER | The identifier of the resource
CLUSTER_ID | The ID of the cluster
NAME | The name of the kubernetes cluster.
KUBECONFIG | The KubeConfig string of the kubernetes cluster.
CLUSTER_CA_CERT | The CA certificate of the kubernetes cluster.

View File

@ -13,21 +13,21 @@ Terraform configuration for Alibaba Cloud AMQP(RabbitMQ)
Name | Description | Type | Required | Default
------------ | ------------- | ------------- | ------------- | -------------
max_tps | The specification of the peak TPS traffic. The smallest valid value is 1000 and the largest value is 100,000. | number | false |
create | Whether to create instance. If false, you can specify an existing instance by setting 'instance_id'. | bool | false |
support_eip | The specification of support EIP. | bool | false |
auto_delete_state | Specifies whether the Auto Delete attribute is configured. Valid values: true: The Auto Delete attributeis configured. If the last queue that is bound to an exchange is unbound, the exchange is automatically deleted. false: The Auto Delete attribute is not configured. If the last queue that is bound to an exchange is unbound, the exchange is not automatically deleted. | bool | false |
internal | The specification of the internal. | bool | false |
binding_type | The specification of the binding type. Valid values: EXCHANGE, QUEUE. | string | false |
max_eip_tps | The specification of the max eip tps. It is valid when support_eip is true. The valid value is [128, 45000] with the step size 128 | number | false |
name | The specification of module name. | string | false |
instance_type | The specification of the instance type. Valid values: professional, vip. | string | false |
queue_capacity | The specification of the queue capacity. The smallest value is 50 and the step size 5. | number | false |
period | The specification of the period. Valid values: 1, 12, 2, 24, 3, 6. | number | false |
create | Whether to create instance. If false, you can specify an existing instance by setting 'instance_id'. | bool | false |
max_tps | The specification of the peak TPS traffic. The smallest valid value is 1000 and the largest value is 100,000. | number | false |
max_eip_tps | The specification of the max eip tps. It is valid when support_eip is true. The valid value is [128, 45000] with the step size 128 | number | false |
instance_id | The instance_id used to RabbitMQ. If set, the 'create' will be ignored. | string | false |
argument | The specification of the argument. | string | false |
binding_type | The specification of the binding type. Valid values: EXCHANGE, QUEUE. | string | false |
name | The specification of module name. | string | false |
payment_type | The specification of the payment type. | string | false |
auto_delete_state | Specifies whether the Auto Delete attribute is configured. Valid values: true: The Auto Delete attributeis configured. If the last queue that is bound to an exchange is unbound, the exchange is automatically deleted. false: The Auto Delete attribute is not configured. If the last queue that is bound to an exchange is unbound, the exchange is not automatically deleted. | bool | false |
exchange_type | The specification of the exchange type. Valid values: FANOUT, DIRECT, TOPIC, HEADERS | string | false |
internal | The specification of the internal. | bool | false |
argument | The specification of the argument. | string | false |
payment_type | The specification of the payment type. | string | false |
period | The specification of the period. Valid values: 1, 12, 2, 24, 3, 6. | number | false |
instance_id | The instance_id used to RabbitMQ. If set, the 'create' will be ignored. | string | false |
writeConnectionSecretToRef | The secret which the cloud resource connection will be written to | [writeConnectionSecretToRef](#writeConnectionSecretToRef) | false |

View File

@ -13,7 +13,7 @@ Terraform configuration for Alibaba Cloud Serverless Kubernetes (ASK)
Name | Description | Type | Required | Default
------------ | ------------- | ------------- | ------------- | -------------
name | ASK name | string | true |
name | ASK name | string | false |
writeConnectionSecretToRef | The secret which the cloud resource connection will be written to | [writeConnectionSecretToRef](#writeConnectionSecretToRef) | false |
@ -31,8 +31,8 @@ If `writeConnectionSecretToRef` is set, a secret will be generated with these ke
Name | Description
------------ | -------------
RESOURCE_IDENTIFIER | The identifier of the resource
Name | Cluster Name
API_SERVER_INTRANET | The API server intranet address of the kubernetes cluster.
API_SERVER_INTERNET | The API server internet address of the kubernetes cluster.
KUBECONFIG | The KubeConfig string of the kubernetes cluster.
RESOURCE_IDENTIFIER | The identifier of the resource
Name | Cluster Name

View File

@ -29,8 +29,8 @@ spec:
Name | Description | Type | Required | Default
------------ | ------------- | ------------- | ------------- | -------------
name | Name to be used on all resources as prefix. Default to 'TF-Module-EIP'. | string | true |
bandwidth | Maximum bandwidth to the elastic public network, measured in Mbps (Mega bit per second). | number | true |
name | Name to be used on all resources as prefix. Default to 'TF-Module-EIP'. | string | false |
bandwidth | Maximum bandwidth to the elastic public network, measured in Mbps (Mega bit per second). | number | false |
writeConnectionSecretToRef | The secret which the cloud resource connection will be written to | [writeConnectionSecretToRef](#writeConnectionSecretToRef) | false |

View File

@ -14,27 +14,27 @@ Alibaba Cloud MongoDB
Name | Description | Type | Required | Default
------------ | ------------- | ------------- | ------------- | -------------
skip_region_validation | (Deprecated from version 1.4.0) Skip static validation of region ID. Used by users of alternative AlibabaCloud-like APIs or users w/ access to regions that are not public (yet). | bool | false |
db_instance_class | The specification of the instance. For more information about the value, see https://www.alibabacloud.com/help/doc-detail/57141.htm | string | true |
storage_engine | The MongoDB storage engine, WiredTiger or RocksDB. Default value: WiredTiger. | string | false |
period | The duration that you will buy DB instance (in month). It is valid when instance_charge_type is PrePaid. Valid values: [1~9], 12, 24, 36. Default to 1 | | false |
engine_version | The version number of the database. Valid value: 3.4, 4.0, 4.2, 4.4, 5.0 | string | true |
zone_id | The ID of the zone. You can refer to https://www.alibabacloud.com/help/doc-detail/61933.htm. | string | false |
security_ip_list | List of IP addresses allowed to access all databases of an instance. The list contains up to 1,000 IP addresses, separated by commas. Supported formats include 0.0.0.0/0, 10.23.12.24 (IP), and 10.23.12.24/24 (Classless Inter-Domain Routing (CIDR) mode. /24 represents the length of the prefix in an IP address. The range of the prefix length is [1,32]). | list(string) | false |
existing_instance_id | The Id of an existing Mongodb instance. If set, the `create` will be ignored. | string | false |
tags | A mapping of tags to assign to the mongodb instance resource. | map(string) | false |
instance_id | `(Deprecated)` It has been deprecated from version 1.2.0 and use `existing_instance_id` instead. | string | false |
create | Whether to use an existing MongoDB. If false, you can use a existing Mongodb instance by setting `existing_instance_id`. | bool | false |
shared_credentials_file | (Deprecated from version 1.4.0) This is the path to the shared credentials file. If this is not set and a profile is specified, $HOME/.aliyun/config.json will be used. | string | false |
name | The name of DB instance. It a string of 2 to 256 characters | string | true |
storage_engine | The MongoDB storage engine, WiredTiger or RocksDB. Default value: WiredTiger. | string | false |
instance_charge_type | The billing method of the instance. Valid values are Prepaid, PostPaid, Default to PostPaid | string | false |
vswitch_id | The virtual switch ID to launch DB instances in one VPC. | string | false |
backup_time | MongoDB instance backup time. It is required when backup_period was existed. In the format of HH:mmZ- HH:mmZ. Time setting interval is one hour. Default to a random time, like '23:00Z-24:00Z'. | string | false |
existing_instance_id | The Id of an existing Mongodb instance. If set, the `create` will be ignored. | string | false |
region | (Deprecated from version 1.4.0) The region used to launch this module resources. | string | false |
engine_version | The version number of the database. Valid value: 3.4, 4.0, 4.2, 4.4, 5.0 | string | true |
account_password | Password of the root account. It is a string of 6 to 32 characters and is composed of letters, numbers, and underlines | string | true |
replication_factor | The number of nodes in the replica set instance. Valid values: 3, 5, 7. Default value: 3. | number | false |
profile | (Deprecated from version 1.4.0) The profile name as set in the shared credentials file. If not set, it will be sourced from the ALICLOUD_PROFILE environment variable. | string | false |
db_instance_storage | The storage space of the instance. Valid values: 10 to 3000. Unit: GB. You can only specify this value in 10 GB increments. | number | false |
security_ip_list | List of IP addresses allowed to access all databases of an instance. The list contains up to 1,000 IP addresses, separated by commas. Supported formats include 0.0.0.0/0, 10.23.12.24 (IP), and 10.23.12.24/24 (Classless Inter-Domain Routing (CIDR) mode. /24 represents the length of the prefix in an IP address. The range of the prefix length is [1,32]). | list(string) | false |
backup_period | MongoDB Instance backup period. It is required when backup_time was existed. Valid values: [Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday]. Default to [Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday]. | list(string) | true |
create | Whether to use an existing MongoDB. If false, you can use a existing Mongodb instance by setting `existing_instance_id`. | bool | false |
account_password | Password of the root account. It is a string of 6 to 32 characters and is composed of letters, numbers, and underlines | string | true |
instance_id | `(Deprecated)` It has been deprecated from version 1.2.0 and use `existing_instance_id` instead. | string | false |
profile | (Deprecated from version 1.4.0) The profile name as set in the shared credentials file. If not set, it will be sourced from the ALICLOUD_PROFILE environment variable. | string | false |
region | (Deprecated from version 1.4.0) The region used to launch this module resources. | string | false |
db_instance_storage | The storage space of the instance. Valid values: 10 to 3000. Unit: GB. You can only specify this value in 10 GB increments. | number | false |
db_instance_class | The specification of the instance. For more information about the value, see https://www.alibabacloud.com/help/doc-detail/57141.htm | string | true |
period | The duration that you will buy DB instance (in month). It is valid when instance_charge_type is PrePaid. Valid values: [1~9], 12, 24, 36. Default to 1 | | false |
name | The name of DB instance. It a string of 2 to 256 characters | string | true |
replication_factor | The number of nodes in the replica set instance. Valid values: 3, 5, 7. Default value: 3. | number | false |
backup_time | MongoDB instance backup time. It is required when backup_period was existed. In the format of HH:mmZ- HH:mmZ. Time setting interval is one hour. Default to a random time, like '23:00Z-24:00Z'. | string | false |
writeConnectionSecretToRef | The secret which the cloud resource connection will be written to | [writeConnectionSecretToRef](#writeConnectionSecretToRef) | false |

View File

@ -4,7 +4,7 @@ title: Alibaba Cloud MSE
## Description
Alibaba Cloud MSE
Terraform configuration for Alibaba Cloud MSE
## Specification

View File

@ -31,8 +31,8 @@ spec:
Name | Description | Type | Required | Default
------------ | ------------- | ------------- | ------------- | -------------
bucket | OSS bucket name | string | true |
acl | OSS bucket ACL, supported 'private', 'public-read', 'public-read-write' | string | true |
bucket | OSS bucket name | string | false |
acl | OSS bucket ACL, supported 'private', 'public-read', 'public-read-write' | string | false |
writeConnectionSecretToRef | The secret which the cloud resource connection will be written to | [writeConnectionSecretToRef](#writeConnectionSecretToRef) | false |

View File

@ -32,15 +32,15 @@ spec:
Name | Description | Type | Required | Default
------------ | ------------- | ------------- | ------------- | -------------
security_ips | List of IP addresses allowed to access all databases of an instance | list(any) | false |
privilege | The privilege of one account access database. | string | false |
sql_file | The name of SQL file in the bucket, like `db.sql` | string | false |
instance_name | RDS instance name | string | false |
account_name | RDS instance user account name | string | false |
password | RDS instance account password | string | false |
security_ips | List of IP addresses allowed to access all databases of an instance | list(any) | false |
privilege | The privilege of one account access database. | string | false |
sql_bucket_name | The bucket name of the SQL file. like `oss://example` | string | false |
instance_name | RDS instance name | string | false |
allocate_public_connection | Whether to allocate public connection for a RDS instance. | bool | false |
database_name | Database name | string | false |
sql_bucket_name | The bucket name of the SQL file. like `oss://example` | string | false |
sql_file | The name of SQL file in the bucket, like `db.sql` | string | false |
sql_bucket_endpoint | The endpoint of the bucket. like `oss-cn-hangzhou.aliyuncs.com` | string | false |
writeConnectionSecretToRef | The secret which the cloud resource connection will be written to | [writeConnectionSecretToRef](#writeConnectionSecretToRef) | false |
@ -59,12 +59,12 @@ If `writeConnectionSecretToRef` is set, a secret will be generated with these ke
Name | Description
------------ | -------------
DB_NAME | RDS Instance Name
DB_USER | RDS Instance User
DB_HOST | RDS Instance Host
DATABASE_NAME | RDS Database Name
RESOURCE_IDENTIFIER | The identifier of the resource
DB_ID | RDS Instance ID
DB_PORT | RDS Instance Port
DB_HOST | RDS Instance Host
DB_PASSWORD | RDS Instance Password
DB_PUBLIC_HOST | RDS Instance Public Host
DATABASE_NAME | RDS Database Name
DB_ID | RDS Instance ID
DB_NAME | RDS Instance Name
DB_USER | RDS Instance User

View File

@ -32,9 +32,9 @@ spec:
Name | Description | Type | Required | Default
------------ | ------------- | ------------- | ------------- | -------------
instance_name | Redis instance name | string | true |
account_name | Redis instance user account name | string | true |
password | RDS instance account password | string | true |
instance_name | Redis instance name | string | false |
account_name | Redis instance user account name | string | false |
password | RDS instance account password | string | false |
writeConnectionSecretToRef | The secret which the cloud resource connection will be written to | [writeConnectionSecretToRef](#writeConnectionSecretToRef) | false |
@ -52,8 +52,8 @@ If `writeConnectionSecretToRef` is set, a secret will be generated with these ke
Name | Description
------------ | -------------
REDIS_CONNECT_ADDRESS | Redis connect address
REDIS_USER | Redis user
REDIS_PASSWORD | Redis password
RESOURCE_IDENTIFIER | The identifier of the resource
REDIS_NAME | Redis instance name
REDIS_CONNECT_ADDRESS | Redis connect address

View File

@ -38,9 +38,9 @@ If `writeConnectionSecretToRef` is set, a secret will be generated with these ke
Name | Description
------------ | -------------
TOPIC_ID | The id of ons topic
GROUP_ID | The id of ons group
HTTP_ENDPOINT_INTERNET | The internet http endpoint of ons instance
HTTP_ENDPOINT_INTERNAL | The internal http endpoint of ons instance
TCP_ENDPOINT | The tcp endpoint of ons instance
INSTANCE_ID | The id of ons instance
TOPIC_ID | The id of ons topic

View File

@ -32,8 +32,8 @@ spec:
Name | Description | Type | Required | Default
------------ | ------------- | ------------- | ------------- | -------------
name | Name of security group. It is used to create a new security group. | string | true |
description | Description of security group | string | true |
name | Name of security group. It is used to create a new security group. | string | false |
description | Description of security group | string | false |
writeConnectionSecretToRef | The secret which the cloud resource connection will be written to | [writeConnectionSecretToRef](#writeConnectionSecretToRef) | false |

View File

@ -34,15 +34,15 @@ spec:
Name | Description | Type | Required | Default
------------ | ------------- | ------------- | ------------- | -------------
project_name | Name of security group. It is used to create a new security group. | string | true |
store_shard_count | The number of shards in this log store. Default to 2. You can modify it by 'Split' or 'Merge' operations. | number | true |
store_max_split_shard_count | The maximum number of shards for automatic split, which is in the range of 1 to 64. You must specify this parameter when autoSplit is true. | number | true |
store_append_meta | Determines whether to append log meta automatically. The meta includes log receive time and client IP address. Default to true. | bool | true |
description | Description of security group | string | true |
create_project | Whether to create log resources | string | true |
store_name | Log store name. | string | true |
store_retention_period | The data retention time (in days). Valid values: [1-3650]. Default to 30. Log store data will be stored permanently when the value is '3650'. | number | true |
store_auto_split | Determines whether to automatically split a shard. Default to true. | bool | true |
store_auto_split | Determines whether to automatically split a shard. Default to true. | bool | false |
store_max_split_shard_count | The maximum number of shards for automatic split, which is in the range of 1 to 64. You must specify this parameter when autoSplit is true. | number | false |
store_append_meta | Determines whether to append log meta automatically. The meta includes log receive time and client IP address. Default to true. | bool | false |
project_name | Name of security group. It is used to create a new security group. | string | false |
description | Description of security group | string | false |
store_shard_count | The number of shards in this log store. Default to 2. You can modify it by 'Split' or 'Merge' operations. | number | false |
create_project | Whether to create log resources | string | false |
store_name | Log store name. | string | false |
store_retention_period | The data retention time (in days). Valid values: [1-3650]. Default to 30. Log store data will be stored permanently when the value is '3650'. | number | false |
writeConnectionSecretToRef | The secret which the cloud resource connection will be written to | [writeConnectionSecretToRef](#writeConnectionSecretToRef) | false |

View File

@ -31,9 +31,9 @@ spec:
Name | Description | Type | Required | Default
------------ | ------------- | ------------- | ------------- | -------------
vpc_name | The vpc name used to launch a new vpc. | string | true |
vpc_description | The vpc description used to launch a new vpc. | string | true |
vpc_cidr | The cidr block used to launch a new vpc. | string | true |
vpc_name | The vpc name used to launch a new vpc. | string | false |
vpc_description | The vpc description used to launch a new vpc. | string | false |
vpc_cidr | The cidr block used to launch a new vpc. | string | false |
writeConnectionSecretToRef | The secret which the cloud resource connection will be written to | [writeConnectionSecretToRef](#writeConnectionSecretToRef) | false |

View File

@ -13,15 +13,15 @@ Terraform configuration for Alibaba Cloud VSwitch
Name | Description | Type | Required | Default
------------ | ------------- | ------------- | ------------- | -------------
create_vpc | Whether to create vpc. If false, you can specify an existing vpc by setting 'vpc_id'. | bool | true |
vpc_description | The vpc description used to launch a new vpc. | string | true |
vpc_name | The vpc name used to launch a new vpc. | string | true |
vpc_cidr | The cidr block used to launch a new vpc. | string | true |
vpc_id | The vpc id used to launch several vswitches. If set, the 'create' will be ignored. | string | true |
vswitch_cidr | cidr blocks used to launch a new vswitch. | string | true |
vswitch_description | The vswitch description used to launch several new vswitch. | string | true |
zone_id | Availability Zone ID | string | true |
vswitch_name | The vswitch name prefix used to launch several new vswitches. | | true |
vswitch_description | The vswitch description used to launch several new vswitch. | string | false |
vpc_name | The vpc name used to launch a new vpc. | string | false |
vpc_description | The vpc description used to launch a new vpc. | string | false |
vpc_cidr | The cidr block used to launch a new vpc. | string | false |
vswitch_cidr | cidr blocks used to launch a new vswitch. | string | false |
create_vpc | Whether to create vpc. If false, you can specify an existing vpc by setting 'vpc_id'. | bool | false |
vpc_id | The vpc id used to launch several vswitches. If set, the 'create' will be ignored. | string | false |
zone_id | Availability Zone ID | string | false |
vswitch_name | The vswitch name prefix used to launch several new vswitches. | | false |
writeConnectionSecretToRef | The secret which the cloud resource connection will be written to | [writeConnectionSecretToRef](#writeConnectionSecretToRef) | false |

View File

@ -0,0 +1,102 @@
---
title: AWS RDS
---
## Description
AWS RDS
## Specification
### Properties
Name | Description | Type | Required | Default
------------ | ------------- | ------------- | ------------- | -------------
port | The port on which the DB accepts connections | string | false |
availability_zone | The Availability Zone of the RDS instance | string | false |
tags | A mapping of tags to assign to all resources | map(string) | false |
parameter_group_description | Description of the DB parameter group to create | string | false |
performance_insights_retention_period | The amount of time in days to retain Performance Insights data. Either 7 (7 days) or 731 (2 years). | number | false |
allocated_storage | The allocated storage in gigabytes | string | false |
s3_import | Restore from a Percona Xtrabackup in S3 (only MySQL is supported) | map(string) | false |
create_db_subnet_group | Whether to create a database subnet group | bool | false |
parameter_group_name | Name of the DB parameter group to associate or create | string | false |
deletion_protection | The database can't be deleted when this value is set to true. | bool | false |
performance_insights_kms_key_id | The ARN for the KMS key to encrypt Performance Insights data. | string | false |
monitoring_role_name | Name of the IAM role which will be created when create_monitoring_role is enabled. | string | false |
restore_to_point_in_time | Restore to a point in time (MySQL is NOT supported) | map(string) | false |
db_subnet_group_name | Name of DB subnet group. DB instance will be created in the VPC associated with the DB subnet group. If unspecified, will be created in the default VPC | string | false |
create_db_parameter_group | Whether to create a database parameter group | bool | false |
create_db_instance | Whether to create a database instance | bool | false |
replicate_source_db | Specifies that this resource is a Replicate database, and to use this value as the source database. This correlates to the identifier of another Amazon RDS Database to replicate. | string | false |
domain | The ID of the Directory Service Active Directory domain to create the instance in | string | false |
snapshot_identifier | Specifies whether or not to create this database from a snapshot. This correlates to the snapshot ID you'd find in the RDS console, e.g: rds:production-2015-06-26-06-05. | string | false |
options | A list of Options to apply. | any | false |
domain_iam_role_name | (Required if domain is provided) The name of the IAM role to be used when making API calls to the Directory Service | string | false |
copy_tags_to_snapshot | On delete, copy all Instance tags to the final snapshot (if final_snapshot_identifier is specified) | bool | false |
name | The DB name to create. If omitted, no database is created initially | string | false |
timeouts | (Optional) Updated Terraform resource management timeouts. Applies to `aws_db_instance` in particular to permit resource management times | map(string) | false |
engine_version | The engine version to use | string | false |
skip_final_snapshot | Determines whether a final DB snapshot is created before the DB instance is deleted. If true is specified, no DBSnapshot is created. If false is specified, a DB snapshot is created before the DB instance is deleted, using the value from final_snapshot_identifier | bool | false |
db_subnet_group_description | Description of the DB subnet group to create | string | false |
create_random_password | Whether to create random password for RDS primary cluster | bool | false |
monitoring_role_description | Description of the monitoring IAM role | string | false |
kms_key_id | The ARN for the KMS encryption key. If creating an encrypted replica, set this to the destination KMS ARN. If storage_encrypted is set to true and kms_key_id is not specified the default KMS key created in your account will be used | string | false |
iam_database_authentication_enabled | Specifies whether or not the mappings of AWS Identity and Access Management (IAM) accounts to database accounts are enabled | bool | false |
final_snapshot_identifier_prefix | The name which is prefixed to the final snapshot on cluster destroy | string | false |
instance_class | The instance type of the RDS instance | string | false |
monitoring_interval | The interval, in seconds, between points when Enhanced Monitoring metrics are collected for the DB instance. To disable collecting Enhanced Monitoring metrics, specify 0. The default is 0. Valid Values: 0, 1, 5, 10, 15, 30, 60. | number | false |
monitoring_role_arn | The ARN for the IAM role that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. Must be specified if monitoring_interval is non-zero. | string | false |
password | Password for the master DB user. Note that this may show up in logs, and it will be stored in the state file | string | false |
vpc_security_group_ids | List of VPC security groups to associate | list(string) | false |
subnet_ids | A list of VPC subnet IDs | list(string) | false |
character_set_name | (Optional) The character set name to use for DB encoding in Oracle instances. This can't be changed. See Oracle Character Sets Supported in Amazon RDS and Collations and Character Sets for Microsoft SQL Server for more information. This can only be set on creation. | string | false |
ca_cert_identifier | Specifies the identifier of the CA certificate for the DB instance | string | false |
parameter_group_use_name_prefix | Determines whether to use `parameter_group_name` as is or create a unique name beginning with the `parameter_group_name` as the prefix | bool | false |
identifier | The name of the RDS instance, if omitted, Terraform will assign a random, unique identifier | string | true |
final_snapshot_identifier | The name of your final DB snapshot when this DB instance is deleted. | string | false |
iops | The amount of provisioned IOPS. Setting this implies a storage_type of 'io1' | number | false |
allow_major_version_upgrade | Indicates that major version upgrades are allowed. Changing this parameter does not result in an outage and the change is asynchronously applied as soon as possible | bool | false |
backup_retention_period | The days to retain backups for | number | false |
backup_window | The daily time range (in UTC) during which automated backups are created if they are enabled. Example: '09:46-10:16'. Must not overlap with maintenance_window | string | false |
performance_insights_enabled | Specifies whether Performance Insights are enabled | bool | false |
max_allocated_storage | Specifies the value for Storage Autoscaling | number | false |
license_model | License model information for this DB instance. Optional, but required for some DB engines, i.e. Oracle SE1 | string | false |
multi_az | Specifies if the RDS instance is multi-AZ | bool | false |
publicly_accessible | Bool to control if instance is publicly accessible | bool | false |
db_instance_tags | Additional tags for the DB instance | map(string) | false |
db_subnet_group_use_name_prefix | Determines whether to use `subnet_group_name` as is or create a unique name beginning with the `subnet_group_name` as the prefix | bool | false |
timezone | (Optional) Time zone of the DB instance. timezone is currently only supported by Microsoft SQL Server. The timezone can only be set on creation. See MSSQL User Guide for more information. | string | false |
create_monitoring_role | Create IAM role with a defined name that permits RDS to send enhanced monitoring metrics to CloudWatch Logs. | bool | false |
auto_minor_version_upgrade | Indicates that minor engine upgrades will be applied automatically to the DB instance during the maintenance window | bool | false |
major_engine_version | Specifies the major version of the engine that this option group should be associated with | string | false |
maintenance_window | The window to perform maintenance in. Syntax: 'ddd:hh24:mi-ddd:hh24:mi'. Eg: 'Mon:00:00-Mon:03:00' | string | false |
db_option_group_tags | Additional tags for the DB option group | map(string) | false |
db_subnet_group_tags | Additional tags for the DB subnet group | map(string) | false |
random_password_length | (Optional) Length of random password to create. (default: 10) | number | false |
storage_type | One of 'standard' (magnetic), 'gp2' (general purpose SSD), or 'io1' (provisioned IOPS SSD). The default is 'io1' if iops is specified, 'gp2' if not. | string | false |
family | The family of the DB parameter group | string | false |
storage_encrypted | Specifies whether the DB instance is encrypted | bool | false |
username | Username for the master DB user | string | false |
parameters | A list of DB parameters (map) to apply | list(map(string)) | false |
option_group_name | Name of the option group | string | false |
enabled_cloudwatch_logs_exports | List of log types to enable for exporting to CloudWatch logs. If omitted, no logs will be exported. Valid values (depending on engine): alert, audit, error, general, listener, slowquery, trace, postgresql (PostgreSQL), upgrade (PostgreSQL). | list(string) | false |
delete_automated_backups | Specifies whether to remove automated backups immediately after the DB instance is deleted | bool | false |
apply_immediately | Specifies whether any database modifications are applied immediately, or during the next maintenance window | bool | false |
db_parameter_group_tags | Additional tags for the DB parameter group | map(string) | false |
create_db_option_group | (Optional) Create a database option group | bool | false |
option_group_use_name_prefix | Determines whether to use `option_group_name` as is or create a unique name beginning with the `option_group_name` as the prefix | bool | false |
cross_region_replica | Specifies if the replica should be cross region. It allows the use of a subnet group in a region different than the master instance | bool | false |
engine | The database engine to use | string | false |
option_group_description | The description of the option group | string | false |
option_group_timeouts | Define maximum timeout for deletion of `aws_db_option_group` resource | map(string) | false |
writeConnectionSecretToRef | The secret which the cloud resource connection will be written to | [writeConnectionSecretToRef](#writeConnectionSecretToRef) | false |
#### writeConnectionSecretToRef
Name | Description | Type | Required | Default
------------ | ------------- | ------------- | ------------- | -------------
name | The secret name which the cloud resource connection will be written to | string | true |
namespace | The secret namespace which the cloud resource connection will be written to | string | false |

View File

@ -32,8 +32,8 @@ spec:
Name | Description | Type | Required | Default
------------ | ------------- | ------------- | ------------- | -------------
bucket | S3 bucket name | string | true |
acl | S3 bucket ACL | string | true |
bucket | S3 bucket name | string | false |
acl | S3 bucket ACL | string | false |
writeConnectionSecretToRef | The secret which the cloud resource connection will be written to | [writeConnectionSecretToRef](#writeConnectionSecretToRef) | false |

View File

@ -0,0 +1,71 @@
---
title: AWS SECURITY-GROUP
---
## Description
AWS Security Group
## Specification
### Properties
Name | Description | Type | Required | Default
------------ | ------------- | ------------- | ------------- | -------------
egress_with_self | List of egress rules to create where 'self' is defined | list(map(string)) | false |
egress_with_ipv6_cidr_blocks | List of egress rules to create where 'ipv6_cidr_blocks' is used | list(map(string)) | false |
number_of_computed_egress_with_source_security_group_id | Number of computed egress rules to create where 'source_security_group_id' is used | number | false |
create | Whether to create security group and all rules | bool | false |
ingress_cidr_blocks | List of IPv4 CIDR ranges to use on all ingress rules | list(string) | false |
delete_timeout | Time to wait for a security group to be deleted | string | false |
ingress_prefix_list_ids | List of prefix list IDs (for allowing access to VPC endpoints) to use on all ingress rules | list(string) | false |
computed_ingress_with_cidr_blocks | List of computed ingress rules to create where 'cidr_blocks' is used | list(map(string)) | false |
number_of_computed_ingress_with_cidr_blocks | Number of computed ingress rules to create where 'cidr_blocks' is used | number | false |
egress_rules | List of egress rules to create by name | list(string) | false |
egress_with_source_security_group_id | List of egress rules to create where 'source_security_group_id' is used | list(map(string)) | false |
revoke_rules_on_delete | Instruct Terraform to revoke all of the Security Groups attached ingress and egress rules before deleting the rule itself. Enable for EMR. | bool | false |
tags | A mapping of tags to assign to security group | map(string) | false |
egress_ipv6_cidr_blocks | List of IPv6 CIDR ranges to use on all egress rules | list(string) | false |
number_of_computed_egress_rules | Number of computed egress rules to create by name | number | false |
computed_ingress_rules | List of computed ingress rules to create by name | list(string) | false |
number_of_computed_ingress_rules | Number of computed ingress rules to create by name | number | false |
number_of_computed_ingress_with_ipv6_cidr_blocks | Number of computed ingress rules to create where 'ipv6_cidr_blocks' is used | number | false |
computed_egress_rules | List of computed egress rules to create by name | list(string) | false |
ingress_with_self | List of ingress rules to create where 'self' is defined | list(map(string)) | false |
ingress_with_source_security_group_id | List of ingress rules to create where 'source_security_group_id' is used | list(map(string)) | false |
egress_cidr_blocks | List of IPv4 CIDR ranges to use on all egress rules | list(string) | false |
number_of_computed_egress_with_self | Number of computed egress rules to create where 'self' is defined | number | false |
number_of_computed_egress_with_ipv6_cidr_blocks | Number of computed egress rules to create where 'ipv6_cidr_blocks' is used | number | false |
create_sg | Whether to create security group | bool | false |
description | Description of security group | string | false |
computed_ingress_with_ipv6_cidr_blocks | List of computed ingress rules to create where 'ipv6_cidr_blocks' is used | list(map(string)) | false |
computed_ingress_with_source_security_group_id | List of computed ingress rules to create where 'source_security_group_id' is used | list(map(string)) | false |
number_of_computed_ingress_with_source_security_group_id | Number of computed ingress rules to create where 'source_security_group_id' is used | number | false |
computed_egress_with_source_security_group_id | List of computed egress rules to create where 'source_security_group_id' is used | list(map(string)) | false |
ingress_rules | List of ingress rules to create by name | list(string) | false |
ingress_ipv6_cidr_blocks | List of IPv6 CIDR ranges to use on all ingress rules | list(string) | false |
egress_prefix_list_ids | List of prefix list IDs (for allowing access to VPC endpoints) to use on all egress rules | list(string) | false |
name | Name of security group - not required if create_sg is false | string | false |
ingress_with_ipv6_cidr_blocks | List of ingress rules to create where 'ipv6_cidr_blocks' is used | list(map(string)) | false |
computed_egress_with_self | List of computed egress rules to create where 'self' is defined | list(map(string)) | false |
computed_egress_with_ipv6_cidr_blocks | List of computed egress rules to create where 'ipv6_cidr_blocks' is used | list(map(string)) | false |
ingress_with_cidr_blocks | List of ingress rules to create where 'cidr_blocks' is used | list(map(string)) | false |
egress_with_cidr_blocks | List of egress rules to create where 'cidr_blocks' is used | list(map(string)) | false |
use_name_prefix | Whether to use name_prefix or fixed name. Should be true to able to update security group name after initial creation | bool | false |
create_timeout | Time to wait for a security group to be created | string | false |
computed_ingress_with_self | List of computed ingress rules to create where 'self' is defined | list(map(string)) | false |
number_of_computed_ingress_with_self | Number of computed ingress rules to create where 'self' is defined | number | false |
computed_egress_with_cidr_blocks | List of computed egress rules to create where 'cidr_blocks' is used | list(map(string)) | false |
number_of_computed_egress_with_cidr_blocks | Number of computed egress rules to create where 'cidr_blocks' is used | number | false |
security_group_id | ID of existing security group whose rules we will manage | string | false |
vpc_id | ID of the VPC where to create security group | string | false |
writeConnectionSecretToRef | The secret which the cloud resource connection will be written to | [writeConnectionSecretToRef](#writeConnectionSecretToRef) | false |
#### writeConnectionSecretToRef
Name | Description | Type | Required | Default
------------ | ------------- | ------------- | ------------- | -------------
name | The secret name which the cloud resource connection will be written to | string | true |
namespace | The secret namespace which the cloud resource connection will be written to | string | false |

Some files were not shown because too many files have changed in this diff Show More