Skip to main content

Civo UI Install

Summary​

After reviewing and confirming you have all of the prerequisites required for this installation process this page walks through all of the steps for Kubefirst installation with Civo and the Kubefirst UI.

Installing Kubefirst​

Step 1 - Install the Platform Installer Tools​

Run the following command launch the Kubefirst installer. This enables us to create your new management cluster in Civo using your preferred git provider.

kubefirst launch up

Step 2 - Connect to Kubefirst provisioning tool​

When kubefirst launch up completes, it launches a browser displaying the Kubefirst installer at - http://console.kubefirst.dev

Kubefirst Installer

Step 3 - Create your management cluster​

  1. From the path in the previous step select your preferred Git provider. (We’re using GitHub for this example.)

    Authentication

  2. Provide the required details for your Git provider.

    • Personal Access Token/GitHub username
    • Organization name (Group for GitLab)
    • Civo API Key

  3. Select Next for Cluster details. Note: the recommendations below are the minimum requirements to run a management cluster.

    • Alerts email - receives notifications for encryption certificate expiration. This email will not be used by Konstruct for anything outside of these notifications
    • Cloud region - fra1 (recommended)
    • Instance size - g4s.kube.large (recommended)
    • Number of nodes - 4 (recommended)
    • DNS provider - For Cloudflare provide the Cloudflare token, cluster domain name, subdomain name (optional), and cluster name

    Cluster details

  4. Advanced Options are all optional and allow you to:

    • Override the gitops-template repository
    • Specify a different GitOps template branch
    • Use HTTPs instead of SSH
    • Prevent the installation of the Kubefirst Pro UI component

  5. Select Create Cluster once you’re satisfied with the details you’ve provided to start provisioning! This process is typically about 15-20 minutes.

  6. When your cluster has successfully provisioned select Next.

    Successful provisioning

  7. After successful provisioning the cluster details with the new Vault password are provided in the next screen.

tip

This part of the provisioning process creates your management cluster, bootstraps your new platform onto that cluster, and then adds the Kubefirst UI to that platform. Kubefirst includes a management cluster for free. You can upgrade your license to manage additional workload clusters.

Step 4 - Launch the Kubefirst Pro UI​

From the success screen you can now launch the Kubefirst Pro UI

Cluster is ready

  1. Select Open kubefirst console to see your cluster details.

    • The default username for your new platform bot administrator account is kbot
    • Save this password somewhere safe to retain access to your management cluster.

    New management cluster

Congratulations you have a brand new management cluster. 🎉

What's Next?​

After completing the installation we recommend that you deprovision the install cluster.

Remove the Kubefirst installer​

After you’ve completed your Kubernetes Pro installation you can run the following commands to remove the installer from your cluster.


kubefirst launch down

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: