Skip to content

docs: Devtron Intelligence + Resource Browser Restructuring #94

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.

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

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
10 changes: 9 additions & 1 deletion docs/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,15 @@
* [Software Distribution Hub](user-guide/software-distribution-hub/README.md)
* [Tenants](user-guide/software-distribution-hub/tenants.md)
* [Release Hub](user-guide/software-distribution-hub/release-hub.md)
* [Resource Browser](user-guide/resource-browser.md)
* [Resource Browser](user-guide/resource-browser/README.md)
* [Overview Page](user-guide/resource-browser/overview.md)
* [Discover and Manage Resources](user-guide/resource-browser/manage-resources.md)
* [Nodes and Operations](user-guide/resource-browser/nodes.md)
* [Pod Management and Debugging](user-guide/resource-browser/pods.md)
* [Using Devtron Intelligence](user-guide/resource-browser/devtron-intelligence.md)
* [Cluster Terminal](user-guide/resource-browser/cluster-terminal.md)
* [Add Monitoring Dashboards/Graphs](user-guide/resource-browser/monitoring-graphs.md)
* [Run Kubectl Commands Locally](user-guide/resource-browser/kubectl-local.md)
* [Resource Watcher](user-guide/resource-watcher.md)
* [Charts](user-guide/deploy-chart/README.md)
* [Charts Overview](user-guide/deploy-chart/overview-of-charts.md)
Expand Down
12 changes: 6 additions & 6 deletions docs/reference/glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ A place where all Helm charts are centrally listed for users to deploy applicati

A cluster in Kubernetes refers to a set of connected computers (nodes) that collectively manage containerized applications using Kubernetes. It provides resources and services to run, manage, and scale applications.

In Devtron, you can view the list of clusters in 'Global Configurations' as well as 'Resource Browser'. [Read More...](../user-guide/resource-browser.md)
In Devtron, you can view the list of clusters in 'Global Configurations' as well as 'Resource Browser'. [Read More...](../user-guide/resource-browser/README.md)

### Commit Hash

Expand All @@ -64,7 +64,7 @@ An OCI-compliant registry can also store artifacts (such as helm charts). Here,

### Cordoning

Temporarily marking a node as unschedulable, preventing new pods from being assigned to it. In Devtron, you can cordon a node by going to Resource Browser → (choose a cluster) → Nodes → (click on a node) → Cordon (available in blue). [Read More...](../user-guide/resource-browser.md#cordon-a-node)
Temporarily marking a node as unschedulable, preventing new pods from being assigned to it. In Devtron, you can cordon a node by going to Resource Browser → (choose a cluster) → Nodes → (click on a node) → Cordon (available in blue). [Read More...](../user-guide/resource-browser/nodes.md#cordon-a-node)

### CronJob

Expand Down Expand Up @@ -104,7 +104,7 @@ However, in case you don't have a Dockerfile, Devtron helps you create one. Go t

Evacuating pods from a node before cordoning it, ensuring that running pods are gracefully rescheduled on other nodes.

In Devtron, you can drain a node by going to Resource Browser → (choose a cluster) → Nodes → (click on a node) → Drain (available in blue). [Read More...](../user-guide/resource-browser.md#drain-a-node)
In Devtron, you can drain a node by going to Resource Browser → (choose a cluster) → Nodes → (click on a node) → Drain (available in blue). [Read More...](../user-guide/resource-browser/nodes.md#drain-a-node)

### Environment

Expand Down Expand Up @@ -176,7 +176,7 @@ In Devtron, you can view a list of namespaces by going to Resource Browser → (

A setting applied to a node that influences the scheduling of pods. Taints can restrict which pods are allowed to run on the node.

In Devtron, you can edit the taints of a node by going to Resource Browser → (choose a cluster) → Nodes → (click on a node) → Edit taints (available in blue). [Read More...](../user-guide/resource-browser.md#taint-a-node)
In Devtron, you can edit the taints of a node by going to Resource Browser → (choose a cluster) → Nodes → (click on a node) → Edit taints (available in blue). [Read More...](../user-guide/resource-browser/nodes.md#taint-a-node)

### NodePort

Expand All @@ -186,13 +186,13 @@ A Kubernetes service type that exposes a port on each node in the cluster, makin

The physical or virtual machines that make up a Kubernetes cluster, where containers are scheduled to run.

In Devtron, you can view nodes by going to Resource Browser → (choose a cluster) → Nodes. [Read More...](../user-guide/resource-browser.md#nodes)
In Devtron, you can view nodes by going to Resource Browser → (choose a cluster) → Nodes. [Read More...](../user-guide/resource-browser/nodes.md)

### Objects

Kubernetes objects are the building blocks that define and manage your applications running on the platform. They are also known as 'Resources' or 'Kinds'. This includes nodes, pods, deployment, cronjob, configmap, and many more.

Devtron's [Resource Browser](../user-guide/resource-browser.md) helps you manage all such objects present in your clusters.
Devtron's [Resource Browser](../user-guide/resource-browser/README.md) helps you manage all such objects present in your clusters.

### Pod

Expand Down
4 changes: 2 additions & 2 deletions docs/setup/install/install-devtron-Kubernetes-client.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ With `Kubernetes Resource browser`, you can also perform the following:

![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/install-devtron/install+devtron+K8s+client/k8s-resource-browser.jpg)

After your cluster is added via `Global Configurations`, go to the `Kubernetes Resource Browser` page and select your cluster. [Refer Resource Browser documentation for detail and its operations](../../user-guide/resource-browser.md).
After your cluster is added via `Global Configurations`, go to the `Kubernetes Resource Browser` page and select your cluster. [Refer Resource Browser documentation for detail and its operations](../../user-guide/resource-browser/README.md).

`Note`: You do not need to have a `super admin` permission to access `Kubernetes Resource Browser` if you install `Devtron Kubernetes Client`.

Expand All @@ -80,7 +80,7 @@ It enables you to observe and monitor the cluster health and real-time node cond
* Edit a node config
* Delete a node

With its rich features and intuitive interface, you can easily manage and [debug clusters through cluster terminal access](../../user-guide/resource-browser.md#cluster-terminal) and use any CLI debugging tools like busybox, kubectl, netshoot or any custom CLI tools like k9s.
With its rich features and intuitive interface, you can easily manage and [debug clusters through cluster terminal access](../../user-guide/resource-browser/cluster-terminal.md) and use any CLI debugging tools like busybox, kubectl, netshoot or any custom CLI tools like k9s.

![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/install-devtron/install+devtron+K8s+client/cluster-terminal.jpg)

Expand Down
2 changes: 1 addition & 1 deletion docs/user-guide/app-details/ephemeral-containers.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ Wherever you can access pod resources in Devtron, you can launch an ephemeral co

### From Devtron (Resource Browser)

Click [here](../resource-browser.md#launching-ephemeral-container) to know more.
Click [here](../resource-browser/pods.md#launching-ephemeral-container) to know more.

### From Devtron's Cluster Terminal

Expand Down
2 changes: 1 addition & 1 deletion docs/user-guide/creating-application/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,7 @@ You can apply this configuration using Devtron’s **Resource Browser**

**Apply using Devtron’s Resource Browser**

1. Navigate to [Resource Browser](../resource-browser.md) in the Devtron sidebar.
1. Navigate to [Resource Browser](../resource-browser/README.md) in the Devtron sidebar.
2. Select the Cluster where your CI pipelines run.
3. Click **Create Resource**.
4. Paste the YAML into the editor and click **Create**.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ Once you have finished assigning the appropriate permissions for the groups, Cli

### Kubernetes Resources Permissions

In `Kubernetes Resources` option, you can provide permission to view, inspect, manage, and delete resources in your clusters from [Kubernetes Resource Browser](../../../user-guide/resource-browser.md) page in Devtron. You can also create resources from the `Kubernetes Resource Browser` page.
In `Kubernetes Resources` option, you can provide permission to view, inspect, manage, and delete resources in your clusters from [Kubernetes Resource Browser](../../../user-guide/resource-browser/README.md) page in Devtron. You can also create resources from the `Kubernetes Resource Browser` page.

{% hint style="info" %}
Only super admin users will be able to see `Kubernetes Resources` tab and provide permission to other users to access `Resource Browser`.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -205,7 +205,7 @@ There are three role-based access levels for Jobs:
The 'Kubernetes Resources' tab will be available only if you have super-admin permissions.
{% endhint %}

Here you can provide permission to view, inspect, manage, and delete resources in your clusters from [Devtron's Resource Browser](../../resource-browser.md).
Here you can provide permission to view, inspect, manage, and delete resources in your clusters from [Devtron's Resource Browser](../../resource-browser/README.md).

To grant Kubernetes resource permission, click **Add permission**.

Expand Down
2 changes: 1 addition & 1 deletion docs/user-guide/global-configurations/gitops.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ Alternatively, you may use the feature flag **FEATURE_USER_DEFINED_GITOPS_REPO_E

![Using Feature Flag](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/global-configurations/gitops/dashboard-cm.gif)

1. Go to [Devtron's Resource Browser](../resource-browser.md).
1. Go to [Devtron's Resource Browser](../resource-browser/README.md).
2. Select the cluster where Devtron is running, i.e., `default_cluster`.
3. Go to the **Config & Storage** dropdown on the left.
4. Click **ConfigMap**.
Expand Down
Loading