KubestackKubestack

Framework Tutorial

Contribute on GithubJoin #kubestack on Slack

Get Started

This tutorial will help you get started with the Kubestack framework. It is divided into three steps.

Community Help: If you have any questions while following the tutorial, join the #kubestack channel on the Kubernetes community. To create an account request an invitation.

1. Design platform

Starting with step one, you will design your custom Kubernetes platform stack. If you're trying Kubestack for the first time, start with the minimal defaults. You can always expand your platform later.

2. Provision infrastructure

Continuing with step two, you will set-up cloud prerequisites and bootstrap your Kubernetes platform's environments and clusters for the first time. This step provisions the platform you designed in step one in the cloud.

3. Set-up automation

Finally, in step three, you will integrate CI/CD to automate changes following Kubestack's GitOps workflow. Once automation is configured, you are ready to maintain your Kubernetes platform together as a team.

When you are ready, let's get started and install the CLI.

Install the CLI

The CLI is a single binary Go application. It helps you scaffold the Terraform code that defines the clusters, node pools or services of your platform. The CLI works on local files only, you can see any change it makes with git status.

You can follow the command line instructions below or download the latest version from the GitHub releases directly.

LinuxMacOSWindows

  1. Download and extract the latest release

    Binaries are available for AMD64 and ARM64.

    AMD64

    # Download the latest AMD64 release
    curl -LO "https://github.com/kbst/kbst/releases/download/$(curl -s https://www.kubestack.com/cli-latest.txt)/kbst_linux_amd64.zip"
    

    # Extract the AMD64 binary into your PATH e.g. /usr/local/bin
    sudo unzip -d /usr/local/bin/ kbst_linux_amd64.zip kbst

    ARM64

    # Download the latest ARM64 release
    curl -LO "https://github.com/kbst/kbst/releases/download/$(curl -s https://www.kubestack.com/cli-latest.txt)/kbst_linux_arm64.zip"
    

    # Extract the ARM64 binary into your PATH e.g. /usr/local/bin
    sudo unzip -d /usr/local/bin/ kbst_linux_arm64.zip kbst

  2. Verify the binary works

    # Verify the binary works
    kbst --version
next