Update Terraform ComponentDefinition specifications and siderbar (#455)

* Update Terraform ComponentDefinition specifications and siderbar

Use vela cli to automatically generate Terraform Componentdefinition
specification in English and Chinese

Signed-off-by: Zheng Xi Zhou <zzxwill@gmail.com>

* regenerate vpc/vswitch/ask

Signed-off-by: Zheng Xi Zhou <zzxwill@gmail.com>
This commit is contained in:
Zheng Xi Zhou 2022-01-18 18:55:36 +08:00 committed by GitHub
parent d31d80f4fd
commit 2bd38359e0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
47 changed files with 443 additions and 250 deletions

View File

@ -17,18 +17,21 @@ This tutorial will talk about how to provision and consume Cloud Resources by Te
## Supported Cloud Resource list
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
| | | [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
| | | [Storage Account](./terraform/azure-storage-account) | Terraform configuration for Azure Storage Account
| | AWS | [S3](./terraform/aws-s3) | Terraform configuration for AWS S3 bucket
| Orchestration Type | Cloud Provider | Cloud Resource | Description |
|--------------------|----------------|------------------------------------------------------|-----------------------------------------------------------------------|
| Terraform | Alibaba Cloud | [ACK](./terraform/alibaba-ack) | Terraform configuration for Alibaba Cloud ACK cluster |
| | | [ASK](./terraform/alibaba-ask) | Terraform configuration for Alibaba Cloud Serverless Kubernetes (ASK) |
| | | [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 |
| | | [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 |
| | Azure | [Mariadb](./terraform/azure-database-mariadb) | Terraform configuration for Azure Database Mariadb |
| | | [Storage Account](./terraform/azure-storage-account) | Terraform configuration for Azure Storage Account |
## Terraform

View File

@ -31,28 +31,28 @@ 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 |
zone_id | Availability Zone ID | 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 |
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 |
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 |
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 |
vswitch_ids | List of existing vswitch id. | list(any) | true |
k8s_name_prefix | The name prefix used to create several kubernetes clusters. Default to variable `example_name` | string | 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 |
install_cloud_monitor | Install cloud monitor agent on ECS. | bool | 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 |
writeConnectionSecretToRef | The secret which the cloud resource connection will be written to | [writeConnectionSecretToRef](#writeConnectionSecretToRef) | false |
@ -70,6 +70,7 @@ 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.
@ -77,4 +78,3 @@ If `writeConnectionSecretToRef` is set, a secret will be generated with these ke
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

View File

@ -31,5 +31,8 @@ If `writeConnectionSecretToRef` is set, a secret will be generated with these ke
Name | Description
------------ | -------------
CLUSTER_ID | ID of the kunernetes cluster.
Name |
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: Alibaba Cloud OSS
## Description
Terraform configuration for Alibaba Cloud OSS object
Terraform configuration for Alibaba Cloud OSS
## Samples

View File

@ -4,7 +4,7 @@ title: Alibaba Cloud RDS
## Description
Terraform configuration for Alibaba Cloud RDS object
Terraform configuration for Alibaba Cloud RDS
## Samples
@ -32,13 +32,13 @@ spec:
Name | Description | Type | Required | Default
------------ | ------------- | ------------- | ------------- | -------------
security_ips | List of IP addresses allowed to access all databases of an instance | list(any) | true |
database_name | Database name | string | true |
privilege | The privilege of one account access database. | string | true |
instance_name | RDS instance name | string | true |
account_name | RDS instance user account name | string | true |
password | RDS instance account password | string | true |
allocate_public_connection | Whether to allocate public connection for a RDS instance. | bool | true |
security_ips | List of IP addresses allowed to access all databases of an instance | list(any) | true |
database_name | Database name | string | true |
privilege | The privilege of one account access database. | string | true |
writeConnectionSecretToRef | The secret which the cloud resource connection will be written to | [writeConnectionSecretToRef](#writeConnectionSecretToRef) | false |
@ -56,12 +56,12 @@ If `writeConnectionSecretToRef` is set, a secret will be generated with these ke
Name | Description
------------ | -------------
DB_ID | RDS Instance ID
DB_USER | RDS Instance User
DB_PORT | RDS Instance Port
DB_HOST | RDS Instance Host
DB_PASSWORD | RDS Instance Password
RESOURCE_IDENTIFIER | The identifier of the resource
DB_NAME | RDS Instance Name
DB_PUBLIC_HOST | RDS Instance Public Host
DATABASE_NAME | RDS Database Name
DB_NAME | RDS Instance Name
DB_HOST | RDS Instance Host
DB_USER | RDS Instance User
DB_PORT | RDS Instance Port
DB_PASSWORD | RDS Instance Password
RESOURCE_IDENTIFIER | The identifier of the resource
DB_ID | RDS Instance ID

View File

@ -32,9 +32,9 @@ spec:
Name | Description | Type | Required | Default
------------ | ------------- | ------------- | ------------- | -------------
password | RDS instance account password | string | true |
instance_name | Redis instance name | string | true |
account_name | Redis instance user account name | string | true |
password | RDS instance account password | string | true |
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_NAME | Redis instance name
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

@ -6,6 +6,25 @@ title: Alibaba Cloud SLS-PROJECT
Terraform configuration for Alibaba Cloud SLS Project
## Samples
```yaml
apiVersion: core.oam.dev/v1beta1
kind: Application
metadata:
name: app-sls-project-sample
spec:
components:
- name: sample-sls-project
type: alibaba-sls-project
properties:
name: kubevela-1112
description: "Managed by KubeVela"
writeConnectionSecretToRef:
name: sls-project-conn
```
## Specification
@ -13,8 +32,8 @@ Terraform configuration for Alibaba Cloud SLS Project
Name | Description | Type | Required | Default
------------ | ------------- | ------------- | ------------- | -------------
description | Description of security group | string | true |
name | Name of security group. It is used to create a new security group. | string | true |
description | Description of security group | string | true |
writeConnectionSecretToRef | The secret which the cloud resource connection will be written to | [writeConnectionSecretToRef](#writeConnectionSecretToRef) | false |

View File

@ -6,6 +6,27 @@ title: Alibaba Cloud SLS-STORE
Terraform configuration for Alibaba Cloud SLS Store
## Samples
```yaml
apiVersion: core.oam.dev/v1beta1
kind: Application
metadata:
name: app-sls-store-sample
spec:
components:
- name: sample-sls-store
type: alibaba-sls-store
properties:
store_name: kubevela-1111
store_retention_period: 30
store_shard_count: 2
store_max_split_shard_count: 2
writeConnectionSecretToRef:
name: sls-store-conn
```
## Specification
@ -13,15 +34,15 @@ Terraform configuration for Alibaba Cloud SLS Store
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_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_auto_split | Determines whether to automatically split a shard. Default to true. | bool | 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 |
project_name | Name of security group. It is used to create a new security group. | string | true |
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
------------ | ------------- | ------------- | ------------- | -------------
vswitch_description | The vswitch description used to launch several new vswitch. | 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 |
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_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 |
writeConnectionSecretToRef | The secret which the cloud resource connection will be written to | [writeConnectionSecretToRef](#writeConnectionSecretToRef) | false |
@ -39,5 +39,5 @@ If `writeConnectionSecretToRef` is set, a secret will be generated with these ke
Name | Description
------------ | -------------
VSWITCH_ID |
VPC_ID |
VSWITCH_ID | VSwitch ID
VPC_ID | VPC ID

View File

@ -36,12 +36,12 @@ spec:
Name | Description | Type | Required | Default
------------ | ------------- | ------------- | ------------- | -------------
server_name | mariadb server name | string | true |
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 |
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
------------ | -------------
SERVER_NAME | mariadb server name
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

@ -12,16 +12,22 @@ KubeVela 通过云资源组件Component和运维特征Trait里的资
## 支持的云资源列表
编排类型 | 云服务商 | 云资源 | 描述
------------ | ------------- | ------------- | -------------
Terraform | Alibaba Cloud | [ACK](./terraform/alibaba-ack) | 用于部署阿里云 ACK 的 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
| | | [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
| 编排类型 | 云服务商 | 云资源 | 描述 |
|-----------|-------|------------------------------------------------------|----------------------------------------------------------------------------|
| 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

View File

@ -30,29 +30,29 @@ spec:
名称 | 描述 | 类型 | 是否必须 | 默认值
------------ | ------------- | ------------- | ------------- | -------------
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 |
proxy_mode | Proxy mode is option of kube-proxy. Valid values: 'ipvs','iptables'. Default to 'iptables'. | string | true |
k8s_worker_number | The number of worker nodes in kubernetes cluster. | number | 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 |
number_format | The number format used to output. | 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 |
master_instance_types | The ecs instance types used to launch master nodes. | list(any) | 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 |
zone_id | Availability Zone ID | 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 |
node_cidr_mask | The node cidr block to specific how many pods can run on single node. Valid values: [24-28]. | number | true |
install_cloud_monitor | Install cloud monitor agent on ECS. | bool | true |
password | The password of ECS instance. | 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 |
zone_id | Availability Zone ID | string | true |
cpu_core_count | CPU core count is used to fetch instance types. | number | true |
vpc_cidr | The cidr block used to launch a new vpc when 'vpc_id' is not specified. | string | true |
vswitch_cidrs | List of cidr blocks used to create several new vswitches when 'vswitch_ids' is not specified. | list(any) | true |
k8s_name_prefix | The name prefix used to create several kubernetes clusters. Default to variable `example_name` | string | 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 | 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 |
writeConnectionSecretToRef | The secret which the cloud resource connection will be written to | [writeConnectionSecretToRef](#writeConnectionSecretToRef) | false |
@ -70,11 +70,11 @@ spec:
名称 | 描述
------------ | -------------
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.
CLIENT_CERT | The client certificate of the kubernetes cluster.

View File

@ -4,7 +4,7 @@ title: 阿里云 ASK
## 描述
Terraform configuration for Alibaba Cloud Serverless Kubernetes (ASK)
用于部署阿里云 Serverless Kubernetes (ASK) 的组件说明
## 参数说明
@ -31,5 +31,8 @@ Terraform configuration for Alibaba Cloud Serverless Kubernetes (ASK)
名称 | 描述
------------ | -------------
CLUSTER_ID | ID of the kunernetes cluster.
Name |
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
## 描述
Terraform configuration for Alibaba Cloud Elastic IP
用于部署阿里云 Elastic IP 的组件说明
## 示例

View File

@ -4,7 +4,7 @@ title: 阿里云 OSS
## 描述
Terraform configuration for Alibaba Cloud OSS object
用于部署阿里云 OSS 的组件说明
## 示例

View File

@ -4,7 +4,7 @@ title: 阿里云 RDS
## 描述
Terraform configuration for Alibaba Cloud RDS object
用于部署阿里云 RDS 的组件说明
## 示例
@ -32,13 +32,13 @@ spec:
名称 | 描述 | 类型 | 是否必须 | 默认值
------------ | ------------- | ------------- | ------------- | -------------
instance_name | RDS instance name | string | true |
account_name | RDS instance user account name | string | true |
password | RDS instance account password | string | true |
allocate_public_connection | Whether to allocate public connection for a RDS instance. | bool | true |
security_ips | List of IP addresses allowed to access all databases of an instance | list(any) | true |
database_name | Database name | string | true |
privilege | The privilege of one account access database. | string | true |
instance_name | RDS instance name | string | true |
account_name | RDS instance user account name | string | true |
password | RDS instance account password | string | true |
writeConnectionSecretToRef | The secret which the cloud resource connection will be written to | [writeConnectionSecretToRef](#writeConnectionSecretToRef) | false |
@ -56,12 +56,12 @@ spec:
名称 | 描述
------------ | -------------
DB_PORT | RDS Instance Port
DATABASE_NAME | RDS Database Name
RESOURCE_IDENTIFIER | The identifier of the resource
DB_NAME | RDS Instance Name
DB_USER | RDS Instance User
DB_HOST | RDS Instance Host
DB_PUBLIC_HOST | RDS Instance Public Host
DB_ID | RDS Instance ID
DB_HOST | RDS Instance Host
DB_PORT | RDS Instance Port
DB_PASSWORD | RDS Instance Password
DATABASE_NAME | RDS Database Name

View File

@ -4,7 +4,7 @@ title: 阿里云 REDIS
## 描述
Terraform configuration for Alibaba Cloud Redis
用于部署阿里云 Redis 的组件说明
## 示例
@ -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 | true |
writeConnectionSecretToRef | The secret which the cloud resource connection will be written to | [writeConnectionSecretToRef](#writeConnectionSecretToRef) | false |

View File

@ -4,7 +4,26 @@ title: 阿里云 SLS-PROJECT
## 描述
Terraform configuration for Alibaba Cloud SLS Project
用于部署阿里云 SLS Project 的组件说明
## 示例
```yaml
apiVersion: core.oam.dev/v1beta1
kind: Application
metadata:
name: app-sls-project-sample
spec:
components:
- name: sample-sls-project
type: alibaba-sls-project
properties:
name: kubevela-1112
description: "Managed by KubeVela"
writeConnectionSecretToRef:
name: sls-project-conn
```
## 参数说明

View File

@ -4,7 +4,28 @@ title: 阿里云 SLS-STORE
## 描述
Terraform configuration for Alibaba Cloud SLS Store
用于部署阿里云 SLS Store 的组件说明
## 示例
```yaml
apiVersion: core.oam.dev/v1beta1
kind: Application
metadata:
name: app-sls-store-sample
spec:
components:
- name: sample-sls-store
type: alibaba-sls-store
properties:
store_name: kubevela-1111
store_retention_period: 30
store_shard_count: 2
store_max_split_shard_count: 2
writeConnectionSecretToRef:
name: sls-store-conn
```
## 参数说明
@ -13,15 +34,15 @@ Terraform configuration for Alibaba Cloud SLS Store
名称 | 描述 | 类型 | 是否必须 | 默认值
------------ | ------------- | ------------- | ------------- | -------------
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_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 |
description | Description of security group | string | true |
create_project | Whether to create log resources | string | 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 |
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 |
writeConnectionSecretToRef | The secret which the cloud resource connection will be written to | [writeConnectionSecretToRef](#writeConnectionSecretToRef) | false |

View File

@ -4,7 +4,7 @@ title: 阿里云 VPC
## 描述
Terraform configuration for Alibaba Cloud VPC
用于部署阿里云 VPC 的组件说明
## 示例

View File

@ -4,7 +4,7 @@ title: 阿里云 VSWITCH
## 描述
Terraform configuration for Alibaba Cloud VSwitch
用于部署阿里云 VSwitch 的组件说明
## 参数说明
@ -13,15 +13,15 @@ Terraform configuration for Alibaba Cloud VSwitch
名称 | 描述 | 类型 | 是否必须 | 默认值
------------ | ------------- | ------------- | ------------- | -------------
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 |
zone_id | Availability Zone ID | string | true |
create_vpc | Whether to create vpc. If false, you can specify an existing vpc by setting 'vpc_id'. | bool | true |
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 |
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 |
writeConnectionSecretToRef | The secret which the cloud resource connection will be written to | [writeConnectionSecretToRef](#writeConnectionSecretToRef) | false |
@ -39,5 +39,5 @@ Terraform configuration for Alibaba Cloud VSwitch
名称 | 描述
------------ | -------------
VPC_ID |
VSWITCH_ID |
VSWITCH_ID | VSwitch ID
VPC_ID | VPC ID

View File

@ -4,7 +4,7 @@ title: Azure DATABASE-MARIADB
## 描述
Terraform configuration for Azure Database Mariadb
用于部署 Azure mariadb 数据库的组件说明
## 示例
@ -36,12 +36,12 @@ spec:
名称 | 描述 | 类型 | 是否必须 | 默认值
------------ | ------------- | ------------- | ------------- | -------------
server_name | mariadb server name | string | true |
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 |
db_name | Database instance name | string | true |
username | Database instance username | string | true |
writeConnectionSecretToRef | The secret which the cloud resource connection will be written to | [writeConnectionSecretToRef](#writeConnectionSecretToRef) | false |

View File

@ -4,7 +4,7 @@ title: Azure STORAGE-ACCOUNT
## 描述
Terraform configuration for Azure Blob Storage Account
用于部署 Azure Blob Storage 账号的的组件说明
## 示例
@ -45,12 +45,12 @@ spec:
名称 | 描述 | 类型 | 是否必须 | 默认值
------------ | ------------- | ------------- | ------------- | -------------
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 |
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 |
writeConnectionSecretToRef | The secret which the cloud resource connection will be written to | [writeConnectionSecretToRef](#writeConnectionSecretToRef) | false |

View File

@ -8,20 +8,25 @@ title: 创建和使用云资源
KubeVela 通过云资源组件Component和运维特征Trait里的资源绑定功能高效安全地完成不同类型云资源的集成工作。目前你可以直接调用下面这些云资源默认组件。
同时在未来,更多新的云资源也会在社区的支撑下逐渐成为默认选项,让你标准化统一地去使用各种厂商的云资源。
> ⚠️ 请确认管理员已经安装了 [Terraform 插件 'terraform/provider-alicloud'](../../../install#4-【可选】安装插件).
> ⚠️ 请确认管理员已经安装了 [Terraform 插件 'terraform/provider-alicloud'](../../../install#4-【可选】安装插件)。
## 支持的云资源列表
编排类型 | 云服务商 | 云资源 | 描述
------------ | ------------- | ------------- | -------------
Terraform | Alibaba Cloud | [ACK](./terraform/alibaba-ack) | 用于部署阿里云 ACK 的 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
| | | [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
| 编排类型 | 云服务商 | 云资源 | 描述 |
|-----------|-------|------------------------------------------------------|----------------------------------------------------------------------------|
| 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

View File

@ -30,29 +30,29 @@ spec:
名称 | 描述 | 类型 | 是否必须 | 默认值
------------ | ------------- | ------------- | ------------- | -------------
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 |
proxy_mode | Proxy mode is option of kube-proxy. Valid values: 'ipvs','iptables'. Default to 'iptables'. | string | true |
k8s_worker_number | The number of worker nodes in kubernetes cluster. | number | 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 |
number_format | The number format used to output. | 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 |
master_instance_types | The ecs instance types used to launch master nodes. | list(any) | 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 |
zone_id | Availability Zone ID | 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 |
node_cidr_mask | The node cidr block to specific how many pods can run on single node. Valid values: [24-28]. | number | true |
install_cloud_monitor | Install cloud monitor agent on ECS. | bool | true |
password | The password of ECS instance. | 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 |
zone_id | Availability Zone ID | string | true |
cpu_core_count | CPU core count is used to fetch instance types. | number | true |
vpc_cidr | The cidr block used to launch a new vpc when 'vpc_id' is not specified. | string | true |
vswitch_cidrs | List of cidr blocks used to create several new vswitches when 'vswitch_ids' is not specified. | list(any) | true |
k8s_name_prefix | The name prefix used to create several kubernetes clusters. Default to variable `example_name` | string | 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 | 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 |
writeConnectionSecretToRef | The secret which the cloud resource connection will be written to | [writeConnectionSecretToRef](#writeConnectionSecretToRef) | false |
@ -70,11 +70,11 @@ spec:
名称 | 描述
------------ | -------------
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.
CLIENT_CERT | The client certificate of the kubernetes cluster.

View File

@ -4,7 +4,7 @@ title: 阿里云 ASK
## 描述
Terraform configuration for Alibaba Cloud Serverless Kubernetes (ASK)
用于部署阿里云 Serverless Kubernetes (ASK) 的组件说明
## 参数说明
@ -31,5 +31,8 @@ Terraform configuration for Alibaba Cloud Serverless Kubernetes (ASK)
名称 | 描述
------------ | -------------
CLUSTER_ID | ID of the kunernetes cluster.
Name |
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
## 描述
Terraform configuration for Alibaba Cloud Elastic IP
用于部署阿里云 Elastic IP 的组件说明
## 示例

View File

@ -4,7 +4,7 @@ title: 阿里云 OSS
## 描述
Terraform configuration for Alibaba Cloud OSS object
用于部署阿里云 OSS 的组件说明
## 示例

View File

@ -4,7 +4,7 @@ title: 阿里云 RDS
## 描述
Terraform configuration for Alibaba Cloud RDS object
用于部署阿里云 RDS 的组件说明
## 示例
@ -32,13 +32,13 @@ spec:
名称 | 描述 | 类型 | 是否必须 | 默认值
------------ | ------------- | ------------- | ------------- | -------------
instance_name | RDS instance name | string | true |
account_name | RDS instance user account name | string | true |
password | RDS instance account password | string | true |
allocate_public_connection | Whether to allocate public connection for a RDS instance. | bool | true |
security_ips | List of IP addresses allowed to access all databases of an instance | list(any) | true |
database_name | Database name | string | true |
privilege | The privilege of one account access database. | string | true |
instance_name | RDS instance name | string | true |
account_name | RDS instance user account name | string | true |
password | RDS instance account password | string | true |
writeConnectionSecretToRef | The secret which the cloud resource connection will be written to | [writeConnectionSecretToRef](#writeConnectionSecretToRef) | false |
@ -56,12 +56,12 @@ spec:
名称 | 描述
------------ | -------------
DB_PORT | RDS Instance Port
DATABASE_NAME | RDS Database Name
RESOURCE_IDENTIFIER | The identifier of the resource
DB_NAME | RDS Instance Name
DB_USER | RDS Instance User
DB_HOST | RDS Instance Host
DB_PUBLIC_HOST | RDS Instance Public Host
DB_ID | RDS Instance ID
DB_HOST | RDS Instance Host
DB_PORT | RDS Instance Port
DB_PASSWORD | RDS Instance Password
DATABASE_NAME | RDS Database Name

View File

@ -4,7 +4,7 @@ title: 阿里云 REDIS
## 描述
Terraform configuration for Alibaba Cloud Redis
用于部署阿里云 Redis 的组件说明
## 示例
@ -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 | true |
writeConnectionSecretToRef | The secret which the cloud resource connection will be written to | [writeConnectionSecretToRef](#writeConnectionSecretToRef) | false |

View File

@ -4,7 +4,26 @@ title: 阿里云 SLS-PROJECT
## 描述
Terraform configuration for Alibaba Cloud SLS Project
用于部署阿里云 SLS Project 的组件说明
## 示例
```yaml
apiVersion: core.oam.dev/v1beta1
kind: Application
metadata:
name: app-sls-project-sample
spec:
components:
- name: sample-sls-project
type: alibaba-sls-project
properties:
name: kubevela-1112
description: "Managed by KubeVela"
writeConnectionSecretToRef:
name: sls-project-conn
```
## 参数说明

View File

@ -4,7 +4,28 @@ title: 阿里云 SLS-STORE
## 描述
Terraform configuration for Alibaba Cloud SLS Store
用于部署阿里云 SLS Store 的组件说明
## 示例
```yaml
apiVersion: core.oam.dev/v1beta1
kind: Application
metadata:
name: app-sls-store-sample
spec:
components:
- name: sample-sls-store
type: alibaba-sls-store
properties:
store_name: kubevela-1111
store_retention_period: 30
store_shard_count: 2
store_max_split_shard_count: 2
writeConnectionSecretToRef:
name: sls-store-conn
```
## 参数说明
@ -13,15 +34,15 @@ Terraform configuration for Alibaba Cloud SLS Store
名称 | 描述 | 类型 | 是否必须 | 默认值
------------ | ------------- | ------------- | ------------- | -------------
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_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 |
description | Description of security group | string | true |
create_project | Whether to create log resources | string | 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 |
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 |
writeConnectionSecretToRef | The secret which the cloud resource connection will be written to | [writeConnectionSecretToRef](#writeConnectionSecretToRef) | false |

View File

@ -4,7 +4,7 @@ title: 阿里云 VPC
## 描述
Terraform configuration for Alibaba Cloud VPC
用于部署阿里云 VPC 的组件说明
## 示例

View File

@ -4,7 +4,7 @@ title: 阿里云 VSWITCH
## 描述
Terraform configuration for Alibaba Cloud VSwitch
用于部署阿里云 VSwitch 的组件说明
## 参数说明
@ -13,15 +13,15 @@ Terraform configuration for Alibaba Cloud VSwitch
名称 | 描述 | 类型 | 是否必须 | 默认值
------------ | ------------- | ------------- | ------------- | -------------
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 |
zone_id | Availability Zone ID | string | true |
create_vpc | Whether to create vpc. If false, you can specify an existing vpc by setting 'vpc_id'. | bool | true |
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 |
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 |
writeConnectionSecretToRef | The secret which the cloud resource connection will be written to | [writeConnectionSecretToRef](#writeConnectionSecretToRef) | false |
@ -39,5 +39,5 @@ Terraform configuration for Alibaba Cloud VSwitch
名称 | 描述
------------ | -------------
VPC_ID |
VSWITCH_ID |
VSWITCH_ID | VSwitch ID
VPC_ID | VPC ID

View File

@ -4,7 +4,7 @@ title: Azure DATABASE-MARIADB
## 描述
Terraform configuration for Azure Database Mariadb
用于部署 Azure mariadb 数据库的组件说明
## 示例
@ -36,12 +36,12 @@ spec:
名称 | 描述 | 类型 | 是否必须 | 默认值
------------ | ------------- | ------------- | ------------- | -------------
server_name | mariadb server name | string | true |
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 |
db_name | Database instance name | string | true |
username | Database instance username | string | true |
writeConnectionSecretToRef | The secret which the cloud resource connection will be written to | [writeConnectionSecretToRef](#writeConnectionSecretToRef) | false |

View File

@ -4,7 +4,7 @@ title: Azure STORAGE-ACCOUNT
## 描述
Terraform configuration for Azure Blob Storage Account
用于部署 Azure Blob Storage 账号的的组件说明
## 示例
@ -45,12 +45,12 @@ spec:
名称 | 描述 | 类型 | 是否必须 | 默认值
------------ | ------------- | ------------- | ------------- | -------------
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 |
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 |
writeConnectionSecretToRef | The secret which the cloud resource connection will be written to | [writeConnectionSecretToRef](#writeConnectionSecretToRef) | false |

View File

@ -178,14 +178,18 @@ module.exports = {
label: "Supported Cloud Resource",
items: [
"end-user/components/cloud-services/terraform/alibaba-ack",
"end-user/components/cloud-services/terraform/alibaba-ask",
"end-user/components/cloud-services/terraform/alibaba-eip",
"end-user/components/cloud-services/terraform/alibaba-rds",
"end-user/components/cloud-services/terraform/alibaba-oss",
"end-user/components/cloud-services/terraform/alibaba-rds",
"end-user/components/cloud-services/terraform/alibaba-redis",
"end-user/components/cloud-services/terraform/alibaba-sls-project",
"end-user/components/cloud-services/terraform/alibaba-sls-store",
"end-user/components/cloud-services/terraform/alibaba-vpc",
"end-user/components/cloud-services/terraform/alibaba-vswitch",
"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/aws-s3",
],
},
{

View File

@ -17,18 +17,21 @@ This tutorial will talk about how to provision and consume Cloud Resources by Te
## Supported Cloud Resource list
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
| | | [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
| | | [Storage Account](./terraform/azure-storage-account) | Terraform configuration for Azure Storage Account
| | AWS | [S3](./terraform/aws-s3) | Terraform configuration for AWS S3 bucket
| Orchestration Type | Cloud Provider | Cloud Resource | Description |
|--------------------|----------------|------------------------------------------------------|-----------------------------------------------------------------------|
| Terraform | Alibaba Cloud | [ACK](./terraform/alibaba-ack) | Terraform configuration for Alibaba Cloud ACK cluster |
| | | [ASK](./terraform/alibaba-ask) | Terraform configuration for Alibaba Cloud Serverless Kubernetes (ASK) |
| | | [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 |
| | | [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 |
| | Azure | [Mariadb](./terraform/azure-database-mariadb) | Terraform configuration for Azure Database Mariadb |
| | | [Storage Account](./terraform/azure-storage-account) | Terraform configuration for Azure Storage Account |
## Terraform

View File

@ -31,28 +31,28 @@ 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 |
zone_id | Availability Zone ID | 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 |
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 |
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 |
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 |
vswitch_ids | List of existing vswitch id. | list(any) | true |
k8s_name_prefix | The name prefix used to create several kubernetes clusters. Default to variable `example_name` | string | 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 |
install_cloud_monitor | Install cloud monitor agent on ECS. | bool | 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 |
writeConnectionSecretToRef | The secret which the cloud resource connection will be written to | [writeConnectionSecretToRef](#writeConnectionSecretToRef) | false |
@ -70,6 +70,7 @@ 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.
@ -77,4 +78,3 @@ If `writeConnectionSecretToRef` is set, a secret will be generated with these ke
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

View File

@ -31,5 +31,8 @@ If `writeConnectionSecretToRef` is set, a secret will be generated with these ke
Name | Description
------------ | -------------
CLUSTER_ID | ID of the kunernetes cluster.
Name |
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: Alibaba Cloud OSS
## Description
Terraform configuration for Alibaba Cloud OSS object
Terraform configuration for Alibaba Cloud OSS
## Samples

View File

@ -4,7 +4,7 @@ title: Alibaba Cloud RDS
## Description
Terraform configuration for Alibaba Cloud RDS object
Terraform configuration for Alibaba Cloud RDS
## Samples
@ -32,13 +32,13 @@ spec:
Name | Description | Type | Required | Default
------------ | ------------- | ------------- | ------------- | -------------
security_ips | List of IP addresses allowed to access all databases of an instance | list(any) | true |
database_name | Database name | string | true |
privilege | The privilege of one account access database. | string | true |
instance_name | RDS instance name | string | true |
account_name | RDS instance user account name | string | true |
password | RDS instance account password | string | true |
allocate_public_connection | Whether to allocate public connection for a RDS instance. | bool | true |
security_ips | List of IP addresses allowed to access all databases of an instance | list(any) | true |
database_name | Database name | string | true |
privilege | The privilege of one account access database. | string | true |
writeConnectionSecretToRef | The secret which the cloud resource connection will be written to | [writeConnectionSecretToRef](#writeConnectionSecretToRef) | false |
@ -56,12 +56,12 @@ If `writeConnectionSecretToRef` is set, a secret will be generated with these ke
Name | Description
------------ | -------------
DB_ID | RDS Instance ID
DB_USER | RDS Instance User
DB_PORT | RDS Instance Port
DB_HOST | RDS Instance Host
DB_PASSWORD | RDS Instance Password
RESOURCE_IDENTIFIER | The identifier of the resource
DB_NAME | RDS Instance Name
DB_PUBLIC_HOST | RDS Instance Public Host
DATABASE_NAME | RDS Database Name
DB_NAME | RDS Instance Name
DB_HOST | RDS Instance Host
DB_USER | RDS Instance User
DB_PORT | RDS Instance Port
DB_PASSWORD | RDS Instance Password
RESOURCE_IDENTIFIER | The identifier of the resource
DB_ID | RDS Instance ID

View File

@ -32,9 +32,9 @@ spec:
Name | Description | Type | Required | Default
------------ | ------------- | ------------- | ------------- | -------------
password | RDS instance account password | string | true |
instance_name | Redis instance name | string | true |
account_name | Redis instance user account name | string | true |
password | RDS instance account password | string | true |
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_NAME | Redis instance name
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

@ -6,6 +6,25 @@ title: Alibaba Cloud SLS-PROJECT
Terraform configuration for Alibaba Cloud SLS Project
## Samples
```yaml
apiVersion: core.oam.dev/v1beta1
kind: Application
metadata:
name: app-sls-project-sample
spec:
components:
- name: sample-sls-project
type: alibaba-sls-project
properties:
name: kubevela-1112
description: "Managed by KubeVela"
writeConnectionSecretToRef:
name: sls-project-conn
```
## Specification
@ -13,8 +32,8 @@ Terraform configuration for Alibaba Cloud SLS Project
Name | Description | Type | Required | Default
------------ | ------------- | ------------- | ------------- | -------------
description | Description of security group | string | true |
name | Name of security group. It is used to create a new security group. | string | true |
description | Description of security group | string | true |
writeConnectionSecretToRef | The secret which the cloud resource connection will be written to | [writeConnectionSecretToRef](#writeConnectionSecretToRef) | false |

View File

@ -6,6 +6,27 @@ title: Alibaba Cloud SLS-STORE
Terraform configuration for Alibaba Cloud SLS Store
## Samples
```yaml
apiVersion: core.oam.dev/v1beta1
kind: Application
metadata:
name: app-sls-store-sample
spec:
components:
- name: sample-sls-store
type: alibaba-sls-store
properties:
store_name: kubevela-1111
store_retention_period: 30
store_shard_count: 2
store_max_split_shard_count: 2
writeConnectionSecretToRef:
name: sls-store-conn
```
## Specification
@ -13,15 +34,15 @@ Terraform configuration for Alibaba Cloud SLS Store
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_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_auto_split | Determines whether to automatically split a shard. Default to true. | bool | 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 |
project_name | Name of security group. It is used to create a new security group. | string | true |
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
------------ | ------------- | ------------- | ------------- | -------------
vswitch_description | The vswitch description used to launch several new vswitch. | 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 |
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_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 |
writeConnectionSecretToRef | The secret which the cloud resource connection will be written to | [writeConnectionSecretToRef](#writeConnectionSecretToRef) | false |
@ -39,5 +39,5 @@ If `writeConnectionSecretToRef` is set, a secret will be generated with these ke
Name | Description
------------ | -------------
VSWITCH_ID |
VPC_ID |
VSWITCH_ID | VSwitch ID
VPC_ID | VPC ID

View File

@ -36,12 +36,12 @@ spec:
Name | Description | Type | Required | Default
------------ | ------------- | ------------- | ------------- | -------------
server_name | mariadb server name | string | true |
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 |
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
------------ | -------------
SERVER_NAME | mariadb server name
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