Install KubeVela on Kubernetes

1. Kubernetes Requirements:

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

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

• Alibaba Cloud ACK Service
• AWS EKS Service
• Azure AKS Service
• Google GKE Service
• Rancher K3s or RKE

2. Install KubeVela CLI

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

Script

MacOS/Linux

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

Windows

note

Only the official release version is supported.

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

Homebrew

MacOS/Linux

Update your brew first. Please note that the brew method only supports the installation of the official release version.

brew update

Then install KubeVela CLI

brew install kubevela

Download directly from releases

• Download the latest vela binary file via release log.
• Unzip the binary file, and configure the environment variables in $PATH, and you're done.

sudo mv ./vela /usr/local/bin/vela

note

• Installation Tips:
• If you are using a Mac system, it will pop up a warning that "vela" cannot be opened because the package from the developer cannot be verified.
• MacOS imposes stricter restrictions on the software that can run in the system. You can temporarily solve this problem by opening System Preference ->Security & Privacy -> General and clicking on Allow Anyway.

Asdf-vm

MacOS/Linux

If you are using the asdf version manager, you can install vela with:

# Add the vela plugin for asdf
asdf plugin add vela

# List all installable versions
asdf list-all vela

# Install the desired version (could be "latest")
asdf install vela <version>

# set it as the global version, unless a project declares it otherwise locally
asdf global vela <version>

Docker

If you have docker environment, you can easily run CLI with the vela CLI docker image called oamdev/vela-cli:

$ docker run --rm -it -v ~/.kube:/root/.kube oamdev/vela-cli version
CLI Version: master
Core Version: v1.3.4
GitRevision: git-1d823780
GolangVersion: go1.17.10

Refer to using Vela CLI docker image for more usage.

3. Install KubeVela Core

Default

$ 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"

Helm

If you are helm user, you can also use helm to install KubeVela core:

note

helm v3.2.0+ required

helm repo add kubevela https://charts.kubevela.net/core
helm repo update
helm install --create-namespace -n vela-system kubevela kubevela/vela-core --wait

4. Install VelaUX

VelaUX is a dashboard for KubeVela. It is a web application that runs in your cluster. You can access it with your browser. This is optional if you don't use UI console of KubeVela.

Please refer to VelaUX Guide.

5. Custom Installation or Upgrade

Please refer advanced installation