From 764a80c572f2fab382b83ab62593cb73c7056fc7 Mon Sep 17 00:00:00 2001 From: Zheng Xi Zhou Date: Fri, 4 Feb 2022 10:07:32 +0800 Subject: [PATCH] Add reference doc for MQ (#489) --- .../provision-and-consume-cloud-services.md | 3 ++ .../cloud-services/terraform/alibaba-amqp.md | 39 ++++++++++++++++ .../terraform/alibaba-rocketmq.md | 46 +++++++++++++++++++ docs/tutorials/consume-cloud-services.md | 3 ++ .../provision-and-consume-cloud-services.md | 33 +++++++------ .../cloud-services/terraform/alibaba-amqp.md | 39 ++++++++++++++++ .../terraform/alibaba-rocketmq.md | 46 +++++++++++++++++++ .../tutorials/consume-cloud-services.md | 4 +- .../cloud-services/terraform/alibaba-amqp.md | 39 ++++++++++++++++ .../terraform/alibaba-rocketmq.md | 46 +++++++++++++++++++ sidebars.js | 2 + .../cloud-services/terraform/alibaba-amqp.md | 39 ++++++++++++++++ .../terraform/alibaba-rocketmq.md | 46 +++++++++++++++++++ versioned_sidebars/version-v1.2-sidebars.json | 8 ++++ 14 files changed, 377 insertions(+), 16 deletions(-) create mode 100644 docs/end-user/components/cloud-services/terraform/alibaba-amqp.md create mode 100644 docs/end-user/components/cloud-services/terraform/alibaba-rocketmq.md create mode 100644 i18n/zh/docusaurus-plugin-content-docs/current/end-user/components/cloud-services/terraform/alibaba-amqp.md create mode 100644 i18n/zh/docusaurus-plugin-content-docs/current/end-user/components/cloud-services/terraform/alibaba-rocketmq.md create mode 100644 i18n/zh/docusaurus-plugin-content-docs/version-v1.2/end-user/components/cloud-services/terraform/alibaba-amqp.md create mode 100644 i18n/zh/docusaurus-plugin-content-docs/version-v1.2/end-user/components/cloud-services/terraform/alibaba-rocketmq.md create mode 100644 versioned_docs/version-v1.2/end-user/components/cloud-services/terraform/alibaba-amqp.md create mode 100644 versioned_docs/version-v1.2/end-user/components/cloud-services/terraform/alibaba-rocketmq.md diff --git a/docs/end-user/components/cloud-services/provision-and-consume-cloud-services.md b/docs/end-user/components/cloud-services/provision-and-consume-cloud-services.md index 9526bbf2..709c4c8e 100644 --- a/docs/end-user/components/cloud-services/provision-and-consume-cloud-services.md +++ b/docs/end-user/components/cloud-services/provision-and-consume-cloud-services.md @@ -20,11 +20,14 @@ 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 | +| | | [ASK](./terraform/alibaba-amqp) | Terraform configuration for Alibaba Cloud AMQP (RabbitMQ) | | | | [ASK](./terraform/alibaba-ask) | Terraform configuration for Alibaba Cloud Serverless Kubernetes (ASK) | | | | [EIP](./terraform/alibaba-eip) | Terraform configuration for Alibaba Cloud EIP | +| | | [MSE](./terraform/alibaba-mse) | Terraform configuration for Alibaba Cloud MSE | | | | [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 | +| | | [RocketMQ](./terraform/alibaba-rocketmq) | Terraform configuration for Alibaba Cloud RocketMQ | | | | [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 | diff --git a/docs/end-user/components/cloud-services/terraform/alibaba-amqp.md b/docs/end-user/components/cloud-services/terraform/alibaba-amqp.md new file mode 100644 index 00000000..3ad45df6 --- /dev/null +++ b/docs/end-user/components/cloud-services/terraform/alibaba-amqp.md @@ -0,0 +1,39 @@ +--- +title: Alibaba Cloud AMQP +--- + +## Description + +Terraform configuration for Alibaba Cloud AMQP(RabbitMQ) + +## Specification + + +### Properties + + Name | Description | Type | Required | Default + ------------ | ------------- | ------------- | ------------- | ------------- + support_eip | The specification of support EIP. | bool | false | + auto_delete_state | Specifies whether the Auto Delete attribute is configured. Valid values: true: The Auto Delete attributeis configured. If the last queue that is bound to an exchange is unbound, the exchange is automatically deleted. false: The Auto Delete attribute is not configured. If the last queue that is bound to an exchange is unbound, the exchange is not automatically deleted. | bool | false | + instance_type | The specification of the instance type. Valid values: professional, vip. | string | false | + queue_capacity | The specification of the queue capacity. The smallest value is 50 and the step size 5. | number | false | + period | The specification of the period. Valid values: 1, 12, 2, 24, 3, 6. | number | false | + create | Whether to create instance. If false, you can specify an existing instance by setting 'instance_id'. | bool | false | + max_tps | The specification of the peak TPS traffic. The smallest valid value is 1000 and the largest value is 100,000. | number | false | + max_eip_tps | The specification of the max eip tps. It is valid when support_eip is true. The valid value is [128, 45000] with the step size 128 | number | false | + instance_id | The instance_id used to RabbitMQ. If set, the 'create' will be ignored. | string | false | + argument | The specification of the argument. | string | false | + binding_type | The specification of the binding type. Valid values: EXCHANGE, QUEUE. | string | false | + name | The specification of module name. | string | false | + payment_type | The specification of the payment type. | string | false | + exchange_type | The specification of the exchange type. Valid values: FANOUT, DIRECT, TOPIC, HEADERS | string | false | + internal | The specification of the internal. | bool | false | + writeConnectionSecretToRef | The secret which the cloud resource connection will be written to | [writeConnectionSecretToRef](#writeConnectionSecretToRef) | false | + + +#### writeConnectionSecretToRef + + Name | Description | Type | Required | Default + ------------ | ------------- | ------------- | ------------- | ------------- + name | The secret name which the cloud resource connection will be written to | string | true | + namespace | The secret namespace which the cloud resource connection will be written to | string | false | diff --git a/docs/end-user/components/cloud-services/terraform/alibaba-rocketmq.md b/docs/end-user/components/cloud-services/terraform/alibaba-rocketmq.md new file mode 100644 index 00000000..16e866c8 --- /dev/null +++ b/docs/end-user/components/cloud-services/terraform/alibaba-rocketmq.md @@ -0,0 +1,46 @@ +--- +title: Alibaba Cloud ROCKETMQ +--- + +## Description + +Terraform configuration for Alibaba Cloud RocketMQ + +## Specification + + +### Properties + + Name | Description | Type | Required | Default + ------------ | ------------- | ------------- | ------------- | ------------- + message_type | The type of the message. Read [Ons Topic Create](https://www.alibabacloud.com/help/doc-detail/29591.html) for further details. | number | false | + group_name | The name of MQ group | string | false | + group_type | Specify the protocol applicable to the created Group ID. Valid values: tcp, http. Default to tcp | string | false | + perm | The permission of MQ topic | string | false | + ons_instance_name | The name of ons instance. The length must be 3 to 64 characters. Chinese characters, English letters digits and hyphen are allowed. | string | false | + topic | The specification of ons topic name. Two topics on a single instance cannot have the same name and the name cannot start with 'GID' or 'CID'. The length cannot exceed 64 characters. | string | false | + ons_instance_remark | The specification of ons instance remark. | string | false | + ons_topic_remark | The specification of ons topic remark. | string | false | + writeConnectionSecretToRef | The secret which the cloud resource connection will be written to | [writeConnectionSecretToRef](#writeConnectionSecretToRef) | false | + + +#### writeConnectionSecretToRef + + Name | Description | Type | Required | Default + ------------ | ------------- | ------------- | ------------- | ------------- + name | The secret name which the cloud resource connection will be written to | string | true | + namespace | The secret namespace which the cloud resource connection will be written to | string | false | + + +### Outputs + +If `writeConnectionSecretToRef` is set, a secret will be generated with these keys as below: + + Name | Description + ------------ | ------------- + GROUP_ID | The id of ons group + HTTP_ENDPOINT_INTERNET | The internet http endpoint of ons instance + HTTP_ENDPOINT_INTERNAL | The internal http endpoint of ons instance + TCP_ENDPOINT | The tcp endpoint of ons instance + INSTANCE_ID | The id of ons instance + TOPIC_ID | The id of ons topic diff --git a/docs/tutorials/consume-cloud-services.md b/docs/tutorials/consume-cloud-services.md index 77fa2197..3aee1999 100644 --- a/docs/tutorials/consume-cloud-services.md +++ b/docs/tutorials/consume-cloud-services.md @@ -48,11 +48,14 @@ KubeVela supports the following types of resources and more later on: | Orchestration Type | Cloud Provider | Cloud Resource | Description | |--------------------|----------------|------------------------------------------------------------------------------------------|-----------------------------------------------------------------------| | Terraform | Alibaba Cloud | [ACK](../end-user/components/cloud-services/terraform/alibaba-ack) | Terraform configuration for Alibaba Cloud ACK cluster | +| | | [ASK](../end-user/components/cloud-services/terraform/alibaba-amqp) | Terraform configuration for Alibaba Cloud AMQP (RabbitMQ) | | | | [ASK](../end-user/components/cloud-services/terraform/alibaba-ask) | Terraform configuration for Alibaba Cloud Serverless Kubernetes (ASK) | | | | [EIP](../end-user/components/cloud-services/terraform/alibaba-eip) | Terraform configuration for Alibaba Cloud EIP | +| | | [MSE](../end-user/components/cloud-services/terraform/alibaba-mse) | Terraform configuration for Alibaba Cloud MSE | | | | [OSS](../end-user/components/cloud-services/terraform/alibaba-oss) | Terraform configuration for Alibaba Cloud OSS | | | | [RDS](../end-user/components/cloud-services/terraform/alibaba-rds) | Terraform configuration for Alibaba Cloud RDS | | | | [Redis](../end-user/components/cloud-services/terraform/alibaba-redis) | Terraform configuration for Alibaba Cloud Redis | +| | | [RocketMQ](../end-user/components/cloud-services/terraform/alibaba-rocketmq) | Terraform configuration for Alibaba Cloud RocketMQ | | | | [SLS Project](../end-user/components/cloud-services/terraform/alibaba-sls-project) | Terraform configuration for Alibaba Cloud SLS Project | | | | [SLS Store](../end-user/components/cloud-services/terraform/alibaba-sls-store) | Terraform configuration for Alibaba Cloud SLS Store | | | | [VPC](../end-user/components/cloud-services/terraform/alibaba-vpc) | Terraform configuration for Alibaba Cloud VPC | diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/end-user/components/cloud-services/provision-and-consume-cloud-services.md b/i18n/zh/docusaurus-plugin-content-docs/current/end-user/components/cloud-services/provision-and-consume-cloud-services.md index 09d41144..dbe47224 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/current/end-user/components/cloud-services/provision-and-consume-cloud-services.md +++ b/i18n/zh/docusaurus-plugin-content-docs/current/end-user/components/cloud-services/provision-and-consume-cloud-services.md @@ -12,21 +12,24 @@ KubeVela 通过云资源组件（Component）和运维特征（Trait）里的资 ## 支持的云资源列表 -| 编排类型 | 云服务商 | 云资源 | 描述 | -|-----------|-------|------------------------------------------------------|----------------------------------------------------------------------------| -| 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 | 阿里云 | [ACK](./terraform/alibaba-ack) | Terraform configuration for Alibaba Cloud ACK cluster | +| | | [ASK](./terraform/alibaba-amqp) | Terraform configuration for Alibaba Cloud AMQP (RabbitMQ) | +| | | [ASK](./terraform/alibaba-ask) | Terraform configuration for Alibaba Cloud Serverless Kubernetes (ASK) | +| | | [EIP](./terraform/alibaba-eip) | Terraform configuration for Alibaba Cloud EIP | +| | | [MSE](./terraform/alibaba-mse) | Terraform configuration for Alibaba Cloud MSE | +| | | [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 | +| | | [RocketMQ](./terraform/alibaba-rocketmq) | Terraform configuration for Alibaba Cloud RocketMQ | +| | | [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 diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/end-user/components/cloud-services/terraform/alibaba-amqp.md b/i18n/zh/docusaurus-plugin-content-docs/current/end-user/components/cloud-services/terraform/alibaba-amqp.md new file mode 100644 index 00000000..9f846381 --- /dev/null +++ b/i18n/zh/docusaurus-plugin-content-docs/current/end-user/components/cloud-services/terraform/alibaba-amqp.md @@ -0,0 +1,39 @@ +--- +title: 阿里云 AMQP +--- + +## 描述 + +Terraform configuration for Alibaba Cloud AMQP(RabbitMQ) + +## 参数说明 + + +### 属性 + + 名称 | 描述 | 类型 | 是否必须 | 默认值 + ------------ | ------------- | ------------- | ------------- | ------------- + create | Whether to create instance. If false, you can specify an existing instance by setting 'instance_id'. | bool | false | + payment_type | The specification of the payment type. | string | false | + auto_delete_state | Specifies whether the Auto Delete attribute is configured. Valid values: true: The Auto Delete attributeis configured. If the last queue that is bound to an exchange is unbound, the exchange is automatically deleted. false: The Auto Delete attribute is not configured. If the last queue that is bound to an exchange is unbound, the exchange is not automatically deleted. | bool | false | + internal | The specification of the internal. | bool | false | + instance_type | The specification of the instance type. Valid values: professional, vip. | string | false | + queue_capacity | The specification of the queue capacity. The smallest value is 50 and the step size 5. | number | false | + support_eip | The specification of support EIP. | bool | false | + max_eip_tps | The specification of the max eip tps. It is valid when support_eip is true. The valid value is [128, 45000] with the step size 128 | number | false | + period | The specification of the period. Valid values: 1, 12, 2, 24, 3, 6. | number | false | + argument | The specification of the argument. | string | false | + binding_type | The specification of the binding type. Valid values: EXCHANGE, QUEUE. | string | false | + name | The specification of module name. | string | false | + max_tps | The specification of the peak TPS traffic. The smallest valid value is 1000 and the largest value is 100,000. | number | false | + instance_id | The instance_id used to RabbitMQ. If set, the 'create' will be ignored. | string | false | + exchange_type | The specification of the exchange type. Valid values: FANOUT, DIRECT, TOPIC, HEADERS | string | false | + writeConnectionSecretToRef | The secret which the cloud resource connection will be written to | [writeConnectionSecretToRef](#writeConnectionSecretToRef) | false | + + +#### writeConnectionSecretToRef + + 名称 | 描述 | 类型 | 是否必须 | 默认值 + ------------ | ------------- | ------------- | ------------- | ------------- + name | The secret name which the cloud resource connection will be written to | string | true | + namespace | The secret namespace which the cloud resource connection will be written to | string | false | diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/end-user/components/cloud-services/terraform/alibaba-rocketmq.md b/i18n/zh/docusaurus-plugin-content-docs/current/end-user/components/cloud-services/terraform/alibaba-rocketmq.md new file mode 100644 index 00000000..fe67fda4 --- /dev/null +++ b/i18n/zh/docusaurus-plugin-content-docs/current/end-user/components/cloud-services/terraform/alibaba-rocketmq.md @@ -0,0 +1,46 @@ +--- +title: 阿里云 ROCKETMQ +--- + +## 描述 + +Terraform configuration for Alibaba Cloud RocketMQ + +## 参数说明 + + +### 属性 + + 名称 | 描述 | 类型 | 是否必须 | 默认值 + ------------ | ------------- | ------------- | ------------- | ------------- + ons_instance_name | The name of ons instance. The length must be 3 to 64 characters. Chinese characters, English letters digits and hyphen are allowed. | string | false | + topic | The specification of ons topic name. Two topics on a single instance cannot have the same name and the name cannot start with 'GID' or 'CID'. The length cannot exceed 64 characters. | string | false | + ons_instance_remark | The specification of ons instance remark. | string | false | + ons_topic_remark | The specification of ons topic remark. | string | false | + message_type | The type of the message. Read [Ons Topic Create](https://www.alibabacloud.com/help/doc-detail/29591.html) for further details. | number | false | + group_name | The name of MQ group | string | false | + group_type | Specify the protocol applicable to the created Group ID. Valid values: tcp, http. Default to tcp | string | false | + perm | The permission of MQ topic | string | false | + writeConnectionSecretToRef | The secret which the cloud resource connection will be written to | [writeConnectionSecretToRef](#writeConnectionSecretToRef) | false | + + +#### writeConnectionSecretToRef + + 名称 | 描述 | 类型 | 是否必须 | 默认值 + ------------ | ------------- | ------------- | ------------- | ------------- + name | The secret name which the cloud resource connection will be written to | string | true | + namespace | The secret namespace which the cloud resource connection will be written to | string | false | + + +### 输出 + +如果设置了 `writeConnectionSecretToRef`，一个 Kubernetes Secret 将会被创建，并且，它的数据里有这些键（key）： + + 名称 | 描述 + ------------ | ------------- + GROUP_ID | The id of ons group + HTTP_ENDPOINT_INTERNET | The internet http endpoint of ons instance + HTTP_ENDPOINT_INTERNAL | The internal http endpoint of ons instance + TCP_ENDPOINT | The tcp endpoint of ons instance + INSTANCE_ID | The id of ons instance + TOPIC_ID | The id of ons topic diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/tutorials/consume-cloud-services.md b/i18n/zh/docusaurus-plugin-content-docs/current/tutorials/consume-cloud-services.md index 1e47cad8..6e9234c8 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/current/tutorials/consume-cloud-services.md +++ b/i18n/zh/docusaurus-plugin-content-docs/current/tutorials/consume-cloud-services.md @@ -43,11 +43,14 @@ KubeVela支持以下类型的资源，以后还会有更多： | 编排类型 | 云服务商 | 云资源 | 描述 | |-----------|-------|------------------------------------------------------------------------------------------|-----------------------------------------------------------------------| | Terraform | 阿里云 | [ACK](../end-user/components/cloud-services/terraform/alibaba-ack) | Terraform configuration for Alibaba Cloud ACK cluster | +| | | [ASK](../end-user/components/cloud-services/terraform/alibaba-amqp) | Terraform configuration for Alibaba Cloud AMQP (RabbitMQ) | | | | [ASK](../end-user/components/cloud-services/terraform/alibaba-ask) | Terraform configuration for Alibaba Cloud Serverless Kubernetes (ASK) | | | | [EIP](../end-user/components/cloud-services/terraform/alibaba-eip) | Terraform configuration for Alibaba Cloud EIP | +| | | [MSE](../end-user/components/cloud-services/terraform/alibaba-mse) | Terraform configuration for Alibaba Cloud MSE | | | | [OSS](../end-user/components/cloud-services/terraform/alibaba-oss) | Terraform configuration for Alibaba Cloud OSS | | | | [RDS](../end-user/components/cloud-services/terraform/alibaba-rds) | Terraform configuration for Alibaba Cloud RDS | | | | [Redis](../end-user/components/cloud-services/terraform/alibaba-redis) | Terraform configuration for Alibaba Cloud Redis | +| | | [RocketMQ](../end-user/components/cloud-services/terraform/alibaba-rocketmq) | Terraform configuration for Alibaba Cloud RocketMQ | | | | [SLS Project](../end-user/components/cloud-services/terraform/alibaba-sls-project) | Terraform configuration for Alibaba Cloud SLS Project | | | | [SLS Store](../end-user/components/cloud-services/terraform/alibaba-sls-store) | Terraform configuration for Alibaba Cloud SLS Store | | | | [VPC](../end-user/components/cloud-services/terraform/alibaba-vpc) | Terraform configuration for Alibaba Cloud VPC | @@ -56,7 +59,6 @@ KubeVela支持以下类型的资源，以后还会有更多： | | Azure | [Mariadb](../end-user/components/cloud-services/terraform/azure-database-mariadb) | Terraform configuration for Azure Database Mariadb | | | | [Storage Account](../end-user/components/cloud-services/terraform/azure-storage-account) | Terraform configuration for Azure Storage Account | - ## 创建你的云服务 首先[创建一个应用程序](../how-to/dashboard/application/create-application)。请选择你的云服务的类型。 diff --git a/i18n/zh/docusaurus-plugin-content-docs/version-v1.2/end-user/components/cloud-services/terraform/alibaba-amqp.md b/i18n/zh/docusaurus-plugin-content-docs/version-v1.2/end-user/components/cloud-services/terraform/alibaba-amqp.md new file mode 100644 index 00000000..9f846381 --- /dev/null +++ b/i18n/zh/docusaurus-plugin-content-docs/version-v1.2/end-user/components/cloud-services/terraform/alibaba-amqp.md @@ -0,0 +1,39 @@ +--- +title: 阿里云 AMQP +--- + +## 描述 + +Terraform configuration for Alibaba Cloud AMQP(RabbitMQ) + +## 参数说明 + + +### 属性 + + 名称 | 描述 | 类型 | 是否必须 | 默认值 + ------------ | ------------- | ------------- | ------------- | ------------- + create | Whether to create instance. If false, you can specify an existing instance by setting 'instance_id'. | bool | false | + payment_type | The specification of the payment type. | string | false | + auto_delete_state | Specifies whether the Auto Delete attribute is configured. Valid values: true: The Auto Delete attributeis configured. If the last queue that is bound to an exchange is unbound, the exchange is automatically deleted. false: The Auto Delete attribute is not configured. If the last queue that is bound to an exchange is unbound, the exchange is not automatically deleted. | bool | false | + internal | The specification of the internal. | bool | false | + instance_type | The specification of the instance type. Valid values: professional, vip. | string | false | + queue_capacity | The specification of the queue capacity. The smallest value is 50 and the step size 5. | number | false | + support_eip | The specification of support EIP. | bool | false | + max_eip_tps | The specification of the max eip tps. It is valid when support_eip is true. The valid value is [128, 45000] with the step size 128 | number | false | + period | The specification of the period. Valid values: 1, 12, 2, 24, 3, 6. | number | false | + argument | The specification of the argument. | string | false | + binding_type | The specification of the binding type. Valid values: EXCHANGE, QUEUE. | string | false | + name | The specification of module name. | string | false | + max_tps | The specification of the peak TPS traffic. The smallest valid value is 1000 and the largest value is 100,000. | number | false | + instance_id | The instance_id used to RabbitMQ. If set, the 'create' will be ignored. | string | false | + exchange_type | The specification of the exchange type. Valid values: FANOUT, DIRECT, TOPIC, HEADERS | string | false | + writeConnectionSecretToRef | The secret which the cloud resource connection will be written to | [writeConnectionSecretToRef](#writeConnectionSecretToRef) | false | + + +#### writeConnectionSecretToRef + + 名称 | 描述 | 类型 | 是否必须 | 默认值 + ------------ | ------------- | ------------- | ------------- | ------------- + name | The secret name which the cloud resource connection will be written to | string | true | + namespace | The secret namespace which the cloud resource connection will be written to | string | false | diff --git a/i18n/zh/docusaurus-plugin-content-docs/version-v1.2/end-user/components/cloud-services/terraform/alibaba-rocketmq.md b/i18n/zh/docusaurus-plugin-content-docs/version-v1.2/end-user/components/cloud-services/terraform/alibaba-rocketmq.md new file mode 100644 index 00000000..fe67fda4 --- /dev/null +++ b/i18n/zh/docusaurus-plugin-content-docs/version-v1.2/end-user/components/cloud-services/terraform/alibaba-rocketmq.md @@ -0,0 +1,46 @@ +--- +title: 阿里云 ROCKETMQ +--- + +## 描述 + +Terraform configuration for Alibaba Cloud RocketMQ + +## 参数说明 + + +### 属性 + + 名称 | 描述 | 类型 | 是否必须 | 默认值 + ------------ | ------------- | ------------- | ------------- | ------------- + ons_instance_name | The name of ons instance. The length must be 3 to 64 characters. Chinese characters, English letters digits and hyphen are allowed. | string | false | + topic | The specification of ons topic name. Two topics on a single instance cannot have the same name and the name cannot start with 'GID' or 'CID'. The length cannot exceed 64 characters. | string | false | + ons_instance_remark | The specification of ons instance remark. | string | false | + ons_topic_remark | The specification of ons topic remark. | string | false | + message_type | The type of the message. Read [Ons Topic Create](https://www.alibabacloud.com/help/doc-detail/29591.html) for further details. | number | false | + group_name | The name of MQ group | string | false | + group_type | Specify the protocol applicable to the created Group ID. Valid values: tcp, http. Default to tcp | string | false | + perm | The permission of MQ topic | string | false | + writeConnectionSecretToRef | The secret which the cloud resource connection will be written to | [writeConnectionSecretToRef](#writeConnectionSecretToRef) | false | + + +#### writeConnectionSecretToRef + + 名称 | 描述 | 类型 | 是否必须 | 默认值 + ------------ | ------------- | ------------- | ------------- | ------------- + name | The secret name which the cloud resource connection will be written to | string | true | + namespace | The secret namespace which the cloud resource connection will be written to | string | false | + + +### 输出 + +如果设置了 `writeConnectionSecretToRef`，一个 Kubernetes Secret 将会被创建，并且，它的数据里有这些键（key）： + + 名称 | 描述 + ------------ | ------------- + GROUP_ID | The id of ons group + HTTP_ENDPOINT_INTERNET | The internet http endpoint of ons instance + HTTP_ENDPOINT_INTERNAL | The internal http endpoint of ons instance + TCP_ENDPOINT | The tcp endpoint of ons instance + INSTANCE_ID | The id of ons instance + TOPIC_ID | The id of ons topic diff --git a/sidebars.js b/sidebars.js index df7fc2a8..4983ef81 100644 --- a/sidebars.js +++ b/sidebars.js @@ -188,6 +188,8 @@ module.exports = { "end-user/components/cloud-services/terraform/alibaba-vswitch", "end-user/components/cloud-services/terraform/alibaba-mse", "end-user/components/cloud-services/terraform/alibaba-mongodb", + "end-user/components/cloud-services/terraform/alibaba-amqp", + "end-user/components/cloud-services/terraform/alibaba-rocketmq", "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", diff --git a/versioned_docs/version-v1.2/end-user/components/cloud-services/terraform/alibaba-amqp.md b/versioned_docs/version-v1.2/end-user/components/cloud-services/terraform/alibaba-amqp.md new file mode 100644 index 00000000..3ad45df6 --- /dev/null +++ b/versioned_docs/version-v1.2/end-user/components/cloud-services/terraform/alibaba-amqp.md @@ -0,0 +1,39 @@ +--- +title: Alibaba Cloud AMQP +--- + +## Description + +Terraform configuration for Alibaba Cloud AMQP(RabbitMQ) + +## Specification + + +### Properties + + Name | Description | Type | Required | Default + ------------ | ------------- | ------------- | ------------- | ------------- + support_eip | The specification of support EIP. | bool | false | + auto_delete_state | Specifies whether the Auto Delete attribute is configured. Valid values: true: The Auto Delete attributeis configured. If the last queue that is bound to an exchange is unbound, the exchange is automatically deleted. false: The Auto Delete attribute is not configured. If the last queue that is bound to an exchange is unbound, the exchange is not automatically deleted. | bool | false | + instance_type | The specification of the instance type. Valid values: professional, vip. | string | false | + queue_capacity | The specification of the queue capacity. The smallest value is 50 and the step size 5. | number | false | + period | The specification of the period. Valid values: 1, 12, 2, 24, 3, 6. | number | false | + create | Whether to create instance. If false, you can specify an existing instance by setting 'instance_id'. | bool | false | + max_tps | The specification of the peak TPS traffic. The smallest valid value is 1000 and the largest value is 100,000. | number | false | + max_eip_tps | The specification of the max eip tps. It is valid when support_eip is true. The valid value is [128, 45000] with the step size 128 | number | false | + instance_id | The instance_id used to RabbitMQ. If set, the 'create' will be ignored. | string | false | + argument | The specification of the argument. | string | false | + binding_type | The specification of the binding type. Valid values: EXCHANGE, QUEUE. | string | false | + name | The specification of module name. | string | false | + payment_type | The specification of the payment type. | string | false | + exchange_type | The specification of the exchange type. Valid values: FANOUT, DIRECT, TOPIC, HEADERS | string | false | + internal | The specification of the internal. | bool | false | + writeConnectionSecretToRef | The secret which the cloud resource connection will be written to | [writeConnectionSecretToRef](#writeConnectionSecretToRef) | false | + + +#### writeConnectionSecretToRef + + Name | Description | Type | Required | Default + ------------ | ------------- | ------------- | ------------- | ------------- + name | The secret name which the cloud resource connection will be written to | string | true | + namespace | The secret namespace which the cloud resource connection will be written to | string | false | diff --git a/versioned_docs/version-v1.2/end-user/components/cloud-services/terraform/alibaba-rocketmq.md b/versioned_docs/version-v1.2/end-user/components/cloud-services/terraform/alibaba-rocketmq.md new file mode 100644 index 00000000..16e866c8 --- /dev/null +++ b/versioned_docs/version-v1.2/end-user/components/cloud-services/terraform/alibaba-rocketmq.md @@ -0,0 +1,46 @@ +--- +title: Alibaba Cloud ROCKETMQ +--- + +## Description + +Terraform configuration for Alibaba Cloud RocketMQ + +## Specification + + +### Properties + + Name | Description | Type | Required | Default + ------------ | ------------- | ------------- | ------------- | ------------- + message_type | The type of the message. Read [Ons Topic Create](https://www.alibabacloud.com/help/doc-detail/29591.html) for further details. | number | false | + group_name | The name of MQ group | string | false | + group_type | Specify the protocol applicable to the created Group ID. Valid values: tcp, http. Default to tcp | string | false | + perm | The permission of MQ topic | string | false | + ons_instance_name | The name of ons instance. The length must be 3 to 64 characters. Chinese characters, English letters digits and hyphen are allowed. | string | false | + topic | The specification of ons topic name. Two topics on a single instance cannot have the same name and the name cannot start with 'GID' or 'CID'. The length cannot exceed 64 characters. | string | false | + ons_instance_remark | The specification of ons instance remark. | string | false | + ons_topic_remark | The specification of ons topic remark. | string | false | + writeConnectionSecretToRef | The secret which the cloud resource connection will be written to | [writeConnectionSecretToRef](#writeConnectionSecretToRef) | false | + + +#### writeConnectionSecretToRef + + Name | Description | Type | Required | Default + ------------ | ------------- | ------------- | ------------- | ------------- + name | The secret name which the cloud resource connection will be written to | string | true | + namespace | The secret namespace which the cloud resource connection will be written to | string | false | + + +### Outputs + +If `writeConnectionSecretToRef` is set, a secret will be generated with these keys as below: + + Name | Description + ------------ | ------------- + GROUP_ID | The id of ons group + HTTP_ENDPOINT_INTERNET | The internet http endpoint of ons instance + HTTP_ENDPOINT_INTERNAL | The internal http endpoint of ons instance + TCP_ENDPOINT | The tcp endpoint of ons instance + INSTANCE_ID | The id of ons instance + TOPIC_ID | The id of ons topic diff --git a/versioned_sidebars/version-v1.2-sidebars.json b/versioned_sidebars/version-v1.2-sidebars.json index abc2c71a..9d8f09c0 100644 --- a/versioned_sidebars/version-v1.2-sidebars.json +++ b/versioned_sidebars/version-v1.2-sidebars.json @@ -429,6 +429,14 @@ "type": "doc", "id": "version-v1.2/end-user/components/cloud-services/terraform/alibaba-mongodb" }, + { + "type": "doc", + "id": "version-v1.2/end-user/components/cloud-services/terraform/alibaba-amqp" + }, + { + "type": "doc", + "id": "version-v1.2/end-user/components/cloud-services/terraform/alibaba-rocketmq" + }, { "type": "doc", "id": "version-v1.2/end-user/components/cloud-services/terraform/aws-s3"