Devtron Kubernetes Desktop Client

Introduction

The Devtron Kubernetes Desktop Client is a lightweight dashboard that is installed outside your Kubernetes cluster on a arm64 / amd64 based architecture to help you manage your Kubernetes resources with a unified view.

The Devtron Kubernetes Desktop Client comes packaged with the following modules:

• Kubernetes Resource Browser - To manage all Kubernetes resources in your cluster(s)

• Clusters - To perform troubleshooting and node operations on the cluster(s) you connect from the Devtron Kubernetes Desktop Client

Steps

1. Run the following command in your terminal to automatically download the executable file. Devtron Kubernetes Desktop Client will automatically opened in your default browser.

   Copy

   wget -O devtron-install.bash https://cdn.devtron.ai/k8s-client/devtron-install.bash && [ -f devtron-install.bash ] && sh devtron-install.bash start

1. Open your terminal and enter the following command to download and run a bash script for generating the kubeconfig:

   Copy

   curl -O https://raw.githubusercontent.com/devtron-labs/utilities/main/kubeconfig-exporter/kubernetes_export_sa.sh && bash kubernetes_export_sa.sh cd-user devtroncd

   The cluster credentials are displayed in the output of the command.

1. Fetch the cluster credentials (Cluster name, Server URL, Bearer token) from the terminal and note them aside.

   
2. Navigate to Global Configurations → Clusters → Add cluster and paste the credentials in their respective fields.

   

   
3. Click Save Cluster. This cluster will now be displayed in the Kubernetes Resource Browser page. Refer Kubernetes Resource Browser or Clusters in the Devtron Kubernetes Desktop Client for more information.

4. To stop the Devtron Kubernetes Desktop Client, run the following command in your terminal:

   Copy

   sh devtron-install.bash stop

sh devtron-install.bash start

Kubernetes Resource Browser

Kubernetes Resource Browser, in short, is a central interface from which you can view logs, edit live manifests, and even perform CRUD operations (create, read, update, or delete) on resources like pods, deployments, configmaps, jobs, and many more in the cluster(s).

On the left side bar, under the K8s Resources tab, the Kubernetes resources are grouped into the following categories:

• Workloads

• Config & Storage

• Networking

• RBAC

• Administration

• Other Resources

• Custom Resource

For the convenience of the user, the Resource Browser page comes with a search box and filters to locate resource kinds quickly.

Create a Resource

Sample Script for Creating a Pod

apiVersion: v1
kind: Pod
metadata:
  name: my-sample-pod
  labels:
    app: sampleApp
spec:
  containers:
  - name: nginx-container
    image: nginx:latest
    ports:
    - containerPort: 80

View a Resource

Update a Resource

Delete a Resource

Clusters

Devtron Kubernetes Desktop Client allows you to add multiple clusters and manage all of them from your local machine. The Clusters module allows you to view CPU and Memory metrics like CPU Capacity, Memory Capacity, and much more.

Perform Node Operations

You can perform node operations such as Cordon, Drain, and Taints either from the (⋮) icon displayed against the cluster name or by clicking the cluster itself.

Access Cluster Terminal

At any time, you can debug and troubleshoot any issues in your cluster using the Cluster Terminal. You can access the Cluster Terminal by either clicking Terminal option in the Overview page or by clicking the cluster and then clicking the Debug option. The same Cluster Terminal will be opened irrespective of the option that you choose.

Upgrade Devtron Kubernetes Desktop Client

To upgrade your Devtron Kubernetes Desktop Client, run the following command in your terminal. The Devtron Kubernetes Desktop Client will automatically be stopped, and the downloaded latest executable file will be opened in the default browser.

sh devtron-install.bash upgrade