Manage Your Clusters Using the kubegrid UI¶
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
The logs show you the raw output from the underlying tools and let you know where it’s at in the overall process.
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.
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.
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.
From here, you can add a new cluster, delete this cluster, or view additional details.
Cluster detail page¶
View Details for a specific cluster to view additional details.
At the top, you can see the overall status of your cluster (in this case, running). Next, you see the Cluster IP address. This is the IP address to use to ssh into your Kubernetes master node, if you want to do so.
If you do want to directly access your Kubernetes cluster, you can do so via a web-based terminal or from your local computer. See Accessing Your Cluster for additional information.
For the web-based terminal, click
kubectl terminal. This will open up a terminal in a new tab, which you can use to control your Kubernetes cluster. When prompted, log in with your KubeGrid account credentials.
For config files to enable access via your local terminal, click on
View Config Files. This will show 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.
If you click
Cluster Dashboard, you’ll be shown a link and a token. Open the link in a new tab, and use the token when prompted.
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.
The pod summary table 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.
The Hosting Providers page shows you a list of the hosting provider profiles that you have created.
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.
The Repository Profiles page shows you a list of the repositories you have linked to kubegrid.
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.
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.
You can check the status of any support tickets you’ve opened under the
Support top menu item.
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.