kubevela
/
kubevela.github.io
mirror of https://github.com/kubevela/kubevela.github.io.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

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 <zzxwill@gmail.com>
This commit is contained in:
Zheng Xi Zhou 2022-01-05 20:26:40 +08:00 committed by GitHub
parent 23ba2b985a
commit 046c4849ad
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 115 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
docs/end-user/components/cloud-services/provider-and-consume-cloud-services.md
View File

@ -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

54
docs/end-user/components/cloud-services/terraform/alibaba-vpc.md Normal file
View File

@ -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.

1
i18n/zh/docusaurus-plugin-content-docs/current/end-user/components/cloud-services/provider-and-consume-cloud-services.md
View File

@ -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

54
i18n/zh/docusaurus-plugin-content-docs/current/end-user/components/cloud-services/terraform/alibaba-vpc.md Normal file
View File

@ -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.

1
sidebars.js
View File

@ -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",