diff --git a/docs/end-user/components/cloud-services/alibaba-ack.md b/docs/end-user/components/cloud-services/alibaba-ack.md new file mode 100644 index 00000000..f57fbafb --- /dev/null +++ b/docs/end-user/components/cloud-services/alibaba-ack.md @@ -0,0 +1,67 @@ +--- +title: Alibaba Cloud ACK +--- + + + +## Description + +Terraform configuration for Alibaba Cloud ACK cluster + +## Sample + +```yaml +apiVersion: core.oam.dev/v1beta1 +kind: Application +metadata: + name: ack-cloud-source +spec: + components: + - name: ack-cluster + type: alibaba-ack + properties: + writeConnectionSecretToRef: + name: ack-conn + namespace: vela-system + +``` + +## Specification + + +### Properties + +Name | Description | Type | Required | Default +------------ | ------------- | ------------- | ------------- | ------------- +k8s_worker_number | The number of worker nodes in kubernetes cluster. | number | false | +zone_id | Availability Zone ID | string | false | +node_cidr_mask | The node cidr block to specific how many pods can run on single node. Valid values: [24-28]. | number | false | +proxy_mode | Proxy mode is option of kube-proxy. Valid values: 'ipvs','iptables'. Default to 'iptables'. | string | false | +password | The password of ECS instance. | string | false | +k8s_version | The version of the kubernetes version. Valid values: '1.16.6-aliyun.1','1.14.8-aliyun.1'. Default to '1.16.6-aliyun.1'. | string | false | +memory_size | Memory size used to fetch instance types. | number | false | +vpc_cidr | The cidr block used to launch a new vpc when 'vpc_id' is not specified. | string | false | +vswitch_cidrs | List of cidr blocks used to create several new vswitches when 'vswitch_ids' is not specified. | list | false | +master_instance_types | The ecs instance types used to launch master nodes. | list | false | +worker_instance_types | The ecs instance types used to launch worker nodes. | list | false | +install_cloud_monitor | Install cloud monitor agent on ECS. | bool | false | +k8s_service_cidr | The kubernetes service cidr block. It cannot be equals to vpc's or vswitch's or pod's and cannot be in them. | string | false | +cpu_core_count | CPU core count is used to fetch instance types. | number | false | +vpc_name | The vpc name used to create a new vpc when 'vpc_id' is not specified. Default to variable `example_name` | string | false | +vswitch_name_prefix | The vswitch name prefix used to create several new vswitches. Default to variable 'example_name'. | string | false | +number_format | The number format used to output. | string | false | +vswitch_ids | List of existing vswitch id. | list | false | +k8s_name_prefix | The name prefix used to create several kubernetes clusters. Default to variable `example_name` | string | false | +new_nat_gateway | Whether to create a new nat gateway. In this template, a new nat gateway will create a nat gateway, eip and server snat entries. | bool | false | +enable_ssh | Enable login to the node through SSH. | bool | false | +cpu_policy | kubelet cpu policy. Valid values: 'none','static'. Default to 'none'. | string | false | +k8s_pod_cidr | The kubernetes pod cidr block. It cannot be equals to vpc's or vswitch's and cannot be in them. | string | false | +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 | false | +namespace | The secret namespace which the cloud resource connection will be written to | string | false | diff --git a/docs/end-user/components/cloud-services/alibaba-oss.md b/docs/end-user/components/cloud-services/alibaba-oss.md new file mode 100644 index 00000000..5d86a1b5 --- /dev/null +++ b/docs/end-user/components/cloud-services/alibaba-oss.md @@ -0,0 +1,44 @@ +--- +title: Alibaba Cloud OSS +--- + +## Description + +Terraform configuration for Alibaba Cloud OSS object + +## Samples + +```yaml +apiVersion: core.oam.dev/v1beta1 +kind: Application +metadata: + name: oss-cloud-source +spec: + components: + - name: sample-oss + type: alibaba-oss + properties: + bucket: vela-website + acl: private + writeConnectionSecretToRef: + name: oss-conn +``` + +## Specification + + +### Properties + +Name | Description | Type | Required | Default +------------ | ------------- | ------------- | ------------- | ------------- +bucket | OSS bucket name | string | true | +acl | OSS bucket ACL, supported 'private', 'public-read', 'public-read-write' | 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 | diff --git a/docs/end-user/components/cloud-services/alibaba-rds.md b/docs/end-user/components/cloud-services/alibaba-rds.md new file mode 100644 index 00000000..1cce405c --- /dev/null +++ b/docs/end-user/components/cloud-services/alibaba-rds.md @@ -0,0 +1,46 @@ +--- +title: Alibaba Cloud RDS +--- + +## Description + +Terraform configuration for Alibaba Cloud RDS object + +## Sample + +```yaml +apiVersion: core.oam.dev/v1beta1 +kind: Application +metadata: + name: rds-cloud-source +spec: + components: + - name: sample-db + type: alibaba-rds + properties: + instance_name: sample-db + account_name: oamtest + password: U34rfwefwefffaked + writeConnectionSecretToRef: + name: db-conn +``` + +## Specification + + +### Properties + +Name | Description | Type | Required | Default +------------ | ------------- | ------------- | ------------- | ------------- +password | RDS instance account password | string | true | +instance_name | RDS instance name | string | true | +account_name | RDS instance user account name | 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 | diff --git a/docs/end-user/components/cloud-services/alicloud-ack.md b/docs/end-user/components/cloud-services/alicloud-ack.md deleted file mode 100644 index 9b881dbf..00000000 --- a/docs/end-user/components/cloud-services/alicloud-ack.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -title: AliCloud ACK - ---- - -WIP \ No newline at end of file diff --git a/docs/end-user/components/cloud-services/alicloud-oss.md b/docs/end-user/components/cloud-services/alicloud-oss.md deleted file mode 100644 index b45cc33a..00000000 --- a/docs/end-user/components/cloud-services/alicloud-oss.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: AliCloud OSS ---- - -WIP \ No newline at end of file diff --git a/docs/end-user/components/cloud-services/alicloud-rds.md b/docs/end-user/components/cloud-services/alicloud-rds.md deleted file mode 100644 index 288d1e33..00000000 --- a/docs/end-user/components/cloud-services/alicloud-rds.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: AliCloudRDS ---- - -WIP \ No newline at end of file diff --git a/docusaurus.config.js b/docusaurus.config.js index ec817e12..114d1fa6 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -54,9 +54,13 @@ module.exports = { label: 'Blog', position: 'left' }, + { + type: 'localeDropdown', + position: 'right', + }, { href: 'https://github.com/oam-dev/kubevela', - className: 'header-githab-link', + className: 'header-github-link', position: 'right', }, ], diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/end-user/components/cloud-services/alibaba-ack.md b/i18n/zh/docusaurus-plugin-content-docs/current/end-user/components/cloud-services/alibaba-ack.md new file mode 100644 index 00000000..3c7b5328 --- /dev/null +++ b/i18n/zh/docusaurus-plugin-content-docs/current/end-user/components/cloud-services/alibaba-ack.md @@ -0,0 +1,66 @@ +--- +title: 阿里云 ACK + +--- + +## 描述 + +用于部署阿里云 ACK 集群的组件说明 + +## 示例 + +```yaml +apiVersion: core.oam.dev/v1beta1 +kind: Application +metadata: + name: ack-cloud-source +spec: + components: + - name: ack-cluster + type: alibaba-ack + properties: + writeConnectionSecretToRef: + name: ack-conn + namespace: vela-system + +``` + +## 参数说明 + + +### Properties + +名字 | 描述 | 类型 | 是否必须 | 默认值 +------------ | ------------- | ------------- | ------------- | ------------- +k8s_worker_number | The number of worker nodes in kubernetes cluster. | number | false | +zone_id | Availability Zone ID | string | false | +node_cidr_mask | The node cidr block to specific how many pods can run on single node. Valid values: [24-28]. | number | false | +proxy_mode | Proxy mode is option of kube-proxy. Valid values: 'ipvs','iptables'. Default to 'iptables'. | string | false | +password | The password of ECS instance. | string | false | +k8s_version | The version of the kubernetes version. Valid values: '1.16.6-aliyun.1','1.14.8-aliyun.1'. Default to '1.16.6-aliyun.1'. | string | false | +memory_size | Memory size used to fetch instance types. | number | false | +vpc_cidr | The cidr block used to launch a new vpc when 'vpc_id' is not specified. | string | false | +vswitch_cidrs | List of cidr blocks used to create several new vswitches when 'vswitch_ids' is not specified. | list | false | +master_instance_types | The ecs instance types used to launch master nodes. | list | false | +worker_instance_types | The ecs instance types used to launch worker nodes. | list | false | +install_cloud_monitor | Install cloud monitor agent on ECS. | bool | false | +k8s_service_cidr | The kubernetes service cidr block. It cannot be equals to vpc's or vswitch's or pod's and cannot be in them. | string | false | +cpu_core_count | CPU core count is used to fetch instance types. | number | false | +vpc_name | The vpc name used to create a new vpc when 'vpc_id' is not specified. Default to variable `example_name` | string | false | +vswitch_name_prefix | The vswitch name prefix used to create several new vswitches. Default to variable 'example_name'. | string | false | +number_format | The number format used to output. | string | false | +vswitch_ids | List of existing vswitch id. | list | false | +k8s_name_prefix | The name prefix used to create several kubernetes clusters. Default to variable `example_name` | string | false | +new_nat_gateway | Whether to create a new nat gateway. In this template, a new nat gateway will create a nat gateway, eip and server snat entries. | bool | false | +enable_ssh | Enable login to the node through SSH. | bool | false | +cpu_policy | kubelet cpu policy. Valid values: 'none','static'. Default to 'none'. | string | false | +k8s_pod_cidr | The kubernetes pod cidr block. It cannot be equals to vpc's or vswitch's and cannot be in them. | string | false | +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 | false | +namespace | The secret namespace which the cloud resource connection will be written to | string | false | diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/end-user/components/cloud-services/alibaba-oss.md b/i18n/zh/docusaurus-plugin-content-docs/current/end-user/components/cloud-services/alibaba-oss.md new file mode 100644 index 00000000..13bc5982 --- /dev/null +++ b/i18n/zh/docusaurus-plugin-content-docs/current/end-user/components/cloud-services/alibaba-oss.md @@ -0,0 +1,44 @@ +--- +title: 阿里云 OSS +--- + +## 描述 + +用于部署阿里云 OSS 的组件说明 + +## 示例 + +```yaml +apiVersion: core.oam.dev/v1beta1 +kind: Application +metadata: + name: oss-cloud-source +spec: + components: + - name: sample-oss + type: alibaba-oss + properties: + bucket: vela-website + acl: private + writeConnectionSecretToRef: + name: oss-conn +``` + +## 参数说明 + + +### Properties + +名字 | 描述 | 类型 | 是否必须 | 默认值 +------------ | ------------- | ------------- | ------------- | ------------- +bucket | OSS bucket name | string | true | +acl | OSS bucket ACL, supported 'private', 'public-read', 'public-read-write' | string | true | +writeConnectionSecretToRef | The secret which the cloud resource connection will be written to | [writeConnectionSecretToRef](#writeConnectionSecretToRef) | false | + + +#### writeConnectionSecretToRef + +名字 | 描述 | 类型 | 是否必须 | 默认值 +------------ | ------------- | ------------- | ------------- | ------------- +name | The secret name which the cloud resource connection will be written to | string | true | +namespace | The secret namespace which the cloud resource connection will be written to | string | false | diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/end-user/components/cloud-services/alibaba-rds.md b/i18n/zh/docusaurus-plugin-content-docs/current/end-user/components/cloud-services/alibaba-rds.md new file mode 100644 index 00000000..161e5759 --- /dev/null +++ b/i18n/zh/docusaurus-plugin-content-docs/current/end-user/components/cloud-services/alibaba-rds.md @@ -0,0 +1,46 @@ +--- +title: 阿里云 RDS +--- + +## 描述 + +用于部署阿里云 RDS 的组件说明 + +## 示例 + +```yaml +apiVersion: core.oam.dev/v1beta1 +kind: Application +metadata: + name: rds-cloud-source +spec: + components: + - name: sample-db + type: alibaba-rds + properties: + instance_name: sample-db + account_name: oamtest + password: U34rfwefwefffaked + writeConnectionSecretToRef: + name: db-conn +``` + +## 参数说明 + + +### Properties + +名字 | 描述 | 类型 | 是否必须 | 默认值 +------------ | ------------- | ------------- | ------------- | ------------- +password | RDS instance account password | string | true | +instance_name | RDS instance name | string | true | +account_name | RDS instance user account name | string | true | +writeConnectionSecretToRef | The secret which the cloud resource connection will be written to | [writeConnectionSecretToRef](#writeConnectionSecretToRef) | false | + + +#### writeConnectionSecretToRef + +名字 | 描述 | 类型 | 是否必须 | 默认值 +------------ | ------------- | ------------- | ------------- | ------------- +name | The secret name which the cloud resource connection will be written to | string | true | +namespace | The secret namespace which the cloud resource connection will be written to | string | false | diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/end-user/components/cloud-services/alicloud-ack.md b/i18n/zh/docusaurus-plugin-content-docs/current/end-user/components/cloud-services/alicloud-ack.md deleted file mode 100644 index 856e8ee2..00000000 --- a/i18n/zh/docusaurus-plugin-content-docs/current/end-user/components/cloud-services/alicloud-ack.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -title: 阿里云 ACK - ---- - -WIP \ No newline at end of file diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/end-user/components/cloud-services/alicloud-oss.md b/i18n/zh/docusaurus-plugin-content-docs/current/end-user/components/cloud-services/alicloud-oss.md deleted file mode 100644 index 172573b9..00000000 --- a/i18n/zh/docusaurus-plugin-content-docs/current/end-user/components/cloud-services/alicloud-oss.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: 阿里云 OSS ---- - -WIP \ No newline at end of file diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/end-user/components/cloud-services/alicloud-rds.md b/i18n/zh/docusaurus-plugin-content-docs/current/end-user/components/cloud-services/alicloud-rds.md deleted file mode 100644 index b6b24985..00000000 --- a/i18n/zh/docusaurus-plugin-content-docs/current/end-user/components/cloud-services/alicloud-rds.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: 阿里云 RDS ---- - -WIP \ No newline at end of file diff --git a/sidebars.js b/sidebars.js index 04a4e06a..9ac1cd5a 100644 --- a/sidebars.js +++ b/sidebars.js @@ -33,9 +33,9 @@ module.exports = { 'end-user/components/kustomize', { 'Cloud Services': [ - 'end-user/components/cloud-services/alicloud-ack', - 'end-user/components/cloud-services/alicloud-rds', - 'end-user/components/cloud-services/alicloud-oss', + 'end-user/components/cloud-services/alibaba-ack', + 'end-user/components/cloud-services/alibaba-rds', + 'end-user/components/cloud-services/alibaba-oss', ] }, { diff --git a/src/css/custom.css b/src/css/custom.css index 8f3ad721..59465300 100644 --- a/src/css/custom.css +++ b/src/css/custom.css @@ -30,11 +30,11 @@ padding: 0 var(--ifm-pre-padding); } -.header-githab-link:hover { +.header-github-link:hover { opacity: 0.6; } -.header-githab-link:before { +.header-github-link:before { content: ''; width: 24px; height: 24px;