Before installing Devtron's Modern Kubernetes Dashboard, make sure to fulfill the following requirements:

• Create a Kubernetes cluster

• Install Helm

• Recommended Resources

Create a Kubernetes Cluster

You can create any (preferably K8s version 1.16 or higher) for installing Devtron.

You can create a cluster using one of the following cloud providers as per your requirements:

Recommended Resources

The minimum cluster resource requirements for installing Modern Kubernetes Dashboard (as per the number of applications you want to manage on Devtron) are provided below:

Install Helm

Refer to know the process of installing Helm on your target machine.

Next Steps

Refer

The Authorization section describes how to authenticate and authorize access to resources, also managing role-based access levels in Devtron.

Access can be granted to a user via:

• SSO Login Services

• User Permissions

• Permission Groups

Projects are the logical grouping of your applications so that you can manage and control the access level of users.

Refer user permissions for more detail.

Add Project

1. To add a project name, go to the Projects section of Global Configurations.

2. Click Add Project.

3. Provide a project name in the field and click Save.

Introduction

The Devtron Resource Browser provides you a central interface to view and manage all your across clusters. It helps you perform key actions like viewing logs, editing live manifests, and even creating/deleting resources directly from the user interface. This is especially useful for troubleshooting purposes as it supports multi-cluster too.

Preface

In Argo CD, a user manages one dashboard for one ArgoCD instance. Therefore, with multiple ArgoCD instances, the process becomes cumbersome for the user to manage several dashboards.

With Devtron, you get an entire Argo CD app listing in one place. This listing includes:

• Argo CD apps present in the cluster where Devtron is installed

Introduction

The Modern Kubernetes Dashboard by Devtron provides a unified interface for managing and observing all Kubernetes resources across your clusters. It simplifies resource management by offering visualizations, RBAC controls, multi-cluster support, thus making it intuitive for you to view and manage your microservices.

This documentation helps you deploy a few Helm Charts available on Devtron.

Parts of Documentation

Deploying mySQL Helm Chart

Deploying mongoDB Helm Chart

1. Add Helm Repo

Add the Devtron Helm repository to pull the necessary charts

2. Update Helm Repo

Update the Helm repo to ensure you are using the latest version.

3. Install Dashboard

For EKS, AKS, GKE Users

For Minikube, MicroK8s, Kind, K3s Users

Click the relevant tab given below to get the command:

For Cloud VM Users (AWS EC2, Azure VM, GCP VM)

It is recommended to use Cloud VM with 2vCPU+, 4GB+ free memory, 20GB+ storage, Compute Optimized VM type, and Ubuntu Flavoured OS.

First, create a MicroK8s Cluster:

Then use these commands after setting up MicroK8s:

4. Get Dashboard URL

For EKS, AKS, GKE Users

Run the following command to get the dashboard URL:

Assuming you have an EKS cluster, you might get a similar message as shown below:

here, hostname aaff16e9760594a92afa0140dbfd99f7-305259315.us-east-1.elb.amazonaws.com is the Loadbalancer URL at which you can access the Devtron dashboard.

For Minikube, MicroK8s, Kind, K3s Users

For Cloud VM Users (AWS EC2, Azure VM, GCP VM)

Get devtron-service port number using the following command:

The dashboard URL will be: http://<HOST_IP>:<nodeport>/dashboard

5. Get Admin Login credentials

By default, the username will be admin. Run the below command to get the admin password.

Sample Configuration

Values You Would Require at SSO Provider

Devtron provides a sample configuration out of the box. There are some values that you need to either get from your SSO provider or give to your SSO provider.

Values to Fetch

• clientID

• clientSecret

Values to Provide

• redirectURI (provided in SSO Login Services by Devtron)

Reference

Introduction

The Resource Browser allows you to integrate monitoring graphs and dashboards from tools like Grafana, Kibana, Prometheus, and many more tools, with each cluster. This centralizes all monitoring visuals for your clusters in one place within Devtron, streamlining troubleshooting and significantly reducing manual effort.

It works similarly to a 'Single Pane of Glass (SPOG)' that displays data coming from different sources in a single unified view.

Tutorial

Steps

1. Go to Resource Browser and select your cluster.

2. Click the graph icon as shown below and click the Add Panel button.
3. Give a name to the monitoring dashboard and add the iframe code supplied by your graph/dashboard tool.

You can also rearrange and resize the graphs/dashboards in case you have added many of them. Refer the to know more.

Preface

Flux CD doesn't have any official dashboard; however, Devtron supports the listing of your apps in one dashboard.

With Devtron, you get an entire Flux CD app listing in one place. This listing includes:

• Flux CD apps present in the cluster where Devtron is installed

• Flux CD apps present in other clusters you added to Devtron

View FluxCD App Listing

In the FluxCD Apps tab, select the cluster(s) from the dropdown to view the Flux CD apps available in the chosen cluster(s).

(Optional) Once you choose cluster(s), you may use the Template Type dropdown to further filter your Flux CD app listing based on its type, i.e., or .

Click any Flux CD app to view its details as shown below.

Advantages

Devtron also bridges the gap for Flux CD users by providing additional features as follows:

• Single-pane View: All Flux CD apps will show details such as their app status, environment, cluster, and namespace together in one dashboard.

• Feature-rich Options: Clicking an Flux CD app will give you access to its logs, terminal, events, manifest, available resource kinds, pod restart log, and many more.

Introduction

bitnami/mysql Helm chart bootstraps a single node MySQL deployment on a Kubernetes cluster using the Helm package manager.

Sample Configuration

Values You Would Require at SSO Provider

Sample Configuration

Values You Would Require at SSO Provider

User with 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.

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

• You will see the user-defined name for the cluster in Devtron. E.g. default-cluster.

• Select the node you wish to troubleshoot from the Node

You can add more chart repositories to Devtron. Once added, they will be available in the All Charts section of the . Note: After the successful installation of Devtron, click Refetch Charts to sync and download all the default charts listed on the dashboard.

Add Chart Repository

Search a Resource

You can use the searchbox to browse the resources.

Filter Resources

Moreover, you can use filters that allow you to quickly filter your workload as per labels, field selectors, or as shown below.

Resource Kinds

Resource kinds displayed upfront for you to manage:

• Nodes

• Events

• Namespaces

Further resources in the cluster are grouped under the following categories:

• Namespace

• Workloads

• Config & Storage

• Networking

Edit a Manifest

You can edit the of a Kubernetes object. This can be for fixing errors, scaling resources, or changing configuration. Moreover, you can edit a manifest or , as per your convenience.

Edit using YAML

Edit using GUI

View Events

You can monitor activities like creation, deletion, updation, scaling, or errors in the resources involved. Refer to learn more.

AI-assistance on Events

For events with warnings, you can take the assistance of AI. Clicking the Explain button will help you identify the root cause of the issue along with suggestions to fix those.

Delete a Resource

You can delete an unwanted resource if it is orphaned and no longer required by your applications.

Create a Resource

You can create one or more in your cluster using YAML. In case you wish to create multiple objects, separate each resource definition by three dashes (---).

Once you select a cluster in Resource Browser, click + Create Resource, and add the resource definition.

In the below example, we have created a simple pod named nginx:

Here's one more example that shows the required fields and object specifications for a Kubernetes Deployment:

Bulk Actions on Resources

You can use the checkbox to select the resources/workloads you wish to delete or restart.

Bulk Delete

Bulk Restart

The Devtron Dashboard displays the helm applications deployed to your cluster and lets you deploy your own helm charts or third-party charts (e.g. postgresql) using the Chart Store.

View Helm Apps

1. From the left pane, go to Applications.

2. Click the Helm Apps tab.

You can see the Helm Apps available in your cluster. If you have connected more than one cluster to Devtron, you can use the Cluster selection dropdown to view the respective Helm Apps in your other clusters.

Deploy Helm Charts

1. Discover the Chart from Chart Store

• Select the Charts section from the left pane, you will be landed to the Chart Store page.

• Search nginx or any other charts in search filter.
• Click on chart and it will redirect you to Chart Details

2. Configure the Chart

• You may refer the README.md attached to the chart to know more about the chart configurations.
• Click Configure & Deploy and enter the following details:

  Key

  Description

Create a Preset Value

• You can use the default values or create preset value by clicking on Create preset value.
• You can name your preset value, select a chart version, and change the configurations in the YAML file using the editor.
• Click on Save Value to save the template, and go back and choose your template from the dropdown for deployment.

3. Check Deployment Status

After clicking the Deploy button, you will land on the App Details page that shows the status of the chart deployment.

The status of the chart should be Healthy. It might take a few seconds after initiating the deployment of the chart. In case the status of the deployment shows Degraded or if takes a long time to get deployed, click Details in Application Status section on the same page or check the logs of the pods to debug the issue.

1. Shows status of deployed chart.

2. Shows the controller service accounts being used.

3. In the Configure tab, you can update, upgrade, or delete your chart instance.

4. From the Chart used section you can go to the charts page where you can see all the running instances of this chart.

Update or Upgrade Helm Chart

• For update, you can change its Chart Version or values.yaml and then click Update And Deploy.
• For upgrade, click on Helm Chart field, search a chart name, change its values corresponding, and click Update And Deploy.

5. Delete Chart Instances

Clicking on View Chart in Chart Used section in the App Details page will redirect you to the Chart Details page where you can see the number of instances installed by that chart along with an option to delete those chart instances too.

Manifest

Shows you the of the selected pod and allows you to edit it. Refer to learn more.

Events

Shows you all the activities (create/update/delete) of the selected pod. Refer to know more.

Logs

Examining your cluster's pods helps you understand the health of your application. By inspecting pod logs, you can check the performance and identify if there are any failures. This is especially useful for debugging any issues effectively.

Moreover, you can download the pod logs for ease of sharing and troubleshooting as shown in the below video.

Pod Last Restart Snapshot

Frequent pod restarts can impact your application as it might lead to unexpected downtimes. In such cases, it is important to determine the root cause and take actions (both preventive and corrective) if needed.

In case any of your pod restarts, you can view its details from the pod listing screen:

• Last pod restart event, along with the timestamp and message

• Reason behind restart

• Container log before restart

• Node status and events

Terminal

You can access the terminal within a running container of a pod to view its logs, troubleshoot issues, or execute commands directly. This is different from the you get at node level.

Launching Ephemeral Container

This is a part of . It is especially useful when kubectl exec is insufficient because a container has crashed or a container image doesn't include debugging utilities.

1. In the Resource Browser, select Pod within Workloads.

2. Use the searchbar to find and locate the pod you wish to debug. Click the pod.

3. Go to the Terminal tab

4. Click Launch Ephemeral Container as shown below.

Once Devtron is installed, it has a built-in admin user with super-admin privileges having unrestricted access to all Devtron resources. We recommended to use this user only for initial and global configurations and then switch to local users or configure SSO-login.

Only users with super-admin privileges can configure the SSO. Devtron uses Dex for authenticating a user against the identity provider.

Below are the SSO providers which are available in Devtron. Select one of the SSO providers (e.g., GitHub) to configure SSO:

• Google

• GitHub

Dex implements connectors that target specific identity providers for each connector configuration. You must have a created account for the corresponding identity provider and registered an app for client key and secret.

Refer the following documents for more detail.

• https://dexidp.io/docs/connectors/

• https://dexidp.io/docs/connectors/google/

Create SSO Configuration

Make sure that you have a .

• From the left sidebar, go to Global Configurations → Authorization → SSO Login Services

• Click any SSO Provider of your choice.

• In the URL field, enter the valid Devtron application URL where it is hosted.

Note:

• Only single SSO login configuration can be active at one time. Whenever you create or update any SSO configuration, it will be activated and used by Devtron and previous configurations will be deleted.

• Except for the domain substring, URL and redirectURI remains same.

Update SSO Configuration

You can change SSO configuration anytime by updating the configuration and click Update. Note: In case of configuration change, all users will be logged out of Devtron and will have to login again.

Configuration Payload

• type : Any platform name such as (Google, GitLab, GitHub etc.)

• name : Identity provider platform name

• id : Identity provider platform which is a unique ID in string. (Refer to

Next Steps

After configuring an SSO for authentication, you must in Devtron for them to be able to log in via SSO.

In case you have enabled auto-assign permissions in or , relevant must also exist in Devtron for a successful login.

Introduction

Let's assume that you are creating an application and want to use mongodb to store data of your application. You can deploy mongodb using bitnami/mongodb Helm chart and connect it to your application.

This guide will introduce you to how to deploy the mongoDB's Helm chart.

1. Discover the Chart from the Chart Store

Visit the Chart Store page by clicking on Charts present on left panel and find bitnami/mongodb Helm Chart. You also can search mongodb chart using the search bar.

2. Configure the Chart

• After selecting the bitnami/mongodb Helm chart, click on Configure & Deploy.
• Enter the following details before deploying the mongoDB chart:

  Key

  Description

Configure Values

Using GUI

Set the following parameters in the chart.

Using YAML

You can configure the values.yaml according to your project's requirements. To learn about different parameters used in the chart, you can check

Click on Deploy Chart once you have finished configuring the chart.

3. Check the Status of Deployment

After clicking on Deploy Chart, you will be redirected to App Details page that shows the deployment status of the chart. The Status of the chart should be Healthy. It might take few seconds after initiating the deployment.

In case the status of the deployment is Degraded or takes a long time to get deployed, click on Status or check the logs of the pods to debug the issue.

4. Extract the Service name

Copy the service name, it will be used to connect your application to mongoDB.

Resource Utilization

This shows the combined CPU and memory consumption of all running pods in the cluster.

Errors in Cluster

This shows errors in the cluster. If no error is present in the cluster, Resource Browser will not display this section.

Catalog Framework

Based on the schema provided in the catalog framework, you can add relevant details for each cluster. Refer for more details.

Readme

You can also include additional information about your cluster using the Markdown editor.

Check Compatibility before Cluster Upgrade

Whenever you upgrade your Kubernetes version, the API versions change and your workloads/resources may not be compatible with those API versions. Therefore, the resources need to be upgraded first. This could mean changing the API version of the resources itself or changing their outdated spec.

The Check Compatibility feature within Resource Browser scans your cluster and automatically identifies all such resources/workloads that need manual intervention before proceeding with an actual cluster upgrade.

Walkthrough

Sample Configuration

Values to fetch from LDAP

Devtron provides a sample configuration out of the box. Here are some values you need to fetch from your LDAP.

• bindDN

• bindPW

• baseDN

Reference

Auto-assign Permissions

Since LDAP supports creation of User Groups, this feature simplifies the onboarding process of organizations having a large headcount of users. It also eliminates repetitive permission assignment by automatically mapping your LDAP User groups to Devtron's during single sign-on (SSO) login.

If you've created user groups in LDAP, you can create corresponding permission groups in Devtron with the same names. When members of those user groups first log in to Devtron, they'll automatically inherit the permissions from their Devtron permission group. This means you can't manually adjust or add mapped to a permission group.

Introduction

If you wish to run kubectl commands from your local system, you need to have access to your cluster. Traditionally, the kubeconfig file (./kube/config) helps you connect with the cluster from your local system.

Prerequisite

The cluster in which Argo CD apps exist should be added in Global Configurations → Clusters and Environments

Prerequisite

The cluster in which Flux CD apps exist should be added in Global Configurations → Clusters and Environments

Introduction

Devtron makes it easier for you to populate your charts from multiple sources to the . These sources are:

Introduction

In Devtron, you can create CRDs for defining lock schema. Your lock schema will be used to determine the fields (in the resource manifest) that cannot be added/updated/deleted by non-superadmins. This is especially useful for preventing unwanted edits to the manifests of pod, deployment, configmap, and many more.

Editing Lock Schema

1. Go to Resource Browser and select your cluster.

2. Use the searchbox labelled 'Jump to Kind' and search for LockSchema.
3. Click the Lock Schema you wish to edit. In case no Lock Schema exists, you may for your resource kind.

Create your own Lock Schema

1. Go to Resource Browser and select your cluster.

2. Click Create Resource at the top.

3. Use the following template and specify the fields/paths you wish to lock in the lockedPaths list, also specify the resource kinds in applyTo. Once done, click Apply.

Introduction

You can add your existing Kubernetes clusters and environments on the Clusters and Environments section. You must have a access to add a cluster.

Prerequisites

A verified account on . Okta activates your account only if email verification is successful.

Here's a reference guide to set up your Okta org and application:

You can see the list of nodes available in your cluster. Typically you have several nodes in a cluster; in a learning or resource-limited environment, you might have only one node.

The components on a typical node include the kubelet, a container runtime, and the kube-proxy.

If you have multiple nodes, you can search a node by name or label in the search bar. The search result will display the following information about the node. To display a parameter of a node, use Columns on the right side, select the parameter to display from the drop-down list, and click Apply.

Clicking on a node shows you a number of details such as:

• CPU Usage and Memory Usage of Node

• CPU Usage and Memory Usage of Each Pod

• Number of Pods in the Node

• List of Pods

Further using the Devtron UI, you will be able to:

Debug a Node

You can debug a node via 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.

• Click Debug.
• Debug a node by selecting the terminal shell, i.e., bash or sh.

Cordon a Node

Cordoning a node means making the node unschedulable. After , new pods cannot be scheduled on this node.

• Click Cordon.
• A confirmation dialog box will appear, click Cordon Node to proceed.

The status of the node shows SchedulingDisabled with Unschedulable parameter set as true.

Similarly, you can uncordon a node by clicking Uncordon. After a node is uncordoned, new pods can be scheduled on the node.

Drain a Node

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

After the node is drained, all pods (including those managed by DaemonSets) in the node will be automatically drained to other nodes in the cluster, and the drained node will be set to cordoned status.

• Click Drain.
• A confirmation dialog box will appear, click Drain Node to proceed.

You can also select from the following conditions before draining a node:

Taint a Node

Taints are key:value pairs associated with effect. After you add taints to nodes, you can set tolerations on a pod to allow the pod to be scheduled to nodes with certain taints. When you taint a node, it will repel all the pods except those that have a toleration for that taint. A node can have one or many taints associated with it.

Note: Make sure to check taint validations before you add a taint.

• Click Edit taints.
• Enter the key:value pairs and select the from the drop-down list.
• Click Save.

You can also add more taints using + Add taint button, or delete the existing taint by using the delete icon.

Edit a Node Config

This allows you to directly edit any node. It will open the editor which contains all the configuration settings in which the default format is YAML. You can edit multiple objects, although changes are applied one at a time.

• Go to the YAML tab and click Edit YAML.

• Make the changes using the editor.

• Click Review & Save changes to compare the changes in the YAML file.

• Click Apply changes to confirm.

Delete a Node

You can also delete a node by clicking the Delete button present on the right-hand side.

The node will be deleted from the cluster.

Introduction

An incident response if delayed can impact businesses, revenue, and waste valuable engineering time. Devtron's Resource Watcher enables you to perform automated actions upon the occurrence of events:

• Create Event - Occurs when a new Kubernetes resource is created, for e.g., a new pod spun up to handle increased traffic.

• Update Event - Occurs when an existing Kubernetes resource is modified, for e.g., deployment configuration tweaked to increase the replica count.

• Delete Event - Occurs when an existing Kubernetes resource is deleted, for e.g., deletion of an orphaned pod.

You can make the Resource Watcher listen to the above events and accordingly trigger a webhook to notify the relevant party. Since manual intervention is absent, the timely response of this auto-remediation system improves your operational efficiency.

Creating a Watcher

This page allows you to create a watcher to track events and trigger a webhook. It also shows the existing list of watchers (if any).

1. Click + Create Watcher.
2. Creating a watcher consists of 4 parts, fill all the sections one by one:

Basic Details

Here, you can give a name and description to your watcher.

Namespaces to Watch

Here, you can select the whose you wish to monitor for changes.

• You can watch the namespace(s) across All Clusters (existing and future).
• Or you can watch namespace(s) of Specific Clusters.

Intercept Change in Resources

Here, you can select the exact Kubernetes resource(s) you wish to track for changes (in the namespace(s) you selected in the previous step).

• You can choose the resource from the Resource kind(s) to watch dropdown. Enter the Group/Version/Kind (GVK) if it's a custom resource definition (CRD), for e.g., install.istio.io/v1apha1/IstioOperator

• Choose the event type your watcher should listen to: Created, Updated, Deleted.

  Event Type

  Description

Example: DEVTRON_FINAL_MANIFEST.status.currentReplicas == DEVTRON_FINAL_MANIFEST.spec.maxReplicas

Execute Runbook

Here, you can set up a webhook to receive notifications when specified changes in Kubernetes resources are detected.

• Webhook URL: Here, you'll provide the Webhook URL where you want the payload delivered. It must be valid and reachable for the watcher to work properly.

• Header Key-Value: Fill in any relevant header key-value pairs necessary for authentication or to include additional metadata for the receiving endpoint.

• Payload: Define what you want to deliver to the Webhook when this watcher is triggered. You can customize this payload with information related to changes in the intercepted resources. You can pass the properties of resource manifest in the webhook payload using the following keys:

Click Create Watcher. Your watcher is now ready to intercept the changes to the selected resources.

Viewing Intercepted Changes

Details

This page allows you to view the changes to Kubernetes resources that you have selected for tracking changes.

It comes with the following items to help you locate the resource, where the event has been intercepted:

• Searchbox

• Cluster filter

• Namespace filter

• Action filter (event type, i.e., Created, Updated, Deleted

You get the following details in the results shown on the page.

Change in Resource

You can check the changes in manifest by clicking View Manifest in Change In Resource column.

Use Cases

Live Stream Traffic Surge

A live streaming sports application experiences a surge in viewers during a major game. The Horizontal Pod Autoscaler (HPA) might not be able to handle the unexpected traffic if it's capped at a low max replica count.

1. Create a watcher named 'Live Stream Scaling Alert'.

2. Monitor updates to HPA resource in the application's namespace.

3. When currentReplicas count reaches maxReplicas, trigger a webhook to intimate the concerned users.

Pod Health Monitoring

A stock trading application constantly updates stock prices for its traders. If the pods become unhealthy, traders might see incorrect stock prices leading to bad investments.

1. Create a watcher named 'Pod Health Monitor'.

2. Track the pod workload of your application, if DEVTRON_FINAL_MANIFEST.status.phase != 'Running', trigger a webhook to notify the stakeholders.

API tokens are the access tokens for authentication. Instead of using username and password, it can be used for programmatic access to API. It allows users to generate API tokens with the desired access. Only super admin users can generate API tokens and see the generated tokens.

Generate API Token

To generate API tokens, go to Global Configurations -> Authorization -> API tokens and click Generate New Token.

• Enter a name for the token.

• Add Description.

• Select an expiration date for the token (7 days, 30 days, 60 days, 90 days, custom and no expiration).

• To select a custom expiration date, select Custom from the drop-down list. In the adjacent field, you can select your custom expiration date for the API token.

• You can assign permission to the token either with:

  • Super admin permission: To generate a token with super admin permission, select Super admin permission.

  • Specific permissions: Selecting Specific permissions option allows you to generate a token with a specific role for:

• Click Generate Token.

A pop-up window will appear on the screen from where you can copy the API token.

Use API Token

Once Devtron API token has been generated, you can use this token to request Devtron APIs using any API testing tool like Jmeter, Postman, Citrus. Using Postman here as an example.

Open Postman. Enter the request URL with POST method and under HEADERS, enter the API token as shown in the image below.

In the Body section, provide the API payload as shown below and click Send.

As soon as you click Send, the created application API will be triggered and a new Devtron app will be created as provided in the payload.

Update API Token

To set a new expiration date or to make changes in permissions assigned to the token, we need to update the API token in Devtron. To update the API token, click the token name or click on the edit icon.

To set a new expiration date, you can regenerate the API token. Any scripts or applications using this token must be updated. To regenerate a token, click Regenerate token.

A pop-up window will appear on the screen from where you can select a new expiration date.

Select a new expiration date and click Regenerate token.

This will generate a new token with a new expiration date.

To update API token permissions, give the permissions as you want to and click Update Token.

Delete API Token

To delete an API token, click delete icon. Any applications or scripts using this token will no longer be able to access the Devtron API.

Introduction

In Devtron, you can create CRDs for defining the GUI schema. Your GUI schema will be used to determine the fields displayed to the user when they edit the manifest in GUI mode.

Editing GUI Schema

1. Go to Resource Browser and select your cluster.

2. Use the searchbox labelled 'Jump to Kind' and search for Guischema.
3. Click the GUI schema you wish to edit. In case no GUI schema exists, you may for your resource kind.

Create your own GUI Schema

1. Go to Resource Browser and select your cluster.

2. Click Create Resource at the top.

3. Use the following template and define your schema in the schema object, also specify the resource kinds in applyTo. Once done, click Apply.

If you have stored in your , you can add the OCI registry to Devtron's Modern Kubernetes Dashboard and pull those to Devtron's [Chart Store].

You can configure an OCI registry using any registry provider of your choice, including:

• ECR

• Docker

• Azure

External Links allow you to connect to the third-party applications within your Devtron dashboard for seamlessly monitoring/debugging/logging/analyzing your applications. You can select from the pre-defined third-party applications such as Grafana to link to your application for quick access.

Configured external links will be available on the App details page. You can also integrate Document or Folder using External Links.

Some of the third-party applications which are pre-defined on Devtron Dashboard are:

Introduction

Ideally, all resources such as microservices, clusters, jobs, pods, etc. should contain detailed information so that its users know what each of those resources do, how to use them, as well as all their technical specs. Access to such data makes it easier for engineers to quickly discover and understand the relevant resources.

To achieve this, Devtron supports a feature known as Catalog Framework. Using this, you as a can decide the data you expect from the managers of different resource types. In other words, you can create a custom that would ultimately render a form for the resource owners to fill. Once the form is filled, a GUI output will appear as shown below.

Using the Permission groups, you can assign a user to a particular group and a user inherits all the permissions granted to the group.

The advantage of the Permission groups is to define a set of privileges like create, edit, or delete for the given set of resources that can be shared among the users within the group.

Introduction

The Chart Store shows all the Helm Charts added to the Chart Repository/OCI registry connected to Devtron.

Refer to know the process of deploy helm charts from the chart store.

Add User

To add a user, go to the Authorization > User Permissions section of Global Configurations. Click Add user.

There are two types of permissions in Devtron:

Assign Super admin permission

To assign a super admin access, go to the Authorization > User Permissions section of Global Configurations.

• Click Add user.

• Provide the email address of a user. You can add more than one email address. Please note that email address must be same as that in the email field in the JWT token returned by OIDC provider.

• Select Super admin permission and click Save.

Note:

• Only users with Super admin permission can assign super admin permissions to a user.

• We suggest that super admin access must be given to the selected users only.

Assign Specific permissions

To assign a specific permission, go to the Authorization > User Permissions section of Global Configurations.

• Click Add user.

• Provide the email address of a user. You can add more than one email address. Please note that email address must be same as that in the email field in the JWT token returned by OIDC provider.

• Select Specific permissions.

Helm Apps Permissions

In Helm Apps option, you can provide access to a user to manage permission for Helm apps deployed from Devtron or outside Devtron.

Provide the information in the following fields:

You can add multiple rows for Helm app permission.

Once you have finished assigning the appropriate permissions for the users, Click Save.

Kubernetes Resources Permissions

In Kubernetes Resources option, you can provide permission to view, inspect, manage, and delete resources in your clusters from page in Devtron. You can also create resources from the Resource Browser.

Note: Only super admin users will be able to see Kubernetes Resources tab and provide permission to other users to access Resource Browser.

To provide Kubernetes resource permission, click Add permission.

On the Kubernetes resource permission, provide the information in the following fields: