Installation
For upgrading existing KubeVela, please read the upgrade guide.
1. Choose Control Plane Cluster
Requirements:
- Kubernetes cluster >= v1.19 && <= v1.22
- Kubectl
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. For offline installation, please refer to KubeVela Offline Installation Guide.
- Kind
- Minikube
- K3s
- RKE
- Cloud Provider
Minikube is NOT RECOMMENDED for production.
Follow the minikube installation guide.
Then spins up a minikube cluster
minikube start
Install ingress to enable service route:
minikube addons enable ingress
The k3s is great for: Edge、IoT、Development.
- Install k3s
K3s provides an installation script that is a convenient way to install it as a service on systemd or openrc based systems.
Follow this guide to get more support.
curl -sfL https://get.k3s.io | sh -
- Copy kubeconfig
make ~/.kube
cp /etc/rancher/k3s/k3s.yaml ~/.kube/config
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) DockerThe 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:
wget https://static.kubevela.net/binary/rke/rke_linux-amd64 -O /usr/bin/rke
chmod +x /usr/bin/rke
Please switch to a non-root user who has permission to operate docker and execute the following commands.
mkdir ~/rkeinit && cd ~/rkeinit
# Wizard-style configuration
rke config
# Kubernetes Cluster Installation
rke up
# Install kubectl Command
mkdir ~/.kube
cp kube_config_cluster.yml ~/.kube/config
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:
cat <<EOF | kind create cluster --image=kindest/node:v1.20.7 --config=-
kind: Cluster
apiVersion: kind.x-k8s.io/v1alpha4
nodes:
- role: control-plane
kubeadmConfigPatches:
- |
kind: InitConfiguration
nodeRegistration:
kubeletExtraArgs:
node-labels: "ingress-ready=true"
extraPortMappings:
- containerPort: 80
hostPort: 80
protocol: TCP
- containerPort: 443
hostPort: 443
protocol: TCP
EOF
Using for production environment
- Alibaba Cloud ACK Service
- AWS EKS Service
- Azure AKS Service
- Google GKE Service
Please make sure one of the ingress controllers is available.
2. Install KubeVela CLI
KubeVela CLI provides an easy to engage and manage your application delivery in command lines.
- Script
- Homebrew
- Download directly from releases
MacOS/Linux
curl -fsSl https://kubevela.io/script/install.sh | bash -s 1.3.6
Windows
Only the official release version is supported.
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.
brew update
Then install KubeVela CLI
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.
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 onAllow Anyway
.
3. Install KubeVela Core
- Default
- Helm
The version of vela CLI >= 1.2.3.
vela install --version v1.3.6
check out the outcome
If you are helm user, you can also use helm to install kubevela core:
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 --version 1.3.6 --wait
4. Install VelaUX
This is optional if you don't use UI console of KubeVela.
VelaUX is a dashboard including UI+API services, it enables you to do everything around application delivery and management.
vela addon enable velaux --version v1.3.6
expected output:
Addon: velaux enabled Successfully.
By default, velaux didn't have any exposed port, you can view it by:
vela port-forward addon-velaux -n vela-system 8080:80
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.
VelaUX need authentication. Default username is admin and get default password as below
vela logs -n vela-system --name apiserver addon-velaux | grep "initialized admin username"
If there is no password in logs, you can get it from secret with the name admin
in the vela-system
namespace.
5. Uninstall
Before uninstalling kubevela, you must delete all applications and disable all addons.
- Uninstall VelaUX
vela addon disable velaux
- Uninstall KubeVela Core
vela uninstall
- Uninstall CRD
Before deleting, you must delete all CR resources.
kubectl get crd |grep oam | awk '{print $1}' | xargs kubectl delete crd