Skip to content

Getting Started

First, create an account. Once you’ve done that and are logged in, you’ll be taken to the main page, which looks like this:

alt text

This page summarizes the state of your account. Since you just created it, everything will be zero. To fix that, let’s get started by clicking the Setup wizard link in the left Shortcuts menu.

alt text

Create Hosting Provider

alt text

Here, you’ll need to first select the hosting provider you’d like to use for your first cluster. Once selected, you’ll be prompted to enter additional information such as the region in which you’d like your cluster to be created and credential information. Once you’ve entered this information, click Next: Kubernetes.

Define Kubernetes Configuration

alt text

Here, you’ll define the basics of your desired Kubernetes cluster configuration. First, give your cluster a name, which will be used by the kubegrid UI to refer to this cluster. Then, determine the size of the compute nodes for your Kubernetes cluster and the number and composition (linux-based vs Windows-based) of Kubernetes worker nodes. The master size must be at least small in order to provide enough resources to successfully run a simple configuration. The number and size of worker nodes, in conjunction with the resources required by your application, will determine the scaling capacity of your cluster.

You can also either enable or disable the Web UI (Dashboard). If enabled, a Kubernetes dashboard will be set up on your cluster, and a link to view the dashboard will be provided once the cluster is live.

When the settings are complete, click Next: Pods.

Define Services

alt text

The next step is to add application services to your cluster, which will be deployed in Kubernetes Pods. For the moment, services come from your Git repository. Kubegrid will create a container for your cluster, dependent on the application type. In the near future, you’ll also be able to provide your own Dockerfile or include services from Dockerhub.

When you select GIT, you can then choose which provider hosts the repository that contains your service. When you select a provider, you’ll be prompted to provide your credentials and grant access. Then select a repository and branch that contain a service you want to run on this cluster. If not auto-detected, click Select Application to tell kubegrid which application type this service is. alt text

Kubegrid will enable a webhook on the repository/branch combination. Going forward, when you commit updates onto this branch, kubegrid will get called and will build and deploy the service onto your cluster, using connection draining to replace the previous version on your cluster.

When all the fields are filled in, click Create Service.

alt text

At this point, you can add more services to the cluster by clicking Add Another. This will take you back through the same flow that you went through for the first service. Keep adding services until all the services you want to run on your cluster are added. Then click Next: Review & Launch.

Launch

alt text

At this point, you’re presented with a screen summarizing the configuration that has been specified using your inputs from the Setup Wizard.

The Kubernetes tab shows you the Kubernetes configuration files that will be used to deploy your Kubernetes cluster. The kubegrid tab shows you the settings that define the cluster from the top-level kubegrid configuration.

If you want, you can go back and change things on any previous Setup Wizard screen. Otherwise, click Launch This Configuration.

See UI Tour for details on how to manage your cluster once it's deployed. Notably, links to your public-facing applications will be available in the cluster's Pod Summary.