Docs: change some doc and change install version (#452)
Signed-off-by: barnettZQG <barnett.zqg@gmail.com>
This commit is contained in:
barnettZQG
GitHub
parent
0e4ff4f8e8
commit
03b888e990
|
|
@ -41,6 +41,8 @@ Environment refers to the environment for development, testing, and production a
|
|||
|
||||
- <b>Bind Application with Environment</b> The application can be bound to multiple Environments, and for each environment, you can set the unique parameter difference for each environment.
|
||||
|
||||
> The concept of environment exists only in VelaUX, and users who only use Vela Core need not pay attention it.
|
||||
|
||||
## Target
|
||||
|
||||
Target describes the space where the application resources actually delivered. One target describes one Kubernetes cluster and namespace, it can also describe a region or VPC for cloud providers. In the target, credentials of cloud resources created will automatically delievered to the Kubernetes cluster.
|
||||
|
|
|
|||
|
|
@ -157,7 +157,7 @@ helm repo update
|
|||
2. Install KubeVela Core
|
||||
|
||||
```shell script
|
||||
helm install --create-namespace -n vela-system kubevela kubevela/vela-core --version 1.2.0 --wait
|
||||
helm install --create-namespace -n vela-system kubevela kubevela/vela-core --version 1.2.1 --wait
|
||||
```
|
||||
|
||||
3. Verify KubeVela Core installation
|
||||
|
|
@ -213,7 +213,7 @@ KubeVela CLI provides an easy to engage. We install VelaUX extensions through CL
|
|||
** MacOS/Linux **
|
||||
|
||||
```shell script
|
||||
curl -fsSl https://kubevela.io/script/install.sh | bash -s 1.2.0
|
||||
curl -fsSl https://kubevela.io/script/install.sh | bash -s 1.2.1
|
||||
```
|
||||
|
||||
**Windows**
|
||||
|
|
|
|||
Binary file not shown.
|
Before Width: | Height: | Size: 178 KiB After Width: | Height: | Size: 157 KiB |
|
|
@ -23,7 +23,7 @@ KubeVela 本身是一个的应用交付与管理控制平面，它架在 Kuberne
|
|||
- **核心控制器** 为整个系统提供核心控制逻辑，完成诸如编排应用和工作流、修订版本快照、垃圾回收等等基础逻辑
|
||||
- **模块化能力控制器** 负责对 X-Definitions 对象进行注册和管理。
|
||||
- **插件控制器** 负责注册和管理 KubeVela 运行所需要的第三方插件，比如 VelaUX、 Flux、Terraform 组件等等。
|
||||
- **UI 控制台和 CLI** UI 控制台服务于希望开箱即用的用户，CLI 适用于集成 KubeVela 和终端管理的用户。
|
||||
- **UI 控制台和 CLI** UI 控制台服务于希望开箱即用的开发者用户，CLI 适用于集成 KubeVela 和终端管理的用户。
|
||||
|
||||
### 运行时基础设施
|
||||
|
||||
|
|
|
|||
|
|
@ -41,6 +41,8 @@ KubeVela 围绕着云原生应用交付和管理场景展开，背后的应用
|
|||
|
||||
- <b>应用环境绑定</b> 应用可绑定多个环境进行发布，对于每一个环境可设置环境级部署差异。
|
||||
|
||||
> 环境概念仅在 VelaUX 中存在，仅使用 Vela Core 的用户无需关注此概念。
|
||||
|
||||
## 交付目标（Target）
|
||||
|
||||
交付目标用于描述应用的相关资源实际部署的物理空间，对应 Kubernetes 集群或者云的区域（Region）和专有网络（VPC）。对于普通应用，组件渲染生成的资源会在交付目标指定的 Kubernetes 集群中创建（可以精确到指定集群的 Namespace）；对于云服务，资源创建时会根据交付目标中指定的云厂商的参数创建到对应的区域和专有网络中，然后将生成的云资源信息分发到交付目标指定的 Kubernetes 集群中。单个环境可关联多个交付目标，代表该环境需要多集群交付。单个交付目标只能对应一个环境。
|
||||
|
|
|
|||
|
|
@ -162,7 +162,7 @@ helm repo update
|
|||
2. 安装 KubeVela Core
|
||||
|
||||
```shell script
|
||||
helm install --create-namespace -n vela-system kubevela kubevela/vela-core --version 1.2.0 --wait
|
||||
helm install --create-namespace -n vela-system kubevela kubevela/vela-core --version 1.2.1 --wait
|
||||
```
|
||||
|
||||
3. 验证 KubeVela Core 安装是否成功
|
||||
|
|
@ -218,7 +218,7 @@ KubeVela CLI 提供了便捷的应用终端管理能力，我们通过 CLI 来
|
|||
** MacOS/Linux **
|
||||
|
||||
```shell script
|
||||
curl -fsSl https://kubevela.io/script/install.sh | bash -s 1.2.0
|
||||
curl -fsSl https://kubevela.io/script/install.sh | bash -s 1.2.1
|
||||
```
|
||||
|
||||
**Windows**
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
title: Vela UI 控制台
|
||||
title: 启用 VelaUX 控制台
|
||||
---
|
||||
|
||||
## Install
|
||||
|
|
@ -7,10 +7,13 @@ title: Vela UI 控制台
|
|||
```shell script
|
||||
vela addon enable velaux
|
||||
```
|
||||
|
||||
expected output:
|
||||
|
||||
```
|
||||
Addon: velaux enabled Successfully.
|
||||
```
|
||||
|
||||
By default, velaux didn't have any exposed port.
|
||||
|
||||
## Visit VelaUX by port-forward
|
||||
|
|
@ -31,13 +34,13 @@ By default the service type is ClusterIP for security.
|
|||
If you want to expose your VelaUX dashboard for convenient, you can specify the service type.
|
||||
|
||||
- `LoadBalancer` type requires your cluster has cloud LoadBalancer available.
|
||||
```shell script
|
||||
vela addon enable velaux serviceType=LoadBalancer
|
||||
```
|
||||
```shell script
|
||||
vela addon enable velaux serviceType=LoadBalancer
|
||||
```
|
||||
- `NodePort` type requires you can access the Kubernetes Node IP/Port.
|
||||
```shell script
|
||||
vela addon enable velaux serviceType=NodePort
|
||||
```
|
||||
```shell script
|
||||
vela addon enable velaux serviceType=NodePort
|
||||
```
|
||||
|
||||
After specify the service type to `LoadBalancer` or `NodePort`, you can obtain the access address through `vela status`:
|
||||
|
||||
|
|
@ -46,6 +49,7 @@ vela status addon-velaux -n vela-system --endpoint
|
|||
```
|
||||
|
||||
The expected output:
|
||||
|
||||
```
|
||||
+----------------------------+----------------------+
|
||||
| REF(KIND/NAMESPACE/NAME) | ENDPOINT |
|
||||
|
|
@ -63,6 +67,7 @@ vela addon enable velaux domain=example.doamin.com
|
|||
```
|
||||
|
||||
The expected output:
|
||||
|
||||
```
|
||||
I0112 15:23:40.428364 34884 apply.go:106] "patching object" name="addon-velaux" resource="core.oam.dev/v1beta1, Kind=Application"
|
||||
I0112 15:23:40.676894 34884 apply.go:106] "patching object" name="addon-secret-velaux" resource="/v1, Kind=Secret"
|
||||
|
|
@ -75,10 +80,9 @@ Please access the velaux from the following endpoints:
|
|||
+----------------------------+---------------------------+
|
||||
```
|
||||
|
||||
|
||||
## Specify the addon image
|
||||
|
||||
By default the image repo is docker hub, you can specify the image repo by the `repo` parameter:
|
||||
By default the image repo is docker hub, you can specify the image repo by the `repo` parameter:
|
||||
|
||||
```
|
||||
vela addon enable velaux repo=acr.kubevela.net
|
||||
|
|
@ -87,4 +91,4 @@ vela addon enable velaux repo=acr.kubevela.net
|
|||
But it has API request limit, so you can try specify the `acr.kubevela.net` image registry as alternative,
|
||||
It's maintained by KubeVela team, we will upload/sync the built-in addon image for convenience.
|
||||
|
||||
This feature can also help you to build your private installation, just upload all images to your private image registry.
|
||||
This feature can also help you to build your private installation, just upload all images to your private image registry.
|
||||
|
|
|
|||
Binary file not shown.
|
Before Width: | Height: | Size: 178 KiB After Width: | Height: | Size: 157 KiB |
|
|
@ -7,7 +7,7 @@ import TabItem from "@theme/TabItem";
|
|||
|
||||
> 如果是要升级现有的 KubeVela，请直接阅读[升级指南](./platform-engineers/advanced-install#升级).
|
||||
|
||||
> 1.2.0 版本已发布，欢迎试用。[去安装](/zh/docs/next/install)
|
||||
> 1.2 版本已发布，欢迎试用。[去安装](/zh/docs/next/install)
|
||||
|
||||
## 1. 选择放置控制平面的集群
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
{
|
||||
"version.label": {
|
||||
"message": "Next",
|
||||
"message": "v1.2",
|
||||
"description": "The label for version current"
|
||||
},
|
||||
"sidebar.docs.category.Getting Started": {
|
||||
|
|
|
|||
|
|
@ -23,7 +23,7 @@ KubeVela 本身是一个的应用交付与管理控制平面，它架在 Kuberne
|
|||
- **核心控制器** 为整个系统提供核心控制逻辑，完成诸如编排应用和工作流、修订版本快照、垃圾回收等等基础逻辑
|
||||
- **模块化能力控制器** 负责对 X-Definitions 对象进行注册和管理。
|
||||
- **插件控制器** 负责注册和管理 KubeVela 运行所需要的第三方插件，比如 VelaUX、 Flux、Terraform 组件等等。
|
||||
- **UI 控制台和 CLI** UI 控制台服务于希望开箱即用的用户，CLI 适用于集成 KubeVela 和终端管理的用户。
|
||||
- **UI 控制台和 CLI** UI 控制台服务于希望开箱即用的开发者用户，CLI 适用于集成 KubeVela 和终端管理的用户。
|
||||
|
||||
### 运行时基础设施
|
||||
|
||||
|
|
|
|||
|
|
@ -41,6 +41,8 @@ KubeVela 围绕着云原生应用交付和管理场景展开，背后的应用
|
|||
|
||||
- <b>应用环境绑定</b> 应用可绑定多个环境进行发布，对于每一个环境可设置环境级部署差异。
|
||||
|
||||
> 环境概念仅在 VelaUX 中存在，仅使用 Vela Core 的用户无需关注此概念。
|
||||
|
||||
## 交付目标（Target）
|
||||
|
||||
交付目标用于描述应用的相关资源实际部署的物理空间，对应 Kubernetes 集群或者云的区域（Region）和专有网络（VPC）。对于普通应用，组件渲染生成的资源会在交付目标指定的 Kubernetes 集群中创建（可以精确到指定集群的 Namespace）；对于云服务，资源创建时会根据交付目标中指定的云厂商的参数创建到对应的区域和专有网络中，然后将生成的云资源信息分发到交付目标指定的 Kubernetes 集群中。单个环境可关联多个交付目标，代表该环境需要多集群交付。单个交付目标只能对应一个环境。
|
||||
|
|
|
|||
|
|
@ -162,7 +162,7 @@ helm repo update
|
|||
2. 安装 KubeVela Core
|
||||
|
||||
```shell script
|
||||
helm install --create-namespace -n vela-system kubevela kubevela/vela-core --version 1.2.0 --wait
|
||||
helm install --create-namespace -n vela-system kubevela kubevela/vela-core --version 1.2.1 --wait
|
||||
```
|
||||
|
||||
3. 验证 KubeVela Core 安装是否成功
|
||||
|
|
@ -218,7 +218,7 @@ KubeVela CLI 提供了便捷的应用终端管理能力，我们通过 CLI 来
|
|||
** MacOS/Linux **
|
||||
|
||||
```shell script
|
||||
curl -fsSl https://kubevela.io/script/install.sh | bash -s 1.2.0
|
||||
curl -fsSl https://kubevela.io/script/install.sh | bash -s 1.2.1
|
||||
```
|
||||
|
||||
**Windows**
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
---
|
||||
title: Vela UI 控制台
|
||||
title: 启用 VelaUX 控制台
|
||||
---
|
||||
|
||||
## Install
|
||||
|
|
@ -7,10 +7,13 @@ title: Vela UI 控制台
|
|||
```shell script
|
||||
vela addon enable velaux
|
||||
```
|
||||
|
||||
expected output:
|
||||
|
||||
```
|
||||
Addon: velaux enabled Successfully.
|
||||
```
|
||||
|
||||
By default, velaux didn't have any exposed port.
|
||||
|
||||
## Visit VelaUX by port-forward
|
||||
|
|
@ -31,13 +34,13 @@ By default the service type is ClusterIP for security.
|
|||
If you want to expose your VelaUX dashboard for convenient, you can specify the service type.
|
||||
|
||||
- `LoadBalancer` type requires your cluster has cloud LoadBalancer available.
|
||||
```shell script
|
||||
vela addon enable velaux serviceType=LoadBalancer
|
||||
```
|
||||
```shell script
|
||||
vela addon enable velaux serviceType=LoadBalancer
|
||||
```
|
||||
- `NodePort` type requires you can access the Kubernetes Node IP/Port.
|
||||
```shell script
|
||||
vela addon enable velaux serviceType=NodePort
|
||||
```
|
||||
```shell script
|
||||
vela addon enable velaux serviceType=NodePort
|
||||
```
|
||||
|
||||
After specify the service type to `LoadBalancer` or `NodePort`, you can obtain the access address through `vela status`:
|
||||
|
||||
|
|
@ -46,6 +49,7 @@ vela status addon-velaux -n vela-system --endpoint
|
|||
```
|
||||
|
||||
The expected output:
|
||||
|
||||
```
|
||||
+----------------------------+----------------------+
|
||||
| REF(KIND/NAMESPACE/NAME) | ENDPOINT |
|
||||
|
|
@ -63,6 +67,7 @@ vela addon enable velaux domain=example.doamin.com
|
|||
```
|
||||
|
||||
The expected output:
|
||||
|
||||
```
|
||||
I0112 15:23:40.428364 34884 apply.go:106] "patching object" name="addon-velaux" resource="core.oam.dev/v1beta1, Kind=Application"
|
||||
I0112 15:23:40.676894 34884 apply.go:106] "patching object" name="addon-secret-velaux" resource="/v1, Kind=Secret"
|
||||
|
|
@ -75,10 +80,9 @@ Please access the velaux from the following endpoints:
|
|||
+----------------------------+---------------------------+
|
||||
```
|
||||
|
||||
|
||||
## Specify the addon image
|
||||
|
||||
By default the image repo is docker hub, you can specify the image repo by the `repo` parameter:
|
||||
By default the image repo is docker hub, you can specify the image repo by the `repo` parameter:
|
||||
|
||||
```
|
||||
vela addon enable velaux repo=acr.kubevela.net
|
||||
|
|
@ -87,4 +91,4 @@ vela addon enable velaux repo=acr.kubevela.net
|
|||
But it has API request limit, so you can try specify the `acr.kubevela.net` image registry as alternative,
|
||||
It's maintained by KubeVela team, we will upload/sync the built-in addon image for convenience.
|
||||
|
||||
This feature can also help you to build your private installation, just upload all images to your private image registry.
|
||||
This feature can also help you to build your private installation, just upload all images to your private image registry.
|
||||
|
|
|
|||
Binary file not shown.
|
Before Width: | Height: | Size: 178 KiB After Width: | Height: | Size: 157 KiB |
|
|
@ -10,15 +10,10 @@ module.exports = {
|
|||
"getting-started/introduction",
|
||||
"getting-started/core-concept",
|
||||
"getting-started/architecture",
|
||||
"install",
|
||||
"quick-start",
|
||||
],
|
||||
},
|
||||
{
|
||||
type: "category",
|
||||
label: "Install",
|
||||
collapsed: false,
|
||||
items: ["install"],
|
||||
},
|
||||
{
|
||||
type: "category",
|
||||
label: "Tutorials",
|
||||
|
|
@ -31,7 +26,6 @@ module.exports = {
|
|||
"tutorials/jenkins",
|
||||
"tutorials/trigger",
|
||||
"case-studies/gitops",
|
||||
"tutorials/scaler",
|
||||
"tutorials/workflows",
|
||||
// "case-studies/jenkins-cicd",
|
||||
// "case-studies/canary-blue-green",
|
||||
|
|
@ -54,6 +48,7 @@ module.exports = {
|
|||
"how-to/dashboard/application/bind-new-environment",
|
||||
"how-to/dashboard/application/deploy-application",
|
||||
"how-to/dashboard/application/get-application-instance",
|
||||
"tutorials/scaler",
|
||||
"how-to/dashboard/application/get-application-log",
|
||||
"how-to/dashboard/application/get-application-endpoint",
|
||||
"how-to/dashboard/application/view-application-resource",
|
||||
|
|
|
|||
|
|
@ -7,7 +7,7 @@ import TabItem from "@theme/TabItem";
|
|||
|
||||
> For upgrading existing KubeVela, please read the [upgrade guide](./platform-engineers/advanced-install/#upgrade).
|
||||
|
||||
> the 1.2.0 version is released, [go to install](/docs/next/install)
|
||||
> the 1.2 version is released, [go to install](/docs/next/install)
|
||||
|
||||
## 1. Choose Control Plane Cluster
|
||||
|
||||
|
|
|
|||
|
|
@ -41,6 +41,8 @@ Environment refers to the environment for development, testing, and production a
|
|||
|
||||
- <b>Bind Application with Environment</b> The application can be bound to multiple Environments, and for each environment, you can set the unique parameter difference for each environment.
|
||||
|
||||
> The concept of environment exists only in VelaUX, and users who only use Vela Core need not pay attention it.
|
||||
|
||||
## Target
|
||||
|
||||
Target describes the space where the application resources actually delivered. One target describes one Kubernetes cluster and namespace, it can also describe a region or VPC for cloud providers. In the target, credentials of cloud resources created will automatically delievered to the Kubernetes cluster.
|
||||
|
|
|
|||
|
|
@ -157,7 +157,7 @@ helm repo update
|
|||
2. Install KubeVela Core
|
||||
|
||||
```shell script
|
||||
helm install --create-namespace -n vela-system kubevela kubevela/vela-core --version 1.2.0 --wait
|
||||
helm install --create-namespace -n vela-system kubevela kubevela/vela-core --version 1.2.1 --wait
|
||||
```
|
||||
|
||||
3. Verify KubeVela Core installation
|
||||
|
|
@ -213,7 +213,7 @@ KubeVela CLI provides an easy to engage. We install VelaUX extensions through CL
|
|||
** MacOS/Linux **
|
||||
|
||||
```shell script
|
||||
curl -fsSl https://kubevela.io/script/install.sh | bash -s 1.2.0
|
||||
curl -fsSl https://kubevela.io/script/install.sh | bash -s 1.2.1
|
||||
```
|
||||
|
||||
**Windows**
|
||||
|
|
|
|||
Binary file not shown.
|
Before Width: | Height: | Size: 178 KiB After Width: | Height: | Size: 157 KiB |
|
|
@ -19,18 +19,11 @@
|
|||
},
|
||||
{
|
||||
"type": "doc",
|
||||
"id": "version-v1.2/quick-start"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"collapsed": false,
|
||||
"type": "category",
|
||||
"label": "Install",
|
||||
"items": [
|
||||
"id": "version-v1.2/install"
|
||||
},
|
||||
{
|
||||
"type": "doc",
|
||||
"id": "version-v1.2/install"
|
||||
"id": "version-v1.2/quick-start"
|
||||
}
|
||||
]
|
||||
},
|
||||
|
|
@ -67,10 +60,6 @@
|
|||
"type": "doc",
|
||||
"id": "version-v1.2/case-studies/gitops"
|
||||
},
|
||||
{
|
||||
"type": "doc",
|
||||
"id": "version-v1.2/tutorials/scaler"
|
||||
},
|
||||
{
|
||||
"type": "doc",
|
||||
"id": "version-v1.2/tutorials/workflows"
|
||||
|
|
@ -108,6 +97,10 @@
|
|||
"type": "doc",
|
||||
"id": "version-v1.2/how-to/dashboard/application/get-application-instance"
|
||||
},
|
||||
{
|
||||
"type": "doc",
|
||||
"id": "version-v1.2/tutorials/scaler"
|
||||
},
|
||||
{
|
||||
"type": "doc",
|
||||
"id": "version-v1.2/how-to/dashboard/application/get-application-log"
|
||||
|
|
@ -499,4 +492,4 @@
|
|||
"id": "version-v1.2/developers/references/devex/faq"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
Loading…
Reference in New Issue