To try the features of the Banzai Cloud Pipeline in your own environment, you will need a Kubernetes cluster managed by Pipeline. You can either create a cloud provider managed cluster (like AKS, EKS, GKE, etc), or a PKE cluster or import an existing Kubernetes cluster. The networking setup created in the local installation guide does not allow the automatic deployment of Banzai Cloud PKE clusters (unless you create an internet tunnel), but you can import a PKE cluster running on your machine.

This quick start guide will lead you through the process of launching a single-node PKE cluster with Vagrant, and importing it to your own local instance of Banzai Cloud Pipeline. After completing the steps, you will have an environment where you can evaluate most services of the platform.


This guide assumes that you already have an own local instance of Banzai Cloud Pipeline, and the Banzai CLI tool logged in to it.

Spinning up PKE with Vagrant

Head over to the Vagrant downloads page and get the appropriate installer or package for your platform. Install the package using standard procedures for your operating system. The installer will automatically add vagrant to your system path so that it is available in terminals.

Alternatively you can install it on MacOS with Homebrew:

brew cask install virtualbox
brew cask install vagrant
brew cask install virtualbox-extension-pack
vagrant plugin install vagrant-vbguest

Create Vagrant configuration file. This will be used as a template for virtual machine creation.

curl 'https://banzaicloud.com/downloads/pke/pke-centos7-single.vagrantfile' -o Vagrantfile

Start the virtual machine.

vagrant up

Import cluster to Banzai Cloud Pipeline

To import the cluster, download its kubeconfig from the VM just created:

vagrant ssh node1 -c 'sudo cat /etc/kubernetes/admin.conf' > pke.yaml

After that you can import it to Banzai Cloud Pipeline with the Banzai CLI:

banzai cluster import --no-interactive --kubeconfig=pke.yaml --name=myfirstcluster

Verify running cluster

You can check the status of the import with the following command:

banzai cluster get myfirstcluster

Once the cluster is ready, you can try it with some simple commands. banzai cluster shell executes a shell within the context of the selected cluster. If you type a command in the shell opened, or pass it as arguments, it will be executed in a prepared environment. For example, you can list the nodes of the cluster using the original kubectl command:

banzai cluster shell -- kubectl get nodes

Further steps

If you are happy with the results, go on with the Deploying workload guide to learn about the basic features of a cluster.