Skip to main content
Version: 2.2

GitHub Prerequisites


Local Prerequisites

If you are on macOS, and have Homebrew installed, you can run:

brew install kubefirst/tools/kubefirst

To upgrade an existing kubefirst CLI to the latest version run:

brew update
brew upgrade kubefirst

There are other ways to install kubefirst for different operating systems, architectures, and containerized environments. See our installation README for details.

DigitalOcean Prerequisites

For kubefirst to be able to provision your DigitalOcean cloud resources:

Create your new kubefirst cluster

Adjust the following command with your GitHub and DigitalOcean key in addition to the appropriate values for your new platform.

export GITHUB_TOKEN=ghp_xxxxxxxxxxxxxxxx
export DO_TOKEN=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
export DO_SPACES_KEY=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
export DO_SPACES_SECRET=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

kubefirst beta digitalocean create \
--alerts-email \
--github-org your-github-org \
--domain-name \
--cluster-name kubefirst

By default kubefirst use the cloud providers to manage DNS. You also have the option to use Cloudflare.

To do so, add the dnsProvider flag with the value cloudflare to your create command —dnsProvider cloudflare.

You also need to set the CF_API_TOKEN environment variable with a Cloudflare token (export CF_API_TOKEN=xxxxxxxxx) having the Zone.Zone, and Zone.DNS edit permission. More information on Cloudflare token creation in their documentation.

Example of terminal output following cluster creation

terminal handoff

Root credentials

To obtain your 3 initial passwords, run

kubefirst beta vultr root-credentials

root credentials

Connecting to Kubernetes

To connect to your new Kubernetes cluster, run

export KUBECONFIG=~/.k1/kubeconfig

To view all cluster pods, run

kubectl get pods -A