Version: v1.2

Installation

For upgrading existing KubeVela, please read the upgrade guide.

1. Choose Control Plane Cluster

Requirements:

KubeVela relies on Kubernetes as a control plane. The control plane could be any managed Kubernetes offering or your cluster.

For local deployment and test, you could use kind or minikube.

For production usage, you could use your Kubernetes cluster or Kubernetes services provided by cloud providers.

  • Kind
  • Minikube
  • RKE
  • Cloud Provider

Minikube is NOT RECOMMENDED for production.

Follow the minikube installation guide.

Then spins up a minikube cluster

  1. minikube start

Install ingress to enable service route

  1. minikube addons enable ingress

This installation applies to the production environment. Please prepare 1~N servers or VMs.

This section guides to install a RKE Kubernetes cluster, you can refer to their installation guides for more details.

（1） Docker

The RKE depends on docker, Please install Docker on all servers or virtual machines, if not installed follow the docker installation guide.

（2）Install RKE:

Download RKE binary from RKE release page.

If your internet access was limited, try using the binary cached by KubeVela team:

  1. wget https://static.kubevela.net/binary/rke/rke_linux-amd64 -O /usr/bin/rke
  3. chmod +x /usr/bin/rke

（3）Install RKE cluster

Please switch to a non-root user who has permission to operate docker and execute the following commands.

  1.   mkdir ~/rkeinit && cd ~/rkeinit
  3.   # Wizard-style configuration
  5.   rke config
  7.   # Kubernetes Cluster Installation
  9.   rke up
  11.   # Install kubectl Command
  13.   mkdir ~/.kube
  15.   cp kube_config_cluster.yml ~/.kube/config
  17.   docker cp kubelet:/usr/local/bin/kubectl /usr/local/bin/kubectl

Kind is NOT RECOMMENDED for production.

Follow this guide to install kind.

Then spins up a kind cluster:

  1. cat <<EOF | kind create cluster --image=kindest/node:v1.18.15 --config=-
  3. kind: Cluster
  5. apiVersion: kind.x-k8s.io/v1alpha4
  7. nodes:
  9. - role: control-plane
  11.   kubeadmConfigPatches:
  13.   - |
  15.     kind: InitConfiguration
  17.     nodeRegistration:
  19.       kubeletExtraArgs:
  21.         node-labels: "ingress-ready=true"
  23.   extraPortMappings:
  25.   - containerPort: 80
  27.     hostPort: 80
  29.     protocol: TCP
  31.   - containerPort: 443
  33.     hostPort: 443
  35.     protocol: TCP
  37. EOF

Install ingress controller to enable service route

  1. kubectl apply -f https://raw.githubusercontent.com/kubernetes/ingress-nginx/master/deploy/static/provider/kind/deploy.yaml

Using for production environment

Please make sure one of the ingress controllers is available.

2. Install KubeVela Core

Before installation, please make sure that Helm is available. If not installed, please head to Helm Installation first.

  1. Add and update KubeVela Helm chart repo
  1. helm repo add kubevela https://charts.kubevela.net/core
  3. helm repo update
  1. Install KubeVela Core
  1. helm install --create-namespace -n vela-system kubevela kubevela/vela-core --version 1.2.0 --wait
  1. Verify KubeVela Core installation
  1. helm test kubevela -n vela-system

check out the outcome

  1. Pod kubevela-application-test pending
  3. Pod kubevela-application-test pending
  5. Pod kubevela-application-test running
  7. Pod kubevela-application-test succeeded
  9. NAME: kubevela
  11. LAST DEPLOYED: Tue Apr 13 18:42:20 2021
  13. NAMESPACE: vela-system
  15. STATUS: deployed
  17. REVISION: 1
  19. TEST SUITE:     kubevela-application-test
  21. Last Started:   Fri Apr 16 20:49:10 2021
  23. Last Completed: Fri Apr 16 20:50:04 2021
  25. Phase:          Succeeded
  27. TEST SUITE:     first-vela-app
  29. Last Started:   Fri Apr 16 20:49:10 2021
  31. Last Completed: Fri Apr 16 20:49:10 2021
  33. Phase:          Succeeded
  35. NOTES:
  37. Welcome to use the KubeVela! Enjoy your shipping application journey!

3. Install VelaUX

VelaUX is a dashboard including UI+API services, it enables you to do everything around application delivery and management.

1. Install KubeVela CLI

KubeVela CLI provides an easy to engage. We install VelaUX extensions through CLI.

  • Script
  • Homebrew
  • Download directly from releases

MacOS/Linux

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

Windows

Only the official release version is supported.

  1. powershell -Command "iwr -useb https://kubevela.io/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

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.

2. Install VelaUX via Addon

  1. vela addon enable velaux

expected output:

  1. Addon: velaux enabled Successfully.

By default, velaux didn’t have any exposed port, you can view it by:

  1. vela port-forward addon-velaux -n vela-system

Choose > Cluster: local | Namespace: vela-system | Component: velaux | Kind: Service for visit.

If you have loadbalaner or ingress, please refer to VelaUX addon docs for more advanced installation ways.

4. Uninstall

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

  1. Uninstall VelaUX
  1. vela addon disable velaux
  1. Uninstall KubeVela Core
  1. helm uninstall -n vela-system kubevela
  1. Uninstall CRD

Before deleting, you must delete all CR resources.

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

Next Step