From 256ef34b66e5e4a06aecd03f13d57599d70ed772 Mon Sep 17 00:00:00 2001 From: barnettZQG Date: Fri, 4 Nov 2022 00:28:39 +0800 Subject: [PATCH] Docs: refine the document about the Terraform (#1049) * Docs: refine the document about the terrafom Signed-off-by: barnettZQG * Docs: deprecated the vale provider commands Signed-off-by: barnettZQG * Fix: change the command Signed-off-by: barnettZQG * Fix: change the command Signed-off-by: barnettZQG * Fix: change the command Signed-off-by: barnettZQG Signed-off-by: barnettZQG --- ...022-06-27-terraform-integrate-with-vela.md | 13 ++- docs/cli/vela_provider_add.md | 40 ---------- .../vela_provider_add_terraform-alibaba.md | 44 ----------- docs/cli/vela_provider_add_terraform-aws.md | 45 ----------- docs/cli/vela_provider_add_terraform-azure.md | 45 ----------- docs/cli/vela_provider_add_terraform-baidu.md | 44 ----------- docs/cli/vela_provider_add_terraform-gcp.md | 44 ----------- .../vela_provider_add_terraform-tencent.md | 44 ----------- .../cli/vela_provider_add_terraform-ucloud.md | 45 ----------- docs/cli/vela_provider_delete.md | 40 ---------- .../vela_provider_delete_terraform-alibaba.md | 41 ---------- .../cli/vela_provider_delete_terraform-aws.md | 41 ---------- .../vela_provider_delete_terraform-azure.md | 41 ---------- .../vela_provider_delete_terraform-baidu.md | 41 ---------- .../cli/vela_provider_delete_terraform-gcp.md | 41 ---------- .../vela_provider_delete_terraform-tencent.md | 41 ---------- .../vela_provider_delete_terraform-ucloud.md | 41 ---------- docs/platform-engineers/openapi/overview.md | 4 + docs/reference/addons/overview.md | 33 ++++---- docs/reference/addons/terraform-ec.md | 27 +------ docs/reference/addons/terraform.md | 79 +++---------------- docs/tutorials/consume-cloud-services.md | 12 +++ ...022-06-27-terraform-integrate-with-vela.md | 10 +++ ...vision-instance-and-database-separately.md | 7 +- .../platform-engineers/openapi/overview.md | 4 + .../current/reference/addons/terraform.md | 11 +-- .../tutorials/consume-cloud-services.md | 14 +++- ...vision-instance-and-database-separately.md | 7 +- .../platform-engineers/openapi/overview.md | 4 + .../reference/addons/terraform.md | 11 +-- .../tutorials/consume-cloud-services.md | 14 +++- .../version-v1.6/cli/vela_provider_add.md | 40 ---------- .../vela_provider_add_terraform-alibaba.md | 44 ----------- .../cli/vela_provider_add_terraform-aws.md | 45 ----------- .../cli/vela_provider_add_terraform-azure.md | 45 ----------- .../cli/vela_provider_add_terraform-baidu.md | 44 ----------- .../cli/vela_provider_add_terraform-gcp.md | 44 ----------- .../vela_provider_add_terraform-tencent.md | 44 ----------- .../cli/vela_provider_add_terraform-ucloud.md | 45 ----------- .../version-v1.6/cli/vela_provider_delete.md | 40 ---------- .../vela_provider_delete_terraform-alibaba.md | 41 ---------- .../cli/vela_provider_delete_terraform-aws.md | 41 ---------- .../vela_provider_delete_terraform-azure.md | 41 ---------- .../vela_provider_delete_terraform-baidu.md | 41 ---------- .../cli/vela_provider_delete_terraform-gcp.md | 41 ---------- .../vela_provider_delete_terraform-tencent.md | 41 ---------- .../vela_provider_delete_terraform-ucloud.md | 41 ---------- .../platform-engineers/openapi/overview.md | 4 + .../version-v1.6/reference/addons/overview.md | 33 ++++---- .../reference/addons/terraform-ec.md | 27 +------ .../reference/addons/terraform.md | 79 +++---------------- .../tutorials/consume-cloud-services.md | 12 +++ 52 files changed, 172 insertions(+), 1589 deletions(-) delete mode 100644 docs/cli/vela_provider_add.md delete mode 100644 docs/cli/vela_provider_add_terraform-alibaba.md delete mode 100644 docs/cli/vela_provider_add_terraform-aws.md delete mode 100644 docs/cli/vela_provider_add_terraform-azure.md delete mode 100644 docs/cli/vela_provider_add_terraform-baidu.md delete mode 100644 docs/cli/vela_provider_add_terraform-gcp.md delete mode 100644 docs/cli/vela_provider_add_terraform-tencent.md delete mode 100644 docs/cli/vela_provider_add_terraform-ucloud.md delete mode 100644 docs/cli/vela_provider_delete.md delete mode 100644 docs/cli/vela_provider_delete_terraform-alibaba.md delete mode 100644 docs/cli/vela_provider_delete_terraform-aws.md delete mode 100644 docs/cli/vela_provider_delete_terraform-azure.md delete mode 100644 docs/cli/vela_provider_delete_terraform-baidu.md delete mode 100644 docs/cli/vela_provider_delete_terraform-gcp.md delete mode 100644 docs/cli/vela_provider_delete_terraform-tencent.md delete mode 100644 docs/cli/vela_provider_delete_terraform-ucloud.md delete mode 100644 versioned_docs/version-v1.6/cli/vela_provider_add.md delete mode 100644 versioned_docs/version-v1.6/cli/vela_provider_add_terraform-alibaba.md delete mode 100644 versioned_docs/version-v1.6/cli/vela_provider_add_terraform-aws.md delete mode 100644 versioned_docs/version-v1.6/cli/vela_provider_add_terraform-azure.md delete mode 100644 versioned_docs/version-v1.6/cli/vela_provider_add_terraform-baidu.md delete mode 100644 versioned_docs/version-v1.6/cli/vela_provider_add_terraform-gcp.md delete mode 100644 versioned_docs/version-v1.6/cli/vela_provider_add_terraform-tencent.md delete mode 100644 versioned_docs/version-v1.6/cli/vela_provider_add_terraform-ucloud.md delete mode 100644 versioned_docs/version-v1.6/cli/vela_provider_delete.md delete mode 100644 versioned_docs/version-v1.6/cli/vela_provider_delete_terraform-alibaba.md delete mode 100644 versioned_docs/version-v1.6/cli/vela_provider_delete_terraform-aws.md delete mode 100644 versioned_docs/version-v1.6/cli/vela_provider_delete_terraform-azure.md delete mode 100644 versioned_docs/version-v1.6/cli/vela_provider_delete_terraform-baidu.md delete mode 100644 versioned_docs/version-v1.6/cli/vela_provider_delete_terraform-gcp.md delete mode 100644 versioned_docs/version-v1.6/cli/vela_provider_delete_terraform-tencent.md delete mode 100644 versioned_docs/version-v1.6/cli/vela_provider_delete_terraform-ucloud.md diff --git a/blog/2022-06-27-terraform-integrate-with-vela.md b/blog/2022-06-27-terraform-integrate-with-vela.md index 82a64476..249e3c78 100644 --- a/blog/2022-06-27-terraform-integrate-with-vela.md +++ b/blog/2022-06-27-terraform-integrate-with-vela.md @@ -158,12 +158,23 @@ vela addon enable terraform vela addon enable terraform-alibaba ``` -* Add credentials as provider +* Add credentials as a provider +```bash +vela config create terraform-alibaba-default -t terraform-alibaba ALICLOUD_ACCESS_KEY=<"your-accesskey-id"> ALICLOUD_SECRET_KEY="your-accesskey-secret" ALICLOUD_REGION= ``` + +:::warning + +Before the 1.6.0 version: + +```shell vela provider add terraform-alibaba --ALICLOUD_ACCESS_KEY <"your-accesskey-id"> --ALICLOUD_SECRET_KEY "your-accesskey-secret" --ALICLOUD_REGION --name terraform-alibaba-default ``` +::: + + Check [this doc](https://kubevela.net/docs/reference/addons/terraform) for more details about other clouds. ### Launch a ECS with Public IP and Deploy the `frp` server diff --git a/docs/cli/vela_provider_add.md b/docs/cli/vela_provider_add.md deleted file mode 100644 index 9f6d9be3..00000000 --- a/docs/cli/vela_provider_add.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: vela provider add ---- - -Authenticate Terraform Cloud Provider - -### Synopsis - -Authenticate Terraform Cloud Provider by creating a credential secret and a Terraform Controller Provider - -``` -vela provider add [flags] -``` - -### Examples - -``` -vela provider add -``` - -### Options - -``` - -h, --help help for add -``` - -### Options inherited from parent commands - -``` - -y, --yes Assume yes for all user prompts -``` - -### SEE ALSO - -* [vela provider](vela_provider) - Authenticate Terraform Cloud Providers - -#### Go Back to [CLI Commands](vela) Homepage. - - -###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen). diff --git a/docs/cli/vela_provider_add_terraform-alibaba.md b/docs/cli/vela_provider_add_terraform-alibaba.md deleted file mode 100644 index 6a61ab2b..00000000 --- a/docs/cli/vela_provider_add_terraform-alibaba.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: vela provider add terraform-alibaba ---- - -Authenticate Terraform Cloud Provider terraform-alibaba - -### Synopsis - -Authenticate Terraform Cloud Provider terraform-alibaba by creating a credential secret and a Terraform Controller Provider - -``` -vela provider add terraform-alibaba [flags] -``` - -### Examples - -``` -vela provider add terraform-alibaba -``` - -### Options - -``` - --ALICLOUD_ACCESS_KEY string Get ALICLOUD_ACCESS_KEY per this guide https://help.aliyun.com/knowledge_detail/38738.html - --ALICLOUD_REGION string Get ALICLOUD_REGION by picking one RegionId from Alibaba Cloud region list https://www.alibabacloud.com/help/doc-detail/72379.htm - --ALICLOUD_SECRET_KEY string Get ALICLOUD_SECRET_KEY per this guide https://help.aliyun.com/knowledge_detail/38738.html - -h, --help help for terraform-alibaba - --name default The name of Terraform Provider for Alibaba Cloud, default is default (default "default") -``` - -### Options inherited from parent commands - -``` - -y, --yes Assume yes for all user prompts -``` - -### SEE ALSO - -* [vela provider add](vela_provider_add) - Authenticate Terraform Cloud Provider - -#### Go Back to [CLI Commands](vela) Homepage. - - -###### Auto generated by spf13/cobra on 19-Apr-2022, refer to [script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen). diff --git a/docs/cli/vela_provider_add_terraform-aws.md b/docs/cli/vela_provider_add_terraform-aws.md deleted file mode 100644 index f1d775e5..00000000 --- a/docs/cli/vela_provider_add_terraform-aws.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: vela provider add terraform-aws ---- - -Authenticate Terraform Cloud Provider terraform-aws - -### Synopsis - -Authenticate Terraform Cloud Provider terraform-aws by creating a credential secret and a Terraform Controller Provider - -``` -vela provider add terraform-aws [flags] -``` - -### Examples - -``` -vela provider add terraform-aws -``` - -### Options - -``` - --AWS_ACCESS_KEY_ID string Get AWS_ACCESS_KEY_ID per https://aws.amazon.com/blogs/security/wheres-my-secret-access-key/ - --AWS_DEFAULT_REGION string Choose one of Code form region list https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html#concepts-available-regions - --AWS_SECRET_ACCESS_KEY string Get AWS_SECRET_ACCESS_KEY per https://aws.amazon.com/blogs/security/wheres-my-secret-access-key/ - --AWS_SESSION_TOKEN string Get AWS_SESSION_TOKEN per https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_use-resources.html - -h, --help help for terraform-aws - --name default The name of Terraform Provider for AWS, default is default (default "aws") -``` - -### Options inherited from parent commands - -``` - -y, --yes Assume yes for all user prompts -``` - -### SEE ALSO - -* [vela provider add](vela_provider_add) - Authenticate Terraform Cloud Provider - -#### Go Back to [CLI Commands](vela) Homepage. - - -###### Auto generated by spf13/cobra on 19-Apr-2022, refer to [script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen). diff --git a/docs/cli/vela_provider_add_terraform-azure.md b/docs/cli/vela_provider_add_terraform-azure.md deleted file mode 100644 index e3b7461f..00000000 --- a/docs/cli/vela_provider_add_terraform-azure.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: vela provider add terraform-azure ---- - -Authenticate Terraform Cloud Provider terraform-azure - -### Synopsis - -Authenticate Terraform Cloud Provider terraform-azure by creating a credential secret and a Terraform Controller Provider - -``` -vela provider add terraform-azure [flags] -``` - -### Examples - -``` -vela provider add terraform-azure -``` - -### Options - -``` - --ARM_CLIENT_ID string - --ARM_CLIENT_SECRET string - --ARM_SUBSCRIPTION_ID string - --ARM_TENANT_ID string - -h, --help help for terraform-azure - --name azure The name of Terraform Provider for Azure, default is azure (default "azure") -``` - -### Options inherited from parent commands - -``` - -y, --yes Assume yes for all user prompts -``` - -### SEE ALSO - -* [vela provider add](vela_provider_add) - Authenticate Terraform Cloud Provider - -#### Go Back to [CLI Commands](vela) Homepage. - - -###### Auto generated by spf13/cobra on 19-Apr-2022, refer to [script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen). diff --git a/docs/cli/vela_provider_add_terraform-baidu.md b/docs/cli/vela_provider_add_terraform-baidu.md deleted file mode 100644 index 18660cb2..00000000 --- a/docs/cli/vela_provider_add_terraform-baidu.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: vela provider add terraform-baidu ---- - -Authenticate Terraform Cloud Provider terraform-baidu - -### Synopsis - -Authenticate Terraform Cloud Provider terraform-baidu by creating a credential secret and a Terraform Controller Provider - -``` -vela provider add terraform-baidu [flags] -``` - -### Examples - -``` -vela provider add terraform-baidu -``` - -### Options - -``` - --BAIDUCLOUD_ACCESS_KEY string Get BAIDUCLOUD_ACCESS_KEY per this guide https://cloud.baidu.com/doc/Reference/s/9jwvz2egb - --BAIDUCLOUD_REGION string Get BAIDUCLOUD_REGION by picking one RegionId from Baidu Cloud region list https://cloud.baidu.com/doc/Reference/s/2jwvz23xx - --BAIDUCLOUD_SECRET_KEY string Get BAIDUCLOUD_SECRET_KEY per this guide https://cloud.baidu.com/doc/Reference/s/9jwvz2egb - -h, --help help for terraform-baidu - --name baidu The name of Terraform Provider for Baidu Cloud, default is baidu (default "baidu") -``` - -### Options inherited from parent commands - -``` - -y, --yes Assume yes for all user prompts -``` - -### SEE ALSO - -* [vela provider add](vela_provider_add) - Authenticate Terraform Cloud Provider - -#### Go Back to [CLI Commands](vela) Homepage. - - -###### Auto generated by spf13/cobra on 19-Apr-2022, refer to [script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen). diff --git a/docs/cli/vela_provider_add_terraform-gcp.md b/docs/cli/vela_provider_add_terraform-gcp.md deleted file mode 100644 index b3c82cac..00000000 --- a/docs/cli/vela_provider_add_terraform-gcp.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: vela provider add terraform-gcp ---- - -Authenticate Terraform Cloud Provider terraform-gcp - -### Synopsis - -Authenticate Terraform Cloud Provider terraform-gcp by creating a credential secret and a Terraform Controller Provider - -``` -vela provider add terraform-gcp [flags] -``` - -### Examples - -``` -vela provider add terraform-gcp -``` - -### Options - -``` - --GOOGLE_CREDENTIALS string Get gcpCredentialsJSON per this guide https://registry.terraform.io/providers/hashicorp/google/latest/docs/guides/getting_started#adding-credentials - --GOOGLE_PROJECT string Set gcpProject per this guide https://registry.terraform.io/providers/hashicorp/google/latest/docs/guides/getting_started#configuring-the-provider - --GOOGLE_REGION string Get GOOGLE_REGION by picking one RegionId from Google Cloud region list https://cloud.google.com/compute/docs/regions-zones - -h, --help help for terraform-gcp - --name default The name of Terraform Provider for GCP, default is default (default "gcp") -``` - -### Options inherited from parent commands - -``` - -y, --yes Assume yes for all user prompts -``` - -### SEE ALSO - -* [vela provider add](vela_provider_add) - Authenticate Terraform Cloud Provider - -#### Go Back to [CLI Commands](vela) Homepage. - - -###### Auto generated by spf13/cobra on 19-Apr-2022, refer to [script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen). diff --git a/docs/cli/vela_provider_add_terraform-tencent.md b/docs/cli/vela_provider_add_terraform-tencent.md deleted file mode 100644 index a481b570..00000000 --- a/docs/cli/vela_provider_add_terraform-tencent.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: vela provider add terraform-tencent ---- - -Authenticate Terraform Cloud Provider terraform-tencent - -### Synopsis - -Authenticate Terraform Cloud Provider terraform-tencent by creating a credential secret and a Terraform Controller Provider - -``` -vela provider add terraform-tencent [flags] -``` - -### Examples - -``` -vela provider add terraform-tencent -``` - -### Options - -``` - --TENCENTCLOUD_REGION string Get TENCENTCLOUD_REGION by picking one RegionId from Tencent Cloud region list https://cloud.tencent.com/document/api/1140/40509#.E5.9C.B0.E5.9F.9F.E5.88.97.E8.A1.A8 - --TENCENTCLOUD_SECRET_ID string Get TENCENTCLOUD_SECRET_ID per this guide https://cloud.tencent.com/document/product/1213/67093 - --TENCENTCLOUD_SECRET_KEY string Get TENCENTCLOUD_SECRET_KEY per this guide https://cloud.tencent.com/document/product/1213/67093 - -h, --help help for terraform-tencent - --name default The name of Terraform Provider for Tencent Cloud, default is default (default "tencent") -``` - -### Options inherited from parent commands - -``` - -y, --yes Assume yes for all user prompts -``` - -### SEE ALSO - -* [vela provider add](vela_provider_add) - Authenticate Terraform Cloud Provider - -#### Go Back to [CLI Commands](vela) Homepage. - - -###### Auto generated by spf13/cobra on 19-Apr-2022, refer to [script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen). diff --git a/docs/cli/vela_provider_add_terraform-ucloud.md b/docs/cli/vela_provider_add_terraform-ucloud.md deleted file mode 100644 index 124e9688..00000000 --- a/docs/cli/vela_provider_add_terraform-ucloud.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: vela provider add terraform-ucloud ---- - -Authenticate Terraform Cloud Provider terraform-ucloud - -### Synopsis - -Authenticate Terraform Cloud Provider terraform-ucloud by creating a credential secret and a Terraform Controller Provider - -``` -vela provider add terraform-ucloud [flags] -``` - -### Examples - -``` -vela provider add terraform-ucloud -``` - -### Options - -``` - --UCLOUD_PRIVATE_KEY string Get UCLOUD_PRIVATE_KEY per this guide https://docs.ucloud.cn/terraform/quickstart - --UCLOUD_PROJECT_ID string Get UCLOUD_PROJECT_ID per this guide https://docs.ucloud.cn/terraform/quickstart - --UCLOUD_PUBLIC_KEY string Get UCLOUD_PUBLIC_KEY per this guide https://docs.ucloud.cn/terraform/quickstart - --UCLOUD_REGION string Get UCLOUD_REGION by picking one RegionId from UCloud region list https://docs.ucloud.cn/api/summary/regionlist - -h, --help help for terraform-ucloud - --name default The name of Terraform Provider for Ucloud Cloud, default is default (default "ucloud") -``` - -### Options inherited from parent commands - -``` - -y, --yes Assume yes for all user prompts -``` - -### SEE ALSO - -* [vela provider add](vela_provider_add) - Authenticate Terraform Cloud Provider - -#### Go Back to [CLI Commands](vela) Homepage. - - -###### Auto generated by spf13/cobra on 19-Apr-2022, refer to [script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen). diff --git a/docs/cli/vela_provider_delete.md b/docs/cli/vela_provider_delete.md deleted file mode 100644 index c8f46b11..00000000 --- a/docs/cli/vela_provider_delete.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: vela provider delete ---- - -Delete Terraform Cloud Provider - -### Synopsis - -Delete Terraform Cloud Provider - -``` -vela provider delete [flags] -``` - -### Examples - -``` -vela provider delete --name -``` - -### Options - -``` - -h, --help help for delete -``` - -### Options inherited from parent commands - -``` - -y, --yes Assume yes for all user prompts -``` - -### SEE ALSO - -* [vela provider](vela_provider) - Authenticate Terraform Cloud Providers - -#### Go Back to [CLI Commands](vela) Homepage. - - -###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen). diff --git a/docs/cli/vela_provider_delete_terraform-alibaba.md b/docs/cli/vela_provider_delete_terraform-alibaba.md deleted file mode 100644 index 4392bd3c..00000000 --- a/docs/cli/vela_provider_delete_terraform-alibaba.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: vela provider delete terraform-alibaba ---- - -Delete Terraform Cloud Provider terraform-alibaba - -### Synopsis - -Delete Terraform Cloud Provider terraform-alibaba - -``` -vela provider delete terraform-alibaba [flags] -``` - -### Examples - -``` -vela provider delete terraform-alibaba -``` - -### Options - -``` - -h, --help help for terraform-alibaba - --name default The name of Terraform Provider for Alibaba Cloud, default is default (default "default") -``` - -### Options inherited from parent commands - -``` - -y, --yes Assume yes for all user prompts -``` - -### SEE ALSO - -* [vela provider delete](vela_provider_delete) - Delete Terraform Cloud Provider - -#### Go Back to [CLI Commands](vela) Homepage. - - -###### Auto generated by spf13/cobra on 19-Apr-2022, refer to [script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen). diff --git a/docs/cli/vela_provider_delete_terraform-aws.md b/docs/cli/vela_provider_delete_terraform-aws.md deleted file mode 100644 index 1bdc8649..00000000 --- a/docs/cli/vela_provider_delete_terraform-aws.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: vela provider delete terraform-aws ---- - -Delete Terraform Cloud Provider terraform-aws - -### Synopsis - -Delete Terraform Cloud Provider terraform-aws - -``` -vela provider delete terraform-aws [flags] -``` - -### Examples - -``` -vela provider delete terraform-aws -``` - -### Options - -``` - -h, --help help for terraform-aws - --name default The name of Terraform Provider for AWS, default is default (default "aws") -``` - -### Options inherited from parent commands - -``` - -y, --yes Assume yes for all user prompts -``` - -### SEE ALSO - -* [vela provider delete](vela_provider_delete) - Delete Terraform Cloud Provider - -#### Go Back to [CLI Commands](vela) Homepage. - - -###### Auto generated by spf13/cobra on 19-Apr-2022, refer to [script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen). diff --git a/docs/cli/vela_provider_delete_terraform-azure.md b/docs/cli/vela_provider_delete_terraform-azure.md deleted file mode 100644 index 6178f85d..00000000 --- a/docs/cli/vela_provider_delete_terraform-azure.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: vela provider delete terraform-azure ---- - -Delete Terraform Cloud Provider terraform-azure - -### Synopsis - -Delete Terraform Cloud Provider terraform-azure - -``` -vela provider delete terraform-azure [flags] -``` - -### Examples - -``` -vela provider delete terraform-azure -``` - -### Options - -``` - -h, --help help for terraform-azure - --name azure The name of Terraform Provider for Azure, default is azure (default "azure") -``` - -### Options inherited from parent commands - -``` - -y, --yes Assume yes for all user prompts -``` - -### SEE ALSO - -* [vela provider delete](vela_provider_delete) - Delete Terraform Cloud Provider - -#### Go Back to [CLI Commands](vela) Homepage. - - -###### Auto generated by spf13/cobra on 19-Apr-2022, refer to [script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen). diff --git a/docs/cli/vela_provider_delete_terraform-baidu.md b/docs/cli/vela_provider_delete_terraform-baidu.md deleted file mode 100644 index 643e23ad..00000000 --- a/docs/cli/vela_provider_delete_terraform-baidu.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: vela provider delete terraform-baidu ---- - -Delete Terraform Cloud Provider terraform-baidu - -### Synopsis - -Delete Terraform Cloud Provider terraform-baidu - -``` -vela provider delete terraform-baidu [flags] -``` - -### Examples - -``` -vela provider delete terraform-baidu -``` - -### Options - -``` - -h, --help help for terraform-baidu - --name baidu The name of Terraform Provider for Baidu Cloud, default is baidu (default "baidu") -``` - -### Options inherited from parent commands - -``` - -y, --yes Assume yes for all user prompts -``` - -### SEE ALSO - -* [vela provider delete](vela_provider_delete) - Delete Terraform Cloud Provider - -#### Go Back to [CLI Commands](vela) Homepage. - - -###### Auto generated by spf13/cobra on 19-Apr-2022, refer to [script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen). diff --git a/docs/cli/vela_provider_delete_terraform-gcp.md b/docs/cli/vela_provider_delete_terraform-gcp.md deleted file mode 100644 index b4c789d0..00000000 --- a/docs/cli/vela_provider_delete_terraform-gcp.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: vela provider delete terraform-gcp ---- - -Delete Terraform Cloud Provider terraform-gcp - -### Synopsis - -Delete Terraform Cloud Provider terraform-gcp - -``` -vela provider delete terraform-gcp [flags] -``` - -### Examples - -``` -vela provider delete terraform-gcp -``` - -### Options - -``` - -h, --help help for terraform-gcp - --name default The name of Terraform Provider for GCP, default is default (default "gcp") -``` - -### Options inherited from parent commands - -``` - -y, --yes Assume yes for all user prompts -``` - -### SEE ALSO - -* [vela provider delete](vela_provider_delete) - Delete Terraform Cloud Provider - -#### Go Back to [CLI Commands](vela) Homepage. - - -###### Auto generated by spf13/cobra on 19-Apr-2022, refer to [script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen). diff --git a/docs/cli/vela_provider_delete_terraform-tencent.md b/docs/cli/vela_provider_delete_terraform-tencent.md deleted file mode 100644 index bc0f0d41..00000000 --- a/docs/cli/vela_provider_delete_terraform-tencent.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: vela provider delete terraform-tencent ---- - -Delete Terraform Cloud Provider terraform-tencent - -### Synopsis - -Delete Terraform Cloud Provider terraform-tencent - -``` -vela provider delete terraform-tencent [flags] -``` - -### Examples - -``` -vela provider delete terraform-tencent -``` - -### Options - -``` - -h, --help help for terraform-tencent - --name default The name of Terraform Provider for Tencent Cloud, default is default (default "tencent") -``` - -### Options inherited from parent commands - -``` - -y, --yes Assume yes for all user prompts -``` - -### SEE ALSO - -* [vela provider delete](vela_provider_delete) - Delete Terraform Cloud Provider - -#### Go Back to [CLI Commands](vela) Homepage. - - -###### Auto generated by spf13/cobra on 19-Apr-2022, refer to [script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen). diff --git a/docs/cli/vela_provider_delete_terraform-ucloud.md b/docs/cli/vela_provider_delete_terraform-ucloud.md deleted file mode 100644 index 526945f4..00000000 --- a/docs/cli/vela_provider_delete_terraform-ucloud.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: vela provider delete terraform-ucloud ---- - -Delete Terraform Cloud Provider terraform-ucloud - -### Synopsis - -Delete Terraform Cloud Provider terraform-ucloud - -``` -vela provider delete terraform-ucloud [flags] -``` - -### Examples - -``` -vela provider delete terraform-ucloud -``` - -### Options - -``` - -h, --help help for terraform-ucloud - --name default The name of Terraform Provider for Ucloud Cloud, default is default (default "ucloud") -``` - -### Options inherited from parent commands - -``` - -y, --yes Assume yes for all user prompts -``` - -### SEE ALSO - -* [vela provider delete](vela_provider_delete) - Delete Terraform Cloud Provider - -#### Go Back to [CLI Commands](vela) Homepage. - - -###### Auto generated by spf13/cobra on 19-Apr-2022, refer to [script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen). diff --git a/docs/platform-engineers/openapi/overview.md b/docs/platform-engineers/openapi/overview.md index a16354f8..6ffcd51e 100644 --- a/docs/platform-engineers/openapi/overview.md +++ b/docs/platform-engineers/openapi/overview.md @@ -168,3 +168,7 @@ Refer to [Kubevela API 1.4](https://kubevela.stoplight.io/docs/kubevela/uz7fzdxt ### 1.5 Refer to [KubeVela API 1.5](https://kubevela.stoplight.io/docs/kubevela/pi1st0zdzoejp-kube-vela-api-1-5) + +### 1.6 + +Refer to [KubeVela API 1.6](https://kubevela.stoplight.io/docs/kubevela/178jb51mk763f-kube-vela-api-1-6) diff --git a/docs/reference/addons/overview.md b/docs/reference/addons/overview.md index 79a3a156..d0f876dd 100644 --- a/docs/reference/addons/overview.md +++ b/docs/reference/addons/overview.md @@ -11,26 +11,27 @@ There's an community addon registry (https://addons.kubevela.net) maintained by * [Traefik](./traefik): Traefik is a modern HTTP reverse proxy and load balancer made to deploy microservices with ease. * [Rollout](./rollout): Provide a capability rollout the applicaton. * [Pyroscope](./pyroscope): Pyroscope is an open source platform, consisting of server and agent. It allows the user to collect, store, and query the profiling data in a CPU and disk efficient way. -* [AI addon](./ai) Introduction modeling-training and modeling-serving addon. +* [AI](./ai) Introduction modeling-training and modeling-serving addon. * [Vegeta](./vegeta) Vegeta is a versatile HTTP load testing tool built out of a need to drill HTTP services with a constant request rate. It can be used both as a command line utility and a library. * [OCM Cluster-Gateway Manager](./ocm-gateway-manager-addon) An operator component into the hub cluster that help the administrator to easily operate the configuration of cluster-gateway instances via "ClusterGatewayConfiguration"custom resource. *WARNING* this addon will restart the cluster-gateway instances upon the first-time installation. * [OCM Hub Control Plane](./ocm-hub-control-plane) Help you to initiate and install the [cluster manager](https://open-cluster-management.io/getting-started/core/cluster-manager/)(i.e. OCM's control plane) components into the hosting cluster where your KubeVela control plane is running. -* [Vela prism](./vela-prism) Provide API Extensions to the core [KubeVela](https://github.com/kubevela/kubevela). -* [Cert manager](./cert-manager) Add certificates and certificate issuers as resource types in Kubernetes clusters, and simplifies the process of obtaining, renewing and using those certificates. -* [KubeVela doc](./kubevela-io) Help you to read the KubeVela document in your cluster which can be air-gaped environment. -* [Flink kubernetes operator](./flink-kubernetes-operator) A Kubernetes operator for Apache Flink(https://github.com/apache/flink-kubernetes-operator). -* [dex](./dex) Provide [dex](https://github.com/dexidp/dex) login for VelaUX. +* [Vela Prism](./vela-prism) Provide API Extensions to the core [KubeVela](https://github.com/kubevela/kubevela). +* [Cert Manager](./cert-manager) Add certificates and certificate issuers as resource types in Kubernetes clusters, and simplifies the process of obtaining, renewing and using those certificates. +* [KubeVela Website](./kubevela-io) Help you to read the KubeVela document in your cluster which can be air-gaped environment. +* [Flink Operator](./flink-kubernetes-operator) A Kubernetes operator for Apache Flink(https://github.com/apache/flink-kubernetes-operator). +* [Dex](./dex) Provide [dex](https://github.com/dexidp/dex) login for VelaUX. * [Kruise Rollout](./kruise-rollout): [OpenKruise rollout](https://github.com/openkruise/rollouts) supports canary rollout for native deployment, stateful-set and OpenKruise [cloneset](https://openkruise.io/docs/user-manuals/cloneset/). -* [ingress-nginx](./nginx-ingress-controller): An Ingress controller for Kubernetes using NGINX as a reverse proxy and load balancer. +* [Nginx Ingress Controller](./nginx-ingress-controller): An Ingress controller for Kubernetes using NGINX as a reverse proxy and load balancer. * [ChartMuseum](./chartmuseum): An open-source and easy to deploy Helm Chart Repository server. -* [trivy-operator](./trivy-operator): Provides a vulnerability scanner that continuously scans containers deployed in a Kubernetes cluster. -* [prometheus-server](../../platform-engineers/operations/observability): Collects metrics from configured targets at given intervals, evaluates rule expressions, displays the results, and can trigger alerts if some condition is observed to be true. -* [node-exporter](../../platform-engineers/operations/observability): Prometheus exporter for hardware and OS metrics exposed by *NIX kernels, written in Go with pluggable metric collectors. -* [mysql-exporter](./mysql-exporter): Prometheus exporter for MySQL server metrics. -* [grafana](../../platform-engineers/operations/observability): Grafana is an open source, feature rich metrics dashboard and graph editor for Graphite, Elasticsearch, OpenTSDB, Prometheus and InfluxDB. -* [loki](../../platform-engineers/operations/o11y/logging): A log aggregation system designed to store and query logs from all your applications and infrastructure. -* [kube-state-metrics](../../platform-engineers/operations/observability): A simple service that listens to the Kubernetes API server and generates metrics about the state of the objects. +* [Trivy Operator](./trivy-operator): Provides a vulnerability scanner that continuously scans containers deployed in a Kubernetes cluster. +* [Prometheus Server](../../platform-engineers/operations/observability): Collects metrics from configured targets at given intervals, evaluates rule expressions, displays the results, and can trigger alerts if some condition is observed to be true. +* [Node Exporter](../../platform-engineers/operations/observability): Prometheus exporter for hardware and OS metrics exposed by *NIX kernels, written in Go with pluggable metric collectors. +* [Mysql Exporter](./mysql-exporter): Prometheus exporter for MySQL server metrics. +* [Grafana](../../platform-engineers/operations/observability): Grafana is an open source, feature rich metrics dashboard and graph editor for Graphite, Elasticsearch, OpenTSDB, Prometheus and InfluxDB. +* [Loki](../../platform-engineers/operations/o11y/logging): A log aggregation system designed to store and query logs from all your applications and infrastructure. +* [Kube State Metrics](../../platform-engineers/operations/observability): A simple service that listens to the Kubernetes API server and generates metrics about the state of the objects. * [netlify](./netlify): Netlify is a SaaS platform that can serve website especially for frontend service, it provides free allowances that was pretty cool to be used for demo and test. -* [cloudshell](../../tutorials/cloud-shell): Set up a web terminal and cloud shell intended for a kubernetes-native environment. -* [terraform-ec](./terraform-ec) Terraform provider addon for Elastic Cloud. +* [Cloud Shell](../../tutorials/cloud-shell): Set up a web terminal and cloud shell intended for a kubernetes-native environment. +* [Terraform](./terraform) Terraform provider addon to provide the capability to deploy the cloud resource. + **If you want to make your own addon please refer to [doc](../../platform-engineers/addon/intro.md).** \ No newline at end of file diff --git a/docs/reference/addons/terraform-ec.md b/docs/reference/addons/terraform-ec.md index 27c70815..81bb91ae 100644 --- a/docs/reference/addons/terraform-ec.md +++ b/docs/reference/addons/terraform-ec.md @@ -40,33 +40,12 @@ Then, enable Terraform provider addon for Elastic Cloud. vela addon enable terraform-ec ``` -You can also disable, upgrade, check status of an addon by `vela addon` command. +You can also disable, upgrade, and check the status of an addon by `vela addon` command. -After that, you can create credential for the provider. Find supported flags using following command: +After that, you can create credentials for the provider. Refer to the following command: ```shell -$ vela provider add terraform-ec -h -Authenticate Terraform Cloud Provider terraform-ec by creating a credential secret and a Terraform Controller Provider - -Usage: - vela provider add terraform-ec [flags] - -Examples: -vela provider add terraform-ec - -Flags: - --EC_API_KEY string Get EC_API_KEY per this guide https://registry.terraform.io/providers/elastic/ec/latest/docs - -h, --help help for terraform-ec - --name string The name of Terraform Provider for Elastic Cloud (default "ec") - -Global Flags: - -y, --yes Assume yes for all user prompts -``` - -Now, you can authenticate the Terraform provider with `--EC_API_KEY`. - -```shell -vela provider add terraform-ec --EC_API_KEY= +vela config create -t terraform-ec EC_API_KEY= ``` ## Find supported components diff --git a/docs/reference/addons/terraform.md b/docs/reference/addons/terraform.md index 08feff22..d5b3a781 100644 --- a/docs/reference/addons/terraform.md +++ b/docs/reference/addons/terraform.md @@ -6,15 +6,15 @@ To provision cloud resources, you can use terraform along with related cloud pro ## Enable Terraform addon - ```shell - vela addon enable terraform - ``` +```shell +vela addon enable terraform +``` -After terraform addon enabled, you will have a basic capability to create cloud resource in CRD ways. Then you can enable a terraform provider addon for specific cloud.s +After Terraform addon is enabled, you will have a basic capability to create cloud resources in CRD ways. Then you can enable a terraform provider addon for specific clouds. ## Enable Terraform Provider addon -KubeVela can support following cloud providers by enabling the Terraform provider addons. +KubeVela can support the following cloud providers by enabling the Terraform provider addons. ```shell $ vela addon list | grep terraform- @@ -30,78 +30,23 @@ terraform-ucloud KubeVela Kubernetes Terraform Controller Provider for To enable one of them, use the following command: ```shell -$ vela addon enable terraform- +vela addon enable terraform- ``` -You can also disable, upgrade, check status of an addon by command `vela addon`. - -## Authenticate Terraform Provider - -After any of the terraform provider addon enabled, you can create credential for them by `vela provider` command. - -### Add Credential - -Each Terraform provider can be authenticated by the command as below. - -```shell -$ vela provider add -h -Authenticate Terraform Cloud Provider by creating a credential secret and a Terraform Controller Provider - -Usage: - vela provider add [flags] - vela provider add [command] - -Examples: -vela provider add - -Available Commands: - terraform-alibaba Authenticate Terraform Cloud Provider terraform-alibaba - terraform-aws Authenticate Terraform Cloud Provider terraform-aws - terraform-azure Authenticate Terraform Cloud Provider terraform-azure - terraform-baidu Authenticate Terraform Cloud Provider terraform-baidu - terraform-gcp Authenticate Terraform Cloud Provider terraform-gcp - terraform-tencent Authenticate Terraform Cloud Provider terraform-tencent - terraform-ucloud Authenticate Terraform Cloud Provider terraform-ucloud -``` - -For example, let's authenticate the Terraform provider `terraform-aws`. - -Here is the help message for authenticate the `terraform-aws`. - -``` -$ vela provider add terraform-aws -h -Authenticate Terraform Cloud Provider terraform-aws by creating a credential secret and a Terraform Controller Provider - -Usage: - vela provider add terraform-aws [flags] - -Examples: -vela provider add terraform-aws - -Flags: - --AWS_ACCESS_KEY_ID string Get AWS_ACCESS_KEY_ID per https://aws.amazon.com/blogs/security/wheres-my-secret-access-key/ - --AWS_DEFAULT_REGION string Choose one of Code form region list https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html#concepts-available-regions - --AWS_SECRET_ACCESS_KEY string Get AWS_SECRET_ACCESS_KEY per https://aws.amazon.com/blogs/security/wheres-my-secret-access-key/ - --AWS_SESSION_TOKEN string Get AWS_SESSION_TOKEN per https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_use-resources.html - -h, --help help for terraform-aws - --name default The name of Terraform Provider for AWS, default is default (default "aws") - -Global Flags: - -y, --yes Assume yes for all user prompts -``` +You can also disable, upgrade, and check the status of an addon by command `vela addon`. ### Authenticate a Terraform provider +View the supported Terraform providers. + ```shell -$ vela provider add terraform-aws --AWS_ACCESS_KEY_ID=xxx --AWS_SECRET_ACCESS_KEY=yyy --AWS_DEFAULT_REGION=us-east-1 +vela config-template list | grep terraform ``` -Without setting a provider name by `--name`, an AWS Terraform provider named `aws` will be created. - -You also create multiple providers by specifying the `--name` flag. +For example to create a provider config for AWS. ```shell -$ vela provider add terraform-aws --name aws-dev --AWS_ACCESS_KEY_ID=xxx --AWS_SECRET_ACCESS_KEY=yyy --AWS_DEFAULT_REGION=us-east-1 +vela config create aws -t terraform-aws AWS_ACCESS_KEY_ID=xxx AWS_SECRET_ACCESS_KEY=yyy AWS_DEFAULT_REGION=us-east-1 ``` ### Provision cloud resources diff --git a/docs/tutorials/consume-cloud-services.md b/docs/tutorials/consume-cloud-services.md index 0933660f..f9b218ff 100644 --- a/docs/tutorials/consume-cloud-services.md +++ b/docs/tutorials/consume-cloud-services.md @@ -59,6 +59,18 @@ For different vendors, these parameters update accordingly. All cloud resources ### Provision by Creating Application +First, Prepare a available cloud provider. Let's list the exist configs, If exist you could ignore this step. + +```bash +vela config list -t terraform-alibaba +``` + +If not exist, you can refer to this command to create a default provider: + +```bash +vela config create default -t terraform-alibaba ALICLOUD_REGION= ALICLOUD_SECRET_KEY= ALICLOUD_ACCESS_KEY= +``` + Use the following Application to provision an OSS bucket: ```yaml diff --git a/i18n/zh/docusaurus-plugin-content-blog/2022-06-27-terraform-integrate-with-vela.md b/i18n/zh/docusaurus-plugin-content-blog/2022-06-27-terraform-integrate-with-vela.md index 1d1d6384..ffa0b8a7 100644 --- a/i18n/zh/docusaurus-plugin-content-blog/2022-06-27-terraform-integrate-with-vela.md +++ b/i18n/zh/docusaurus-plugin-content-blog/2022-06-27-terraform-integrate-with-vela.md @@ -155,9 +155,19 @@ vela addon enable terraform-alibaba * 添加授权信息 ```bash +vela config create terraform-alibaba-default -t terraform-alibaba ALICLOUD_ACCESS_KEY=<"your-accesskey-id"> ALICLOUD_SECRET_KEY="your-accesskey-secret" ALICLOUD_REGION= +``` + +:::warning + +如果是 1.6.0 之前的版本: + +```shell vela provider add terraform-alibaba --ALICLOUD_ACCESS_KEY <"your-accesskey-id"> --ALICLOUD_SECRET_KEY "your-accesskey-secret" --ALICLOUD_REGION --name terraform-alibaba-default ``` +::: + 查看 [此文档](https://kubevela.net/docs/reference/addons/terraform) 以获取有关其他云的更多详细信息。 ### 部署带有公网 IP 地址的 ECS 实例并启动 FRP 服务 diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/end-user/components/cloud-services/provision-instance-and-database-separately.md b/i18n/zh/docusaurus-plugin-content-docs/current/end-user/components/cloud-services/provision-instance-and-database-separately.md index 6899267c..ccf9e33e 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/current/end-user/components/cloud-services/provision-instance-and-database-separately.md +++ b/i18n/zh/docusaurus-plugin-content-docs/current/end-user/components/cloud-services/provision-instance-and-database-separately.md @@ -10,9 +10,10 @@ title: 分别配置实例和数据库 ## 先决条件 1. `terraform` 插件已经启用 -2. `terraform-alibaba` 插件已经启用，版本 >= 1.0.3 -3. 已经使用 `vela provider add terraform-alibaba` 配置了证书 -任何问题，可以按照这个[指导](../../../reference/addons/terraform) 进行设置. +2. `terraform-alibaba` 插件已经启用，版本 >= 1.0.3 +3. 已经使用 `vela config create -t terraform-alibaba` 配置了云厂商账号。 + +如有疑问，可以按照这个[指导](../../../reference/addons/terraform) 进行设置。 ## 步骤 diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/platform-engineers/openapi/overview.md b/i18n/zh/docusaurus-plugin-content-docs/current/platform-engineers/openapi/overview.md index a16354f8..6ffcd51e 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/current/platform-engineers/openapi/overview.md +++ b/i18n/zh/docusaurus-plugin-content-docs/current/platform-engineers/openapi/overview.md @@ -168,3 +168,7 @@ Refer to [Kubevela API 1.4](https://kubevela.stoplight.io/docs/kubevela/uz7fzdxt ### 1.5 Refer to [KubeVela API 1.5](https://kubevela.stoplight.io/docs/kubevela/pi1st0zdzoejp-kube-vela-api-1-5) + +### 1.6 + +Refer to [KubeVela API 1.6](https://kubevela.stoplight.io/docs/kubevela/178jb51mk763f-kube-vela-api-1-6) diff --git a/i18n/zh/docusaurus-plugin-content-docs/current/reference/addons/terraform.md b/i18n/zh/docusaurus-plugin-content-docs/current/reference/addons/terraform.md index 01685832..f50f5656 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/current/reference/addons/terraform.md +++ b/i18n/zh/docusaurus-plugin-content-docs/current/reference/addons/terraform.md @@ -3,9 +3,10 @@ title: 云资源插件 --- ## Terraform 插件 - ```shell - vela addon enable terraform - ``` + +```shell +vela addon enable terraform +``` ## 启用 Terraform Provider 插件 @@ -25,7 +26,7 @@ terraform-ucloud KubeVela Kubernetes Terraform Controller Provider for 要启用其中之一，请使用以下命令： ```shell -$ vela addon enable terraform-xxx +vela addon enable terraform-xxx ``` 您还可以通过命令 `vela addon` 卸载、升级、检查插件的状态。 @@ -34,7 +35,7 @@ $ vela addon enable terraform-xxx ### 介绍 -每个 Terraform provider 都可以通过以下命令进行云资源的授权。 +每个 Terraform Provider 都可以通过以下命令进行云资源的授权。 ```shell $ vela provider add -h 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 00294afc..c2acd82e 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 @@ -53,7 +53,19 @@ For different vendors, these parameters update accordingly. All cloud resources ### 部署云资源 -我们以 OSS bucket 为例展示如何部署云资源。 +首先，我们需要准备一个可用的提供商配置，通过下述命令可以查询是否存在，如果已有则忽略该步骤。 + +```bash +vela config list -t terraform-alibaba +``` + +如果不存在，可以参考下述命令创建一个默认的可以提供商配置，在这之前你需要获取云厂商的 Access Key 和 Secret Key。 + +```bash +vela config create default -t terraform-alibaba ALICLOUD_REGION= ALICLOUD_SECRET_KEY= ALICLOUD_ACCESS_KEY= +``` + +接下来，我们以 OSS bucket 为例展示如何部署云资源。 ```yaml apiVersion: core.oam.dev/v1beta1 diff --git a/i18n/zh/docusaurus-plugin-content-docs/version-v1.6/end-user/components/cloud-services/provision-instance-and-database-separately.md b/i18n/zh/docusaurus-plugin-content-docs/version-v1.6/end-user/components/cloud-services/provision-instance-and-database-separately.md index 6899267c..ccf9e33e 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/version-v1.6/end-user/components/cloud-services/provision-instance-and-database-separately.md +++ b/i18n/zh/docusaurus-plugin-content-docs/version-v1.6/end-user/components/cloud-services/provision-instance-and-database-separately.md @@ -10,9 +10,10 @@ title: 分别配置实例和数据库 ## 先决条件 1. `terraform` 插件已经启用 -2. `terraform-alibaba` 插件已经启用，版本 >= 1.0.3 -3. 已经使用 `vela provider add terraform-alibaba` 配置了证书 -任何问题，可以按照这个[指导](../../../reference/addons/terraform) 进行设置. +2. `terraform-alibaba` 插件已经启用，版本 >= 1.0.3 +3. 已经使用 `vela config create -t terraform-alibaba` 配置了云厂商账号。 + +如有疑问，可以按照这个[指导](../../../reference/addons/terraform) 进行设置。 ## 步骤 diff --git a/i18n/zh/docusaurus-plugin-content-docs/version-v1.6/platform-engineers/openapi/overview.md b/i18n/zh/docusaurus-plugin-content-docs/version-v1.6/platform-engineers/openapi/overview.md index a16354f8..6ffcd51e 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/version-v1.6/platform-engineers/openapi/overview.md +++ b/i18n/zh/docusaurus-plugin-content-docs/version-v1.6/platform-engineers/openapi/overview.md @@ -168,3 +168,7 @@ Refer to [Kubevela API 1.4](https://kubevela.stoplight.io/docs/kubevela/uz7fzdxt ### 1.5 Refer to [KubeVela API 1.5](https://kubevela.stoplight.io/docs/kubevela/pi1st0zdzoejp-kube-vela-api-1-5) + +### 1.6 + +Refer to [KubeVela API 1.6](https://kubevela.stoplight.io/docs/kubevela/178jb51mk763f-kube-vela-api-1-6) diff --git a/i18n/zh/docusaurus-plugin-content-docs/version-v1.6/reference/addons/terraform.md b/i18n/zh/docusaurus-plugin-content-docs/version-v1.6/reference/addons/terraform.md index 01685832..f50f5656 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/version-v1.6/reference/addons/terraform.md +++ b/i18n/zh/docusaurus-plugin-content-docs/version-v1.6/reference/addons/terraform.md @@ -3,9 +3,10 @@ title: 云资源插件 --- ## Terraform 插件 - ```shell - vela addon enable terraform - ``` + +```shell +vela addon enable terraform +``` ## 启用 Terraform Provider 插件 @@ -25,7 +26,7 @@ terraform-ucloud KubeVela Kubernetes Terraform Controller Provider for 要启用其中之一，请使用以下命令： ```shell -$ vela addon enable terraform-xxx +vela addon enable terraform-xxx ``` 您还可以通过命令 `vela addon` 卸载、升级、检查插件的状态。 @@ -34,7 +35,7 @@ $ vela addon enable terraform-xxx ### 介绍 -每个 Terraform provider 都可以通过以下命令进行云资源的授权。 +每个 Terraform Provider 都可以通过以下命令进行云资源的授权。 ```shell $ vela provider add -h diff --git a/i18n/zh/docusaurus-plugin-content-docs/version-v1.6/tutorials/consume-cloud-services.md b/i18n/zh/docusaurus-plugin-content-docs/version-v1.6/tutorials/consume-cloud-services.md index 00294afc..c2acd82e 100644 --- a/i18n/zh/docusaurus-plugin-content-docs/version-v1.6/tutorials/consume-cloud-services.md +++ b/i18n/zh/docusaurus-plugin-content-docs/version-v1.6/tutorials/consume-cloud-services.md @@ -53,7 +53,19 @@ For different vendors, these parameters update accordingly. All cloud resources ### 部署云资源 -我们以 OSS bucket 为例展示如何部署云资源。 +首先，我们需要准备一个可用的提供商配置，通过下述命令可以查询是否存在，如果已有则忽略该步骤。 + +```bash +vela config list -t terraform-alibaba +``` + +如果不存在，可以参考下述命令创建一个默认的可以提供商配置，在这之前你需要获取云厂商的 Access Key 和 Secret Key。 + +```bash +vela config create default -t terraform-alibaba ALICLOUD_REGION= ALICLOUD_SECRET_KEY= ALICLOUD_ACCESS_KEY= +``` + +接下来，我们以 OSS bucket 为例展示如何部署云资源。 ```yaml apiVersion: core.oam.dev/v1beta1 diff --git a/versioned_docs/version-v1.6/cli/vela_provider_add.md b/versioned_docs/version-v1.6/cli/vela_provider_add.md deleted file mode 100644 index 9f6d9be3..00000000 --- a/versioned_docs/version-v1.6/cli/vela_provider_add.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: vela provider add ---- - -Authenticate Terraform Cloud Provider - -### Synopsis - -Authenticate Terraform Cloud Provider by creating a credential secret and a Terraform Controller Provider - -``` -vela provider add [flags] -``` - -### Examples - -``` -vela provider add -``` - -### Options - -``` - -h, --help help for add -``` - -### Options inherited from parent commands - -``` - -y, --yes Assume yes for all user prompts -``` - -### SEE ALSO - -* [vela provider](vela_provider) - Authenticate Terraform Cloud Providers - -#### Go Back to [CLI Commands](vela) Homepage. - - -###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen). diff --git a/versioned_docs/version-v1.6/cli/vela_provider_add_terraform-alibaba.md b/versioned_docs/version-v1.6/cli/vela_provider_add_terraform-alibaba.md deleted file mode 100644 index 6a61ab2b..00000000 --- a/versioned_docs/version-v1.6/cli/vela_provider_add_terraform-alibaba.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: vela provider add terraform-alibaba ---- - -Authenticate Terraform Cloud Provider terraform-alibaba - -### Synopsis - -Authenticate Terraform Cloud Provider terraform-alibaba by creating a credential secret and a Terraform Controller Provider - -``` -vela provider add terraform-alibaba [flags] -``` - -### Examples - -``` -vela provider add terraform-alibaba -``` - -### Options - -``` - --ALICLOUD_ACCESS_KEY string Get ALICLOUD_ACCESS_KEY per this guide https://help.aliyun.com/knowledge_detail/38738.html - --ALICLOUD_REGION string Get ALICLOUD_REGION by picking one RegionId from Alibaba Cloud region list https://www.alibabacloud.com/help/doc-detail/72379.htm - --ALICLOUD_SECRET_KEY string Get ALICLOUD_SECRET_KEY per this guide https://help.aliyun.com/knowledge_detail/38738.html - -h, --help help for terraform-alibaba - --name default The name of Terraform Provider for Alibaba Cloud, default is default (default "default") -``` - -### Options inherited from parent commands - -``` - -y, --yes Assume yes for all user prompts -``` - -### SEE ALSO - -* [vela provider add](vela_provider_add) - Authenticate Terraform Cloud Provider - -#### Go Back to [CLI Commands](vela) Homepage. - - -###### Auto generated by spf13/cobra on 19-Apr-2022, refer to [script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen). diff --git a/versioned_docs/version-v1.6/cli/vela_provider_add_terraform-aws.md b/versioned_docs/version-v1.6/cli/vela_provider_add_terraform-aws.md deleted file mode 100644 index f1d775e5..00000000 --- a/versioned_docs/version-v1.6/cli/vela_provider_add_terraform-aws.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: vela provider add terraform-aws ---- - -Authenticate Terraform Cloud Provider terraform-aws - -### Synopsis - -Authenticate Terraform Cloud Provider terraform-aws by creating a credential secret and a Terraform Controller Provider - -``` -vela provider add terraform-aws [flags] -``` - -### Examples - -``` -vela provider add terraform-aws -``` - -### Options - -``` - --AWS_ACCESS_KEY_ID string Get AWS_ACCESS_KEY_ID per https://aws.amazon.com/blogs/security/wheres-my-secret-access-key/ - --AWS_DEFAULT_REGION string Choose one of Code form region list https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html#concepts-available-regions - --AWS_SECRET_ACCESS_KEY string Get AWS_SECRET_ACCESS_KEY per https://aws.amazon.com/blogs/security/wheres-my-secret-access-key/ - --AWS_SESSION_TOKEN string Get AWS_SESSION_TOKEN per https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_use-resources.html - -h, --help help for terraform-aws - --name default The name of Terraform Provider for AWS, default is default (default "aws") -``` - -### Options inherited from parent commands - -``` - -y, --yes Assume yes for all user prompts -``` - -### SEE ALSO - -* [vela provider add](vela_provider_add) - Authenticate Terraform Cloud Provider - -#### Go Back to [CLI Commands](vela) Homepage. - - -###### Auto generated by spf13/cobra on 19-Apr-2022, refer to [script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen). diff --git a/versioned_docs/version-v1.6/cli/vela_provider_add_terraform-azure.md b/versioned_docs/version-v1.6/cli/vela_provider_add_terraform-azure.md deleted file mode 100644 index e3b7461f..00000000 --- a/versioned_docs/version-v1.6/cli/vela_provider_add_terraform-azure.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: vela provider add terraform-azure ---- - -Authenticate Terraform Cloud Provider terraform-azure - -### Synopsis - -Authenticate Terraform Cloud Provider terraform-azure by creating a credential secret and a Terraform Controller Provider - -``` -vela provider add terraform-azure [flags] -``` - -### Examples - -``` -vela provider add terraform-azure -``` - -### Options - -``` - --ARM_CLIENT_ID string - --ARM_CLIENT_SECRET string - --ARM_SUBSCRIPTION_ID string - --ARM_TENANT_ID string - -h, --help help for terraform-azure - --name azure The name of Terraform Provider for Azure, default is azure (default "azure") -``` - -### Options inherited from parent commands - -``` - -y, --yes Assume yes for all user prompts -``` - -### SEE ALSO - -* [vela provider add](vela_provider_add) - Authenticate Terraform Cloud Provider - -#### Go Back to [CLI Commands](vela) Homepage. - - -###### Auto generated by spf13/cobra on 19-Apr-2022, refer to [script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen). diff --git a/versioned_docs/version-v1.6/cli/vela_provider_add_terraform-baidu.md b/versioned_docs/version-v1.6/cli/vela_provider_add_terraform-baidu.md deleted file mode 100644 index 18660cb2..00000000 --- a/versioned_docs/version-v1.6/cli/vela_provider_add_terraform-baidu.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: vela provider add terraform-baidu ---- - -Authenticate Terraform Cloud Provider terraform-baidu - -### Synopsis - -Authenticate Terraform Cloud Provider terraform-baidu by creating a credential secret and a Terraform Controller Provider - -``` -vela provider add terraform-baidu [flags] -``` - -### Examples - -``` -vela provider add terraform-baidu -``` - -### Options - -``` - --BAIDUCLOUD_ACCESS_KEY string Get BAIDUCLOUD_ACCESS_KEY per this guide https://cloud.baidu.com/doc/Reference/s/9jwvz2egb - --BAIDUCLOUD_REGION string Get BAIDUCLOUD_REGION by picking one RegionId from Baidu Cloud region list https://cloud.baidu.com/doc/Reference/s/2jwvz23xx - --BAIDUCLOUD_SECRET_KEY string Get BAIDUCLOUD_SECRET_KEY per this guide https://cloud.baidu.com/doc/Reference/s/9jwvz2egb - -h, --help help for terraform-baidu - --name baidu The name of Terraform Provider for Baidu Cloud, default is baidu (default "baidu") -``` - -### Options inherited from parent commands - -``` - -y, --yes Assume yes for all user prompts -``` - -### SEE ALSO - -* [vela provider add](vela_provider_add) - Authenticate Terraform Cloud Provider - -#### Go Back to [CLI Commands](vela) Homepage. - - -###### Auto generated by spf13/cobra on 19-Apr-2022, refer to [script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen). diff --git a/versioned_docs/version-v1.6/cli/vela_provider_add_terraform-gcp.md b/versioned_docs/version-v1.6/cli/vela_provider_add_terraform-gcp.md deleted file mode 100644 index b3c82cac..00000000 --- a/versioned_docs/version-v1.6/cli/vela_provider_add_terraform-gcp.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: vela provider add terraform-gcp ---- - -Authenticate Terraform Cloud Provider terraform-gcp - -### Synopsis - -Authenticate Terraform Cloud Provider terraform-gcp by creating a credential secret and a Terraform Controller Provider - -``` -vela provider add terraform-gcp [flags] -``` - -### Examples - -``` -vela provider add terraform-gcp -``` - -### Options - -``` - --GOOGLE_CREDENTIALS string Get gcpCredentialsJSON per this guide https://registry.terraform.io/providers/hashicorp/google/latest/docs/guides/getting_started#adding-credentials - --GOOGLE_PROJECT string Set gcpProject per this guide https://registry.terraform.io/providers/hashicorp/google/latest/docs/guides/getting_started#configuring-the-provider - --GOOGLE_REGION string Get GOOGLE_REGION by picking one RegionId from Google Cloud region list https://cloud.google.com/compute/docs/regions-zones - -h, --help help for terraform-gcp - --name default The name of Terraform Provider for GCP, default is default (default "gcp") -``` - -### Options inherited from parent commands - -``` - -y, --yes Assume yes for all user prompts -``` - -### SEE ALSO - -* [vela provider add](vela_provider_add) - Authenticate Terraform Cloud Provider - -#### Go Back to [CLI Commands](vela) Homepage. - - -###### Auto generated by spf13/cobra on 19-Apr-2022, refer to [script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen). diff --git a/versioned_docs/version-v1.6/cli/vela_provider_add_terraform-tencent.md b/versioned_docs/version-v1.6/cli/vela_provider_add_terraform-tencent.md deleted file mode 100644 index a481b570..00000000 --- a/versioned_docs/version-v1.6/cli/vela_provider_add_terraform-tencent.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -title: vela provider add terraform-tencent ---- - -Authenticate Terraform Cloud Provider terraform-tencent - -### Synopsis - -Authenticate Terraform Cloud Provider terraform-tencent by creating a credential secret and a Terraform Controller Provider - -``` -vela provider add terraform-tencent [flags] -``` - -### Examples - -``` -vela provider add terraform-tencent -``` - -### Options - -``` - --TENCENTCLOUD_REGION string Get TENCENTCLOUD_REGION by picking one RegionId from Tencent Cloud region list https://cloud.tencent.com/document/api/1140/40509#.E5.9C.B0.E5.9F.9F.E5.88.97.E8.A1.A8 - --TENCENTCLOUD_SECRET_ID string Get TENCENTCLOUD_SECRET_ID per this guide https://cloud.tencent.com/document/product/1213/67093 - --TENCENTCLOUD_SECRET_KEY string Get TENCENTCLOUD_SECRET_KEY per this guide https://cloud.tencent.com/document/product/1213/67093 - -h, --help help for terraform-tencent - --name default The name of Terraform Provider for Tencent Cloud, default is default (default "tencent") -``` - -### Options inherited from parent commands - -``` - -y, --yes Assume yes for all user prompts -``` - -### SEE ALSO - -* [vela provider add](vela_provider_add) - Authenticate Terraform Cloud Provider - -#### Go Back to [CLI Commands](vela) Homepage. - - -###### Auto generated by spf13/cobra on 19-Apr-2022, refer to [script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen). diff --git a/versioned_docs/version-v1.6/cli/vela_provider_add_terraform-ucloud.md b/versioned_docs/version-v1.6/cli/vela_provider_add_terraform-ucloud.md deleted file mode 100644 index 124e9688..00000000 --- a/versioned_docs/version-v1.6/cli/vela_provider_add_terraform-ucloud.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -title: vela provider add terraform-ucloud ---- - -Authenticate Terraform Cloud Provider terraform-ucloud - -### Synopsis - -Authenticate Terraform Cloud Provider terraform-ucloud by creating a credential secret and a Terraform Controller Provider - -``` -vela provider add terraform-ucloud [flags] -``` - -### Examples - -``` -vela provider add terraform-ucloud -``` - -### Options - -``` - --UCLOUD_PRIVATE_KEY string Get UCLOUD_PRIVATE_KEY per this guide https://docs.ucloud.cn/terraform/quickstart - --UCLOUD_PROJECT_ID string Get UCLOUD_PROJECT_ID per this guide https://docs.ucloud.cn/terraform/quickstart - --UCLOUD_PUBLIC_KEY string Get UCLOUD_PUBLIC_KEY per this guide https://docs.ucloud.cn/terraform/quickstart - --UCLOUD_REGION string Get UCLOUD_REGION by picking one RegionId from UCloud region list https://docs.ucloud.cn/api/summary/regionlist - -h, --help help for terraform-ucloud - --name default The name of Terraform Provider for Ucloud Cloud, default is default (default "ucloud") -``` - -### Options inherited from parent commands - -``` - -y, --yes Assume yes for all user prompts -``` - -### SEE ALSO - -* [vela provider add](vela_provider_add) - Authenticate Terraform Cloud Provider - -#### Go Back to [CLI Commands](vela) Homepage. - - -###### Auto generated by spf13/cobra on 19-Apr-2022, refer to [script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen). diff --git a/versioned_docs/version-v1.6/cli/vela_provider_delete.md b/versioned_docs/version-v1.6/cli/vela_provider_delete.md deleted file mode 100644 index c8f46b11..00000000 --- a/versioned_docs/version-v1.6/cli/vela_provider_delete.md +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: vela provider delete ---- - -Delete Terraform Cloud Provider - -### Synopsis - -Delete Terraform Cloud Provider - -``` -vela provider delete [flags] -``` - -### Examples - -``` -vela provider delete --name -``` - -### Options - -``` - -h, --help help for delete -``` - -### Options inherited from parent commands - -``` - -y, --yes Assume yes for all user prompts -``` - -### SEE ALSO - -* [vela provider](vela_provider) - Authenticate Terraform Cloud Providers - -#### Go Back to [CLI Commands](vela) Homepage. - - -###### Auto generated by [spf13/cobra script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen). diff --git a/versioned_docs/version-v1.6/cli/vela_provider_delete_terraform-alibaba.md b/versioned_docs/version-v1.6/cli/vela_provider_delete_terraform-alibaba.md deleted file mode 100644 index 4392bd3c..00000000 --- a/versioned_docs/version-v1.6/cli/vela_provider_delete_terraform-alibaba.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: vela provider delete terraform-alibaba ---- - -Delete Terraform Cloud Provider terraform-alibaba - -### Synopsis - -Delete Terraform Cloud Provider terraform-alibaba - -``` -vela provider delete terraform-alibaba [flags] -``` - -### Examples - -``` -vela provider delete terraform-alibaba -``` - -### Options - -``` - -h, --help help for terraform-alibaba - --name default The name of Terraform Provider for Alibaba Cloud, default is default (default "default") -``` - -### Options inherited from parent commands - -``` - -y, --yes Assume yes for all user prompts -``` - -### SEE ALSO - -* [vela provider delete](vela_provider_delete) - Delete Terraform Cloud Provider - -#### Go Back to [CLI Commands](vela) Homepage. - - -###### Auto generated by spf13/cobra on 19-Apr-2022, refer to [script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen). diff --git a/versioned_docs/version-v1.6/cli/vela_provider_delete_terraform-aws.md b/versioned_docs/version-v1.6/cli/vela_provider_delete_terraform-aws.md deleted file mode 100644 index 1bdc8649..00000000 --- a/versioned_docs/version-v1.6/cli/vela_provider_delete_terraform-aws.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: vela provider delete terraform-aws ---- - -Delete Terraform Cloud Provider terraform-aws - -### Synopsis - -Delete Terraform Cloud Provider terraform-aws - -``` -vela provider delete terraform-aws [flags] -``` - -### Examples - -``` -vela provider delete terraform-aws -``` - -### Options - -``` - -h, --help help for terraform-aws - --name default The name of Terraform Provider for AWS, default is default (default "aws") -``` - -### Options inherited from parent commands - -``` - -y, --yes Assume yes for all user prompts -``` - -### SEE ALSO - -* [vela provider delete](vela_provider_delete) - Delete Terraform Cloud Provider - -#### Go Back to [CLI Commands](vela) Homepage. - - -###### Auto generated by spf13/cobra on 19-Apr-2022, refer to [script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen). diff --git a/versioned_docs/version-v1.6/cli/vela_provider_delete_terraform-azure.md b/versioned_docs/version-v1.6/cli/vela_provider_delete_terraform-azure.md deleted file mode 100644 index 6178f85d..00000000 --- a/versioned_docs/version-v1.6/cli/vela_provider_delete_terraform-azure.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: vela provider delete terraform-azure ---- - -Delete Terraform Cloud Provider terraform-azure - -### Synopsis - -Delete Terraform Cloud Provider terraform-azure - -``` -vela provider delete terraform-azure [flags] -``` - -### Examples - -``` -vela provider delete terraform-azure -``` - -### Options - -``` - -h, --help help for terraform-azure - --name azure The name of Terraform Provider for Azure, default is azure (default "azure") -``` - -### Options inherited from parent commands - -``` - -y, --yes Assume yes for all user prompts -``` - -### SEE ALSO - -* [vela provider delete](vela_provider_delete) - Delete Terraform Cloud Provider - -#### Go Back to [CLI Commands](vela) Homepage. - - -###### Auto generated by spf13/cobra on 19-Apr-2022, refer to [script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen). diff --git a/versioned_docs/version-v1.6/cli/vela_provider_delete_terraform-baidu.md b/versioned_docs/version-v1.6/cli/vela_provider_delete_terraform-baidu.md deleted file mode 100644 index 643e23ad..00000000 --- a/versioned_docs/version-v1.6/cli/vela_provider_delete_terraform-baidu.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: vela provider delete terraform-baidu ---- - -Delete Terraform Cloud Provider terraform-baidu - -### Synopsis - -Delete Terraform Cloud Provider terraform-baidu - -``` -vela provider delete terraform-baidu [flags] -``` - -### Examples - -``` -vela provider delete terraform-baidu -``` - -### Options - -``` - -h, --help help for terraform-baidu - --name baidu The name of Terraform Provider for Baidu Cloud, default is baidu (default "baidu") -``` - -### Options inherited from parent commands - -``` - -y, --yes Assume yes for all user prompts -``` - -### SEE ALSO - -* [vela provider delete](vela_provider_delete) - Delete Terraform Cloud Provider - -#### Go Back to [CLI Commands](vela) Homepage. - - -###### Auto generated by spf13/cobra on 19-Apr-2022, refer to [script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen). diff --git a/versioned_docs/version-v1.6/cli/vela_provider_delete_terraform-gcp.md b/versioned_docs/version-v1.6/cli/vela_provider_delete_terraform-gcp.md deleted file mode 100644 index b4c789d0..00000000 --- a/versioned_docs/version-v1.6/cli/vela_provider_delete_terraform-gcp.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: vela provider delete terraform-gcp ---- - -Delete Terraform Cloud Provider terraform-gcp - -### Synopsis - -Delete Terraform Cloud Provider terraform-gcp - -``` -vela provider delete terraform-gcp [flags] -``` - -### Examples - -``` -vela provider delete terraform-gcp -``` - -### Options - -``` - -h, --help help for terraform-gcp - --name default The name of Terraform Provider for GCP, default is default (default "gcp") -``` - -### Options inherited from parent commands - -``` - -y, --yes Assume yes for all user prompts -``` - -### SEE ALSO - -* [vela provider delete](vela_provider_delete) - Delete Terraform Cloud Provider - -#### Go Back to [CLI Commands](vela) Homepage. - - -###### Auto generated by spf13/cobra on 19-Apr-2022, refer to [script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen). diff --git a/versioned_docs/version-v1.6/cli/vela_provider_delete_terraform-tencent.md b/versioned_docs/version-v1.6/cli/vela_provider_delete_terraform-tencent.md deleted file mode 100644 index bc0f0d41..00000000 --- a/versioned_docs/version-v1.6/cli/vela_provider_delete_terraform-tencent.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: vela provider delete terraform-tencent ---- - -Delete Terraform Cloud Provider terraform-tencent - -### Synopsis - -Delete Terraform Cloud Provider terraform-tencent - -``` -vela provider delete terraform-tencent [flags] -``` - -### Examples - -``` -vela provider delete terraform-tencent -``` - -### Options - -``` - -h, --help help for terraform-tencent - --name default The name of Terraform Provider for Tencent Cloud, default is default (default "tencent") -``` - -### Options inherited from parent commands - -``` - -y, --yes Assume yes for all user prompts -``` - -### SEE ALSO - -* [vela provider delete](vela_provider_delete) - Delete Terraform Cloud Provider - -#### Go Back to [CLI Commands](vela) Homepage. - - -###### Auto generated by spf13/cobra on 19-Apr-2022, refer to [script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen). diff --git a/versioned_docs/version-v1.6/cli/vela_provider_delete_terraform-ucloud.md b/versioned_docs/version-v1.6/cli/vela_provider_delete_terraform-ucloud.md deleted file mode 100644 index 526945f4..00000000 --- a/versioned_docs/version-v1.6/cli/vela_provider_delete_terraform-ucloud.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: vela provider delete terraform-ucloud ---- - -Delete Terraform Cloud Provider terraform-ucloud - -### Synopsis - -Delete Terraform Cloud Provider terraform-ucloud - -``` -vela provider delete terraform-ucloud [flags] -``` - -### Examples - -``` -vela provider delete terraform-ucloud -``` - -### Options - -``` - -h, --help help for terraform-ucloud - --name default The name of Terraform Provider for Ucloud Cloud, default is default (default "ucloud") -``` - -### Options inherited from parent commands - -``` - -y, --yes Assume yes for all user prompts -``` - -### SEE ALSO - -* [vela provider delete](vela_provider_delete) - Delete Terraform Cloud Provider - -#### Go Back to [CLI Commands](vela) Homepage. - - -###### Auto generated by spf13/cobra on 19-Apr-2022, refer to [script in KubeVela](https://github.com/kubevela/kubevela/tree/master/hack/docgen). diff --git a/versioned_docs/version-v1.6/platform-engineers/openapi/overview.md b/versioned_docs/version-v1.6/platform-engineers/openapi/overview.md index a16354f8..6ffcd51e 100644 --- a/versioned_docs/version-v1.6/platform-engineers/openapi/overview.md +++ b/versioned_docs/version-v1.6/platform-engineers/openapi/overview.md @@ -168,3 +168,7 @@ Refer to [Kubevela API 1.4](https://kubevela.stoplight.io/docs/kubevela/uz7fzdxt ### 1.5 Refer to [KubeVela API 1.5](https://kubevela.stoplight.io/docs/kubevela/pi1st0zdzoejp-kube-vela-api-1-5) + +### 1.6 + +Refer to [KubeVela API 1.6](https://kubevela.stoplight.io/docs/kubevela/178jb51mk763f-kube-vela-api-1-6) diff --git a/versioned_docs/version-v1.6/reference/addons/overview.md b/versioned_docs/version-v1.6/reference/addons/overview.md index 79a3a156..d0f876dd 100644 --- a/versioned_docs/version-v1.6/reference/addons/overview.md +++ b/versioned_docs/version-v1.6/reference/addons/overview.md @@ -11,26 +11,27 @@ There's an community addon registry (https://addons.kubevela.net) maintained by * [Traefik](./traefik): Traefik is a modern HTTP reverse proxy and load balancer made to deploy microservices with ease. * [Rollout](./rollout): Provide a capability rollout the applicaton. * [Pyroscope](./pyroscope): Pyroscope is an open source platform, consisting of server and agent. It allows the user to collect, store, and query the profiling data in a CPU and disk efficient way. -* [AI addon](./ai) Introduction modeling-training and modeling-serving addon. +* [AI](./ai) Introduction modeling-training and modeling-serving addon. * [Vegeta](./vegeta) Vegeta is a versatile HTTP load testing tool built out of a need to drill HTTP services with a constant request rate. It can be used both as a command line utility and a library. * [OCM Cluster-Gateway Manager](./ocm-gateway-manager-addon) An operator component into the hub cluster that help the administrator to easily operate the configuration of cluster-gateway instances via "ClusterGatewayConfiguration"custom resource. *WARNING* this addon will restart the cluster-gateway instances upon the first-time installation. * [OCM Hub Control Plane](./ocm-hub-control-plane) Help you to initiate and install the [cluster manager](https://open-cluster-management.io/getting-started/core/cluster-manager/)(i.e. OCM's control plane) components into the hosting cluster where your KubeVela control plane is running. -* [Vela prism](./vela-prism) Provide API Extensions to the core [KubeVela](https://github.com/kubevela/kubevela). -* [Cert manager](./cert-manager) Add certificates and certificate issuers as resource types in Kubernetes clusters, and simplifies the process of obtaining, renewing and using those certificates. -* [KubeVela doc](./kubevela-io) Help you to read the KubeVela document in your cluster which can be air-gaped environment. -* [Flink kubernetes operator](./flink-kubernetes-operator) A Kubernetes operator for Apache Flink(https://github.com/apache/flink-kubernetes-operator). -* [dex](./dex) Provide [dex](https://github.com/dexidp/dex) login for VelaUX. +* [Vela Prism](./vela-prism) Provide API Extensions to the core [KubeVela](https://github.com/kubevela/kubevela). +* [Cert Manager](./cert-manager) Add certificates and certificate issuers as resource types in Kubernetes clusters, and simplifies the process of obtaining, renewing and using those certificates. +* [KubeVela Website](./kubevela-io) Help you to read the KubeVela document in your cluster which can be air-gaped environment. +* [Flink Operator](./flink-kubernetes-operator) A Kubernetes operator for Apache Flink(https://github.com/apache/flink-kubernetes-operator). +* [Dex](./dex) Provide [dex](https://github.com/dexidp/dex) login for VelaUX. * [Kruise Rollout](./kruise-rollout): [OpenKruise rollout](https://github.com/openkruise/rollouts) supports canary rollout for native deployment, stateful-set and OpenKruise [cloneset](https://openkruise.io/docs/user-manuals/cloneset/). -* [ingress-nginx](./nginx-ingress-controller): An Ingress controller for Kubernetes using NGINX as a reverse proxy and load balancer. +* [Nginx Ingress Controller](./nginx-ingress-controller): An Ingress controller for Kubernetes using NGINX as a reverse proxy and load balancer. * [ChartMuseum](./chartmuseum): An open-source and easy to deploy Helm Chart Repository server. -* [trivy-operator](./trivy-operator): Provides a vulnerability scanner that continuously scans containers deployed in a Kubernetes cluster. -* [prometheus-server](../../platform-engineers/operations/observability): Collects metrics from configured targets at given intervals, evaluates rule expressions, displays the results, and can trigger alerts if some condition is observed to be true. -* [node-exporter](../../platform-engineers/operations/observability): Prometheus exporter for hardware and OS metrics exposed by *NIX kernels, written in Go with pluggable metric collectors. -* [mysql-exporter](./mysql-exporter): Prometheus exporter for MySQL server metrics. -* [grafana](../../platform-engineers/operations/observability): Grafana is an open source, feature rich metrics dashboard and graph editor for Graphite, Elasticsearch, OpenTSDB, Prometheus and InfluxDB. -* [loki](../../platform-engineers/operations/o11y/logging): A log aggregation system designed to store and query logs from all your applications and infrastructure. -* [kube-state-metrics](../../platform-engineers/operations/observability): A simple service that listens to the Kubernetes API server and generates metrics about the state of the objects. +* [Trivy Operator](./trivy-operator): Provides a vulnerability scanner that continuously scans containers deployed in a Kubernetes cluster. +* [Prometheus Server](../../platform-engineers/operations/observability): Collects metrics from configured targets at given intervals, evaluates rule expressions, displays the results, and can trigger alerts if some condition is observed to be true. +* [Node Exporter](../../platform-engineers/operations/observability): Prometheus exporter for hardware and OS metrics exposed by *NIX kernels, written in Go with pluggable metric collectors. +* [Mysql Exporter](./mysql-exporter): Prometheus exporter for MySQL server metrics. +* [Grafana](../../platform-engineers/operations/observability): Grafana is an open source, feature rich metrics dashboard and graph editor for Graphite, Elasticsearch, OpenTSDB, Prometheus and InfluxDB. +* [Loki](../../platform-engineers/operations/o11y/logging): A log aggregation system designed to store and query logs from all your applications and infrastructure. +* [Kube State Metrics](../../platform-engineers/operations/observability): A simple service that listens to the Kubernetes API server and generates metrics about the state of the objects. * [netlify](./netlify): Netlify is a SaaS platform that can serve website especially for frontend service, it provides free allowances that was pretty cool to be used for demo and test. -* [cloudshell](../../tutorials/cloud-shell): Set up a web terminal and cloud shell intended for a kubernetes-native environment. -* [terraform-ec](./terraform-ec) Terraform provider addon for Elastic Cloud. +* [Cloud Shell](../../tutorials/cloud-shell): Set up a web terminal and cloud shell intended for a kubernetes-native environment. +* [Terraform](./terraform) Terraform provider addon to provide the capability to deploy the cloud resource. + **If you want to make your own addon please refer to [doc](../../platform-engineers/addon/intro.md).** \ No newline at end of file diff --git a/versioned_docs/version-v1.6/reference/addons/terraform-ec.md b/versioned_docs/version-v1.6/reference/addons/terraform-ec.md index 27c70815..81bb91ae 100644 --- a/versioned_docs/version-v1.6/reference/addons/terraform-ec.md +++ b/versioned_docs/version-v1.6/reference/addons/terraform-ec.md @@ -40,33 +40,12 @@ Then, enable Terraform provider addon for Elastic Cloud. vela addon enable terraform-ec ``` -You can also disable, upgrade, check status of an addon by `vela addon` command. +You can also disable, upgrade, and check the status of an addon by `vela addon` command. -After that, you can create credential for the provider. Find supported flags using following command: +After that, you can create credentials for the provider. Refer to the following command: ```shell -$ vela provider add terraform-ec -h -Authenticate Terraform Cloud Provider terraform-ec by creating a credential secret and a Terraform Controller Provider - -Usage: - vela provider add terraform-ec [flags] - -Examples: -vela provider add terraform-ec - -Flags: - --EC_API_KEY string Get EC_API_KEY per this guide https://registry.terraform.io/providers/elastic/ec/latest/docs - -h, --help help for terraform-ec - --name string The name of Terraform Provider for Elastic Cloud (default "ec") - -Global Flags: - -y, --yes Assume yes for all user prompts -``` - -Now, you can authenticate the Terraform provider with `--EC_API_KEY`. - -```shell -vela provider add terraform-ec --EC_API_KEY= +vela config create -t terraform-ec EC_API_KEY= ``` ## Find supported components diff --git a/versioned_docs/version-v1.6/reference/addons/terraform.md b/versioned_docs/version-v1.6/reference/addons/terraform.md index 08feff22..d5b3a781 100644 --- a/versioned_docs/version-v1.6/reference/addons/terraform.md +++ b/versioned_docs/version-v1.6/reference/addons/terraform.md @@ -6,15 +6,15 @@ To provision cloud resources, you can use terraform along with related cloud pro ## Enable Terraform addon - ```shell - vela addon enable terraform - ``` +```shell +vela addon enable terraform +``` -After terraform addon enabled, you will have a basic capability to create cloud resource in CRD ways. Then you can enable a terraform provider addon for specific cloud.s +After Terraform addon is enabled, you will have a basic capability to create cloud resources in CRD ways. Then you can enable a terraform provider addon for specific clouds. ## Enable Terraform Provider addon -KubeVela can support following cloud providers by enabling the Terraform provider addons. +KubeVela can support the following cloud providers by enabling the Terraform provider addons. ```shell $ vela addon list | grep terraform- @@ -30,78 +30,23 @@ terraform-ucloud KubeVela Kubernetes Terraform Controller Provider for To enable one of them, use the following command: ```shell -$ vela addon enable terraform- +vela addon enable terraform- ``` -You can also disable, upgrade, check status of an addon by command `vela addon`. - -## Authenticate Terraform Provider - -After any of the terraform provider addon enabled, you can create credential for them by `vela provider` command. - -### Add Credential - -Each Terraform provider can be authenticated by the command as below. - -```shell -$ vela provider add -h -Authenticate Terraform Cloud Provider by creating a credential secret and a Terraform Controller Provider - -Usage: - vela provider add [flags] - vela provider add [command] - -Examples: -vela provider add - -Available Commands: - terraform-alibaba Authenticate Terraform Cloud Provider terraform-alibaba - terraform-aws Authenticate Terraform Cloud Provider terraform-aws - terraform-azure Authenticate Terraform Cloud Provider terraform-azure - terraform-baidu Authenticate Terraform Cloud Provider terraform-baidu - terraform-gcp Authenticate Terraform Cloud Provider terraform-gcp - terraform-tencent Authenticate Terraform Cloud Provider terraform-tencent - terraform-ucloud Authenticate Terraform Cloud Provider terraform-ucloud -``` - -For example, let's authenticate the Terraform provider `terraform-aws`. - -Here is the help message for authenticate the `terraform-aws`. - -``` -$ vela provider add terraform-aws -h -Authenticate Terraform Cloud Provider terraform-aws by creating a credential secret and a Terraform Controller Provider - -Usage: - vela provider add terraform-aws [flags] - -Examples: -vela provider add terraform-aws - -Flags: - --AWS_ACCESS_KEY_ID string Get AWS_ACCESS_KEY_ID per https://aws.amazon.com/blogs/security/wheres-my-secret-access-key/ - --AWS_DEFAULT_REGION string Choose one of Code form region list https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html#concepts-available-regions - --AWS_SECRET_ACCESS_KEY string Get AWS_SECRET_ACCESS_KEY per https://aws.amazon.com/blogs/security/wheres-my-secret-access-key/ - --AWS_SESSION_TOKEN string Get AWS_SESSION_TOKEN per https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp_use-resources.html - -h, --help help for terraform-aws - --name default The name of Terraform Provider for AWS, default is default (default "aws") - -Global Flags: - -y, --yes Assume yes for all user prompts -``` +You can also disable, upgrade, and check the status of an addon by command `vela addon`. ### Authenticate a Terraform provider +View the supported Terraform providers. + ```shell -$ vela provider add terraform-aws --AWS_ACCESS_KEY_ID=xxx --AWS_SECRET_ACCESS_KEY=yyy --AWS_DEFAULT_REGION=us-east-1 +vela config-template list | grep terraform ``` -Without setting a provider name by `--name`, an AWS Terraform provider named `aws` will be created. - -You also create multiple providers by specifying the `--name` flag. +For example to create a provider config for AWS. ```shell -$ vela provider add terraform-aws --name aws-dev --AWS_ACCESS_KEY_ID=xxx --AWS_SECRET_ACCESS_KEY=yyy --AWS_DEFAULT_REGION=us-east-1 +vela config create aws -t terraform-aws AWS_ACCESS_KEY_ID=xxx AWS_SECRET_ACCESS_KEY=yyy AWS_DEFAULT_REGION=us-east-1 ``` ### Provision cloud resources diff --git a/versioned_docs/version-v1.6/tutorials/consume-cloud-services.md b/versioned_docs/version-v1.6/tutorials/consume-cloud-services.md index 0933660f..f9b218ff 100644 --- a/versioned_docs/version-v1.6/tutorials/consume-cloud-services.md +++ b/versioned_docs/version-v1.6/tutorials/consume-cloud-services.md @@ -59,6 +59,18 @@ For different vendors, these parameters update accordingly. All cloud resources ### Provision by Creating Application +First, Prepare a available cloud provider. Let's list the exist configs, If exist you could ignore this step. + +```bash +vela config list -t terraform-alibaba +``` + +If not exist, you can refer to this command to create a default provider: + +```bash +vela config create default -t terraform-alibaba ALICLOUD_REGION= ALICLOUD_SECRET_KEY= ALICLOUD_ACCESS_KEY= +``` + Use the following Application to provision an OSS bucket: ```yaml