Cluster And Environments
You can add your existing Kubernetes clusters and environments on the
Clusters and Environmentssection. You must have a super admin access to add a cluster.
To add cluster, go to the
Clusters & Environmentssection of
Global Configurations. Click Add cluster.
Provide the information in the following fields to add your kubernetes cluster:
Enter a name of your cluster.
Bearer token of a cluster.
kubectlmust be installed on the bastion.
Note: We recommend to use a self-hosted URL instead of cloud hosted URL. Refer the benefits of self-hosted URL.
You can get the
Bearer Tokenby running the following command depending on the cluster provider:
k8s Cluster Providers
If you are using EKS, AKS, GKE, Kops, Digital Ocean managed Kubernetes, run the following command to generate the server URL and bearer token:
curl -o https://raw.githubusercontent.com/devtron-labs/utilities/main/kubeconfig-exporter/kubernetes_export_sa.sh \
&& bash kubernetes_export_sa.sh cd-user devtroncd
If you are using a
microk8s cluster, run the following command to generate the server URL and bearer token:
curl -o https://raw.githubusercontent.com/devtron-labs/utilities/main/kubeconfig-exporter/kubernetes_export_sa.sh && sed -i 's/kubectl/microk8s kubectl/g' \
kubernetes_export_sa.sh && bash kubernetes_export_sa.sh cd-user \
- Disaster Recovery:
- It is not possible to edit the server URL of a cloud specific provider. If you're using an EKS URL (e.g.
*****.eu-west-1.elb.amazonaws.com), it will be a tedious task to add a new cluster and migrate all the services one by one.
- But in case of using a self-hosted URL (e.g.
clear.example.com), you can just point to the new cluster's server URL in DNS manager and update the new cluster token and sync all the deployments.
- Easy Cluster Migrations:
- In case of managed Kubernetes clusters (like EKS, AKS, GKE etc) which is a cloud provider specific, migrating your cluster from one provider to another will result in waste of time and effort.
- On the other hand, migration for a self-hosted URL is easy as the URL is of single hosted domain independent of the cloud provider.
If you want to see application metrics against the applications deployed in the cluster, Prometheus must be deployed in the cluster. Prometheus is a powerful tool to provide graphical insight into your application behavior.
Note: Make sure that you install
Monitoring (Grafana)from the
Devtron Stack Managerto configure prometheus. If you do not install
Monitoring (Grafana), then the option to configure prometheus will not be available.
Enable the application metrics to configure prometheus and provide the information in the following fields:
Provide the URL of your prometheus.
Prometheus supports two authentication types:
Save Clusterto save your cluster on Devtron.
Your Kubernetes cluster gets mapped with Devtron when you save the cluster configurations. Now, the Devtron agent must be installed on the added cluster so that you can deploy your applications on that cluster.
When the Devtron agent starts installing, click
Detailsto check the installation status.
Install Devtron Agent
A new window pops up displaying all the details about the Devtron agent.
Once you have added your cluster in the
Clusters & Environments, you can add the environment by clicking
A new environment window pops up.
Enter a name of your environment.
Enter a namespace corresponding to your environment. Note: If this namespace does not already exist in your cluster, Devtron will create it. If it exists already, Devtron will map the environment to the existing namespace.
Select your environment type:
Note: Devtron shows deployment metrics (DORA metrics) for environments tagged as
Saveand your environment will be created.
- You can also update an environment by clicking the environment.
- You can change
- You cannot change the
- Make sure to click Update to update your environment.