🚨 Warning: The project is still under heavy development, its UI/UX is also for demo purpose, please don't look inside unless you know what you are doing Please contact @wonderflow if you are interested in its full story or becoming one of the boostrap contributors/maintainers. 🚨

Install

Prerequisites

Kubernetes cluster running Kubernetes v1.15.0 or greater
kubectl current context is configured for the target cluster install
- kubectl config current-context

Get the Vela CLI

Download the vela binary from the Releases page. Unpack the vela binary and add it to $PATH to get started.

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

Install Vela Core

$ vela install

This command will install vela core controller into your K8s cluster, along with built-in workloads and traits.

Demos

Check workloads

$ vela workloads
  NAME         	DEFINITION
  backend      	containerizeds.standard.oam.dev
  task         	jobs
  webservice   	containerizeds.standard.oam.dev

workload run

$ vela comp run -t webservice app123 -p 80 --image nginx:1.9.4
Creating AppConfig app123
SUCCEED

$ vela comp status app123

$ vela comp ls
NAME 	APP  	WORKLOAD  	TRAITS     	STATUS  	CREATED-TIME
app123  app123  deployment	           	Deployed	2020-08-27 10:56:41 +0800 CST

app

$ vela app ls
app123

$ vela app delete app123
Deleting AppConfig "app123"
DELETE SUCCEED

Auto-Completion

bash

To load completions in your current shell session:
$ source <(vela completion bash)

To load completions for every new session, execute once:
Linux:
  $ vela completion bash > /etc/bash_completion.d/vela
MacOS:
  $ vela completion bash > /usr/local/etc/bash_completion.d/vela

zsh

To load completions in your current shell session:
$ source <(vela completion zsh)

To load completions for every new session, execute once:
$ vela completion zsh > "${fpath[1]}/_vela"

Clean your environment

$ helm uninstall vela-core -n oam-system
release "vela-core" uninstalled

$ kubectl delete crd workloaddefinitions.core.oam.dev traitdefinitions.core.oam.dev
customresourcedefinition.apiextensions.k8s.io "workloaddefinitions.core.oam.dev" deleted
customresourcedefinition.apiextensions.k8s.io "traitdefinitions.core.oam.dev" deleted

$ rm -r ~/.vela

CONTRIBUTING

Check out CONTRIBUTING.md to see how to develop with KubeVela.