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

translate i18n/zh/docusaurus-plugin-content-docs/current/install.md (#27) 

* translate i18n/zh/docusaurus-plugin-content-docs/current/install.md

* Update i18n/zh/docusaurus-plugin-content-docs/current/install.mdx

Co-authored-by: Jianbo Sun <wonderflow.sun@gmail.com>

* 处理 中英文之间，中文中文之间，中文链接之间的空格问题

* Update i18n/zh/docusaurus-plugin-content-docs/current/install.mdx

Co-authored-by: Jianbo Sun <wonderflow.sun@gmail.com>

* Update i18n/zh/docusaurus-plugin-content-docs/current/install.mdx

Co-authored-by: Jianbo Sun <wonderflow.sun@gmail.com>

* Update i18n/zh/docusaurus-plugin-content-docs/current/install.mdx

Co-authored-by: Jianbo Sun <wonderflow.sun@gmail.com>

* Update i18n/zh/docusaurus-plugin-content-docs/current/install.mdx

Co-authored-by: Jianbo Sun <wonderflow.sun@gmail.com>

* Update i18n/zh/docusaurus-plugin-content-docs/current/install.mdx

Co-authored-by: Jianbo Sun <wonderflow.sun@gmail.com>

* Update i18n/zh/docusaurus-plugin-content-docs/current/install.mdx

Co-authored-by: Jianbo Sun <wonderflow.sun@gmail.com>

Co-authored-by: Jianbo Sun <wonderflow.sun@gmail.com>
This commit is contained in:
沧海 2021-04-16 13:16:36 +08:00 committed by GitHub
parent 026c7aa176
commit b24a70f8e6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 101 additions and 101 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

190
i18n/zh/docusaurus-plugin-content-docs/current/install.mdx
View File

@ -5,17 +5,17 @@ title: 安装
import Tabs from '@theme/Tabs'; import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem'; import TabItem from '@theme/TabItem';
If you have installed the kubevale chart before, please read the [Upgrade](#upgrade) step directly. 如果你之前已经安装了 KubeVela chart，请直接阅读[升级](#upgrade)步骤。
## 1. Setup Kubernetes cluster ## 1. 设置 Kubernetes 集群
Requirements: 要求:
- Kubernetes cluster >= v1.15.0 - Kubernetes 集群版本 >= v1.15.0
- kubectl installed and configured - 安装并配置 kubectl
If you don't have K8s cluster from Cloud Provider, you may pick either Minikube or KinD as local cluster testing option. KubeVela是一个简单的自定义控制器，可以安装在任何 Kubernetes 集群上，包括托管产品或您自己的集群。唯一的要求是请确保已安装并启用了 [ingress-nginx](https://kubernetes.github.io/ingress-nginx/deploy/)。
> NOTE: If you are not using minikube or kind, please make sure to [install or enable ingress-nginx](https://kubernetes.github.io/ingress-nginx/deploy/) by yourself. > 注意:如果您没有使用 minikube 或 kind，请确保[安装或启用 ingress-nginx](https://kubernetes.github.io/ingress-nginx/deploy/)。
<Tabs <Tabs
className="unique-tabs" className="unique-tabs"
@ -26,15 +26,15 @@ values={[
]}> ]}>
<TabItem value="minikube"> <TabItem value="minikube">
Follow the minikube [installation guide](https://minikube.sigs.k8s.io/docs/start/). 遵循 minikube [安装指南](https://minikube.sigs.k8s.io/docs/start/)。
Once minikube is installed, create a cluster: 安装 minikube 后，创建一个集群:
```shell script ```shell script
minikube start minikube start
``` ```
Install ingress: 安装 ingress:
```shell script ```shell script
minikube addons enable ingress minikube addons enable ingress
@ -43,9 +43,9 @@ minikube addons enable ingress
</TabItem> </TabItem>
<TabItem value="kind"> <TabItem value="kind">
Follow [this guide](https://kind.sigs.k8s.io/docs/user/quick-start/#installation) to install kind. 请按照本[指南](https://kind.sigs.k8s.io/docs/user/quick-start/#installation)进行安装。
Then spins up a kind cluster: 然后拉起一个 kind 集群:
```shell script ```shell script
cat <<EOF | kind create cluster --image=kindest/node:v1.18.15 --config=- cat <<EOF | kind create cluster --image=kindest/node:v1.18.15 --config=-
@ -69,7 +69,7 @@ nodes:
EOF EOF
``` ```
Then install [ingress for kind](https://kind.sigs.k8s.io/docs/user/ingress/#ingress-nginx): 然后安装 [ingress for kind](https://kind.sigs.k8s.io/docs/user/ingress/#ingress-nginx):
```shell script ```shell script
kubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/master/deploy/static/provider/kind/deploy.yaml kubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/master/deploy/static/provider/kind/deploy.yaml
``` ```
@ -78,76 +78,77 @@ kubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/mast
</Tabs> </Tabs>
## 2. Install KubeVela Controller ## 2. 安装 KubeVela 控制器
These steps will install KubeVela controller and its dependency. 这些步骤将安装 KubeVela 控制器及其依赖项。
1. Add helm chart repo for KubeVela 1. 添加 KubeVela helm chart 仓库
```shell script ```shell script
helm repo add kubevela https://kubevelacharts.oss-cn-hangzhou.aliyuncs.com/core helm repo add kubevela https://kubevelacharts.oss-cn-hangzhou.aliyuncs.com/core
``` ```
2. Update the chart repo 2. 更新 chart 仓库
```shell script ```shell script
helm repo update helm repo update
``` ```
3. Install KubeVela 3. 安装 KubeVela
```shell script ```shell script
helm install --create-namespace -n vela-system kubevela kubevela/vela-core helm install --create-namespace -n vela-system kubevela kubevela/vela-core
``` ```
By default, it will enable the webhook with a self-signed certificate provided by [kube-webhook-certgen](https://github.com/jet/kube-webhook-certgen) 默认情况下，它将使用自签名证书来启用 webhook [kube-webhook-certgen](https://github.com/jet/kube-webhook-certgen)
If you want to try the latest master branch, add flag `--devel` in command `helm search` to choose a pre-release 如果你想尝试最新的 master 分支, 在命令 ` helm search` 中添加标志 ` --devel` 以选择预发布版本
version in format `<next_version>-rc-master` which means the next release candidate version build on `master` branch, 格式为 `<下个版本号>-rc-master` 的版本, 表示这是建立在 `master` 分支上的下一个候选发行版应,
like `0.4.0-rc-master`. 例如 `0.4.0-rc-master`。
```shell script ```shell script
helm search repo kubevela/vela-core -l --devel helm search repo kubevela/vela-core -l --devel
``` ```
```console ```console
NAME CHART VERSION APP VERSION DESCRIPTION NAME CHART VERSION APP VERSION DESCRIPTION
kubevela/vela-core 0.4.0-rc-master 0.4.0-rc-master A Helm chart for KubeVela core kubevela/vela-core 0.4.0-rc-master 0.4.0-rc-master A Helm chart for KubeVela core
kubevela/vela-core 0.3.2 0.3.2 A Helm chart for KubeVela core kubevela/vela-core 0.3.2 0.3.2 A Helm chart for KubeVela core
kubevela/vela-core 0.3.1 0.3.1 A Helm chart for KubeVela core kubevela/vela-core 0.3.1 0.3.1 A Helm chart for KubeVela core
``` ```
And try the following command to install it. 尝试使用以下命令进行安装。
```shell script ```shell script
helm install --create-namespace -n vela-system kubevela kubevela/vela-core --version <next_version>-rc-master helm install --create-namespace -n vela-system kubevela kubevela/vela-core --version <next_version>-rc-master
``` ```
```console ```console
NAME: kubevela NAME: kubevela
LAST DEPLOYED: Thu Apr 1 19:41:30 2021 LAST DEPLOYED: Thu Apr 1 19:41:30 2021
NAMESPACE: vela-system NAMESPACE: vela-system
STATUS: deployed STATUS: deployed
REVISION: 1 REVISION: 1
NOTES: NOTES:
Welcome to use the KubeVela! Enjoy your shipping application journey! Welcome to use the KubeVela! Enjoy your shipping application journey!
``` ```
4. Install Kubevela with cert-manager (optional) 4. (可选)使用 cert-manager 安装 Kubevela
If cert-manager has been installed, it can be used to take care about generating certs. 如果已经安装了 cert-manager，则可以使用它来生成证书。
You need to install cert-manager before the kubevela chart. > 你需要在 KubeVela chart 安装之前安装 cert-manager。
```shell script
helm repo add jetstack https://charts.jetstack.io
helm repo update
helm install cert-manager jetstack/cert-manager --namespace cert-manager --version v1.2.0 --create-namespace --set installCRDs=true
```
Install kubevela with enabled certmanager: ```shell script
```shell script helm repo add jetstack https://charts.jetstack.io
helm install --create-namespace -n vela-system --set admissionWebhooks.certManager.enabled=true kubevela kubevela/vela-core helm repo update
``` helm install cert-manager jetstack/cert-manager --namespace cert-manager --version v1.2.0 --create-namespace --set installCRDs=true
```
## 3. (Optional) Install flux2 安装 KubeVela，启用 certmanager:
```shell script
helm install --create-namespace -n vela-system --set admissionWebhooks.certManager.enabled=true kubevela kubevela/vela-core
```
This installation step is optional, it's required if you want to register [Helm Chart](https://helm.sh/) as KubeVela capabilities. ## 3. (可选)安装 flux2
KubeVela relies on several CRDs and controllers from [fluxcd/flux2](https://github.com/fluxcd/flux2). 这个安装步骤是可选的，如果你想将 [Helm Chart](https://helm.sh/) 作为 KubeVela 的能力，那么这一步是必需的。
KubeVela 依赖于 [fluxcd/flux2](https://github.com/fluxcd/flux2) 的几个 CRD 和控制器。
| CRD | Controller Image | | CRD | Controller Image |
| ----------- | ----------- | | ----------- | ----------- |
@ -157,16 +158,15 @@ KubeVela relies on several CRDs and controllers from [fluxcd/flux2](https://gith
| gitrepositories.source.toolkit.fluxcd.io | - | | gitrepositories.source.toolkit.fluxcd.io | - |
| helmreleases.helm.toolkit.fluxcd.io | fluxcd/helm-controller:v0.8.0 | | helmreleases.helm.toolkit.fluxcd.io | fluxcd/helm-controller:v0.8.0 |
You can install the whole flux2 from their [official website](https://github.com/fluxcd/flux2) 你可以从其[官方网站](https://github.com/fluxcd/flux2)上安装整个 flux2，也可以安装由 KubeVela 提供的近包含最小集的 helm chart：
or install the chart with minimal parts provided by KubeVela:
```shell ```shell
$ helm install --create-namespace -n flux-system helm-flux http://oam.dev/catalog/helm-flux2-0.1.0.tgz $ helm install --create-namespace -n flux-system helm-flux http://oam.dev/catalog/helm-flux2-0.1.0.tgz
``` ```
## 4. (Optional) Get KubeVela CLI ## 4. (可选)安装 KubeVela CLI 命令行工具
Here are three ways to get KubeVela Cli: 这里有三种获取 KubeVela Cli 的方法:
<Tabs <Tabs
className="unique-tabs" className="unique-tabs"
@ -194,11 +194,11 @@ powershell -Command "iwr -useb https://kubevela.io/script/install.ps1 | iex"
**macOS/Linux** **macOS/Linux**
Update your brew firstly. 首先更新你的 brew 缓存。
```shell script ```shell script
brew update brew update
``` ```
Then install kubevela client. 安装 KubeVela 客户端.
```shell script ```shell script
brew install kubevela brew install kubevela
@ -206,25 +206,25 @@ brew install kubevela
</TabItem> </TabItem>
<TabItem value="download"> <TabItem value="download">
- Download the latest `vela` binary from the [releases page](https://github.com/oam-dev/kubevela/releases). - 从[版本发布页面](https://github.com/oam-dev/kubevela/releases)下载最新的 `vela` 二进制版本.
- Unpack the `vela` binary and add it to `$PATH` to get started. - 解压缩 vela 二进制文件并将其添加到 `$PATH` 开始使用.
```shell script ```shell script
sudo mv ./vela /usr/local/bin/vela sudo mv ./vela /usr/local/bin/vela
``` ```
> Known Issue(https://github.com/oam-dev/kubevela/issues/625): > 已知问题(https://github.com/oam-dev/kubevela/issues/625):
> If you're using mac, it will report that “vela” cannot be opened because the developer cannot be verified. > 如果你使用 mac，它会报告 “vela” 无法打开，因为开发者无法验证。
> >
> The new version of MacOS is stricter about running software you've downloaded that isn't signed with an Apple developer key. And we haven't supported that for KubeVela yet. > 新版 MacOS 在运行你下载的没有使用苹果开发者密钥的软件方面更加严格，我们还没有为 KubeVela 做这方面支持。
> You can open your 'System Preference' -> 'Security & Privacy' -> General, click the 'Allow Anyway' to temporarily fix it. > 你可以打开你的'系统首选项' -> '安全与隐私' ->一般，点击'允许无论如何'暂时修复它。
</TabItem> </TabItem>
</Tabs> </Tabs>
## 5. (Optional) Sync Capability from Cluster ## 5. (可选)从群集同步功能
If you want to run application from `vela` cli, then you should sync capabilities first like below: 如果要从 `vela` cli 运行应用程序，则应首先同步功能，如下所示：
```shell script ```shell script
vela components vela components
@ -240,20 +240,20 @@ worker vela-system deployments.apps Describes long-running, scalable, contai
to receive external network traffic. to receive external network traffic.
``` ```
## 6. (Optional) Clean Up ## 6. (可选)清理
<details> <details>
Run: 运行:
```shell script ```shell script
helm uninstall -n vela-system kubevela helm uninstall -n vela-system kubevela
rm -r ~/.vela rm -r ~/.vela
``` ```
This will uninstall KubeVela server component and its dependency components. 这将卸载 KubeVela 服务器组件及其依赖组件。
This also cleans up local CLI cache. 这也会清理本地 CLI 缓存。
Then clean up CRDs (CRDs are not removed via helm by default): 然后清除 CRDs (CRDs 默认不会通过 helm 移除):
```shell script ```shell script
kubectl delete crd \ kubectl delete crd \
@ -276,23 +276,23 @@ Then clean up CRDs (CRDs are not removed via helm by default):
``` ```
</details> </details>
# Upgrade # 升级
If you have already installed KubeVela and wants to upgrade to the new version, you could follow below instructions. 如果你已经安装了 KubeVela，并希望升级到新版本，可以按照以下说明进行操作。
## Step 1. Update helm repo ## 步骤 1. 更新 helm 仓库
```shell ```shell
helm repo update helm repo update
``` ```
you can get the new version kubevela chart by run: 你可以通过运行以下命令获取新版本的 KubeVela 图表：
```shell ```shell
helm search repo kubevela/vela-core -l helm search repo kubevela/vela-core -l
``` ```
## Step 2. Upgrade KubeVela CRDs ## Step 2. 升级 KubeVela CRDs
```shell ```shell
kubectl apply -f https://raw.githubusercontent.com/oam-dev/kubevela/master/charts/vela-core/crds/core.oam.dev_componentdefinitions.yaml kubectl apply -f https://raw.githubusercontent.com/oam-dev/kubevela/master/charts/vela-core/crds/core.oam.dev_componentdefinitions.yaml
@ -306,8 +306,8 @@ kubectl apply -f https://raw.githubusercontent.com/oam-dev/kubevela/master/chart
kubectl apply -f https://raw.githubusercontent.com/oam-dev/kubevela/master/charts/vela-core/crds/core.oam.dev_applicationcontexts.yaml kubectl apply -f https://raw.githubusercontent.com/oam-dev/kubevela/master/charts/vela-core/crds/core.oam.dev_applicationcontexts.yaml
``` ```
> Tips: If you meet errors like `* is invalid: spec.scope: Invalid value: "Namespaced": filed is immutable`. Please delete the crd with the error. > Tips: 如果你碰到类似 `* is invalid: spec.scope: Invalid value: "Namespaced": filed is immutable`问题. 请删除带有错误的 crd
and re-apply the kubevela crds. 并重新应用 KubeVela crds。
```shell ```shell
kubectl delete crd \ kubectl delete crd \
@ -316,7 +316,7 @@ and re-apply the kubevela crds.
workloaddefinitions.core.oam.dev workloaddefinitions.core.oam.dev
``` ```
## Step 3. Upgrade KubeVela helm chart ## Step 3. 升级 KubeVela helm chart
```shell ```shell
helm upgrade --install --create-namespace --namespace vela-system kubevela kubevela/vela-core --version <the_new_version> helm upgrade --install --create-namespace --namespace vela-system kubevela kubevela/vela-core --version <the_new_version>