To evaluate the services Banzai Cloud Backyards offers, 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.

Prerequisites 🔗︎

Before deploying Backyards on your cluster, complete the following tasks.

Create a test cluster 🔗︎

You need a Kubernetes cluster to test Backyards with. If you don't already have a Kubernetes cluster to work with, create one with one of the following methods:

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.
  • Deploy a single-node Banzai Cloud PKE cluster on a physical or virtual Linux box.
  • Launch a cluster at one of the many cloud providers’ managed offerings at their console.
  • Use KinD on your machine (make sure to increase the resource allocation of Docker for Mac).

Install the Backyards tool 🔗︎

Install the Backyards command-line tool. You can use the Backyards CLI tool to install Backyards and other components to your cluster.

Note: The Backyards CLI supports macOS and Linux (x86_64). It may work on Windows natively, but 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.

Set Kubernetes configuration and context 🔗︎

The Backyards CLI uses your current Kubernetes context, from the file named in the KUBECONFIG environment variable (~/.kube/config by default). Check if this is the cluster you plan to deploy Backyards by running the following command: kubectl config get-contexts

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, login to your Pipeline instance (for example, by running banzai login --endpoint https://beta.banzaicloud.io/pipeline), run banzai cluster shell, and select the cluster to use. A subshell with the correct environment will open automatically.

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.

Deploy Backyards 🔗︎

After you have completed Prerequisites, 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.