Manage Your Clusters Using the kubegrid UI

Live Logs

While your cluster is deploying, you can view the logs that are being generated. You can access these by clicking the direct link on the last page of the Setup Wizard. Alternatively, you can find them by clicking Clusters from the Shortcuts menu on the left side of the screen, then the wrench icon for your cluster, then select the Logs tab. alt text

alt text

alt text

The logs show you the raw output from the underlying tools and let you know where it’s at in the overall process.

Update Services

When you commit a change to your Git branch that is associated with a service in kubegrid, kubegrid will detect the change and will redeploy the service on your cluster. You’ll receive an email to remind you this is happening.


Let’s explore the Services page, linked from the Shortcuts menu. alt text

Services page

Here is a list of all the services that you have defined across all your clusters. Click on the wrench icon to view additional details about the service. alt text

Here, you can give your service a name. You can also modify the configuration file that kubegrid uses to define the service, or point kubegrid to a specific .yml file in your repository to use instead. Also, you can define the environment variables that your service needs.


To see an overview of all your clusters, click the Clusters link from the Shortcuts menu. alt text

From here, you can view individual cluster details or delete clusters.

Cluster detail page

Click View Details for a specific cluster to view additional details. alt text

At the top, you can see the overall status of your cluster (in this case, running). In the Overview tab, you see the Cluster IP address and a list of nodes. The Cluster IP address is the IP address to use to ssh into your Kubernetes master node, if you want to do so. The node summary table shows all the nodes in your cluster, their names, IP address, and status. From here, you can add or remove nodes to/from your cluster.

Pods tab

The Pods tab shows the status and source of each pod in your cluster. If it runs a public web server, it also contains a link to access that service. From the wrench menu, you can choose to remove this service from this cluster. From the + button, you can add a new pod to this cluster. alt text

Monitoring tab

The Monitoring tab provides tools to monitor the status of your cluster. The k8s cluster tab provides cluster-level metrics such as CPU usage, memory usage, and network I/O. The etcd tab provides details about each etcd node of your cluster. alt text

kubectl tab

The kubectl tab provides a web-based terminal which is pre-configured for kubectl communication with your cluster. See Accessing Your Cluster for additional information. alt text

Cluster Dashboard

The k8s Dashboard tab shows the Kubernetes Dashboard. alt text

Config tab

The Config tab shows two new buttons — Download SSH Key and Download k8s Config. The first button will download the SSH key to use to SSH into a node. The public IP address of the master node to use with SSH is shown at the top of the page. The second button will download the kubeconfig file to use with kubectl. If there are Windows worker nodes in the cluster, there will be a third button to access the password for the Windows machines to use to log in. For all hosting providers except Azure, the default username is "core". For Azure, it is "azureuser". If you're using self-managed servers, the username and SSH key are what you provided during setup.

Additionally, the top-level yaml file that kubegrid uses to manage your cluster is displayed. alt text

Logs tab

The Logs tab shows the recent activity on your cluster, and provides links to a terminal view of the deployment logs. alt text

Hosting Providers

The Hosting Providers page shows you a list of the hosting provider profiles that you have created. alt text

You can edit the region / access credentials / etc associated with each profile by clicking on the wrench icon. You can add a new hosting provider by clicking the Add New Hosting Provider button.

Repository Profiles

The Repository Profiles page shows you a list of the repositories you have linked to kubegrid. alt text

You can add additional repositories by selecting the provider and following the on-screen instructions. However, no new services will be added to any clusters.

Adding More Clusters

When you’re ready to make more clusters, you can add the repository information, hosting provider information, service definitions, and cluster definition through the corresponding Shortcuts menu pages. However, it is easier to go back through the Setup Wizard again. The hosting provider, repository, and service information that you’ve configured previously will be available to you to re-use.

Getting Help

If you aren’t sure how to do so something, or something isn’t working, please open a support ticket by clicking the Open Ticket button in the top menu. alt text

You can check the status of any support tickets you’ve opened under the Support top menu item.

Providing Feedback

We’d love to hear your suggestions for the future evolution of kubegrid! Please contact us by email using the Contact Us top menu item.