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.
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 methods described in Create a test cluster.
CAUTION: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 8 GiB of RAM.
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.
backyards-clipackage for your environment by running the following command:
curl https://getbackyards.sh | sh
For other options, see the Backyards CLI Installation Guide.
Set Kubernetes configuration and context 🔗︎
The command-line tool 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 the product by running the following command: kubectl config get-contexts
If there are multiple contexts in the Kubeconfig file, specify the one you want to use with the
use-context parameter, for example:
kubectl config use-context <context-to-use>
If the cluster is managed by Banzai Cloud Pipeline, complete the following steps. For more detailed instructions, see the Banzai Cloud Pipeline documentation.
- Login to your Pipeline instance (for example, by running banzai login --endpoint https://try.pipeline.banzai.cloud/pipeline).
- Run banzai cluster shell, and select the cluster to use. A subshell with the correct environment will open automatically.
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.