Overview 🔗︎

This quick start guide shows you how to install a self-hosted evaluation instance of the Banzai Cloud Pipeline platform on a local machine. This procedure uses the Banzai CLI tool to deploy a Banzai Cloud Pipeline platform on your machine. The infrastructure will consist of a Kubernetes in Docker (kind) cluster on your machine, which runs the components of Pipeline.

After completing the steps, you will have an environment where you can:

  • import clusters, and
  • evaluate the services of the Banzai Cloud Pipeline platform.

CAUTION:

This installation is strictly for evaluation purposes. You cannot convert this installation into a production installation.

Alternatively:

System requirements 🔗︎

The following procedure works on macOS or Linux (x86_64). If you do not have access to a computer running macOS or Linux, evaluate the Banzai Cloud Pipeline platform online.

Limitations 🔗︎

This installation method is easy and self-contained, but has the following limitation.

  • You won’t able to access the installed service from other machines by default. This means that you won’t be able to create PKE clusters with this Banzai Cloud Pipeline instance, because the cluster must be able to access this Banzai Cloud Pipeline instance (for example, from the cloud provider).

If your machine (especially the TCP 443 port) is accessible from the Internet, you can set the external IP address or FQDN as the external hostname of your installation and providerConfig.listenAddress to 0.0.0.0 in the values file. Note that if you have already deployed Pipeline, you have to re-create the kind cluster to take this change effect by running banzai pipeline down, and running banzai pipeline up again.

Prerequisites 🔗︎

Install the following software on the machine that you will use to manage the deployment (usually your laptop).

  • Banzai CLI tool — the installation process depends heavily on the Banzai CLI tool
  • Docker 18.09+ — the heavy lifting of the deployment is managed by a Docker container

Banzai CLI tool 🔗︎

Banzai Cloud Pipeline is installed using the Banzai CLI tool, which you use for everyday tasks in the Banzai Cloud world.

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

curl https://getpipeline.sh | sh

on Linux You can also use our packages for the most popular Linux distributions. For more options, check our detailed Installation guide for Banzai CLI.

You will also need kubectl`, the command line tool for Kubernetes. Since most Linux distributions have outdated packages for kubectl, we recommend using the following one-liner, or other options from the Kubernetes documentation:
curl https://getpipeline.sh | sh -s -- kubectl.

on macOS: You can install Banzai CLI on macOS directly with Homebrew: brew install banzaicloud/tap/banzai-cli. The Homebrew formula for Banzai CLI also installs kubectl automatically.

Make sure that your Banzai CLI version is up-to-date.

Docker 🔗︎

The installer needs a recent version of the Docker container engine, at least version 18.09. If you don’t already have it installed, follow the Docker docs for your platform.

Please note that the Docker daemon should be running, the docker command should be in the PATH, and the account used for the installation process should have the privileges needed to run containers (for Linux, check the post-installation steps).

For Docker for Mac, ensure that at least 3 CPU and 3 GiB of memory is allocated. You can check this on the Preferences > Advanced tab of Docker for Mac.

Install Banzai Cloud Pipeline 🔗︎

The installer creates a Kubernetes in Docker (kind) cluster on your local machine. Complete the following steps to install the Banzai Cloud Pipeline platform.

  1. To start the installer, simply execute the following command, and answer the questions displayed.

    banzai pipeline up --provider=kind
    
  2. Before finishing, the command will display the URL and access credentials of the created Banzai Cloud Pipeline instance. Record this information, you will need it to login. For example:

    Outputs:
    
    pipeline-address = https://default.localhost.banzaicloud.io/
    pipeline-password = ishbdfwoeihefo
    pipeline-username = admin@example.com
    
  3. When your Banzai Cloud Pipeline instance is ready for use, the installer offers to login for you. Accept the displayed certificate, and use the displayed credentials to login using your browser.

  4. A browser window shows up. Log in with the username and password from the terminal output. After that, you can return to your console.

    Note: If you cannot login for some reason, you can try to login later using the banzai login command.

Next steps 🔗︎

To try the features of the Banzai Cloud Pipeline platform, you will need a Kubernetes cluster that is managed by Pipeline. You can either:

  • create a cluster with Pipeline, or
  • import an existing cluster into Pipeline by following the Create your first cluster guide.

We recommend creating and importing a PKE cluster on your local machine using Vagrant. Alternatively, if your local machine is accessible from the Internet, you can create a cluster on one of the managed Kubernetes services.