To evaluate the services Banzai Cloud Backyards can offer, we recommend to create a test environment and use our demo application. This way you can start over any time, and try all the options you are interested in without having to worry about changes made to your existing environment, even if it’s not used in production.

Production installation is very similar, but of course you won’t need to deploy the demo application, and you must exactly specify which components you want to use.

Preparation 🔗︎

Creating a test cluster 🔗︎

If you don’t already have a Kubernetes cluster to work with, you have a few options to create a new one:

  • You can use the self-hosted or the free online version of Banzai Cloud Pipeline to deploy a cluster.
  • Deploy a single-node Banzai Cloud PKE cluster on a phyisical or virtual Linux box.
  • Launch a cluster at one of the many cloud providers’ managed offerings at their console.
  • Use KinD on your machine (increase the resource allocation on Docker for Mac).
Make sure that your Kubernetes cluster has sufficient resources. The requirements can be as high as 8 CPUs and 16 GiB of RAM if you try all the features with our demo application. The minimum requirements are 6 CPUs and 6 GiB of RAM.

Install the Backyards CLI 🔗︎

We will use the Backyards CLI to install Backyards and other components to your cluster. Normally, this tool will run on your machine. The Backyards CLI supports macOS and Linux (x86_64). It may work on Windows natively, we don’t test it.

The quickest way to install the backyards-cli package for your environment is to run the following command:

curl https://getbackyards.sh | sh

For other options, see the Backyards CLI Installation Guide.

Kubernetes config and context 🔗︎

The Backyards CLI will use your current Kubernetes context. This is loaded from the file named in the KUBECONFIG environment variable (~/.kube/config by default).

Note: You can select a Kubeconfig file explicitly using the --kubeconfig flag without having to set an environment variable.

The file supports multiple contexts, from which, the one named in use-context is selected.

Check if this is the cluster you plan to deploy Backyards to with kubectl config get-contexts.

Note: You can select a context explicitly using the --context flag without having to modify the Kubernetes context globally.

If the cluster is managed by Banzai Cloud Pipeline, simply run banzai cluster shell, which will let you select the cluster to use, and launch a subshell with the correct environment.

Deploying Backyards 🔗︎

You can install Backyards on a single cluster, or you can form a multi-cluster mesh right away.

Select the installation method you want to use:

You can install Backyards on a single cluster first, and attach additional clusters later to form a multi-cluster mesh.