- GitHub
- GitLab
GitHub Prerequisites
- A GitHub organisation.
- A new GitHub account for your
kbot
automation user. - A GitHub personal access token for your
kbot
account.
Prerequisites
Local Prerequisites
Install the kubefirst CLI.
Google Cloud Prerequisites
For kubefirst to be able to provision your Google Cloud resources:
- A Google Cloud account in which you are an account owner.
- A publicly routable DNS.
- The
GOOGLE_APPLICATION_CREDENTIALS
environment variable set with the credential JSON file (see Google Cloud documentation for more information on how to generate it).
Create your new kubefirst cluster
Adjust the following command with your GitHub and Google Cloud tokens in addition to the appropriate values for your new platform.
export GITHUB_TOKEN=ghp_xxxxxxxxxxxxxxxx
kubefirst beta gcp create \
--alerts-email [email protected] \
--github-org your-github-org \
--domain-name your-domain.io \
--gcp-project your-project-id \
--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 --dns-provider 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
Root credentials
To obtain your 3 initial passwords, run
kubefirst beta vultr 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
GitLab
- Create or use an existing GitLab account.
- Create a GitLab group developer permissions.
- A GitLab personal access token for your
kbot
account.
Prerequisites
Local Prerequisites
Install the kubefirst CLI.
Google Cloud Prerequisites
For kubefirst to be able to provision your Google Cloud resources:
- A Google Cloud account in which you are an account owner.
- A publicly routable DNS.
- The
GOOGLE_APPLICATION_CREDENTIALS
environment variable set with the credential JSON file (see Google Cloud documentation for more information on how to generate it).
Create your new kubefirst cluster
Adjust the following command with your GitHub and Google Cloud tokens in addition to the appropriate values for your new platform.
export GITLAB_TOKEN=glpat-xxxxxxxxxxxxxxxx
kubefirst beta gcp create \
--alerts-email [email protected] \
--git-provider gitlab \
--gitlab-group your-fully-qualified-gitlab-group/or-sub-group \
--domain-name your-domain.io \
--gcp-project your-project-id \
--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 --dns-provider 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
Root credentials
To obtain your 3 initial passwords, run
kubefirst beta vultr 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