Add reference doc for Tencent Cloud VPC (#484)
* Add reference doc for Tencent Cloud VPC Added the reference doc for Tecent Cloud VPC Signed-off-by: Zheng Xi Zhou <zzxwill@gmail.com> * address comments Signed-off-by: Zheng Xi Zhou <zzxwill@gmail.com> * fix link issue Signed-off-by: Zheng Xi Zhou <zzxwill@gmail.com>
This commit is contained in:
Zheng Xi Zhou
GitHub
parent
1226c8278b
commit
905b724dec
|
|
@ -0,0 +1,38 @@
|
|||
---
|
||||
title: Tencent-Vpc
|
||||
---
|
||||
|
||||
## Description
|
||||
|
||||
Terraform configuration for Tencent Cloud VPC
|
||||
|
||||
## Specification
|
||||
|
||||
|
||||
### Properties
|
||||
|
||||
Name | Description | Type | Required | Default
|
||||
------------ | ------------- | ------------- | ------------- | -------------
|
||||
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 |
|
||||
|
||||
|
||||
#### 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
|
||||
------------ | -------------
|
||||
VPC_ID | The id of vpc.
|
||||
|
|
@ -0,0 +1,38 @@
|
|||
---
|
||||
title: Tencent-Vpc
|
||||
---
|
||||
|
||||
## 描述
|
||||
|
||||
Terraform configuration for Tencent Cloud VPC
|
||||
|
||||
## 参数说明
|
||||
|
||||
|
||||
### 属性
|
||||
|
||||
名称 | 描述 | 类型 | 是否必须 | 默认值
|
||||
------------ | ------------- | ------------- | ------------- | -------------
|
||||
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 |
|
||||
|
||||
|
||||
#### 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）：
|
||||
|
||||
名称 | 描述
|
||||
------------ | -------------
|
||||
VPC_ID | The id of vpc.
|
||||
|
|
@ -0,0 +1,38 @@
|
|||
---
|
||||
title: Tencent-Vpc
|
||||
---
|
||||
|
||||
## 描述
|
||||
|
||||
Terraform configuration for Tencent Cloud VPC
|
||||
|
||||
## 参数说明
|
||||
|
||||
|
||||
### 属性
|
||||
|
||||
名称 | 描述 | 类型 | 是否必须 | 默认值
|
||||
------------ | ------------- | ------------- | ------------- | -------------
|
||||
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 |
|
||||
|
||||
|
||||
#### 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）：
|
||||
|
||||
名称 | 描述
|
||||
------------ | -------------
|
||||
VPC_ID | The id of vpc.
|
||||
|
|
@ -189,6 +189,7 @@ module.exports = {
|
|||
"end-user/components/cloud-services/terraform/aws-s3",
|
||||
"end-user/components/cloud-services/terraform/azure-database-mariadb",
|
||||
"end-user/components/cloud-services/terraform/azure-storage-account",
|
||||
"end-user/components/cloud-services/terraform/tencent-vpc",
|
||||
],
|
||||
},
|
||||
{
|
||||
|
|
|
|||
|
|
@ -0,0 +1,38 @@
|
|||
---
|
||||
title: Tencent-Vpc
|
||||
---
|
||||
|
||||
## Description
|
||||
|
||||
Terraform configuration for Tencent Cloud VPC
|
||||
|
||||
## Specification
|
||||
|
||||
|
||||
### Properties
|
||||
|
||||
Name | Description | Type | Required | Default
|
||||
------------ | ------------- | ------------- | ------------- | -------------
|
||||
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 |
|
||||
|
||||
|
||||
#### 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
|
||||
------------ | -------------
|
||||
VPC_ID | The id of vpc.
|
||||
|
|
@ -421,6 +421,10 @@
|
|||
{
|
||||
"type": "doc",
|
||||
"id": "version-v1.2/end-user/components/cloud-services/terraform/azure-storage-account"
|
||||
},
|
||||
{
|
||||
"type": "doc",
|
||||
"id": "version-v1.2/end-user/components/cloud-services/terraform/tencent-vpc"
|
||||
}
|
||||
]
|
||||
},
|
||||
|
|
|
|||
Loading…
Reference in New Issue