Vultr CLI Install
Summary
After reviewing and confirming you have all of the prerequisites required for this installation process review the docs here to walk through all of the steps for installation with Vultr and the CLI.
Installing Kubefirst
To get started with this installation you will need to have your git token (for GitHub or GitLab) and the credential associated with your Vultr account.
Kubefirst assumes you will also use Vultr to manage DNS, to use Cloudflare refer to the tip below.
Update to use Cloudflare
To use Cloudflare for DNS 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
) with the Zone.Zone, and Zone.DNS edit permission.
Refer to the Cloudflare token creation details in their documentation.
Steps for Installation
To get started with this installation you will need to have your git provider details (for GitHub or GitLab).
GitHub Installation Steps
Run the following command for GitHub (updated with your values). Note that Kubefirst uses your Cloud Provider to manage DNS but you can also use Cloudflare.
export GITHUB_TOKEN=ghp_xxxxxxxxxxxxxxxx
export VULTR_API_KEY=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
kubefirst vultr create \
--alerts-email [email protected] \
--github-org your-github-org \
--domain-name your-domain.io \
--cluster-name kubefirst
GitLab Installation steps
Run the following command For GitLab (updated with your values). Note that Kubefirst uses your Cloud Provider to manage DNS but you can also use Cloudflare.
export GITLAB_TOKEN=glpat-xxxxxxxxxxxxxxxx
export VULTR_API_KEY=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
kubefirst vultr create \
--alerts-email [email protected] \
--git-provider gitlab \
--gitlab-group your-fully-qualified-gitlab-group/or-sub-group \
--domain-name your-domain.io \
--cluster-name kubefirst
What's Next?
After your initial setup you can connect to your new cluster, upgrade and begin creating workload clusters, manage your users, or explore the functionality available in Kubefirst (or Kubefirst Pro in the UI).
Get your root credentials
To obtain your three initial passwords, run the following command.
kubefirst 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
Explore Kubefirst
By default your new management cluster has been created in the Free tier of the Kubefirst Platform. This tier includes access to the Kubefirst Pro UI.
Now that you have a functional install you may want to:
- Explore more details on Kubefirst Features
- Read details on how to upgrade or manage users and passwords in Kubefirst Administration
- Reach out to us on Slack to chat or ask questions