From 046c4849ad0bd1b0f4db44c21b69262bad768309 Mon Sep 17 00:00:00 2001 From: Zheng Xi Zhou Date: Wed, 5 Jan 2022 20:26:40 +0800 Subject: [PATCH] Add docs for Alibaba Cloud VPC ComponentDefinition (#412) Added the doc on how to use Alibaba Cloud VPC resource Signed-off-by: Zheng Xi Zhou --- .../provider-and-consume-cloud-services.md | 9 ++-- .../cloud-services/terraform/alibaba-vpc.md | 54 +++++++++++++++++++ .../provider-and-consume-cloud-services.md | 1 + .../cloud-services/terraform/alibaba-vpc.md | 54 +++++++++++++++++++ sidebars.js | 1 + 5 files changed, 115 insertions(+), 4 deletions(-) create mode 100644 docs/end-user/components/cloud-services/terraform/alibaba-vpc.md create mode 100644 i18n/zh/docusaurus-plugin-content-docs/current/end-user/components/cloud-services/terraform/alibaba-vpc.md diff --git a/docs/end-user/components/cloud-services/provider-and-consume-cloud-services.md b/docs/end-user/components/cloud-services/provider-and-consume-cloud-services.md index 9218b6f3..cc1b6c5b 100644 --- a/docs/end-user/components/cloud-services/provider-and-consume-cloud-services.md +++ b/docs/end-user/components/cloud-services/provider-and-consume-cloud-services.md @@ -20,10 +20,11 @@ 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 -| | | [EIP](./terraform/alibaba-eip) | Terraform configuration for Alibaba Cloud EIP object -| | | [OSS](./terraform/alibaba-oss) | Terraform configuration for Alibaba Cloud OSS object -| | | [RDS](./terraform/alibaba-rds) | Terraform configuration for Alibaba Cloud RDS object -| | | [Redis](./terraform/alibaba-redis) | Terraform configuration for Alibaba Cloud Redis object +| | | [EIP](./terraform/alibaba-eip) | Terraform configuration for Alibaba Cloud EIP +| | | [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 +| | | [VPC](./terraform/alibaba-vpc) | Terraform configuration for Alibaba Cloud VPC | | Azure | [Mariadb](./terraform/azure-database-mariadb) | Terraform configuration for Azure Database Mariadb | | Azure | [Storage Account](./terraform/azure-storage-account) | Terraform configuration for Azure Storage Account | | AWS | [S3](./terraform/aws-s3) | Terraform configuration for AWS S3 bucket diff --git a/docs/end-user/components/cloud-services/terraform/alibaba-vpc.md b/docs/end-user/components/cloud-services/terraform/alibaba-vpc.md new file mode 100644 index 00000000..f8e3c165 --- /dev/null +++ b/docs/end-user/components/cloud-services/terraform/alibaba-vpc.md @@ -0,0 +1,54 @@ +--- +title: Alibaba Cloud VPC +--- + +## Description + +Terraform configuration for Alibaba Cloud VPC + +## Samples + +```yaml +apiVersion: core.oam.dev/v1beta1 +kind: Application +metadata: + name: app-vpc-sample +spec: + components: + - name: sample-vpc + type: alibaba-vpc + properties: + vpc_cidr: "172.16.0.0/12" + + writeConnectionSecretToRef: + name: vpc-conn +``` + +## Specification + + +### Properties + +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 | + 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 vpc id of the newly created vpc. diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/end-user/components/cloud-services/provider-and-consume-cloud-services.md b/i18n/zh/docusaurus-plugin-content-docs/current/end-user/components/cloud-services/provider-and-consume-cloud-services.md index 7833b15a..7ee1ad96 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/current/end-user/components/cloud-services/provider-and-consume-cloud-services.md +++ b/i18n/zh/docusaurus-plugin-content-docs/current/end-user/components/cloud-services/provider-and-consume-cloud-services.md @@ -19,6 +19,7 @@ Terraform | Alibaba Cloud | [ACK](./terraform/alibaba-ack) | 用于部署阿里 | | | [OSS](./terraform/alibaba-oss) | 用于部署阿里云 OSS 的 Terraform Configuration 的 ComponentDefinition | | | [RDS](./terraform/alibaba-rds) | 用于部署阿里云 RDS 的 Terraform Configuration 的 ComponentDefinition | | | [Redis](./terraform/alibaba-redis) | 用于部署阿里云 Redis 的 Terraform Configuration 的 ComponentDefinition +| | | [VPC](./terraform/alibaba-vpc) | 用于部署阿里云 VPC 的 Terraform Configuration 的 ComponentDefinition | | Azure | [Mariadb](./terraform/azure-database-mariadb) | 用于部署 Azure mariadb 数据库的 Terraform Configuration 的 ComponentDefinition | | AWS | [S3](./terraform/aws-s3) | 用于部署 AWS S3 bucket 的 Terraform Configuration 的 ComponentDefinition diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/end-user/components/cloud-services/terraform/alibaba-vpc.md b/i18n/zh/docusaurus-plugin-content-docs/current/end-user/components/cloud-services/terraform/alibaba-vpc.md new file mode 100644 index 00000000..7e62843c --- /dev/null +++ b/i18n/zh/docusaurus-plugin-content-docs/current/end-user/components/cloud-services/terraform/alibaba-vpc.md @@ -0,0 +1,54 @@ +--- +title: 阿里云 VPC +--- + +## Description + +Terraform configuration for Alibaba Cloud VPC + +## Samples + +```yaml +apiVersion: core.oam.dev/v1beta1 +kind: Application +metadata: + name: app-vpc-sample +spec: + components: + - name: sample-vpc + type: alibaba-vpc + properties: + vpc_cidr: "172.16.0.0/12" + + writeConnectionSecretToRef: + name: vpc-conn +``` + +## Specification + + +### Properties + +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 | + 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 vpc id of the newly created vpc. diff --git a/sidebars.js b/sidebars.js index 0aef991b..92871810 100644 --- a/sidebars.js +++ b/sidebars.js @@ -62,6 +62,7 @@ module.exports = { "end-user/components/cloud-services/terraform/alibaba-rds", "end-user/components/cloud-services/terraform/alibaba-oss", "end-user/components/cloud-services/terraform/alibaba-redis", + "end-user/components/cloud-services/terraform/alibaba-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/aws-s3",