Overview

This quick start guide will lead you through the process of getting started with an own instance of the Banzai Cloud Pipeline platform on a local machine, and import a PKE cluster into it. After completing the steps, you will have an environment where you can import clusters and evaluate the services of the platform.

There is an alternative quick start method for Amazon Web Services as well. If you don’t want to bother with the installation, either try Banzai Cloud Pipeline online for free, or contact our sales team for a demo about our solutions for your environment.

In this method we will use the Banzai CLI tool to deploy a Banzai Cloud Pipeline environment on your machine. The infrastructure will consist of a KinD cluster on your machine, which runs the components of Pipeline.

Prerequisites

Before we start, there are a few items that you will need on the machine that will be used to manage the deployment (usually your laptop).

  • MacOS or Linux (x86_64) — most of the native tooling around Kubernetes is for these platforms, so is ours
  • 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 will like to use for everyday tasks anyway 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

Alternatively you can use our packages for the most popular Linux distributions. You can install Banzai CLI on macOS directly with Homebrew: brew install banzaicloud/tap/banzai-cli. For more options, check our detailed Installation guide for Banzai CLI.

You will also need kubectl`, the command line tool for Kubernetes. The Homebrew formula for Banzai CLI takes care of installing it, but because most Linux distributions have outdated packages for kubectl, we recommend the following one-liner, or other options from the Kubernetes documentation:
curl https://getpipeline.sh | sh -s – kubectl.

Docker

The installer needs a recent version — at least 18.09 — of the Docker container engine. 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).

In case of Docker for Mac, you will have to ensure that at least 3 CPU and 3 GiB of memory is allocated. You can check this on the Advanced tab of the Preferences window of Docker for Mac.

Install Banzai Cloud Pipeline

The installer will create a Kubernetes in Docker (KIND) cluster on your local machine.

banzai pipeline up --provider=kind

Logging in with Banzai CLI

Your Banzai Cloud Pipeline instance is ready for use!

If the installation was successful, the last few lines of the output contains a user name and password that can be used for logging in.

Run the banzai login --endpoint=https://localhost/pipeline command, accept the certificate, and log in using your browser.

A browser window will show up, and you’ll be able to log in with the username and password from the output. After that, you can return to your console.

Limitations

This installation method is easy and self-contained, but 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 they have to call back from the cloud provider to Pipeline. Also, the optional CI/CD service of the system, and thus Spotguides won’t work either, because they require the webhooks of the source code management system (Github) to reach the platform.

If your machine (especially the TCP 443 port) is available from the internet, you can set the external IP address or FQDN as the external hostname of your installation, and run banzai pipeline up again.

What’s Next ?

To try the features of the platform, you will need a Kubernetes cluster that is managed by Pipeline. You can either create a cluster with or import an existing one into Pipeline. We recommend to create and import a PKE cluster on your local machine using Vagrant, or try one of the managed Kubernetes services.