Version: v1.8

Install KubeVela on Kubernetes

  • 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:

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

  • Script
  • Homebrew
  • Download directly from releases
  • Asdf-vm
  • Docker

MacOS/Linux

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

Windows

Kubernetes - 图1note

Only the official release version is supported.

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

MacOS/Linux

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

  1. brew update

Then install KubeVela CLI

  1. brew install kubevela
  • Download the latest vela binary file via release log.
  • Unzip the binary file, and configure the environment variables in $PATH, and you’re done.
  1. sudo mv ./vela /usr/local/bin/vela

Kubernetes - 图2note

  • 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.

MacOS/Linux

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

  1. # Add the vela plugin for asdf
  2. asdf plugin add vela
  4. # List all installable versions
  5. asdf list-all vela
  7. # Install the desired version (could be "latest")
  8. asdf install vela <version>
  10. # set it as the global version, unless a project declares it otherwise locally
  11. asdf global vela <version>

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

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

Refer to using Vela CLI docker image for more usage.

  • Default
  • Helm
  1. $ vela install

check out the outcome

  1. ...
  2. Watching for changes to Job kubevela-vela-core-cluster-gateway-tls-secret-patch with timeout of 18m0s
  3. Add/Modify event for kubevela-vela-core-cluster-gateway-tls-secret-patch: ADDED
  4. kubevela-vela-core-cluster-gateway-tls-secret-patch: Jobs active: 0, jobs failed: 0, jobs succeeded: 0
  5. Add/Modify event for kubevela-vela-core-cluster-gateway-tls-secret-patch: MODIFIED
  6. kubevela-vela-core-cluster-gateway-tls-secret-patch: Jobs active: 1, jobs failed: 0, jobs succeeded: 0
  7. Add/Modify event for kubevela-vela-core-cluster-gateway-tls-secret-patch: MODIFIED
  8. kubevela-vela-core-cluster-gateway-tls-secret-patch: Jobs active: 1, jobs failed: 0, jobs succeeded: 0
  9. Add/Modify event for kubevela-vela-core-cluster-gateway-tls-secret-patch: MODIFIED
  10. Starting delete for "kubevela-vela-core-admission" ServiceAccount
  11. Starting delete for "kubevela-vela-core-admission" ClusterRole
  12. Starting delete for "kubevela-vela-core-admission" ClusterRoleBinding
  13. Starting delete for "kubevela-vela-core-admission" Role
  14. Starting delete for "kubevela-vela-core-admission" RoleBinding
  15. Starting delete for "kubevela-vela-core-admission-patch" Job
  16. Starting delete for "kubevela-vela-core-cluster-gateway-admission" ServiceAccount
  17. Starting delete for "kubevela-vela-core-cluster-gateway-admission" Role
  18. Starting delete for "kubevela-vela-core-cluster-gateway-admission" RoleBinding
  19. Starting delete for "kubevela-vela-core-cluster-gateway-tls-secret-patch" Job
  21. KubeVela control plane has been successfully set up on your cluster.
  22. If you want to enable dashboard, please run "vela addon enable velaux"

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

Kubernetes - 图3note

helm v3.2.0+ required

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

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.

Please refer advanced installation

Last updated on May 6, 2023 by Tianxin Dong