Overview 🔗︎

To try the features of the Banzai Cloud Pipeline in your own environment, you will need a Kubernetes cluster managed by Pipeline. You can:

  • create a cloud provider managed cluster (for example, AKS, EKS, GKE, and so on), or
  • create a PKE cluster,
  • or import an existing Kubernetes cluster.

When you have an own instance of Banzai Cloud Pipeline in AWS, we recommend to follow this guide, and create a PKE cluster, too.

This quick start guide will lead you through the process of launching a PKE cluster with Banzai Cloud Pipeline on Amazon EC2.

Prerequisites 🔗︎

  • AWS credentials
  • An installed Banzai Cloud Pipeline instance
  • Banzai CLI tool logged in to your Pipeline instance

Create AWS secret 🔗︎

To create the first PKE cluster, you need to add your AWS credentials to Banzai Cloud Pipeline’s secret store. The quickest way is to copy the credentials from your aws-cli configuration (the same one that you used for the installation of Banzai Cloud Pipeline).

You can simply do this with the following command:

banzai secret create --name=my-aws --magic --type=amazon

Expected output:

Id                                         Name    Type    UpdatedBy          Tags
35c837429374592ffff000002340984f08c339f0e  my-aws  amazon  admin-example-com

Alternatively you can create a more restricted access key for this purpose.

Create your first PKE on AWS cluster 🔗︎

The following procedure creates a new PKE cluster using the command line.

  1. Run the following command.

    banzai cluster create

    The command will ask for some details interactively.

  2. Select PKE on AWS as cluster type, and confirm the creation of the cluster at the end. All the other defaults should fit the needs for a test cluster.

    Note: Creating the cluster can take several minutes.

  3. Verify the cluster is running. You can check the status of the cluster creation with the following command:

    banzai cluster list

    Expected output:

    Id  Name              Distribution  CreatorName        CreatedAt             Status 
    1   example-name  pke           admin-example-com  2020-01-09T14:18:56Z  RUNNING
  4. Once the cluster is ready, you can try it with some simple commands.

    banzai cluster shell executes a shell within the context of the selected cluster. If you type a command in the shell opened, or pass it as arguments, it will be executed in a prepared environment. For example, you can list the nodes of the cluster using the original kubectl command:

    banzai cluster shell -- kubectl get nodes

Further steps 🔗︎

If you are happy with the results, go on with the Deploying workload guide to learn about the basic features of a cluster.