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

Add reference doc for cloud resources addons (#467) 

* Add reference doc for cloud resources addons

Added reference doc for terraform, provider-xxx addons

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

* fix ci issue

Signed-off-by: Zheng Xi Zhou <zzxwill@gmail.com>
This commit is contained in:
Zheng Xi Zhou 2022-01-21 09:51:35 +08:00 committed by GitHub
parent b40890c989
commit cc3f30dad6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
6 changed files with 169 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
docs/reference/addons/terraform.md Normal file
View File

@ -0,0 +1,41 @@
---
title: Addon Cloud Resources
---
## Terraform addon
```shell
vela addon enable terraform
```
## Terraform Provider addon for Alibaba Cloud
Enable Terraform Alibaba Cloud Provider as below to [provision and/or consume cloud resources](../../end-user/components/cloud-services/provider-and-consume-cloud-services).
Here is how to get [access key](https://help.aliyun.com/knowledge_detail/38738.html). Set the value for `ALICLOUD_REGION` by picking one `RegionId` from [Alibaba Cloud region list](https://www.alibabacloud.com/help/doc-detail/72379.htm).
You can also set the value for parameter `ALICLOUD_SECURITY_TOKEN`, which is optional, per [this doc](https://www.alibabacloud.com/help/doc-detail/28756.htm).
```shell
vela addon enable provider-alibaba ALICLOUD_ACCESS_KEY=<xxx> ALICLOUD_SECRET_KEY=<yyy> ALICLOUD_REGION=<region>
```
## Terraform Provider addon for Azure
Enable Terraform Azure Provider as below to [provision and/or consume cloud resources](../../end-user/components/cloud-services/provider-and-consume-cloud-services).
Set these parameters below per [Authenticate Terraform to Azure](https://docs.microsoft.com/en-us/azure/developer/terraform/authenticate-to-azure?tabs=bash).
```shell
vela addon enable provider-azure ARM_CLIENT_ID=<aaa> ARM_CLIENT_SECRET=<bbb> ARM_SUBSCRIPTION_ID=<ccc> ARM_TENANT_ID=<ddd>
```
## Terraform Provider addon for AWS
Enable Terraform AWS Provider as below to [provision and/or consume cloud resources](../../end-user/components/cloud-services/provider-and-consume-cloud-services).
Set these parameters below per [Authenticate Terraform to AWS](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#environment-variables).
```shell
vela addon enable provider-aws AWS_ACCESS_KEY_ID=<aaa> AWS_SECRET_ACCESS_KEY=<bbb> AWS_DEFAULT_REGION=<region>
```

39
i18n/zh/docusaurus-plugin-content-docs/current/reference/addons/terraform.md Normal file
View File

@ -0,0 +1,39 @@
---
title: 云资源插件
---
## Terraform 插件
```shell
vela addon enable terraform
```
## 阿里云 Terraform Provider 插件
执行如下命令开启 Terraform 对阿里云的支持，可以[创建和消费云资源](../../end-user/components/cloud-services/provider-and-consume-cloud-services)：
其中，请参考[如何获取 Access Key](https://help.aliyun.com/knowledge_detail/38738.html)设置 Access Key，参考 [Region 列表](https://www.alibabacloud.com/help/doc-detail/72379.htm) 中的 `RegionId` 设置 `ALICLOUD_REGION`。
参数 `ALICLOUD_SECURITY_TOKEN` 是可选的，你可以通过 [这篇介绍](https://www.alibabacloud.com/help/zh/doc-detail/28756.htm) 设置。
```shell
vela addon enable provider-alibaba ALICLOUD_ACCESS_KEY=<xxx> ALICLOUD_SECRET_KEY=<yyy> ALICLOUD_REGION=<region>
```
## Azure Terraform Provider 插件
执行如下命令开启 Terraform 对 Azure 的支持，可以[创建和消费云资源](../../end-user/components/cloud-services/provider-and-consume-cloud-services)：
参考 [Authenticate Terraform to Azure](https://docs.microsoft.com/en-us/azure/developer/terraform/authenticate-to-azure?tabs=bash)，设置如下参数。
```shell
vela addon enable provider-azure ARM_CLIENT_ID=<aaa> ARM_CLIENT_SECRET=<bbb> ARM_SUBSCRIPTION_ID=<ccc> ARM_TENANT_ID=<ddd>
```
## AWS Terraform Provider 插件
执行如下命令开启 Terraform 对 AWS 的支持，可以[创建和消费云资源](../../end-user/components/cloud-services/provider-and-consume-cloud-services)：
参考 [Authenticate Terraform to AWS](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#environment-variables)，设置如下参数。
```shell
vela addon enable provider-aws AWS_ACCESS_KEY_ID=<aaa> AWS_SECRET_ACCESS_KEY=<bbb> AWS_DEFAULT_REGION=<region>
```

39
i18n/zh/docusaurus-plugin-content-docs/version-v1.2/reference/addons/terraform.md Normal file
View File

@ -0,0 +1,39 @@
---
title: 云资源插件
---
## Terraform 插件
```shell
vela addon enable terraform
```
## 阿里云 Terraform Provider 插件
执行如下命令开启 Terraform 对阿里云的支持，可以[创建和消费云资源](../../end-user/components/cloud-services/provider-and-consume-cloud-services)：
其中，请参考[如何获取 Access Key](https://help.aliyun.com/knowledge_detail/38738.html)设置 Access Key，参考 [Region 列表](https://www.alibabacloud.com/help/doc-detail/72379.htm) 中的 `RegionId` 设置 `ALICLOUD_REGION`。
参数 `ALICLOUD_SECURITY_TOKEN` 是可选的，你可以通过 [这篇介绍](https://www.alibabacloud.com/help/zh/doc-detail/28756.htm) 设置。
```shell
vela addon enable provider-alibaba ALICLOUD_ACCESS_KEY=<xxx> ALICLOUD_SECRET_KEY=<yyy> ALICLOUD_REGION=<region>
```
## Azure Terraform Provider 插件
执行如下命令开启 Terraform 对 Azure 的支持，可以[创建和消费云资源](../../end-user/components/cloud-services/provider-and-consume-cloud-services)：
参考 [Authenticate Terraform to Azure](https://docs.microsoft.com/en-us/azure/developer/terraform/authenticate-to-azure?tabs=bash)，设置如下参数。
```shell
vela addon enable provider-azure ARM_CLIENT_ID=<aaa> ARM_CLIENT_SECRET=<bbb> ARM_SUBSCRIPTION_ID=<ccc> ARM_TENANT_ID=<ddd>
```
## AWS Terraform Provider 插件
执行如下命令开启 Terraform 对 AWS 的支持，可以[创建和消费云资源](../../end-user/components/cloud-services/provider-and-consume-cloud-services)：
参考 [Authenticate Terraform to AWS](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#environment-variables)，设置如下参数。
```shell
vela addon enable provider-aws AWS_ACCESS_KEY_ID=<aaa> AWS_SECRET_ACCESS_KEY=<bbb> AWS_DEFAULT_REGION=<region>
```

6
sidebars.js
View File

@ -174,7 +174,11 @@ module.exports = {
{
type: "category",
label: "Built-in Addons",
items: ["reference/addons/overview", "reference/addons/velaux"],
items: [
"reference/addons/overview",
"reference/addons/velaux",
"reference/addons/terraform",
],
},
{
type: "category",

41
versioned_docs/version-v1.2/reference/addons/terraform.md Normal file
View File

@ -0,0 +1,41 @@
---
title: Addon Cloud Resources
---
## Terraform addon
```shell
vela addon enable terraform
```
## Terraform Provider addon for Alibaba Cloud
Enable Terraform Alibaba Cloud Provider as below to [provision and/or consume cloud resources](../../end-user/components/cloud-services/provider-and-consume-cloud-services).
Here is how to get [access key](https://help.aliyun.com/knowledge_detail/38738.html). Set the value for `ALICLOUD_REGION` by picking one `RegionId` from [Alibaba Cloud region list](https://www.alibabacloud.com/help/doc-detail/72379.htm).
You can also set the value for parameter `ALICLOUD_SECURITY_TOKEN`, which is optional, per [this doc](https://www.alibabacloud.com/help/doc-detail/28756.htm).
```shell
vela addon enable provider-alibaba ALICLOUD_ACCESS_KEY=<xxx> ALICLOUD_SECRET_KEY=<yyy> ALICLOUD_REGION=<region>
```
## Terraform Provider addon for Azure
Enable Terraform Azure Provider as below to [provision and/or consume cloud resources](../../end-user/components/cloud-services/provider-and-consume-cloud-services).
Set these parameters below per [Authenticate Terraform to Azure](https://docs.microsoft.com/en-us/azure/developer/terraform/authenticate-to-azure?tabs=bash).
```shell
vela addon enable provider-azure ARM_CLIENT_ID=<aaa> ARM_CLIENT_SECRET=<bbb> ARM_SUBSCRIPTION_ID=<ccc> ARM_TENANT_ID=<ddd>
```
## Terraform Provider addon for AWS
Enable Terraform AWS Provider as below to [provision and/or consume cloud resources](../../end-user/components/cloud-services/provider-and-consume-cloud-services).
Set these parameters below per [Authenticate Terraform to AWS](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#environment-variables).
```shell
vela addon enable provider-aws AWS_ACCESS_KEY_ID=<aaa> AWS_SECRET_ACCESS_KEY=<bbb> AWS_DEFAULT_REGION=<region>
```

4
versioned_sidebars/version-v1.2-sidebars.json
View File

@ -361,6 +361,10 @@
{
"type": "doc",
"id": "version-v1.2/reference/addons/velaux"
},
{
"type": "doc",
"id": "version-v1.2/reference/addons/terraform"
}
]
},