Skip to main content
Version: Next

Custom Installation/Upgrade

Install KubeVela with Existing Kubernetes cluster

1. Prerequisites:

  • Kubernetes cluster >= v1.19 && <= v1.22

KubeVela relies on Kubernetes as a control plane. The control plane could be any managed Kubernetes offering or your own clusters, such as:

Please make sure one of the ingress controllers is available in your Kubernetes cluster.

2. Install KubeVela CLI

KubeVela CLI provides an easy to engage and manage your application delivery in command lines.

MacOS/Linux

curl -fsSl https://kubevela.net/script/install.sh | bash

Windows

Only the official release version is supported.

powershell -Command "iwr -useb https://kubevela.net/script/install.ps1 | iex"

3. Install KubeVela Core

$ vela install
check out the outcome
...
Watching for changes to Job kubevela-vela-core-cluster-gateway-tls-secret-patch with timeout of 18m0s
Add/Modify event for kubevela-vela-core-cluster-gateway-tls-secret-patch: ADDED
kubevela-vela-core-cluster-gateway-tls-secret-patch: Jobs active: 0, jobs failed: 0, jobs succeeded: 0
Add/Modify event for kubevela-vela-core-cluster-gateway-tls-secret-patch: MODIFIED
kubevela-vela-core-cluster-gateway-tls-secret-patch: Jobs active: 1, jobs failed: 0, jobs succeeded: 0
Add/Modify event for kubevela-vela-core-cluster-gateway-tls-secret-patch: MODIFIED
kubevela-vela-core-cluster-gateway-tls-secret-patch: Jobs active: 1, jobs failed: 0, jobs succeeded: 0
Add/Modify event for kubevela-vela-core-cluster-gateway-tls-secret-patch: MODIFIED
Starting delete for "kubevela-vela-core-admission" ServiceAccount
Starting delete for "kubevela-vela-core-admission" ClusterRole
Starting delete for "kubevela-vela-core-admission" ClusterRoleBinding
Starting delete for "kubevela-vela-core-admission" Role
Starting delete for "kubevela-vela-core-admission" RoleBinding
Starting delete for "kubevela-vela-core-admission-patch" Job
Starting delete for "kubevela-vela-core-cluster-gateway-admission" ServiceAccount
Starting delete for "kubevela-vela-core-cluster-gateway-admission" Role
Starting delete for "kubevela-vela-core-cluster-gateway-admission" RoleBinding
Starting delete for "kubevela-vela-core-cluster-gateway-tls-secret-patch" Job

KubeVela control plane has been successfully set up on your cluster.
If you want to enable dashboard, please run "vela addon enable velaux"

4 Install VelaUX

Please refer to VelaUX Guide.

Upgrade

If you're trying to upgrade from a big version later (e.g. from 1.2.x to 1.4.x), please refer to version migration for more guides.

1. Upgrade CLI

MacOS/Linux

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

Windows

Only the official release version is supported.

powershell -Command "iwr -useb https://kubevela.io/script/install.ps1 | iex"

2. Upgrade Vela Core

Please make sure you already upgraded the Vela CLI to latest stable version.

vela install

3. Upgrade VelaUX

vela addon enable velaux

If you set custom parameters during installation, be sure to include the corresponding parameters.

Uninstall

Before uninstalling kubevela, you must delete all applications and disable all addons.

  1. Uninstall VelaUX
vela addon disable velaux
  1. Uninstall KubeVela Core
vela uninstall
  1. Uninstall CRD

Before deleting, you must delete all CR resources.

kubectl get crd |grep oam | awk '{print $1}' | xargs kubectl delete crd

Install KubeVela with cert-manager

By default, KubeVela will use a self-signed certificate provided by kube-webhook-certgen for admissionWebhooks. You can also use cert-manager if it's available. Note that you need to install cert-manager before the KubeVela chart.

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:

vela install --set admissionWebhooks.certManager.enabled=true

Install Pre-release

# List all releases
vela version list -a

# Install the specified version.
vela install --version 1.3.0-beta.2

Install Kubectl Vela Plugin

kubectl-vela provides the same features with vela CLI, it helps you to integrate with kubectl better.

  1. Install and set up Krew on your machine.
  2. Discover plugins available on Krew:
kubectl krew update
  1. install kubectl vela:
kubectl krew install vela