Docs: add how-to for Target
Signed-off-by: Yin Da <yd219913@alibaba-inc.com>
|
|
@ -1,3 +1,37 @@
|
|||
---
|
||||
title: Overview
|
||||
title: Manage Targets
|
||||
---
|
||||
|
||||
To deploy application components into different places, VelaUX provides **Target** for user to manage their deploy destinations like clusters or namespaces.
|
||||
|
||||
## Cluster
|
||||
|
||||
First, before configuring Target, you need to ensure your clusters have been joined. You can check your clusters in the Cluster page. The **local** cluster represents the cluster that KubeVela control plane is running on. If you have other clusters, you can either connect those clusters directly to KubeVela by providing their KubeConfig, or join clusters from your cloud provider such as Alibaba Cloud.
|
||||
|
||||

|
||||
|
||||
After adding clusters in KubeVela, you can edit their descriptions or disconnect them when there is no Application running on them.
|
||||
|
||||
## Create Target
|
||||
|
||||
Now you can creating Target for deploying your applications. A target identifies a specific namespace in one cluster. If the namespace does not exist in the cluster, you can also create the namespace by clicking the **New** button.
|
||||
|
||||

|
||||
|
||||
If you want to use the cloud resource (such as RDS from alibaba cloud), you can also set the *Shared Variables* and fill the provider name and region name in it. Make sure you have related terraform addon installed already.
|
||||
|
||||
## Bind Targets in Environment
|
||||
|
||||
Go to **Environment** page and now you can bind your created targets in a environment.
|
||||
|
||||

|
||||
|
||||
## Create Application with Environment
|
||||
|
||||
Now you can use the environent which was bound to the targets just created.
|
||||
|
||||

|
||||
|
||||
In the newly created application, you will see two targets contained in the workflow, which means when you deploy this application, the component will be dispatch to both targets.
|
||||
|
||||

|
||||
|
|
|
|||
|
After Width: | Height: | Size: 218 KiB |
|
After Width: | Height: | Size: 132 KiB |
|
After Width: | Height: | Size: 184 KiB |
|
After Width: | Height: | Size: 97 KiB |
|
After Width: | Height: | Size: 107 KiB |
|
|
@ -1,3 +1,38 @@
|
|||
---
|
||||
title: Overview
|
||||
title: 管理部署目标
|
||||
---
|
||||
|
||||
为了将应用组件部署在不同的地方,VelaUX 提供了 **部署目标(Target)** 方便用户管理要部署的具体位置,比如集群或者命名空间。
|
||||
|
||||
## 集群
|
||||
|
||||
首先,在配置部署目标之前,你需要确认你需要使用的集群已经加入到 KubeVela 的管控面中。你可以在 Cluster 页面查看你的集群。**local** 集群会默认加入其中,它代表了 KubeVela 管控组件所在的集群。如果你有其他的集群,你可以通过提供 KubeConfig 的形式将集群加入其中,或者是通过接入你的云服务厂商(如阿里云)来接入对应平台上的集群。
|
||||
|
||||

|
||||
|
||||
|
||||
在向 KubeVela 添加完集群之后,你可以编辑它的基本描述信息,或者在没有应用使用它的时候将它从 KubeVela 管控平台上移除。
|
||||
|
||||
## 创建部署目标
|
||||
|
||||
现在你可以为你的应用创建部署目标了。一个部署目标包含了一个集群中的一个特定命名空间。如果命名空间在集群中还不存在,你可以通过点击 **New** 按钮进行创建。
|
||||
|
||||

|
||||
|
||||
如果你想要使用云资源(如阿里云上的 RDS 数据库),你可以设置在 *Shared Variables* 中设置云服务厂商的名字(provider name)以及区域名称(region name)。在使用云服务厂商之前,你需要确保相关的 Terraform 组件已经安装完成。
|
||||
|
||||
## 将部署目标绑定在环境中
|
||||
|
||||
进入到 **Environment** 页面,你可以将刚刚创建好的部署目标绑定在环境中。
|
||||
|
||||

|
||||
|
||||
## 在环境中创建应用
|
||||
|
||||
现在你可以在含有部署目标的环境中创建应用了。
|
||||
|
||||

|
||||
|
||||
在新创建的应用中,你可以看到有两个部署目标包含在工作流(Workflow)中,这意味着当你部署该应用时,里面的组件会被分发到两个位置(两个集群的两个命名空间中)。
|
||||
|
||||

|
||||
|
|
|
|||
|
After Width: | Height: | Size: 218 KiB |
|
After Width: | Height: | Size: 132 KiB |
|
After Width: | Height: | Size: 184 KiB |
|
After Width: | Height: | Size: 97 KiB |
|
After Width: | Height: | Size: 107 KiB |
|
|
@ -1,3 +1,38 @@
|
|||
---
|
||||
title: Overview
|
||||
title: 管理部署目标
|
||||
---
|
||||
|
||||
为了将应用组件部署在不同的地方,VelaUX 提供了 **部署目标(Target)** 方便用户管理要部署的具体位置,比如集群或者命名空间。
|
||||
|
||||
## 集群
|
||||
|
||||
首先,在配置部署目标之前,你需要确认你需要使用的集群已经加入到 KubeVela 的管控面种。你可以通过在 Cluster 页面查看你的集群。**local** 集群会默认加入其中,它代表了 KubeVela 管控组件所在的集群。如果你有其他的集群,你可以通过提供 KubeConfig 的形式将集群加入其中,或者是通过接入你的云服务厂商(如阿里云)来接入对应平台上的集群。
|
||||
|
||||

|
||||
|
||||
|
||||
在向 KubeVela 添加完集群之后,你可以编辑它,或者在没有应用使用它的时候将它从 KubeVela 管控平台上移除。
|
||||
|
||||
## 创建部署目标
|
||||
|
||||
现在你可以为你的应用创建部署目标了。一个部署目标包含了一个集群中的特定一个命名空间。如果命名空间在集群中还不存在,你可以通过点击 **New** 按钮进行创建。
|
||||
|
||||

|
||||
|
||||
如果你想要使用云资源(如阿里云上的 RDS 数据库),你可以设置在 *Shared Variables* 中设置云服务厂商的名字(provider name)以及区域名称(region name)。在使用云服务厂商之前,你需要确保相关的 Terraform 组件已经安装完成。
|
||||
|
||||
## 将部署目标绑定在环境中
|
||||
|
||||
进入到 **Environment** 页面,你可以将刚刚创建好的部署目标绑定在环境中。
|
||||
|
||||

|
||||
|
||||
## 在环境中创建应用
|
||||
|
||||
现在你可以在含有部署目标的环境中创建应用了。
|
||||
|
||||

|
||||
|
||||
在新创建的应用中,你可以看到有两个部署目标包含在工作流(Workflow)中,这意味着当你部署该应用时,里面的组件会被分发到两个位置(两个集群的两个命名空间中)。
|
||||
|
||||

|
||||
|
|
|
|||
|
|
@ -9,10 +9,10 @@ title: 云资源插件
|
|||
|
||||
## 阿里云 Terraform Provider 插件
|
||||
|
||||
执行如下命令开启 Terraform 对阿里云的支持,可以[创建和消费云资源](../../end-user/components/cloud-services/provision-and-consume-cloud-services):
|
||||
执行如下命令开启 Terraform 对阿里云的支持,可以[创建和消费云资源](../../end-user/components/cloud-services/provision-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) 设置。
|
||||
其中,请参考[如何获取 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>
|
||||
|
|
@ -20,9 +20,9 @@ title: 云资源插件
|
|||
|
||||
## Azure Terraform Provider 插件
|
||||
|
||||
执行如下命令开启 Terraform 对 Azure 的支持,可以[创建和消费云资源](../../end-user/components/cloud-services/provision-and-consume-cloud-services):
|
||||
执行如下命令开启 Terraform 对 Azure 的支持,可以[创建和消费云资源](../../end-user/components/cloud-services/provision-and-consume-cloud-services):
|
||||
|
||||
参考 [Authenticate Terraform to Azure](https://docs.microsoft.com/en-us/azure/developer/terraform/authenticate-to-azure?tabs=bash),设置如下参数。
|
||||
参考 [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>
|
||||
|
|
@ -30,9 +30,9 @@ title: 云资源插件
|
|||
|
||||
## AWS Terraform Provider 插件
|
||||
|
||||
执行如下命令开启 Terraform 对 AWS 的支持,可以[创建和消费云资源](../../end-user/components/cloud-services/provision-and-consume-cloud-services):
|
||||
执行如下命令开启 Terraform 对 AWS 的支持,可以[创建和消费云资源](../../end-user/components/cloud-services/provision-and-consume-cloud-services):
|
||||
|
||||
参考 [Authenticate Terraform to AWS](https://registry.terraform.io/providers/hashicorp/aws/latest/docs#environment-variables),设置如下参数。
|
||||
参考 [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>
|
||||
|
|
|
|||
|
After Width: | Height: | Size: 218 KiB |
|
After Width: | Height: | Size: 132 KiB |
|
After Width: | Height: | Size: 184 KiB |
|
After Width: | Height: | Size: 97 KiB |
|
After Width: | Height: | Size: 107 KiB |
|
|
@ -69,9 +69,9 @@ module.exports = {
|
|||
// {
|
||||
// "Manage environment": ["how-to/dashboard/environment/overview"],
|
||||
// },
|
||||
// {
|
||||
// "Manage target": ["how-to/dashboard/target/overview"],
|
||||
// },
|
||||
{
|
||||
"Manage target": ["how-to/dashboard/target/overview"],
|
||||
},
|
||||
// {
|
||||
// "Manage cluster": [
|
||||
// "how-to/dashboard/cluster/overview",
|
||||
|
|
|
|||
|
|
@ -1,3 +1,37 @@
|
|||
---
|
||||
title: Overview
|
||||
title: Manage Targets
|
||||
---
|
||||
|
||||
To deploy application components into different places, VelaUX provides **Target** for user to manage their deploy destinations like clusters or namespaces.
|
||||
|
||||
## Cluster
|
||||
|
||||
First, before configuring Target, you need to ensure your clusters have been joined. You can check your clusters in the Cluster page. The **local** cluster represents the cluster that KubeVela control plane is running on. If you have other clusters, you can either connect those clusters directly to KubeVela by providing their KubeConfig, or join clusters from your cloud provider such as Alibaba Cloud.
|
||||
|
||||

|
||||
|
||||
After adding clusters in KubeVela, you can edit their descriptions or disconnect them when there is no Application running on them.
|
||||
|
||||
## Create Target
|
||||
|
||||
Now you can creating Target for deploying your applications. A target identifies a specific namespace in one cluster. If the namespace does not exist in the cluster, you can also create the namespace by clicking the **New** button.
|
||||
|
||||

|
||||
|
||||
If you want to use the cloud resource (such as RDS from alibaba cloud), you can also set the *Shared Variables* and fill the provider name and region name in it. Make sure you have related terraform addon installed already.
|
||||
|
||||
## Bind Targets in Environment
|
||||
|
||||
Go to **Environment** page and now you can bind your created targets in a environment.
|
||||
|
||||

|
||||
|
||||
## Create Application with Environment
|
||||
|
||||
Now you can use the environent which was bound to the targets just created.
|
||||
|
||||

|
||||
|
||||
In the newly created application, you will see two targets contained in the workflow, which means when you deploy this application, the component will be dispatch to both targets.
|
||||
|
||||

|
||||
|
|
|
|||
|
After Width: | Height: | Size: 218 KiB |
|
After Width: | Height: | Size: 132 KiB |
|
After Width: | Height: | Size: 184 KiB |
|
After Width: | Height: | Size: 97 KiB |
|
After Width: | Height: | Size: 107 KiB |
|
|
@ -159,6 +159,17 @@
|
|||
"id": "version-v1.2/how-to/dashboard/trigger/overview"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"collapsed": true,
|
||||
"type": "category",
|
||||
"label": "Manage target",
|
||||
"items": [
|
||||
{
|
||||
"type": "doc",
|
||||
"id": "version-v1.2/how-to/dashboard/target/overview"
|
||||
}
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
|
|
@ -409,7 +420,8 @@
|
|||
{
|
||||
"type": "doc",
|
||||
"id": "version-v1.2/end-user/components/cloud-services/terraform/alibaba-vswitch"
|
||||
},{
|
||||
},
|
||||
{
|
||||
"type": "doc",
|
||||
"id": "version-v1.2/end-user/components/cloud-services/terraform/alibaba-mse"
|
||||
},
|
||||
|
|
|
|||