Skip to content

Conversation

@SNe789
Copy link
Contributor

@SNe789 SNe789 commented Dec 21, 2022

Description

  • Added Clusters section

@SNe789 SNe789 force-pushed the cluster-terminal-docs branch from fad8bbb to c4c4910 Compare December 28, 2022 14:24
@SNe789 SNe789 changed the title docs: added cluster section docs: added cluster, k8s resource browser, k8s resource permission Jan 5, 2023
@SNe789 SNe789 force-pushed the cluster-terminal-docs branch from 2f0c8ce to c979576 Compare January 6, 2023 10:08

### Drain a Node

Before performing maintenance on a node, draining a node evicts all of your pods safely from a node. Safe evictions allow the pod’s containers to gracefully terminate and will manage the `PodDisruptionBudgets` you have specified (if relevant).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

will manage the PodDisruptionBudgets -> honour the PodDisruptionBudgets

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.


### Configure YAML

The config.yaml file contains all the configuration settings that are needed to deploy your cluster.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

its node edit, not he cluster edit

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.


### Delete a Node

* Go to the `Clusters` section from the left navigation pane.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

write this document with context of cluster-detail page

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

for any change in app config you don't start with app listing page

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done


### Debug Pod

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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

how we are supporting this

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

@@ -0,0 +1,105 @@
# Resource Browser

`Resource Browser` lists all of the resources running in cluster in your current project. You can use it to view, inspect, manage, and delete resources in your clusters. You can also create resources from the `Resource Browser`.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

project has no role here

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done


![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/kubernetes-resource-browser/kubernetes-resource-browser-latest.jpg)

The following resources are grouped in the following categories:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

twice following is not required here

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done


* **Workloads** displays workloads (Cronjob, Deployment, StatefulSet, DaemonSet, Job, and Pod resources) deployed to clusters in your current project. Includes each workload's name, status, type, number of running and total desired Pods, namespace, and cluster.

* **Config & Storage** provide both long-term and temporary [storage](https://kubernetes.io/docs/concepts/storage/) to Pods in your cluster and [configuration](https://kubernetes.io/docs/concepts/configuration/) of pods.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

provide both long-term and temporary -> need to explain context better way

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done


#### Manifest

The Manifest shows the critical information such as container-image, restartCount, state, phase, podIP, startTime etc. and status of the pods which are deployed.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

need to revisit this definition

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done


#### Events

Events display you the events that took place during the deployment of an application. These events are available until 15 minutes of deployment of the application.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

need to revisit this definition

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

nishant-d
nishant-d previously approved these changes Jan 10, 2023
@nishant-d nishant-d merged commit a816981 into devtron-labs:main Jan 10, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants