Skip to content

docs: adding clusters on devtron using kubeconfig #3494

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 9, 2023
Merged

docs: adding clusters on devtron using kubeconfig #3494

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0853e2f
documentation for adding clusters on devtron using kubeconfig
Jun 8, 2023
8f9ad64
added a minor correction
Jun 8, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 31 additions & 3 deletions docs/user-guide/global-configurations/cluster-and-environments.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,14 +10,19 @@ To add cluster, go to the `Clusters & Environments` section of `Global Configura

![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/global-configurations/cluster-and-environments/add-clusters.png)

Provide the information in the following fields to add your kubernetes cluster:
### Add Clusters Using Server URL & Bearer Token


To add a Kubernetes cluster on Devtron using `server url` and the `bearer token`, provide the information in the following fields:

| Field | Description |
| :--- | :--- |
| `Name` | Enter a name of your cluster. |
| `Server URL` | Server URL of a cluster.<br>Note: We recommended to use a [self-hosted URL](#benefits-of-self-hosted-url) instead of cloud hosted URL.</br> |
| `Bearer Token` | Bearer token of a cluster. |

![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/global-configurations/cluster-and-environments/add-cluster-cred.jpg)

### Get Cluster Credentials

>**Prerequisites:** `kubectl` must be installed on the bastion.
Expand All @@ -30,15 +35,15 @@ You can get the **`Server URL`** & **`Bearer Token`** by running the following c
{% tab title="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:
```bash
curl -o https://raw.githubusercontent.com/devtron-labs/utilities/main/kubeconfig-exporter/kubernetes_export_sa.sh \
curl -O https://raw.githubusercontent.com/devtron-labs/utilities/main/kubeconfig-exporter/kubernetes_export_sa.sh \
&& bash kubernetes_export_sa.sh cd-user devtroncd
```
{% endtab %}
{% tab title="Microk8s Cluster" %}
If you are using a **`microk8s cluster`**, run the following command to generate the server URL and bearer token:

```bash
curl -o https://raw.githubusercontent.com/devtron-labs/utilities/main/kubeconfig-exporter/kubernetes_export_sa.sh && sed -i 's/kubectl/microk8s kubectl/g' \
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 \
devtroncd
```
Expand All @@ -47,6 +52,8 @@ devtroncd

![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/global-configurations/cluster-and-environments/generate-cluster-credentials.png)



### Benefits of Self-hosted URL

* Disaster Recovery:
Expand All @@ -58,6 +65,27 @@ devtroncd
* 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.


### Add Clusters Using Kubeconfig

To add clusters using kubeconfig, follow these steps:

1. First, navigate to the global configurations menu, and then go to "clusters and environment" section.

2. Click on the `Add cluster` button. In the options provided, choose the `From kubeconfig` option.

3. Next, either paste the kubeconfig file or browse for it and select the appropriate file.

4. Afterward, click on the `Get cluster` button. This action will display the cluster details alongside the kubeconfig.

![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/global-configurations/cluster-and-environments/add-cluster-kubeconfig.jpg)

5. Select the desired cluster and click on `Save` to successfully add the cluster to Devtron.

![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/global-configurations/cluster-and-environments/kubeconfig-save-cluster.jpg)


**Note:** Please ensure that the kubeconfig file you use has `admin permissions`. It is crucial for Devtron to have the necessary administrative privileges; otherwise, it may encounter failures or disruptions during deployments and other operations. Admin permission is essential to ensure the smooth functioning of Devtron and to prevent any potential issues that may arise due to insufficient privileges.

### Configure Prometheus (Enable Applications Metrics)

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.
Expand Down