Version: v1.1

自定义安装

带着证书管理器安装 KubeVela

默认情况下，KubeVela 使用 kube-webhook-certgen 提供的自签名证书以便使用参数校验等 Webhook 功能。 你可以对接证书管理软件（Cert Manager），但是你需要提前安装好。

  1. 安装 Cert Manager (如果已经安装，可省略)
  1. helm repo add jetstack https://charts.jetstack.io
  2. helm repo update
  3. helm install cert-manager jetstack/cert-manager --namespace cert-manager --version v1.2.0 --create-namespace --set installCRDs=true
  1. 安装 KubeVela 同时启用证书管理器：
  1. helm install --create-namespace -n vela-system --set admissionWebhooks.certManager.enabled=true kubevela kubevela/vela-core

安装预发布版

在使用 helm search 命令时，添加标记参数 --devel 即可搜索出预发布版。预发布版的版本号格式为 <next_version>-rc-master，例如 0.4.0-rc-master，代表的是一个基于 master 分支构建的发布候选版。

  1. helm search repo kubevela/vela-core -l --devel
  1.     NAME                      CHART VERSION         APP VERSION           DESCRIPTION
  2.     kubevela/vela-core        0.4.0-rc-master         0.4.0-rc-master         A Helm chart for KubeVela core
  3.     kubevela/vela-core        0.3.2                   0.3.2                   A Helm chart for KubeVela core
  4.     kubevela/vela-core        0.3.1                 0.3.1                 A Helm chart for KubeVela core

然后尝试跟着以下的命令安装一个预发布版。

  1. helm install --create-namespace -n vela-system kubevela kubevela/vela-core --version <next_version>-rc-master
  1. NAME: kubevela
  2. LAST DEPLOYED: Thu Apr  1 19:41:30 2021
  3. NAMESPACE: vela-system
  4. STATUS: deployed
  5. REVISION: 1
  6. NOTES:
  7. Welcome to use the KubeVela! Enjoy your shipping application journey!

安装 Kubectl KubeVela CLI 插件

安装 Kubectl KubeVela CLI 插件，可以更好的进行应用交付操作。

  • Krew
  • Script
  1. 先安装 Krew。
  2. 查看 Krew 上可用的插件:
  1. kubectl krew update
  1. 安装 Kubectl KubeVela CLI 插件:
  1. kubectl krew install vela

macOS/Linux

  1. curl -fsSl https://kubevela.io/script/install-kubectl-vela.sh | bash

你也可以直接从发布页面手动下载来使用。

升级

第一步 更新 Helm 仓库

通过以下命令获取 KubeVela 最新发布的 chart：

  1. helm repo update
  2. helm search repo kubevela/vela-core -l

第二步 升级 KubeVela 的 CRDs

  1. kubectl apply -f https://raw.githubusercontent.com/oam-dev/kubevela/release-1.1/charts/vela-core/crds/core.oam.dev_appdeployments.yaml
  2. kubectl apply -f https://raw.githubusercontent.com/oam-dev/kubevela/release-1.1/charts/vela-core/crds/core.oam.dev_applicationcontexts.yaml
  3. kubectl apply -f https://raw.githubusercontent.com/oam-dev/kubevela/release-1.1/charts/vela-core/crds/core.oam.dev_applicationrevisions.yaml
  4. kubectl apply -f https://raw.githubusercontent.com/oam-dev/kubevela/release-1.1/charts/vela-core/crds/core.oam.dev_applications.yaml
  5. kubectl apply -f https://raw.githubusercontent.com/oam-dev/kubevela/release-1.1/charts/vela-core/crds/core.oam.dev_approllouts.yaml
  6. kubectl apply -f https://raw.githubusercontent.com/oam-dev/kubevela/release-1.1/charts/vela-core/crds/core.oam.dev_clusters.yaml
  7. kubectl apply -f https://raw.githubusercontent.com/oam-dev/kubevela/release-1.1/charts/vela-core/crds/core.oam.dev_componentdefinitions.yaml
  8. kubectl apply -f https://raw.githubusercontent.com/oam-dev/kubevela/release-1.1/charts/vela-core/crds/core.oam.dev_containerizedworkloads.yaml
  9. kubectl apply -f https://raw.githubusercontent.com/oam-dev/kubevela/release-1.1/charts/vela-core/crds/core.oam.dev_definitionrevisions.yaml
  10. kubectl apply -f https://raw.githubusercontent.com/oam-dev/kubevela/release-1.1/charts/vela-core/crds/core.oam.dev_envbindings.yaml
  11. kubectl apply -f https://raw.githubusercontent.com/oam-dev/kubevela/release-1.1/charts/vela-core/crds/core.oam.dev_healthscopes.yaml
  12. kubectl apply -f https://raw.githubusercontent.com/oam-dev/kubevela/release-1.1/charts/vela-core/crds/core.oam.dev_initializers.yaml
  13. kubectl apply -f https://raw.githubusercontent.com/oam-dev/kubevela/release-1.1/charts/vela-core/crds/core.oam.dev_manualscalertraits.yaml
  14. kubectl apply -f https://raw.githubusercontent.com/oam-dev/kubevela/release-1.1/charts/vela-core/crds/core.oam.dev_policydefinitions.yaml
  15. kubectl apply -f https://raw.githubusercontent.com/oam-dev/kubevela/release-1.1/charts/vela-core/crds/core.oam.dev_resourcetrackers.yaml
  16. kubectl apply -f https://raw.githubusercontent.com/oam-dev/kubevela/release-1.1/charts/vela-core/crds/core.oam.dev_scopedefinitions.yaml
  17. kubectl apply -f https://raw.githubusercontent.com/oam-dev/kubevela/release-1.1/charts/vela-core/crds/core.oam.dev_traitdefinitions.yaml
  18. kubectl apply -f https://raw.githubusercontent.com/oam-dev/kubevela/release-1.1/charts/vela-core/crds/core.oam.dev_workflowstepdefinitions.yaml
  19. kubectl apply -f https://raw.githubusercontent.com/oam-dev/kubevela/release-1.1/charts/vela-core/crds/core.oam.dev_workloaddefinitions.yaml
  20. kubectl apply -f https://raw.githubusercontent.com/oam-dev/kubevela/release-1.1/charts/vela-core/crds/standard.oam.dev_rollouts.yaml

提示：如果看到诸如 * is invalid: spec.scope: Invalid value: "Namespaced": filed is immutable 之类的错误，请删除出错的 CRD 后再重新安装。

  1.  kubectl delete crd \
  2.   scopedefinitions.core.oam.dev \
  3.   traitdefinitions.core.oam.dev \
  4.   workloaddefinitions.core.oam.dev

第三步 升级 KubeVela Helm chart

  1. helm upgrade --install --create-namespace --namespace vela-system  kubevela kubevela/vela-core --version <the_new_version> --wait

启用多集群管理

KubeVela 提供了跨集群编排应用的能力。上文的安装命令已经启用了该功能，如果你是从旧版本 KubeVela 升级上来，或是在安装时没有选用多集群管理的能力，你可以运行以下命令启用该能力

  1. helm upgrade --install kubevela kubevela/vela-core -n vela-system --set multicluster.enabled=true --create-namespace --wait

你可以运行以下命令来检查多集群功能是否正常启用。

  1. > kubectl get APIService v1alpha1.cluster.core.oam.dev
  2. NAME                            SERVICE                                        AVAILABLE   AGE
  3. v1alpha1.cluster.core.oam.dev   vela-system/kubevela-cluster-gateway-service   True        7h40m

插件列表

插件简介对应的内置功能插件对应开源项目
terraform提供云资源（默认已安装）-https://github.com/oam-dev/terraform-controller
fluxcd提供 Helm、Kustomize 组件的部署功能kustomize、helmhttps://fluxcd.io/
kruise提供比 Kubernetes 原生更强大的工作负载套件clonesethttps://openkruise.io/
prometheus提供基于 Promethus 的基础监控功能-https://prometheus.io/
keda提供基于事件驱动的工作负载自动扩缩容功能-https://keda.sh/
ocm提供多集群功能的系统插件-http://open-cluster-management.io/
observability为 KubeVela core 提供系统级别的监控，也可以为应用提供业务级别的监控。--
  1. 查看可用的插件
  1. vela addon list
  1. 安装插件，以 fluxcd 插件为例
  1. vela addon enable fluxcd
  1. 禁用插件
  1. vela addon disable fluxcd

禁用前请先清理使用插件功能的应用，否则将禁用失败。

卸载

运行命令:

  1. helm uninstall -n vela-system kubevela
  2. rm -r ~/.vela

命令会卸载 KubeVela 服务和相关的依赖组件，同时会清理本地 CLI 的缓存
然后清理 CRDs（默认情况下，helm 不会移除 CRDs）

  1.  kubectl delete crd \
  2.   appdeployments.core.oam.dev \
  3.   applicationconfigurations.core.oam.dev \
  4.   applicationcontexts.core.oam.dev \
  5.   applicationrevisions.core.oam.dev \
  6.   applications.core.oam.dev \
  7.   approllouts.core.oam.dev \
  8.   clusters.core.oam.dev \
  9.   componentdefinitions.core.oam.dev \
  10.   components.core.oam.dev \
  11.   containerizedworkloads.core.oam.dev \
  12.   definitionrevisions.core.oam.dev \
  13.   envbindings.core.oam.dev \
  14.   healthscopes.core.oam.dev \
  15.   initializers.core.oam.dev \
  16.   manualscalertraits.core.oam.dev \
  17.   podspecworkloads.standard.oam.dev \
  18.   policydefinitions.core.oam.dev \
  19.   resourcetrackers.core.oam.dev \
  20.   rollouts.standard.oam.dev \
  21.   rollouttraits.standard.oam.dev \
  22.   scopedefinitions.core.oam.dev \
  23.   traitdefinitions.core.oam.dev \
  24.   workflows.core.oam.dev \
  25.   workflowstepdefinitions.core.oam.dev \
  26.   workloaddefinitions.core.oam.dev