Skip to content

Commit c4c4910

Browse files
committed
added clusters section
1 parent f5007a0 commit c4c4910

File tree

1 file changed

+37
-4
lines changed

1 file changed

+37
-4
lines changed

docs/user-guide/clusters.md

Lines changed: 37 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -58,9 +58,24 @@ To display a parameter of a node, use the `Columns` on the right side, select th
5858

5959
To see the summary of a node, click the particular node.
6060

61-
## Troubleshoot Cluster via Terminal
61+
![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/clusters/node-overview-clusters.jpg)
6262

63-
User with [Super admins](https://docs.devtron.ai/global-configurations/authorization/user-access#assign-super-admin-permissions) access can now troubleshoot cluster issues by accessing the cluster terminal from Devtron. You can select an image from the list that has all CLI utilities like kubectl, helm, netshoot etc. or can use a custom image.
63+
### YAML
64+
65+
The config.yaml file contains all the configuration settings that are needed to deploy your cluster.
66+
67+
* You can edit or modify the parameters or values of a node by clicking `YAML`.
68+
* Click `Review Changes` to compare the changes in the YAML file.
69+
* Click `Update Node`.
70+
71+
### Debug a Node
72+
73+
You can debug a node via Terminal by selecting your namespace and image from the list that has all CLI utilities like kubectl, helm, netshoot etc. or can use a custom image, which is publicly available.
74+
75+
76+
## Access Cluster via Terminal for Troubleshooting
77+
78+
User with [Super admins](https://docs.devtron.ai/global-configurations/authorization/user-access#assign-super-admin-permissions) access can now troubleshoot cluster issues by accessing the cluster terminal from Devtron. You can select an image from the list that has all CLI utilities like kubectl, helm, netshoot etc. or can use a custom image, which is publicly available.
6479

6580
To troubleshoot a cluster or a specific node in a cluster, click the terminal symbol on the right side.
6681

@@ -69,9 +84,27 @@ To troubleshoot a cluster or a specific node in a cluster, click the terminal sy
6984
* You will see the user-defined name for the cluster in Devtron. E.g. `default-cluster`.
7085
* In the `Nodes` field, select the node from the drop-down list you want to troubleshoot. E.g. `demo-new`.
7186
* Select the namespace from the drop-down list which you have added in the [Environment](https://docs.devtron.ai/global-configurations/cluster-and-environments#add-environment) section.
72-
* Select the image from the drop-down list which includes all CLI utilities or you can use a custom image.
73-
* Select the terminal shell from the drop-down list (e.g. `sh`, `bash`, `powershell`, `cmd`) to troubleshoot a node.
87+
* Select the image from the drop-down list which includes all CLI utilities or you can use a custom image, which is publicly available.
88+
* Select the terminal shell from the drop-down list (e.g. `sh`, `bash`) to troubleshoot a node.
89+
90+
91+
### Debug Pod
92+
93+
You can also create pod for debugging which will connect to pod terminal. To find out why the particular pod is not running, you can check `Pod Events` and `Pod Manifest` for details.
94+
95+
Or you can also use the following commands to show events at the end of the output for the pod:
96+
97+
```bash
98+
kubectl describe pod <podname>
99+
```
100+
101+
or
102+
103+
```bash
104+
kubectl get events
105+
```
74106

107+
According to the `Pod Events` messages and `Pod Manifest`, you can debug a pod.
75108

76109
**Note**: A pod can have one or more containers running, and a container can have no or multiple shells running in it. If you are not able to create a successfull connection, try changing the shell, as the container may not have that shell running.
77110

0 commit comments

Comments
 (0)