From 239371d94e2f4e18282b934032de60567e181b8b Mon Sep 17 00:00:00 2001 From: Hii-Arpit Date: Mon, 17 Nov 2025 20:16:18 +0530 Subject: [PATCH 01/10] docs: updated cd pipeline snapshots --- .../workflow/cd-pipeline.md | 92 +++++++++---------- 1 file changed, 46 insertions(+), 46 deletions(-) diff --git a/docs/user-guide/creating-application/workflow/cd-pipeline.md b/docs/user-guide/creating-application/workflow/cd-pipeline.md index c1a8f10d9..c28abce04 100755 --- a/docs/user-guide/creating-application/workflow/cd-pipeline.md +++ b/docs/user-guide/creating-application/workflow/cd-pipeline.md @@ -8,12 +8,12 @@ After your CI pipeline is ready, you can start building your CD pipeline. Devtro Click the '**+**' sign on CI Pipeline to attach a CD Pipeline to it. -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/workflow-cd-pipeline/workflow-cd-v2.jpg) +![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/cd-pipeline/workflow-cd.jpg)
Figure 1: Adding CD Pipeline
A basic `Create deployment pipeline` window will pop up. -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/workflow-cd-pipeline/new-cd-pipeline.jpg) +![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/cd-pipeline/new-cd-pipeline.jpg)
Figure 2: Creating CD Pipeline
Here, you get two tabs: @@ -61,14 +61,14 @@ In case you are choosing an [isolated environment](../../global-configurations/c Devtron supports multiple deployment strategies depending on the [deployment chart type](../../creating-application/base-config/deployment-template.md#select-a-deployment-chart-type). -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/workflow-cd-pipeline/chart-and-strategy.jpg) +![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/cd-pipeline/chart-and-strategy.jpg)
Figure 3: Strategies Supported by Chart Type
Refer to [Deployment Strategies](#deployment-strategies) to know more about each strategy in depth. The next section is [Advanced Options](#advanced-options) and it comes with additional capabilities. This option is available at the bottom of the `Create deployment pipeline` window. However, if you don't need them, you may proceed with a basic CD pipeline and click **Create Pipeline**. -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/workflow-cd-pipeline/advanced-option.jpg) +![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/cd-pipeline/advanced-option.jpg)
Figure 4: Advanced Options
--- @@ -81,7 +81,7 @@ After selecting **Advanced Options**, the `Create deployment pipeline` window ha * [Deployment stage (tab)](#deployment-stage) * [Post-Deployment stage (tab)](#post-deployment-stage) -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/workflow-cd-pipeline/cd-advanced.jpg) +![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/cd-pipeline/cd-advanced.jpg)
Figure 5: Advanced Options (Expanded View)
:::info Note @@ -92,7 +92,7 @@ You can create or edit a deployment strategy in Advanced Options. Remember, only If your deployment requires prior actions like DB migration, code quality check (QC), etc., you can use the `Pre-Deployment stage` to configure such tasks. Refer [Pre/Post tasks](./pre-post-tasks.md) to configure tasks in `Pre-Deployment stage`. -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/workflow-cd-pipeline/cd-predeployment-v2.jpg) +![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/cd-pipeline/cd-predeployment.jpg)
Figure 6: Pre-Deployment Stage
@@ -181,7 +181,7 @@ Currently, only super-admins can enable or disable this option. Users can also specify the number of approvals required for each deployment, where the permissible limit ranges from one approval (minimum) to six approvals (maximum). In other words, if the image doesn't get the specified number of approvals, it will not be eligible for deployment -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/workflow-cd-pipeline/deployment-approval-new.jpg) +![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/cd-pipeline/deployment-approval-new.jpg)
Figure 6: Configuring Manual Approval of Images
To enable manual approval for deployment, follow these steps: @@ -280,38 +280,38 @@ To configure the CD pipeline for different deployment strategies, follow the ste 1. Select **Add Strategy** and select the deployment strategies you want to add. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/app-details/deployment-add-strategy.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/cd-pipeline/deployment-add-strategy.jpg)
Figure 7: Adding Deployment Strategy
* In case, you have multiple deployment strategies, you have to choose a default deployment strategy which are configured for the pipeline. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/app-details/deployment-set-default.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/cd-pipeline/deployment-set-default.jpg)
Figure 8: Selecting Default Deployment Strategy
* If in any scenario such as deploying a hotfix, if you need to use a different deployment strategy other than the default, you can change it from **Build & Deploy** section while triggering the deployment. **Note:** You can only select the deployment strategies which are configured for that pipeline. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/app-details/deployment-build.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/cd-pipeline/deployment-build.jpg)
Figure 9: Selecting Deployment Strategy
2. Configure the deployment strategy by selecting the **Settings** icon next to it to edit the strategy template according to your use case. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/app-details/deployment-rolling-config.jpg) -
Figure 10a: Editing Blue Green Strategy Template
+ ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/cd-pipeline/deployment-rolling-config.jpg) +
Figure 10a: Editing Rolling Strategy Template
- ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/app-details/deployment-recreate-config.jpg) -
Figure 10b: Editing Blue Green Strategy Template
+ ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/cd-pipeline/deployment-recreate-config.jpg) +
Figure 10b: Editing Recreate Strategy Template
- ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/app-details/deployment-canary-config.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/cd-pipeline/deployment-canary-config.jpg)
Figure 10c: Editing Canary Strategy Template
- ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/app-details/deployment-blue-green-config.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/cd-pipeline/deployment-blue-green-config.jpg)
Figure 10d: Editing Blue Green Strategy Template
3. Select **Update Pipeline** to save the configurations. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/app-details/deployment-update-pipeline.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/cd-pipeline/deployment-update-pipeline.jpg)
Figure 11: Selecting Update Pipeline
@@ -323,17 +323,17 @@ This will be utilized only when an existing container image is copied to another 1. Enable the toggle button as shown below. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/workflow-cd-pipeline/cd-image-pattern.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/cd-pipeline/cd-image-pattern.jpg)
Figure 12: Enabling Custom Image Tag Pattern
2. Click the edit icon. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/workflow-cd-pipeline/edit-cd-image-tag.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/cd-pipeline/edit-cd-image-tag.jpg)
Figure 13: Edit Icon
3. You can write an alphanumeric pattern for your image tag, e.g., **prod-v1.0.`{x}`**. Here, 'x' is a mandatory variable whose value will incrementally increase with every pre or post deployment trigger (that option is also available to you). You can also define the value of 'x' for the next trigger in case you want to change it. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/workflow-cd-pipeline/cd-image-tag.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/cd-pipeline/cd-image-tag.jpg)
Figure 14: Defining Tag Pattern
:::caution Warning @@ -350,12 +350,12 @@ Although Devtron ensures that [image tags](#custom-image-tag-pattern) remain uni Therefore, to eliminate the possibility of pulling an unintended image, Devtron offers the option to pull container images using digest and image tag. -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/global-configurations/image-digest/pull-with-digest.jpg) +![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/cd-pipeline/pull-with-digest.jpg)
Figure 15: Pull with Image Digest
An image digest is a unique and immutable SHA-256 string returned by the container registry when you push an image. So the image referenced by the digest will never change. -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/global-configurations/image-digest/tag-digest.jpg) +![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/cd-pipeline/tag-digest.jpg)
Figure 16: Tag@Digest
:::caution Who Can Perform This Action? @@ -372,7 +372,7 @@ You can use [ConfigMap](../base-config/config-maps.md) and [Secrets](../base-con Refer [Pre/Post tasks](./pre-post-tasks.md) to configure tasks in `Post-deployment stage`. -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/workflow-cd-pipeline/cd_post_build.jpg) +![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/cd-pipeline/cd_post_build.jpg)
Figure 17: Post-deployment Stage
--- @@ -411,17 +411,17 @@ You can not only [view your external Helm apps](../../infra-management/other-app 2. Select the external cluster containing your Helm releases, and select the Helm release you wish to migrate. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/workflow-cd-pipeline/choose-cluster-app.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/cd-pipeline/choose-cluster-app.jpg)
Figure 18: Choosing External Cluster and Helm Release from Dropdown
3. The target cluster, its namespace, and environment would be visible. If the environment is not available, click **Add Environment**. This will open a new tab. Once you have [added the environment to your cluster](../../global-configurations/cluster-and-environments.md#add-environment-to-a-cluster), return and click the refresh button. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/workflow-cd-pipeline/add-env-helm.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/cd-pipeline/add-env-helm.jpg)
Figure 19: Adding Environment to Target
4. Select the trigger (**Automatic/Manual**) and click **Create Pipeline**. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/workflow-cd-pipeline/deploy-mode.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/cd-pipeline/deploy-mode.jpg)
Figure 20: Creating CD Pipeline for Helm Release
5. Once the pipeline is created, you may go to [Build & Deploy](../../deploying-application/README.md) to trigger the pipelines. Your Helm release would be deployed using Devtron. @@ -460,17 +460,17 @@ You can not only [view your external Argo CD apps](../../infra-management/other- 2. Select the external cluster containing your Argo apps, and select the Argo CD application you wish to migrate. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/workflow-cd-pipeline/choose-cluster-app2.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/cd-pipeline/choose-cluster-app-argo.jpg)
Figure 21: Choosing External Cluster and Argo App from Dropdown
3. The target cluster, its namespace, and environment would be visible. If the environment is not available, click **Add Environment**. This will open a new tab. Once you have [added the environment to your cluster](../../global-configurations/cluster-and-environments.md#add-environment-to-a-cluster), return and click the refresh button. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/workflow-cd-pipeline/add-env-argo.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/cd-pipeline/add-env-argo.jpg)
Figure 22: Adding Environment to Target
4. Select the trigger (**Automatic/Manual**) and click **Create Pipeline**. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/workflow-cd-pipeline/deploy-mode2.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/cd-pipeline/deploy-mode-argo.jpg)
Figure 23: Creating CD Pipeline for Argo CD App
5. Once the pipeline is created, you may go to [Build & Deploy](../../deploying-application/README.md) to trigger the pipelines. Your Argo CD app would be deployed using Devtron. @@ -510,23 +510,20 @@ You can not only [view your external Flux CD apps](../../infra-management/other- 1. Click **Flux CD Application** in 'Select type of application to migrate'. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/fluxcd/fluxcd-select-fluxcd.jpg) -
Figure 28: Choosing 'Flux CD Application'
- 2. Select the external cluster containing your Flux apps, and select the Flux CD application you wish to migrate. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/fluxcd/fluxcd-select-app.jpg) -
Figure 29: Choosing External Cluster and Flux App from Dropdown
+ ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/cd-pipeline/fluxcd-select-fluxcd.jpg) +
Figure 24: Choosing 'Flux CD Application'
3. The target cluster, its namespace, and environment would be visible. If the environment is not available, click **Add Environment**. This will open a new tab. Once you have [added the environment to your cluster](../../global-configurations/cluster-and-environments.md#add-environment-to-a-cluster), return and click the refresh button. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/fluxcd/fluxcd-target-cluster.jpg) -
Figure 30: Target Environment
+ ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/cd-pipeline/fluxcd-add-env.jpg) +
Figure 25: Choosing External Cluster and Flux App from Dropdown
4. Select the trigger (**Automatic/Manual**) and click **Create Pipeline**. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/fluxcd/fluxcd-select-how-to-deploy.jpg) -
Figure 31: Creating CD Pipeline for Flux CD App
+ ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/cd-pipeline/fluxcd-deploy-mode.jpg) +
Figure 26: Target Environment
5. Once the pipeline is created, you may go to [Build & Deploy](../../deploying-application/README.md) to trigger the pipelines. Your Flux CD app would be deployed using Devtron. @@ -547,8 +544,8 @@ You can update the deployment stages and the deployment strategy of the CD Pipel To update a CD Pipeline, go to the `App Configurations` section, Click on `Workflow editor` and then click on the CD Pipeline you want to Update. -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/workflow-cd-pipeline/ca-workflow-update.gif) -
Figure 32: Updating CD Pipeline
+![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/cd-pipeline/cd-workflow-update.gif) +
Figure 27: Updating CD Pipeline
Make changes as needed and click on `Update Pipeline` to update this CD Pipeline. @@ -560,6 +557,9 @@ If you no longer require the CD Pipeline, you can also delete the Pipeline. To delete a CD Pipeline, go to the App Configurations and then click on the Workflow editor. Now click on the pipeline you wish to delete. A pop-up having the CD details will appear. Verify the name and the details to ensure that you are not accidentally deleting the wrong CD pipeline and then click **Delete Pipeline** to delete it. +![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/cd-pipeline/cd-pipeline-delete.gif) +
Figure 28: Deleting CD Pipeline
+ :::caution Deleting a CD pipeline also deletes all the K8s resources associated with it and will bring a disruption in the deployed micro-service. Before deleting a CD pipeline, please ensure that the associated resources are not being used in any production workload. ::: @@ -580,8 +580,8 @@ Please follow the steps mentioned below to create sequential pipelines: 3. Similarly, you can add multiple CD pipelines by clicking + sign of the last CD pipeline, each deploying in different environments. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/workflow-cd-pipeline/sequential-workflow.jpg) -
Figure 33: Adding Multiple CD Pipelines
+ ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/cd-pipeline/sequential-workflow.jpg) +
Figure 29: Adding Multiple CD Pipelines
:::tip Tip If you have multiple applications that already have an existing pipeline (for a given environment) in their workflow, you may clone the same pipeline and its configurations for new environments instead of recreating them in each application. Refer [Clone Pipeline Config](../../application-groups.md#clone-pipelines-) to know more. From 2d9afb838c92df5b9b27727da1834dfaaea04ea9 Mon Sep 17 00:00:00 2001 From: Hii-Arpit Date: Mon, 17 Nov 2025 20:19:25 +0530 Subject: [PATCH 02/10] docs: fixed job image --- docs/user-guide/jobs/create-job.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/user-guide/jobs/create-job.md b/docs/user-guide/jobs/create-job.md index 2d82c4dc3..2605e7f84 100755 --- a/docs/user-guide/jobs/create-job.md +++ b/docs/user-guide/jobs/create-job.md @@ -55,7 +55,7 @@ To create a new **Clone Job** in Devtron, follow these steps: 2. Click the **Create** button in the top-right corner and select **Job** from the drop-down list. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/automation-and-enablement/jobs/select-create-job-latest.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/automation-and-enablement/jobs/select-create-job.jpg)
Figure 4: Selecting Job
3. The **Create Job** page opens. From the left panel, select **Clone Job** and then choose a job to clone. From e9fedb6bd58cef82eb8180b353c63639ab7f1a7f Mon Sep 17 00:00:00 2001 From: Hii-Arpit Date: Mon, 17 Nov 2025 21:16:27 +0530 Subject: [PATCH 03/10] docs: updated pre-post tasks images --- .../workflow/pre-post-tasks.md | 68 ++++++++++--------- 1 file changed, 37 insertions(+), 31 deletions(-) diff --git a/docs/user-guide/creating-application/workflow/pre-post-tasks.md b/docs/user-guide/creating-application/workflow/pre-post-tasks.md index fcb714194..c9258f3a8 100755 --- a/docs/user-guide/creating-application/workflow/pre-post-tasks.md +++ b/docs/user-guide/creating-application/workflow/pre-post-tasks.md @@ -38,34 +38,34 @@ To create a pre/post task, follow the steps below: 2. Select the Build or Deployment pipeline for configuring the pre/post tasks. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/global-configurations/sso-login-service/pre-post-workflow-editor.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/pre-post/pre-post-workflow-editor.jpg)
Figure 1: Selecting Workflow
3. Based on the pipeline you are editing, follow the steps below to add a task: * **Build pipelines:** On the **Edit build pipeline** window, select the **Pre-Build stage** or **Post-Build stage** tab. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/global-configurations/sso-login-service/pre-post-edit-build.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/pre-post/pre-post-edit-build.jpg)
Figure 2: Pre/Post-build stages
* **Deployment pipelines:** On the **Edit deployment pipeline** window, select the **Pre-Deployment stage** or **Post-Deployment stage** tab. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/global-configurations/sso-login-service/pre-post-edit-deploy.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/pre-post/pre-post-edit-deploy.jpg)
Figure 3: Pre/Post-deployment stages
4. Select **+ Add task** to add a task. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/global-configurations/sso-login-service/pre-post-add-task.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/pre-post/pre-post-add-task.jpg)
Figure 4: Adding task
5. Configure the task using a preset plugin or **Execute custom task**. If you wish, you can add more tasks by clicking on **+ Add task** in the left-side panel. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/global-configurations/sso-login-service/pre-post-configure.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/pre-post/pre-post-configure.jpg)
Figure 5: Configuring the task
6. Click **Update Pipeline**. The pre/post task will be executed when you trigger the next build or deployment. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/global-configurations/sso-login-service/pre-post-update-pipeline.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/pre-post/pre-post-update-pipeline.jpg)
Figure 6: Select 'Update Pipeline'
### Configure a Task using Preset Plugins @@ -88,10 +88,10 @@ To configure a task using the **Codacy** plugin, follow the steps below: * The left-side panel will now shows a task under **Tasks (IN ORDER OF EXECUTION)**, named after the selected plugin(by default), along with its logo.
You can change the task's name using the **Task name** field but plugin's logo will remain indicating that it is a preset plugin. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/global-configurations/sso-login-service/pre-post-search-codacy.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/pre-post/pre-post-search-codacy.jpg)
Figure 7: Searching 'Codacy' plugin
- ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/global-configurations/sso-login-service/pre-post-codacy-plugin.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/pre-post/pre-post-codacy-plugin.jpg)
Figure 8: Codacy plugin
3. Refer the [Codacy](../../plugins/codacy.md) documentation to configure the **Codacy** fields with appropriate values. You may explore [Plugins documentation](../../plugins/README.md) to configure any of the available plugins. @@ -111,12 +111,12 @@ Similarly, you can configure any task with a preset plugin in Pre/post-build sta * The left-side panel will now display a task under **Tasks (IN ORDER OF EXECUTION)**. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/global-configurations/sso-login-service/pre-post-execute-custom-task.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/pre-post/pre-post-execute-custom-task.jpg)
Figure 9: Select 'Execute custom script'
2. Enter the Task name (required) and Task Description (optional). - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/global-configurations/sso-login-service/pre-post-custom-task.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/pre-post/pre-post-custom-task.jpg)
Figure 10: Configuring Task
3. Select the **Task type**, it can be `Shell` or `Container Image`. @@ -189,10 +189,10 @@ Let's take an example of a **Shell task** in the Pre-Build stage that ensures th #### Tasks Configurations -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/global-configurations/sso-login-service/pre-post-shell-example.jpg) +![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/pre-post/pre-post-shell-example.jpg)
Figure 11a: Configuring Shell Task
-![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/global-configurations/sso-login-service/pre-post-shell-task-2.jpg) +![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/pre-post/pre-post-shell-task-2.jpg)
Figure 11b: Configuring Pass/Fail Condition
|Field| Values for This Example| Required/Optional | Description| @@ -216,17 +216,17 @@ Let's take an example of a **Shell task** in the Pre-Build stage that ensures th * You can click `+` icon next to **Variable** header field to add more rows to the input variable table.
- ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/global-configurations/sso-login-service/pre-post-var-config.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/pre-post/pre-post-var-config-shell.jpg)
Figure 12: Variable configuration
* You can click the slider icon next to each variable name to make its value required and add a description for it. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/global-configurations/sso-login-service/pre-post-val-config.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/pre-post/pre-post-val-config-shell.jpg)
Figure 13: Value configuration
* You can click the slider icon next to each variable value to add choices, allow custom input, and ask value at runtime. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/global-configurations/sso-login-service/pre-post-add-choice.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/pre-post/pre-post-add-choice-shell.jpg)
Figure 14: Add choice
#### Script @@ -268,10 +268,10 @@ Since we have already configured a shell task to validate the database name, we #### Tasks Configurations -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/global-configurations/sso-login-service/pre-post-container-task.jpg) +![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/pre-post/pre-post-container-task.jpg)
Figure 15a: Container Image Task
-![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/global-configurations/sso-login-service/pre-post-container-task-2.jpg) +![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/pre-post/pre-post-container-task-2.jpg)
Figure 15b: Configuring task
| Field| Values for This Example| Required/Optional | Description| @@ -302,17 +302,17 @@ Since we have already configured a shell task to validate the database name, we * You can click `+` icon next to **Variable** header field to add more rows to the input variable table.
- ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/global-configurations/sso-login-service/pre-post-var-config.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/pre-post/pre-post-var-config-container.jpg)
Figure 16: Variable configuration
* You can click the slider icon next to each variable name to make its value required and add a description for it. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/global-configurations/sso-login-service/pre-post-val-config.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/pre-post/pre-post-val-config-container.jpg)
Figure 17: Value configuration
* You can click the slider icon next to each variable value to add choices, allow custom input, and ask value at runtime. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/global-configurations/sso-login-service/pre-post-add-choice.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/pre-post/pre-post-add-choice-container.jpg)
Figure 18: Add choice
#### Mount Custom Code @@ -355,7 +355,7 @@ The execution of the Pre/Post-Deployment stages can be set to: **Manually:** The User needs to trigger the Pre/Post-Deployment stages manually. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/global-configurations/sso-login-service/pre-post-trigger-post.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/pre-post/pre-post-trigger-post.jpg)
Figure 19: Trigger Deployment Pipeline
### ConfigMaps & Secrets @@ -366,7 +366,7 @@ Make sure you have added [ConfigMaps](../base-config/config-maps.md) and [Secret If you want to use some configuration files and secrets in pre-deployment stages or post-deployment stages, then you can use the `ConfigMaps` & `Secrets` options. You will get them as a drop-down in the pre-deployment stage. -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/global-configurations/sso-login-service/pre-post-cm-secret.jpg) +![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/pre-post/pre-post-cm-secret.jpg)
Figure 20: ConfigMaps & Secrets
### Execute tasks in an application environment @@ -375,15 +375,18 @@ These `Pre-deployment CD / Post-deployment CD` pods can be created in your deplo Some tasks require extra permissions for the node where Devtron is installed. However, if the node already has the necessary permissions for deploying applications, there is no need to assign them again. Instead, you can enable the **Execute tasks in application environment** option for the pre-CD or post-CD steps. By default, this option is disabled. -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/global-configurations/sso-login-service/pre-post-execute-tasks.jpg) +![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/pre-post/pre-post-execute-tasks.jpg)
Figure 21: Execute tasks in application environment
To enable the `Execute tasks in application environment` option, follow these steps: -1. Go to the **Chart Store** and search for the `devtron-in-clustercd` chart. +1. Go to the **Infrastructure Management** → **Chart Store** and search for the `devtron-in-clustercd` chart. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/workflow-cd-pipeline/devtron-incluster-chart.jpg) -
Figure 22: 'devtron-in-clustercd' Chart
+ ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/pre-post/devtron-incluster-chart.jpg) +
Figure 22a: 'devtron-in-clustercd' Chart
+ + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/pre-post/devtron-incluster-chart-deploy-chart.jpg) +
Figure 22b: Click 'Deploy Chart'
2. Configure the chart according to your requirements and deploy it in the target cluster. @@ -400,7 +403,7 @@ To enable the `Execute tasks in application environment` option, follow these st `ORCH_HOST` value should be the same as of `CD_EXTERNAL_LISTENER_URL` value, which is passed in values.yaml. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/workflow-cd-pipeline/incluster-configuration.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/pre-post/incluster-configuration.jpg)
Figure 23: Configuration
4. Delete the Devtron pod using the following command: @@ -409,14 +412,17 @@ To enable the `Execute tasks in application environment` option, follow these st kubectl delete pod -l app=devtron -n devtroncd ``` -5. Again, navigate to the chart store and search for the "migration-incluster-cd" chart. +5. Again, navigate back to the **Infrastructure Management** → **Chart Store** and search for the "migration-incluster-cd" chart. + + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/pre-post/migration-incluster-chart.jpg) +
Figure 24a: 'migration-incluster-cd' chart
- ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/workflow-cd-pipeline/migration-incluster-chart.jpg) -
Figure 24: 'migration-incluster-cd' chart
+ ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/pre-post/migration-incluster-chart-deploy-chart.jpg) +
Figure 24b: Click 'Deploy Chart'
6. Edit the `cluster-name` and `secret name` values within the chart. The `cluster name` refers to the name used when adding the cluster in the global configuration and for which you are going to enable `Execute tasks in application environment` option. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/workflow-cd-pipeline/migration-incluster.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/pre-post/migration-incluster.jpg)
Figure 25: Configuration
7. Deploy the chart in any environment within the Devtron cluster. Now you should be able to enable the `Execute tasks in application environment` option for an environment of target cluster. From 1a85c839f1c6e4671b683ac66d820b9a8a7dc949 Mon Sep 17 00:00:00 2001 From: Hii-Arpit Date: Mon, 17 Nov 2025 21:45:13 +0530 Subject: [PATCH 04/10] docs: moved ci-pipeline images --- .../workflow/ci-pipeline.md | 210 +++++++++--------- 1 file changed, 105 insertions(+), 105 deletions(-) diff --git a/docs/user-guide/creating-application/workflow/ci-pipeline.md b/docs/user-guide/creating-application/workflow/ci-pipeline.md index 00aa7d4cf..3f01d7ef0 100755 --- a/docs/user-guide/creating-application/workflow/ci-pipeline.md +++ b/docs/user-guide/creating-application/workflow/ci-pipeline.md @@ -33,17 +33,17 @@ Devtron typically uses a Dockerfile from your repository to build container imag 3. Click **+ New Workflow**. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/new-workflow.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/ci-pipeline/new-workflow.jpg)
Figure 1: Creating New Workflow
4. Select **Build from Source Code**. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/workflow-ci-2.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/ci-pipeline/workflow-ci-2.jpg)
Figure 2: 'Selecting Build from Source Code'
5. In the **Create Build Pipeline** window, enter the following details: - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/create-build-pipeline.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/ci-pipeline/create-build-pipeline.jpg)
Figure 3: Configuring build pipeline
| Field Name|Required/Optional| Description| @@ -57,7 +57,7 @@ Devtron typically uses a Dockerfile from your repository to build container imag Devtron allows you set up different source types for a build pipeline, source types specify the repository events that initiate a build pipeline, such as a change in a branch, pull request creation, or tag creation. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/build-deploy-source-type.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/ci-pipeline/build-deploy-source-type.jpg)
Figure 4: Source Types
|Source Type| Description| Additional Requirements| @@ -72,7 +72,7 @@ Devtron typically uses a Dockerfile from your repository to build container imag When using **Pull Request** as a source type, Devtron allows you to filter which PRs should trigger a build using the following filters - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/build-deploy-pull-request-filters.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/ci-pipeline/build-deploy-pull-request-filters.jpg)
Figure 5: Pull Request Filters
Select the appropriate filter and pass the matching condition as a regular expression (regex). @@ -93,7 +93,7 @@ Devtron uses the regexp library, view [regexp cheatsheet](https://yourbasic.org/ When using **Tag Creation** as a source type, Devtron allows you to filter which tags should trigger a build based on the following filters - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/build-deploy-tag-creation-filters.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/ci-pipeline/build-deploy-tag-creation-filters.jpg)
Figure 6: Tag Creation Filters
Select the appropriate filter and pass the matching condition as a regular expression (regex). @@ -109,7 +109,7 @@ Devtron uses the regexp library, view [regexp cheatsheet](https://yourbasic.org/ 6. Click **Create Pipeline** to save the configuration. You can now proceed to trigger the build, or continue below to explore additional configuration options for customizing your pipeline. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/build-deploy-create-pipeline.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/ci-pipeline/build-deploy-create-pipeline.jpg)
Figure 7: Creating pipeline
### Configuring Advanced Options @@ -128,12 +128,12 @@ This document focuses on configuring the Build Stage. If you want to set up Pre- 1. In **Create Build Pipeline** window, select **Advanced options**. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/advanced-options.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/ci-pipeline/advanced-options.jpg)
Figure 8: Advanced Options
2. Go to **Build stage** tab and configure the following fields: - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/build-stage.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/ci-pipeline/build-stage.jpg)
Figure 9: Build stage
@@ -149,7 +149,7 @@ This document focuses on configuring the Build Stage. If you want to set up Pre- 3. Click **Create Pipeline** to save the configuration. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/build-deploy-create-pipeline-2.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/ci-pipeline/build-deploy-create-pipeline-2.jpg)
Figure 10: Create Pipeline
#### Triggering a Build @@ -160,23 +160,23 @@ Once the CI pipeline is set up, follow these steps to trigger a build: 2. Click **Select Material** in the specific pipeline for which you want to trigger the build. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/build-deploy-select-material.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/ci-pipeline/build-deploy-select-material.jpg)
Figure 11: Selecting Material
3. Choose the **Git commit** to build under **Code Source** tab. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/build-deploy-git-commit.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/ci-pipeline/build-deploy-git-commit.jpg)
Figure 12: Selecting Git Commit
4. Configure runtime parameters (if any) before starting the build under the **Parameters** tab. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/build-deploy-runntime-parameters.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/ci-pipeline/build-deploy-runntime-parameters.jpg)
Figure 13: Configuring Runtime Parameters
5. Click **Start Build**. This will trigger the build process and push the generated container image to the configured container registry for storage, versioning, and later use in the CD pipeline. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/build-deploy-start-build.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/ci-pipeline/build-deploy-start-build.jpg)
Figure 14: Starting Build
--- @@ -206,17 +206,17 @@ Refer the [User permissions](../../global-configurations/authorization/user-acce 2. Select **+ New Workflow**, a modal window will appear where you can select the type of pipeline you want to create. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/linked-build-pipeline-new-workflow.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/ci-pipeline/linked-build-pipeline-new-workflow.jpg)
Figure 15: Creating New Workflow
3. Select **Linked Build Pipeline**. Another modal window will appear where you can enter the details of the existing pipeline you want to link. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/linked-build-pipeline.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/ci-pipeline/linked-build-pipeline.jpg)
Figure 16: Selecting 'Linked Build Pipeline'
4. Enter the details of the existing pipeline you want to link and click **Create Linked CI Pipeline** to create the pipeline. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/linked-build-pipeline-create-pipeline.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/ci-pipeline/linked-build-pipeline-create-pipeline.jpg)
Figure 17: Entering details of existing pipeline
:::caution Note @@ -229,17 +229,17 @@ Refer the [User permissions](../../global-configurations/authorization/user-acce |Source CI pipeline|List all the build pipelines for the selected application. Choose the pipeline that you want to link| |Name|Enter the name for the **Linked Build Pipeline**.
  • By default, it takes the name of the source pipeline, if you wish, you can rename it.
  • In case the source pipeline exists within the same application, the **Linked Build Pipeline** name must be different from the source pipeline, as Devtron does not allow two pipelines with the same name within a single application.
| - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/linked-build-pipeline-created.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/ci-pipeline/linked-build-pipeline-created.jpg)
Figure 18: Pipeline created
Thereafter, the source CI pipeline will indicate the number of Linked CI pipelines. On clicking it, a modal window will appear, which lists all the applications from which the source pipeline is linked, as shown in the image below. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/linkedci.gif) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/ci-pipeline/linkedci.gif)
Figure 19: Linked CI with Child Information
5. After creating a **Linked CI Pipeline**, you can create a CD pipeline. Refer to [CD Pipeline](./cd-pipeline.md) page to know more. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/linked-build-pipeline-cd.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/ci-pipeline/linked-build-pipeline-cd.jpg)
Figure 20: Creating CD pipeline
:::caution Note @@ -260,17 +260,17 @@ To create a pipeline form **Deploy Image from External Service**, follow the ste 2. Select **+ New Workflow**, a modal window will appear where you can select the type of pipeline you want to create. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/deploy-image-new-workflow.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/ci-pipeline/deploy-image-new-workflow.jpg)
Figure 21: Creating New Workflow
3. Select **Deploy Image from External Service**, another modal window will appear where you can enter deployment details such as environment, execution mode, and deployment strategy. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/deploy-image.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/ci-pipeline/deploy-image.jpg)
Figure 22: Selecting 'Deploy Image from External Service'
4. Enter the deployment details and click **Create Pipeline** to create the pipeline. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/deploy-image-create-pipeline.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/ci-pipeline/deploy-image-create-pipeline.jpg)
Figure 23: Entering deployment details
| Fields | Description | @@ -288,35 +288,35 @@ To configure the Webhook in External CI, follow the steps below. 1. After creating the pipeline, select **Show webhook details** or select **External Source** stage to get the webhook URL and JSON sample payload to be used in the external CI pipeline. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/deploy-image-show-webhook.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/ci-pipeline/deploy-image-show-webhook.jpg)
Figure 24: Getting Webhook Details
2. On the **Webhook Details** page, click **Select or auto-generate token with required permissions** to select or generate a `API token`. This token allows external CI services to authenticate with Devtron. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/deploy-image-select-auto-generate.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/ci-pipeline/deploy-image-select-auto-generate.jpg)
Figure 25: Clicking 'Select or auto-generate token with required permissions'
* To select an existing API token, choose an API token from the dropdown under **Select API token**. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/deploy-image-select-api-token.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/ci-pipeline/deploy-image-select-api-token.jpg)
Figure 26: Selecting existing API Token
* To generate an API token, select **Auto-generate token** sub tab → Enter a name for the token in the **Token Name** field → Click **Generate token** to generate a token. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/deploy-image-auto-generate-token.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/ci-pipeline/deploy-image-auto-generate-token.jpg)
Figure 27a: Generating API Token
- ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/deploy-image-auto-generate-token-2.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/ci-pipeline/deploy-image-auto-generate-token-2.jpg)
Figure 27b: API Token Generated
3. After generating an API token, click **Sample cURL request** and select the metadata you want to send to Devtron. Sample JSON and cURL request will be generated accordingly. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/deploy-image-select-metadata.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/ci-pipeline/deploy-image-select-metadata.jpg)
Figure 28: Getting sample cURL request and selecting metadata
4. Copy the Sample cURL request and integrate it into your External CI (Jenkins) pipeline along with the API token and tag for Docker Image. Refer to [Integrate with External Sources](#integrate-with-external-sources---jenkins) to know more. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/deploy-image-copy-curl-cmd.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/ci-pipeline/deploy-image-copy-curl-cmd.jpg)
Figure 29: Copying Sample cURL request
5. After integrating the webhook, whenever the external CI pipeline is triggered and generates an image, the webhook will automatically send the image details to Devtron for deployment. @@ -330,21 +330,21 @@ Before adding the stage/step, you need to add the API token provided by Devtron 1. Go to **Manage Jenkins** → **Credentials**. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/deploy-image-manage-jenkins.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/ci-pipeline/deploy-image-manage-jenkins.jpg)
Figure 30a: Selecting 'Manage Jenkins'
- ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/deploy-image-credentials.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/ci-pipeline/deploy-image-credentials.jpg)
Figure 30b: Selecting 'Credentials'
2. Select **System** under **Stores scoped to Jenkins** → **Global credentials (unrestricted)** → **+Add Credentials**. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/deploy-image-system.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/ci-pipeline/deploy-image-system.jpg)
Figure 31a: Selecting 'System' under 'Stores scoped to Jenkins'
- ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/deploy-image-global-cred.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/ci-pipeline/deploy-image-global-cred.jpg)
Figure 31b: Selecting Global credentials (unrestricted)
- ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/deploy-image-add-cred.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/ci-pipeline/deploy-image-add-cred.jpg)
Figure 31c: Selecting 'Add Credentials'
3. Select `Secret text` in the **Kind** field and select the required **Scope** @@ -357,10 +357,10 @@ Before adding the stage/step, you need to add the API token provided by Devtron 7. Select **Create** to create the secret in Jenkins. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/deploy-image-add-secret.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/ci-pipeline/deploy-image-add-secret.jpg)
Figure 32a: Adding Credential
- ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/deploy-image-secret-added.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/ci-pipeline/deploy-image-secret-added.jpg)
Figure 32b: Credential Added
After adding the API token as a secret, add a new step/stage in your Jenkins project/pipeline. @@ -369,12 +369,12 @@ In case your Jenkins project is of type `freestyle`, follow the steps below: 1. Select the Jenkins project in which you want to integrate the Webhook. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/deploy-image-select-project.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/ci-pipeline/deploy-image-select-project.jpg)
Figure 33: Selecting Jenkins Project
2. Go to **Configure** → **Environments** and enable the **Use secret text(s) or file(s)** option. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/deploy-image-configure.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/ci-pipeline/deploy-image-configure.jpg)
Figure 34: Selecting 'Configure'
3. Click **Add** under **Bindings** and select **Secret Text**. @@ -385,22 +385,22 @@ In case your Jenkins project is of type `freestyle`, follow the steps below: **Note:** In case you have provided a description for your credential, then instead of the credential `ID`, the description will be displayed. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/deploy-image-bindings.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/ci-pipeline/deploy-image-bindings.jpg)
Figure 35a: Binding Credential in the project
- ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/deploy-image-secret-binded.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/ci-pipeline/deploy-image-secret-binded.jpg)
Figure 35b: Credential Binding successful
6. Go to **Configure** → **Build Steps**, click **Add build step**, and then select **Execute Shell**. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/deploy-image-add-build-task.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/ci-pipeline/deploy-image-add-build-task.jpg)
Figure 36: Adding Build Step for Webhook
7. Enter the cURL request command as shown below. Make sure to enter the `API token` and `dockerImage` in your cURL command and click **Save**. **Note:** API Token has been referenced from the secret via **Variable Name** (`DEVTRON_TOKEN`) configured in Jenkins credentials using its `ID` - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/deploy-image-build-task-added.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/ci-pipeline/deploy-image-build-task-added.jpg)
Figure 37: Configuring Webhook Build Step
@@ -408,17 +408,17 @@ In case your Jenkins project is of type `pipeline`, `Multibranch Pipeline`, etc. 1. Select the Jenkins project in which you want to integrate the Webhook. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/deploy-image-select-project-2.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/ci-pipeline/deploy-image-select-project-2.jpg)
Figure 38: Selecting Jenkins Project
2. Go to **Configure** → **Pipeline**. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/deploy-image-configure-2.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/ci-pipeline/deploy-image-configure-2.jpg)
Figure 39: Selecting 'Configure'
3. In case you are using **Pipeline Script**, then modify the script to add a new stage as shown below. If you are using **Pipeline script from SCM**, then modify your Jenkinsfile in the same way. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/deploy-image-add-webhook-stage.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/ci-pipeline/deploy-image-add-webhook-stage.jpg)
Figure 40: Adding Webhook pipeline stage
4. Click **Save**. @@ -435,17 +435,17 @@ Before adding the step in the workflow, you need to add the API token provided b 1. Navigate to **Settings** tab of your repository. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/deploy-image-ga-settings.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/ci-pipeline/deploy-image-ga-settings.jpg)
Figure 41: Navigating to 'Settings'
2. Select **Secrets and variables** → **Actions** under **Security**. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/deploy-image-ga-secrets.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/ci-pipeline/deploy-image-ga-secrets.jpg)
Figure 42: Selecting 'Actions'
3. Under **Secrets** tab, select **New repository secret**. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/deploy-image-ga-new-secret.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/ci-pipeline/deploy-image-ga-new-secret.jpg)
Figure 43: Selecting 'New repository secret'
4. Enter a name for your secret in the **Name** field. @@ -454,47 +454,47 @@ Before adding the step in the workflow, you need to add the API token provided b 6. Select **Add Secret** and the secret will be added to your repository. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/deploy-image-ga-add-secret.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/ci-pipeline/deploy-image-ga-add-secret.jpg)
Figure 44a: Entering secret info
- ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/deploy-image-ga-secret-added.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/ci-pipeline/deploy-image-ga-secret-added.jpg)
Figure 44b: Secret Added
After adding the API token as a secret, add a new step in your GitHub Action workflow. To do so, follow the steps below: 1. Navigate to **Actions** tab of your repository. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/deploy-image-ga-actions.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/ci-pipeline/deploy-image-ga-actions.jpg)
Figure 45: Navigating to Actions
2. Select your workflow under the **All workflows** section. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/deploy-image-ga-select-workflow.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/ci-pipeline/deploy-image-ga-select-workflow.jpg)
Figure 46: Selecting workflow
3. Click the workflow file (`main.yml`) under the workflow name, this will open the workflow file in GitHub. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/deploy-image-ga-select-workflow-file.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/ci-pipeline/deploy-image-ga-select-workflow-file.jpg)
Figure 47: Selecting 'Workflow File'
4. Select the edit icon to add the webhook step in the workflow file. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/deploy-image-ga-edit-icon.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/ci-pipeline/deploy-image-ga-edit-icon.jpg)
Figure 48: Selecting 'Edit' Icon
5. Add the webhook step in the workflow file and select **Commit changes...** - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/deploy-image-ga-step-added.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/ci-pipeline/deploy-image-ga-step-added.jpg)
Figure 49a: Adding Webhook Step
- ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/deploy-image-ga-commit-changes.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/ci-pipeline/deploy-image-ga-commit-changes.jpg)
Figure 49b: Committing Changes
6. Provide a **Commit message** and an optional description. 7. Select **Commit changes**, and the workflow file will be updated with the webhook step. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/deploy-image-ga-commit-changes-2.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/ci-pipeline/deploy-image-ga-commit-changes-2.jpg)
Figure 50: Selecting 'Commit changes'
The new images that will be built after adding the webhook will be available to Devtron for deployment. @@ -519,27 +519,27 @@ To create a pipeline form **Sync with Environment**, follow the steps below 2. Select **+ New Workflow**, a modal window will appear where you can select the type of pipeline you want to create. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/sync-env-new-workflow.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/ci-pipeline/sync-env-new-workflow.jpg)
Figure 51: Creating New Workflow
3. Select **Sync with Environment**, another modal window will appear where you need to select the environment in which the source CD pipeline exists. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/sync-env.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/ci-pipeline/sync-env.jpg)
Figure 52 : Selecting 'Sync with Environment'
4. Select the environment in which the source CD pipeline exists. You can only select one source CD per workflow. **Note:** The CD pipeline used as a source cannot be deleted while it’s linked. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/sync-env-select-source-cd.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/ci-pipeline/sync-env-select-source-cd.jpg)
Figure 53: Selecting Source CD Environment
5. Select **Deploy to** in the top right corner to select the environment in which you want to deploy the source CD image. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/sync-env-deploy-to.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/ci-pipeline/sync-env-deploy-to.jpg)
Figure 54a: Selecting 'Deploy To'
- ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/sync-env-select-deploy-env.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/ci-pipeline/sync-env-select-deploy-env.jpg)
Figure 54b: Selecting the Deployment Environment
6. Select **Create Pipeline** to create a new workflow. @@ -564,17 +564,17 @@ To create a workflow using **Create a job**, follow the steps below 2. Select **+ New Workflow**, a modal window will appear where you can select the type of pipeline you want to create. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/job-ci-new-workflow.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/ci-pipeline/job-ci-new-workflow.jpg)
Figure 55: Creating New Workflow
3. Select **Create a job**. This opens the **Create job pipeline** Window in which you can create and configure your job. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/job-ci.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/ci-pipeline/job-ci.jpg)
Figure 56: Selecting 'Create a job'
4. In the **Create job pipeline** window, you can create and configure job pipelines. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/job-ci-create-job-pipeline.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/ci-pipeline/job-ci-create-job-pipeline.jpg)
Figure 57: Create job pipeline
It includes 2 stages @@ -587,7 +587,7 @@ It includes 2 stages This stage allows you to define primary configurations such as Pipeline name, Source Type, Branch Name, and how the job should be triggered. Refer to the following table to configure each field. -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/job-ci-basic-config.jpg) +![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/ci-pipeline/job-ci-basic-config.jpg)
Figure 58: Configure Basic Configurations
| Field Name|Description| @@ -610,12 +610,12 @@ To create a task: 2. Click **Add Task** to add a task in your job pipeline. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/job-ci-task-exec.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/ci-pipeline/job-ci-task-exec.jpg)
Figure 59: Add task
3. A new task will be added (on the left side of the Create job pipeline window), you can configure the task either by selecting one of the available [preset plugins](#pulling-images-through-preset-plugin) or by [Executing a custom script](#create-task-using-custom-script) - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/job-ci-add-task.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/ci-pipeline/job-ci-add-task.jpg)
Figure 60: Type of tasks
#### Pulling Images through Preset Plugin @@ -638,10 +638,10 @@ To create a task using the **Pull Images from Container Repository** plugin, fol * The left-side panel will now show a task under **Tasks (IN ORDER OF EXECUTION)**, named after the selected plugin(by default), along with its logo.
You can change the task's name using the **Task name** field, but plugin's logo will remain indicating that it is a preset plugin. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/job-ci-pull-images.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/ci-pipeline/job-ci-pull-images.jpg)
Figure 61: Search 'Pull Images from Container Repository' plugin
- ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/job-ci-pull-images-added.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/ci-pipeline/job-ci-pull-images-added.jpg)
Figure 62: 'Pull Images from Container Repository' plugin
4. Refer the [Pull Images from Container Repository](../../plugins/pull-images-from-container-repository.md) documentation to configure the **Pull Images from Container Repository** fields with appropriate values. You may explore [Plugins documentation](../../plugins/README.md) to configure any of the available plugins. @@ -689,7 +689,7 @@ To update a pipeline, 2. In the **Edit build pipeline** window, edit the required stages and select **Update Pipeline**. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/update-pipeline.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/ci-pipeline/update-pipeline.jpg)
Figure 63: Updating CI pipeline
--- @@ -702,39 +702,39 @@ To delete a CI pipeline, follow the steps below. 1. Navigate to **Configurations** (tab) → **Workflow Editor** and click the pipeline you wish to delete. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/delete-pipeline-select-workflow.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/ci-pipeline/delete-pipeline-select-workflow.jpg)
Figure 64: Selecting Workflow to delete
2. Click on the Deployment Stage, **Edit deployment pipeline** window will open and select **Delete Pipeline**. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/delete-pipeline-delete-cd.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/ci-pipeline/delete-pipeline-delete-cd.jpg)
Figure 65: Clicking 'Delete Pipeline'
3. A pop-up will appear asking you to enter the environment name of the deployment. 4. Enter the environment name and select **Delete**. The CD pipeline will be deleted. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/delete-pipeline-delete-cd-popup.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/ci-pipeline/delete-pipeline-delete-cd-popup.jpg)
Figure 66: Deleting CD Pipeline
In case there are multiple CD pipelines in the workflow, then you need to delete them individually in a similar way. 5. After deleting all CD pipelines, click the Build stage, and the **Edit build pipeline** window will open. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/delete-pipeline-select-build.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/ci-pipeline/delete-pipeline-select-build.jpg)
Figure 67: Selecting build stage
6. Select **Delete Pipeline** from the bottom left corner of the window button in the Build stage, a pop-up will appear prompting you to delete the CI pipeline. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/delete-pipeline-delete-CI.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/ci-pipeline/delete-pipeline-delete-CI.jpg)
Figure 68: Clicking 'Delete Pipeline'
In case your build pipeline is linked to another pipeline through **Linked Build Pipeline**, then you must first delete the linked pipeline in order to delete your pipeline. 7. Select **Delete** and the CI pipeline will be deleted along with its workflow. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/delete-pipeline-delete-ci-popup.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/ci-pipeline/delete-pipeline-delete-ci-popup.jpg)
Figure 69: Deleting CI pipeline
--- @@ -747,10 +747,10 @@ The **Change Image Source** feature in Devtron lets you update the container ima 1. In the **Configurations** tab of your application, hover over the intended workflow name and click **Change Image Source** icon. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/change-image-source-click.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/ci-pipeline/change-image-source-click.jpg)
Figure 70a: Clicking 'Change Image Source'
- ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/change-image-source-select-workflow.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/ci-pipeline/change-image-source-select-workflow.jpg)
Figure 70b: Selecting Workflow Template
2. Select the intended workflow template and enter the details required as per the selected workflow template. Refer [Types of workflow templates](../workflow/README.md#types-of-ci-pipelines) to learn more. @@ -792,7 +792,7 @@ DEFAULT_CACHE_FOR_CD_PRE # for pre-deployment stage DEFAULT_CACHE_FOR_CD_POST # for post-deployment stage ``` -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/orchestrator-cm.jpg) +![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/ci-pipeline/orchestrator-cm.jpg)
Figure 71: Cache behavior at Global-level
#### 2. Editing Pipeline @@ -801,7 +801,7 @@ Go to **Workflow Editor** → **Edit Build Pipeline** (Build Stage) → **Docker By default, your build pipeline will inherit the Global Settings. However, you can use the toggle button to override it and decide the caching behavior using the **Use remote cache** checkbox. In other words, cache behavior defined in the pipeline configuration will have higher priority than the global one. -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/inherit-global.gif) +![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/ci-pipeline/inherit-global.gif)
Figure 72: Cache behavior at Pipeline-level
#### 3. During Trigger @@ -810,7 +810,7 @@ Go to **Build & Deploy** (tab) → **Select Material** → **Ignore Cache** (che You have the option to ignore cache while triggering a build (regardless of the cache settings defined at the pipeline or global level). -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/ignore-cache.gif) +![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/ci-pipeline/ignore-cache.gif)
Figure 73: Cache behavior at Trigger
:::caution Note @@ -835,7 +835,7 @@ To override a container registry, container image, or target platform: 3. Select the build pipeline of your application. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/select-build-override.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/ci-pipeline/select-build-override.jpg)
Figure 74: Selecting Build Pipeline
4. Click **Allow Override** in the **Build Stage**: @@ -846,14 +846,14 @@ To override a container registry, container image, or target platform: * Set a [new target platform](../../creating-application/docker-build-configuration.md#set-target-platform-for-the-build) from the drop-down list or enter a new target platform. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/build-allow-override.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/ci-pipeline/build-allow-override.jpg)
Figure 75: Selecting Allow Override
5. Select **Update Pipeline**, The override will be effective when the next build is triggered. The overridden container registry/container image location/target platform will be reflected on the [Build Configuration](../../creating-application/docker-build-configuration.md) page. You can also see the number of build pipelines for which the container registry/container image location/target platform are overridden. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/build-configuration-overridden.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/ci-pipeline/build-configuration-overridden.jpg)
Figure 76: Overrides in Build Configuration
### Configuring Webhook @@ -866,15 +866,15 @@ If you choose **Pull Request** or **Tag Creation** as the **Source Type**, you m 1. Go to **Settings** → **Webhooks** of your repository. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/deploy-image-ga-settings.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/ci-pipeline/deploy-image-ga-settings.jpg)
Figure 77a: Navigating to Repository Settings
- ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/webhooks-github-webhooks.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/ci-pipeline/webhooks-github-webhooks.jpg)
Figure 77b: Selecting 'Webhooks'
2. Select **Add webhook**. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/webhooks-github-add-webhook.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/ci-pipeline/webhooks-github-add-webhook.jpg)
Figure 78: Selecting 'Add webhook'
3. In the **Payload URL** field, enter the Webhook URL that you get on selecting the source type as "Pull Request" or "Tag Creation" in Devtron the dashboard. @@ -885,36 +885,36 @@ If you choose **Pull Request** or **Tag Creation** as the **Source Type**, you m 6. Under **Which events would you like to trigger this webhook?**, select **Let me select individual events** to trigger the webhook for specific events. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/webhooks-github-enter-info.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/ci-pipeline/webhooks-github-enter-info.jpg)
Figure 79: Configuring Webhook
7. Select the appropriate triggers * For Pull Requests, select **Pull Requests**. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/webhooks-github-pull.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/ci-pipeline/webhooks-github-pull.jpg)
Figure 80: Selecting 'Pull Requests'
* For Tag Creation, select **Branch or tag creation**. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/webhooks-github-branch.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/ci-pipeline/webhooks-github-branch.jpg)
Figure 81: Selecting 'Branch or tag creation'
8. Select **Add webhook**. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/webhooks-github-webhook-added.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/ci-pipeline/webhooks-github-webhook-added.jpg)
Figure 82: Selecting 'Add webhook'
#### For GitLab 1. Navigate to **Setting** → **Webhooks** of your repository. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/webhooks-gitlab-settings-webhook.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/ci-pipeline/webhooks-gitlab-settings-webhook.jpg)
Figure 83: Navigating to Repository Settings
2. Select **Add new webhook**. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/webhooks-gitlab-add-new-webhook.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/ci-pipeline/webhooks-gitlab-add-new-webhook.jpg)
Figure 84: Selecting 'Add new webhook'
3. You can provide a name and description (optional). @@ -923,39 +923,39 @@ If you choose **Pull Request** or **Tag Creation** as the **Source Type**, you m 5. In the **Secret token** field, enter the secret from the Devtron dashboard when you select the source type as "Pull Request" or "Tag Creation". - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/webhooks-gitlab-enter-info.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/ci-pipeline/webhooks-gitlab-enter-info.jpg)
Figure 85: Configuring Webhook
6. Checkmark the appropriate triggers under the **Trigger** section. * For Pull Requests, select **Merge request events**. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/webhooks-gitlab-merge.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/ci-pipeline/webhooks-gitlab-merge.jpg)
Figure 86: Selecting 'Merge request events'
* For Tag Creation, select **Tag push events** - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/webhooks-gitlab-tag.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/ci-pipeline/webhooks-gitlab-tag.jpg)
Figure 87: Selecting 'Tag push events'
7. Select **Add Webhook** and the webhook will be added to your repository. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/webhooks-gitlab-webhook-added.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/ci-pipeline/webhooks-gitlab-webhook-added.jpg)
Figure 88:Selecting 'Add Webhook'
#### For Bitbucket Cloud 1. Navigate to the **Repository settings** page of your Bitbucket repository. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/webhooks-bitbucket-settings.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/ci-pipeline/webhooks-bitbucket-settings.jpg)
Figure 89: Navigating to Repository Settings
2. Select **Webhooks** under **Workflow** section and then select **Add webhook**. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/webhooks-bitbucket-webhook.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/ci-pipeline/webhooks-bitbucket-webhook.jpg)
Figure 90a: Selecting 'Webhooks'
- ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/webhooks-bitbucket-add-webhook.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/ci-pipeline/webhooks-bitbucket-add-webhook.jpg)
Figure 90b: Selecting 'Add webhook'
3. Enter a **Title** for the webhook. @@ -964,16 +964,16 @@ If you choose **Pull Request** or **Tag Creation** as the **Source Type**, you m 5. In the **Secret** field, enter the secret from the Devtron dashboard when you select the source type as "Pull Request" or "Tag Creation". - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/webhooks-bitbucket-enter-info.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/ci-pipeline/webhooks-bitbucket-enter-info.jpg)
Figure 91: Configuring Webhook
6. Select the event triggers for which you want to trigger the webhook under the **Triggers** section. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/webhooks-bitbucket-trigger.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/ci-pipeline/webhooks-bitbucket-trigger.jpg)
Figure 92: Selecting triggers
7. Select **Save** to save your configurations. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/webhooks-bitbucket-save.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/ci-pipeline/webhooks-bitbucket-save.jpg)
Figure 93: Saving Configurations
From 1adfcdf8c9b229a1458931980d60fda13e2fba68 Mon Sep 17 00:00:00 2001 From: Hii-Arpit Date: Mon, 17 Nov 2025 23:20:39 +0530 Subject: [PATCH 05/10] docs: sanitised devtron-apps folder and updated links --- docs/user-guide/cloning-application.md | 6 +-- docs/user-guide/create-application.md | 4 +- .../base-config/README.md | 2 +- .../deployment-template-types/README.md | 2 +- .../deployment-template-types/deployment.md | 4 +- .../job-and-cronjob.md | 2 +- .../rollout-deployment.md | 4 +- .../deployment-template-types/statefulset.md | 4 +- .../base-config/deployment-template.md | 40 +++++++++---------- .../docker-build-configuration.md | 18 ++++----- .../creating-application/git-material.md | 20 +++++----- .../creating-application/workflow/README.md | 2 +- docs/user-guide/deleting-application.md | 6 +-- 13 files changed, 57 insertions(+), 57 deletions(-) diff --git a/docs/user-guide/cloning-application.md b/docs/user-guide/cloning-application.md index 8106a8a1a..c11aea253 100755 --- a/docs/user-guide/cloning-application.md +++ b/docs/user-guide/cloning-application.md @@ -6,12 +6,12 @@ hide_table_of_contents: true Click on `Create New` and the select `Custom app` to create a new application. -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/create-button.jpg) +![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/creating-application/create-button.jpg)
Figure 1: Create Button
As soon you click on `Custom app`, you will get a popup window on screen where you have to enter `app name` and `project` for the application. there are two radio buttons present on the popup window, one is for `Blank app` and another one is for `Clone an existing app`. For cloning an existing application, select the second one. After this, one more drop-down will appear on the window from which you can select the application that you want to clone. For this, you will have to type minimum three character to see the matching results in the drop-down. After typing the matching characters, select the application that you want to clone. You also can add additional information about the application (eg. `created by`, `Created on`) using `tags` (only key:value allowed). -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/clone-app.jpg) +![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/creating-application/clone-app.jpg)
Figure 2: Choosing an App to Clone
| Key | Description | @@ -23,7 +23,7 @@ Click on `Create New` and the select `Custom app` to create a new application. Now click on `Clone App` to clone the selected application. -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/new-cloned-app.jpg) +![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/creating-application/new-cloned-app.jpg)
Figure 3: Filling the Details
New application with a duplicate template is created. diff --git a/docs/user-guide/create-application.md b/docs/user-guide/create-application.md index 1565379ff..b28088a48 100755 --- a/docs/user-guide/create-application.md +++ b/docs/user-guide/create-application.md @@ -4,7 +4,7 @@ * On the upper-right corner of the screen, click **Create**. * Select **Custom app** from the drop-down list. -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/create-button.jpg) +![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/creating-application/create-button.jpg)
Figure 1: Create Button
A new application can be created from one of the following options: @@ -17,7 +17,7 @@ A new application can be created from one of the following options: To create a new application from the custom app, select **Custom app**. -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/create-application.jpg) +![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/creating-application/create-application.jpg)
Figure 2: Creating App from Scratch
* In the **Create application** window, enter an **App Name** and select a **Project**. diff --git a/docs/user-guide/creating-application/base-config/README.md b/docs/user-guide/creating-application/base-config/README.md index 1471953b2..e55aecf81 100755 --- a/docs/user-guide/creating-application/base-config/README.md +++ b/docs/user-guide/creating-application/base-config/README.md @@ -14,7 +14,7 @@ Base Configurations in Devtron consists of: In Devtron, these are the core settings that dictate an application's behavior. -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/base-configurations-section.jpg) +![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/base-configurations/base-configurations-section.jpg)
Figure 1: Base Configurations of Application
## Next Steps diff --git a/docs/user-guide/creating-application/base-config/deployment-template-types/README.md b/docs/user-guide/creating-application/base-config/deployment-template-types/README.md index 4d82f71fd..56866e0d6 100755 --- a/docs/user-guide/creating-application/base-config/deployment-template-types/README.md +++ b/docs/user-guide/creating-application/base-config/deployment-template-types/README.md @@ -11,7 +11,7 @@ In Devtron, the following deployment charts are available for you to use for you * [Job and Cronjob](job-and-cronjob.md) * [StatefulSets](statefulset.md) -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/deployment-charts-devtron.gif) +![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/base-configurations/deployment-types/deployment-charts-devtron.gif)
Deployment Charts by Devtron
Each template serves a specific purpose; therefore, choose one based on your application’s requirements. \ No newline at end of file diff --git a/docs/user-guide/creating-application/base-config/deployment-template-types/deployment.md b/docs/user-guide/creating-application/base-config/deployment-template-types/deployment.md index 71e4c8f3b..731a8e689 100755 --- a/docs/user-guide/creating-application/base-config/deployment-template-types/deployment.md +++ b/docs/user-guide/creating-application/base-config/deployment-template-types/deployment.md @@ -9,7 +9,7 @@ This chart creates a deployment that runs multiple replicas of your application * Use the status of the Deployment as an indicator that a rollout has stuck. * Clean up older ReplicaSets that you do not need anymore. -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/select-deployment.jpg) +![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/base-configurations/deployment-types/select-deployment.jpg)
Figure 1: Choosing 'Deployment' Chart
You can define application behavior by providing information in the following sections: @@ -1113,7 +1113,7 @@ It gives the realtime metrics of the deployed applications If you want to see application metrics like different HTTP status codes metrics, application throughput, latency, response time. Enable the Application metrics from below the deployment template Save button. After enabling it, you should be able to see all metrics on App detail page. By default it remains disabled. -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/app-metrics.jpg) +![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/base-configurations/deployment-types/app-metrics.jpg)
Figure 2: Application Metrics
Once all the Deployment template configurations are done, click on `Save` to save your deployment configuration. Now you are ready to create [Workflow](../../workflow/README.md) to do CI/CD. diff --git a/docs/user-guide/creating-application/base-config/deployment-template-types/job-and-cronjob.md b/docs/user-guide/creating-application/base-config/deployment-template-types/job-and-cronjob.md index 151c33dfa..64e7a5db2 100755 --- a/docs/user-guide/creating-application/base-config/deployment-template-types/job-and-cronjob.md +++ b/docs/user-guide/creating-application/base-config/deployment-template-types/job-and-cronjob.md @@ -6,7 +6,7 @@ This chart deploys Job & CronJob. A Job is a controller object that represents a * [Job](#1-job) * [CronJob](#2-cronjob) -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/select-job-cronjob.jpg) +![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/base-configurations/deployment-types/select-job-cronjob.jpg)
Figure 1: Choosing 'Job & CronJob' Chart
## 1. Job diff --git a/docs/user-guide/creating-application/base-config/deployment-template-types/rollout-deployment.md b/docs/user-guide/creating-application/base-config/deployment-template-types/rollout-deployment.md index 8d35e8194..1e1600f58 100755 --- a/docs/user-guide/creating-application/base-config/deployment-template-types/rollout-deployment.md +++ b/docs/user-guide/creating-application/base-config/deployment-template-types/rollout-deployment.md @@ -3,7 +3,7 @@ The `Rollout Deployment` chart deploys an advanced version of deployment that supports Blue/Green and Canary deployments. For functioning, it requires a rollout controller to run inside the cluster. -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/select-rollout.jpg) +![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/base-configurations/deployment-types/select-rollout.jpg)
Figure 1: Choosing 'Rollout' Chart
You can define application behavior by providing information in the following sections: @@ -955,7 +955,7 @@ Wait for given period of time before scaling down the container. If you want to see application metrics like different HTTP status codes metrics, application throughput, latency, response time. Enable the Application metrics from below the deployment template Save button. After enabling it, you should be able to see all metrics on App detail page. By default it remains disabled. -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/app-metrics.jpg) +![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/base-configurations/deployment-types/app-metrics.jpg)
Figure 4: Application Metrics
Once all the Deployment template configurations are done, click on `Save` to save your deployment configuration. Now you are ready to create [Workflow](../../workflow/README.md) to do CI/CD. diff --git a/docs/user-guide/creating-application/base-config/deployment-template-types/statefulset.md b/docs/user-guide/creating-application/base-config/deployment-template-types/statefulset.md index 6587581b3..0f761852b 100755 --- a/docs/user-guide/creating-application/base-config/deployment-template-types/statefulset.md +++ b/docs/user-guide/creating-application/base-config/deployment-template-types/statefulset.md @@ -2,7 +2,7 @@ The StatefulSet chart in Devtron allows you to deploy and manage stateful applications. StatefulSet is a Kubernetes resource that provides guarantees about the ordering and uniqueness of Pods during deployment and scaling. -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/select-statefulset.jpg) +![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/base-configurations/deployment-types/select-statefulset.jpg)
Figure 1: Choosing 'StatefulSet' Chart
It supports only `ONDELETE` and `ROLLINGUPDATE` deployment strategy. @@ -973,7 +973,7 @@ It gives the realtime metrics of the deployed applications If you want to see application metrics like different HTTP status codes metrics, application throughput, latency, response time. Enable the Application metrics from below the deployment template Save button. After enabling it, you should be able to see all metrics on App detail page. By default it remains disabled. -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/app-metrics.jpg) +![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/base-configurations/deployment-types/app-metrics.jpg)
Figure 3: Application Metrics
Once all the Deployment template configurations are done, click on `Save` to save your deployment configuration. Now you are ready to create [Workflow](../../workflow/README.md) to do CI/CD. diff --git a/docs/user-guide/creating-application/base-config/deployment-template.md b/docs/user-guide/creating-application/base-config/deployment-template.md index 54cc18396..95aa6171e 100755 --- a/docs/user-guide/creating-application/base-config/deployment-template.md +++ b/docs/user-guide/creating-application/base-config/deployment-template.md @@ -2,7 +2,7 @@ ## Introduction -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/deployment-template.jpg) +![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/base-configurations/deployment-template/deployment-template.jpg)
Figure 1: Deployment Template
In Devtron, a [Deployment Template](../../../reference/glossary.md#deployment-template) defines how your application should run by defining its specifications. Devtron uses [Helm charts](../../../reference/glossary.md#helm-chartspackages) to manage these deployments, allowing you to control everything from [Resource Allocation](../../../reference/glossary.md#resource-allocation) to environment variables. @@ -34,12 +34,12 @@ Users need to have [Admin role](../../../user-guide/global-configurations/user-a 1. Go to the **Configurations** page of your application. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/app-config-page.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/base-configurations/deployment-template/app-config-page.jpg)
Figure 2: Application's 'Configurations' Page
2. Click **Base Configuration** → **Deployment Template**. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/click-baseconfig.gif) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/base-configurations/deployment-template/click-baseconfig.gif)
Figure 3: Navigating to Base Configurations
3. Select the **Chart** drop-down box. The following tabs are displayed: @@ -48,10 +48,10 @@ Users need to have [Admin role](../../../user-guide/global-configurations/user-a * [Custom charts](../../global-configurations/deployment-charts.md) - Displays your custom deployment charts (if available). To create a custom deployment chart, refer to [Deployment Charts](../../global-configurations/deployment-charts.md). - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/deployment-charts-devtron.gif) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/base-configurations/deployment-template/deployment-charts-devtron.gif)
Figure 4a: Charts by Devtron
- ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/deployment-charts-custom.gif) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/base-configurations/deployment-template/deployment-charts-custom.gif)
Figure 4b: Custom Charts
:::danger Important Note @@ -70,12 +70,12 @@ Users need to have [Admin role](../../../user-guide/global-configurations/author Devtron maintains multiple chart versions for each chart type. Additionally, each chart version has a supporting README file that you can use to know more about the features and variables. -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/readme-version.gif) +![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/base-configurations/deployment-template/readme-version.gif)
Figure 5: Accessing the README file
Once you [select a deployment chart](#select-a-deployment-chart-type), choose a chart version with which you wish to deploy your application from the **Version** drop-down box. By default, the latest version of the helm chart is selected. -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/chart-version.jpg) +![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/base-configurations/deployment-template/chart-version.jpg)
Figure 6: Choosing the Chart Version
--- @@ -97,7 +97,7 @@ You can edit a deployment template using the following two ways: If you prefer to use a simple way to configure your chosen deployment chart, select **GUI**. -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/basic-gui.jpg) +![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/base-configurations/deployment-template/basic-gui.jpg)
Figure 7: GUI Option
By default, the following fields are commonly available for you to modify in the **GUI** section of most charts: @@ -125,7 +125,7 @@ By default, the following fields are commonly available for you to modify in the If you wish to perform additional configurations, click the **Switch to Advanced** button or **YAML** button. Or [perform a dry run](#perform-a-dry-run) before saving your configuration. -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/yaml-switch.jpg) +![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/base-configurations/deployment-template/yaml-switch.jpg)
Figure 8: Switch to Advanced (YAML Method)
:::info Note @@ -250,7 +250,7 @@ PUT {{DEVTRON_BASEURL}}/orchestrator/deployment/template/schema If you prefer to perform additional configurations in your chosen deployment template, select **YAML**. -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/yaml-switch.jpg) +![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/base-configurations/deployment-template/yaml-switch.jpg)
Figure 9: YAML Option
Every chart version has its own YAML file that provides specifications for your application. To make it easy to use, we have created templates for the YAML file and added some variables inside the YAML. You can provide or change the values of these variables as per your requirement. @@ -280,12 +280,12 @@ The availability of application metrics depends on the selected chart type and v To enable this, turn on the **Show application metrics** toggle. -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/show-application-metrics.jpg) +![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/base-configurations/deployment-template/show-application-metrics.jpg)
Figure 10: Enabling Application Metrics
Once enabled, you can view the application metrics on the **App Details** page. -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/app-metrics.jpg) +![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/base-configurations/deployment-template/app-metrics.jpg)
Figure 11: Application metrics on 'App Details' page
:::info Important @@ -300,7 +300,7 @@ Before saving your configured deployment template, you can use the **Dry Run** o This feature helps you verify your configurations, detect issues, and ensure correctness before actual deployment. -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/dry-run-dt.gif) +![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/base-configurations/deployment-template/dry-run-dt.gif)
Figure 12: Show application metrics
Your configurations will appear in the left pane, while the right pane will display a section named `Manifest generated from merged` showing the computed Kubernetes manifests, each representing a separate resource after merging all your changes. @@ -316,7 +316,7 @@ Only a super-admin, manager, and admin can edit the configuration values. Any changes made to the deployment template will require approval if an approval policy is enforced. To check if your deployment template is protected, check the stamp/approve symbol as shown below. -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/protected-dt.jpg) +![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/base-configurations/deployment-template/protected-dt.jpg)
Figure 13: Checking Protected Configuration
### Request Approval for Changes @@ -325,12 +325,12 @@ Let's assume you are the application admin and your deployment template in **Bas 1. In the YAML editor of the deployment template, modify the values. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/edit-deployment-template.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/base-configurations/deployment-template/edit-deployment-template.jpg)
Figure 14: Selecting Values to Change
2. You can change the value of a key to a desired value as shown below. Once done, click the **Save Changes** button. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/changed-values.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/base-configurations/deployment-template/changed-values.jpg)
Figure 15: Changing Values
:::info What if the keys are locked from editing? @@ -346,12 +346,12 @@ You cannot modify locked keys in deployment template unless you are a super-admi Since we are proposing the changes immediately, click **Propose Changes**. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/propose-changes.gif) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/base-configurations/deployment-template/propose-changes.gif)
Figure 16: Proposing Changes
4. You can also view the approval status if you wish. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/approval-status.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/base-configurations/deployment-template/approval-status.jpg)
Figure 17: Viewing the Approval Status
:::info Can I approve my own changes? @@ -361,7 +361,7 @@ No, the one who performs the edits cannot approve their own changes. A different Only one draft can exist at time and you cannot create multiple drafts. In the top-right corner, you have the option to discard the draft if you don't wish to proceed with the edits you made. -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/discard-draft.jpg) +![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/base-configurations/deployment-template/discard-draft.jpg)
Figure 18: Discarding the Draft
### Grant Approval for Changes @@ -373,7 +373,7 @@ Only a valid approver or a Super-Admin can approve the changes made to the deplo Go to the edited configuration file to review and approve the changes as shown below. -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/approval-screen.jpg) +![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/base-configurations/deployment-template/approval-screen.jpg)
Figure 19: Approving the Changes
:::info Note diff --git a/docs/user-guide/creating-application/docker-build-configuration.md b/docs/user-guide/creating-application/docker-build-configuration.md index 8b1e26593..ccf05e9f9 100755 --- a/docs/user-guide/creating-application/docker-build-configuration.md +++ b/docs/user-guide/creating-application/docker-build-configuration.md @@ -12,14 +12,14 @@ For **build configuration**, you must provide information in the sections as giv * [Build the Container Image](#build-the-container-image) * [Advanced Options](#advanced-options) -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/build-configuration-section.jpg) +![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/build-configurations/build-configuration-section.jpg)
Figure 1: Build Configuration Section
## Store Container Image The following fields are provided on the **Store Container Image** section: -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/store-container-registry.jpg) +![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/build-configurations/store-container-registry.jpg)
Figure 2: Entering Docker Repo Details
| Field | Description | @@ -29,7 +29,7 @@ The following fields are provided on the **Store Container Image** section: > If you are using Docker Hub account, you need to enter the repository name along with your username. For example, if your username is *nightdocker* and repo name is *banking-nxt-frontend*, then enter `nightdocker/banking-nxt-frontend` instead of only `banking-nxt-frontend`. -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/docker-repo.jpg) +![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/build-configurations/docker-repo.jpg)
Figure 3: Example Docker Repo
@@ -46,7 +46,7 @@ You can choose one of the following options to build your container image: A `Dockerfile` is a text document that contains all the commands which you can call on the command line to build an image. -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/i-have-a-dockerfile.jpg) +![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/build-configurations/i-have-a-dockerfile.jpg)
Figure 4: Marking Dockerfile as Available
| Field | Description | @@ -58,7 +58,7 @@ A `Dockerfile` is a text document that contains all the commands which you can c With the option **Create Dockerfile**, you can create a `Dockerfile` from the available templates. You can edit any selected Dockerfile template as per your build configuration requirements. -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/create-dockerfile.jpg) +![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/build-configurations/create-dockerfile.jpg)
Figure 5: Creating a Dockerfile
| Field | Description | @@ -70,7 +70,7 @@ With the option **Create Dockerfile**, you can create a `Dockerfile` from the av With the option **Build without Dockerfile**, you can use Buildpacks to automatically build the image for your preferred language and framework. -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/build-without-dockerfile.jpg) +![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/build-configurations/build-without-dockerfile.jpg)
Figure 6: Building without Dockerfile
| Field | Description | @@ -101,10 +101,10 @@ You can add Key/Value pair by clicking **Add argument**. Using this option, you can build images for a specific or multiple **architectures and operating systems (target platforms)**. You can select the target platform from the drop-down list or can type to select a customized target platform. -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/set-target-platform.jpg) +![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/build-configurations/set-target-platform.jpg)
Figure 7a: Selecting Target Platform from Drop-down
-![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/set-target-platform-2.jpg) +![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/build-configurations/set-target-platform-2.jpg)
Figure 7b: Entering Custom Target Platform
Before selecting a customized target platform, please ensure that the architecture and the operating system are supported by the `registry type` you are using, otherwise build will fail. Devtron uses BuildX to build images for multiple target Platforms, which requires higher CI worker resources. To allocate more resources, you can increase value of the following parameters in the `devtron-cm` configmap in `devtroncd` namespace. @@ -128,7 +128,7 @@ The Target Platform feature might not work in minikube & microk8s clusters as of * Key * Value -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/docker-build-arguments.jpg) +![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/build-configurations/docker-build-arguments.jpg)
Figure 8: Entering Docker Build Arguments
These fields will contain the key parameter and the value for the specified key for your [docker build](https://docs.docker.com/engine/reference/commandline/build/#options). This field is Optional. If required, this can be overridden at [CI step](../deploying-application/triggering-ci.md). diff --git a/docs/user-guide/creating-application/git-material.md b/docs/user-guide/creating-application/git-material.md index 43ddc72d6..6fa0b0fd9 100755 --- a/docs/user-guide/creating-application/git-material.md +++ b/docs/user-guide/creating-application/git-material.md @@ -6,7 +6,7 @@ During the [CI process](../deploying-application/triggering-ci.md), the applicat Devtron also supports multiple Git repositories (be it from one Git account or multiple Git accounts) in a single deployment. -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/add-git-repo.jpg) +![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/git-repository/add-git-repo.jpg)
Figure 1: Adding Git Repository
Therefore, this doc is divided into 2 sections, read the one that caters to your application: @@ -32,7 +32,7 @@ In your Devtron app, go to **Configuration** (tab) → **Git Repository**. You w This is a dropdown that shows the list of Git accounts added to your organization on Devtron. If you haven't done already, we recommend you to first [add your Git account](../global-configurations/git-accounts.md) (especially when the repository is private). -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/select-git-account.jpg) +![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/git-repository/select-git-account.jpg)
Figure 2: Selecting Git Account
:::info @@ -46,7 +46,7 @@ In this field, you have to provide your code repository’s URL, for e.g., `http You can find this URL by clicking on the **Code** button available on your repository page as shown below: -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/repo-url.jpg) +![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/git-repository/repo-url.jpg)
Figure 3: Getting Repo URL
:::info @@ -59,12 +59,12 @@ You can find this URL by clicking on the **Code** button available on your repos Not all repository changes are worth triggering a new [CI build](../deploying-application/triggering-ci.md). If you enable this checkbox, you can define the file(s) or folder(s) whose commits you wish to use in the CI build. -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/exclude-files.jpg) +![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/git-repository/exclude-files.jpg)
Figure 4: Sample Exclusion Rule
In other words, if a given commit contains changes only in file(s) present in your exclusion rule, the commit won't show up while selecting the [Git material](../../reference/glossary.md#material), which means it will not be eligible for build. However, if a given commit contains changes in other files too (along with the excluded file), the commit won't be excluded and it will definitely show up in the list of commits. -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/excluded-commit.jpg) +![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/git-repository/excluded-commit.jpg)
Figure 5: Excludes commits made to README.md
Devtron allows you to create either an exclusion rule, an inclusion rule, or a combination of both. In case of multiple files or folders, you can list them in new lines. @@ -89,7 +89,7 @@ To include a path, don't use any prefix, e.g. `path/to/file` Since file paths can be long, Devtron supports regex too for writing the paths. To understand it better, you may click the **How to use** link as shown below. -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/regex-help.jpg) +![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/git-repository/regex-help.jpg)
Figure 6: Regex Support
#### How to view excluded commits? @@ -98,13 +98,13 @@ As we saw earlier in fig. 4 and 5, commits containing the changes of only `READM However, Devtron gives you the option to view the excluded commits too. There's a döner menu at the top-right (beside the `Search by commit hash` search bar). -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/doner-menu.jpg) +![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/git-repository/doner-menu.jpg)
Figure 7a: Döner Menu Icon
-![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/show-exclusions.jpg) +![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/git-repository/show-exclusions.jpg)
Figure 7b: Show Excluded Commits
-![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/excluded-commits.jpg) +![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/git-repository/excluded-commits.jpg)
Figure 7c: Commits Unavailable for Build
The **EXCLUDED** label (in red) indicates that the commits contain changes made only to the excluded file, and hence they are unavailable for build. @@ -116,7 +116,7 @@ After clicking the checkbox, a field titled `clone directory path` appears. It i This field is optional for a single Git repository application and you can leave the path as default. Devtron assigns a directory by itself when the field is left blank. The default value of this field is `./` -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/clone-directory.jpg) +![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/git-repository/clone-directory.jpg)
Figure 8: Clone Directory Option
diff --git a/docs/user-guide/creating-application/workflow/README.md b/docs/user-guide/creating-application/workflow/README.md index e959ef573..af24f3270 100755 --- a/docs/user-guide/creating-application/workflow/README.md +++ b/docs/user-guide/creating-application/workflow/README.md @@ -6,7 +6,7 @@ After configuring the **Build Configurations** and **Base Configurations**, the In Devtron, a **Workflow** is a logical sequence of different stages(pipelines) used for continuous integration and continuous deployment of an application. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/workflow-intro.gif) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/ci-pipeline/workflow-intro.gif)
Figure 1: Workflow Editor
--- diff --git a/docs/user-guide/deleting-application.md b/docs/user-guide/deleting-application.md index fb6472161..85fb42640 100755 --- a/docs/user-guide/deleting-application.md +++ b/docs/user-guide/deleting-application.md @@ -10,21 +10,21 @@ Clicking on `Delete Application` will not delete your application if you have wo If your Application contains workflows in the Workflow Editor. So, when you click on `Delete Application`, you will see the following prompt. -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/app-delete-warning.gif) +![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/creating-application/app-delete-warning.gif)
Figure 1: Error while Deleting App
Click on `View Workflows` to view and delete your workflows in the application. To delete the workflows in your application, you must first delete all the pipelines \(CD Pipeline, CI Pipeline or Linked CI Pipeline or External CI Pipeline if there are any\). -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/delete-workflows.gif) +![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/creating-application/delete-workflows.gif)
Figure 2: Deleting Pipelines and Workflows
After you have deleted all the pipelines in the workflow, you can delete that particular workflow. Similarly, delete all the workflows in the application. -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/delete-application.gif) +![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/creating-application/delete-application.gif)
Figure 3: Deleting Application
From 4995dd87d600249b6efa504d70ad0615c8fc931a Mon Sep 17 00:00:00 2001 From: Hii-Arpit Date: Tue, 18 Nov 2025 14:09:24 +0530 Subject: [PATCH 06/10] docs: updated images and gifs for environment overrides --- .../environment-overrides.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/user-guide/creating-application/environment-overrides.md b/docs/user-guide/creating-application/environment-overrides.md index d73488ee8..95d526928 100755 --- a/docs/user-guide/creating-application/environment-overrides.md +++ b/docs/user-guide/creating-application/environment-overrides.md @@ -2,7 +2,7 @@ You can view all environments associated with an application under the **Environment Overrides** section. -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/environment-overrides/environment-override-v3.jpg) +![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/environment-override/environment-override.jpg)
Figure 1: Environment Overrides Section
The Environment Overrides section allows you to customize the **Deployment Template**, **ConfigMaps**, and **Secrets** for different environments such as development, testing, staging, and production. @@ -23,12 +23,12 @@ Users need to have [Admin role](../global-configurations/authorization/user-acce 1. In your Devtron app, go to **Configurations** (tab) → **Environment Overrides**. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/environment-overrides/config-env-override.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/environment-override/config-env-override.jpg)
Figure 2: Accessing Environment Overrides
2. Select an environment whose configurations you wish to modify. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/environment-overrides/environment-override-v3.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/environment-override/environment-override-1.jpg)
Figure 3: Selecting Environment
3. You will get the following options (similar to the **Base Configurations** page): @@ -36,7 +36,7 @@ Users need to have [Admin role](../global-configurations/authorization/user-acce * [ConfigMaps](#override-configmap--secret) * [Secrets](#override-configmap--secret) - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/environment-overrides/env-config-screen.gif) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/environment-override/env-config-screen.gif)
Figure 4: Configuration Options
@@ -53,17 +53,17 @@ As you can see, the Deployment Template for the *banking-final* environment show 1. Go to the **Inherited** tab. This will show the inherited configuration in a read-only YAML editor. You cannot edit any values here. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/environment-overrides/inherited-dt.gif) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/environment-override/inherited-dt.gif)
Figure 5: Inherited Deployment Template
2. Clicking **No override** to override the inherited configuration (if not done already). - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/environment-overrides/no-override-tab.gif) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/environment-override/no-override-tab.gif)
Figure 6: No Override Tab
3. Click the **Create Override** button. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/environment-overrides/create-override.gif) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/environment-override/create-override.gif)
Figure 7: Creat Override Button
4. In the same tab (now labelled as **Override**), you can choose any one mode for changing the configuration values: @@ -180,7 +180,7 @@ This action will discard the current overrides and the base configuration file ( 2. Click **Delete Override**. 3. Confirm the deletion in the dialogbox. -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/creating-application/environment-overrides/delete-override.gif) +![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/app-management/devtron-apps/environment-override/delete-override.gif)
Figure 8: Delete Override Option
--- From d679e6e2e94468cd6323d2775d3eef1cf1aa3dea Mon Sep 17 00:00:00 2001 From: Hii-Arpit Date: Tue, 18 Nov 2025 21:20:35 +0530 Subject: [PATCH 07/10] docs: fix user access link --- .../global-configurations/authorization/user-access.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/user-guide/global-configurations/authorization/user-access.md b/docs/user-guide/global-configurations/authorization/user-access.md index 31a2cae66..259326e3c 100755 --- a/docs/user-guide/global-configurations/authorization/user-access.md +++ b/docs/user-guide/global-configurations/authorization/user-access.md @@ -52,7 +52,7 @@ Only managers and super-admins can add users. ## Grant Super Admin Permission -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/global-configurations/user-permissions/superadmin-perm.jpg) +![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/global-configurations/user-access/superadmin-perm.jpg)
Figure 7: Granting Superadmin Access
Super-Admins have unrestricted access to all Devtron resources. They can create, modify, delete, and manage any resource, including user access, Git repositories, container registries, clusters, and environments. Before assigning this permission, please note: From 5157b51eb57503a399570380e0f76b0be06faf94 Mon Sep 17 00:00:00 2001 From: Hii-Arpit Date: Wed, 19 Nov 2025 08:24:29 +0530 Subject: [PATCH 08/10] docs: updated resource browser snapshots --- .../resource-browser/compare-and-sync.md | 24 +++---- .../resource-browser/manage-resources.md | 20 +++--- docs/user-guide/resource-browser/nodes.md | 32 ++++----- docs/user-guide/resource-browser/overview.md | 4 +- docs/user-guide/resource-browser/pods.md | 4 +- .../resource-browser/resource-recommender.md | 66 ++++++++++--------- 6 files changed, 76 insertions(+), 74 deletions(-) diff --git a/docs/user-guide/resource-browser/compare-and-sync.md b/docs/user-guide/resource-browser/compare-and-sync.md index a6572ca48..e11f93e09 100755 --- a/docs/user-guide/resource-browser/compare-and-sync.md +++ b/docs/user-guide/resource-browser/compare-and-sync.md @@ -12,7 +12,7 @@ The Compare & Sync feature in Devtron allows you to: Refer to [Use Cases](#use-cases) to know more on how this feature can help you. -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/kubernetes-resource-browser/compare-sync-highlighted.jpg) +![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/infra-management/resource-browser+/compare-sync/compare-sync-highlighted.jpg)
Figure 1: Compare & Sync Feature
:::caution Who Can Perform This Action? @@ -26,29 +26,29 @@ Only a [Super-Admin](../global-configurations/authorization/user-access.md#grant 1. Navigate to **Resource Browser**. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/kubernetes-resource-browser/k8s-resource-browser.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/infra-management/resource-browser+/compare-sync/k8s-resource-browser.jpg)
Figure 2: Resource Browser
2. Click the reference cluster (e.g., `default-cluster`) to compare against other clusters. 3. Click the **Compare & Sync** button. The **Compare & Sync Clusters** page is displayed. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/kubernetes-resource-browser/compare-sync-highlighted.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/infra-management/resource-browser+/compare-sync/compare-sync-highlighted.jpg)
Figure 3: Compare & Sync Button
The **Compare & Sync Clusters** page is primarily divided into two halves. The left side of the page displays the resources of the reference cluster you previously selected (`default-cluster` in this case). The right side of the page displays the resources of the target cluster you want to compare against. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/kubernetes-resource-browser/compare-sync-home.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/infra-management/resource-browser+/compare-sync/compare-sync-home.jpg)
Figure 4: Compare & Sync Clusters Page
4. Select the target cluster in the **Select Cluster** drop-down box (e.g., `playground-vcluster` in this case). - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/kubernetes-resource-browser/select-cluster-option.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/infra-management/resource-browser+/compare-sync/select-cluster-option.jpg)
Figure 5: Select the Cluster
Once you select the clusters that you want to compare, all the resources associated with those clusters are listed in the **Compare & Sync Clusters** page. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/kubernetes-resource-browser/resources-displayed.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/infra-management/resource-browser+/compare-sync/resources-displayed.jpg)
Figure 6: Cluster Resources are Displayed
:::info How to Identify Missing Resource(s)? @@ -64,7 +64,7 @@ For instance, when a resource is displayed in blue in cluster A and in red in cl 5. Click the filter available at the top left corner of the page. All the resource groups and resource kinds are displayed in the filter box. For example, when you select `ConfigMap` as a resource kind, all the available ConfigMaps in both clusters are displayed. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/kubernetes-resource-browser/resource-group-filterbox.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/infra-management/resource-browser+/compare-sync/resource-group-filterbox.jpg)
Figure 7: Resource Kind Filter
6. Click the **View all** drop-down box. This filter allows you to filter the resources based on the following criteria: @@ -79,7 +79,7 @@ For instance, when a resource is displayed in blue in cluster A and in red in cl * `View right join` - To display all resources from the target cluster (right-hand side) and only matching resources from the reference cluster (left-hand side). - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/kubernetes-resource-browser/view-all-filterbox.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/infra-management/resource-browser+/compare-sync/view-all-filterbox.jpg)
Figure 8: View All Filter
:::caution Creating a Missing Resource? @@ -97,14 +97,14 @@ Follow the below steps to match the namespaces: 4. Click the **Create Resources** button. The namespaces will now be matched. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/kubernetes-resource-browser/sync-namespaces.gif) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/infra-management/resource-browser+/compare-sync/sync-namespaces.gif)
Figure 9: Match Namespaces
### Create Missing Resource(s) Hover over the resource that you'd like to create in the target cluster and click the **Create Resource** option. -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/kubernetes-resource-browser/create-resource.jpg) +![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/infra-management/resource-browser+/compare-sync/create-resource.jpg)
Figure 10: Create Resource
:::info Note @@ -118,14 +118,14 @@ Hover over the resource that you'd like to create in the target cluster and clic 1. Hover over the resource and click the **Compare manifest** option to compare the manifest of the resource in both clusters. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/kubernetes-resource-browser/compare-manifest.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/infra-management/resource-browser+/compare-sync/compare-manifest.jpg)
Figure 11: Compare Manifest
2. Click **Edit YAML**. 3. Click the **Revert this chunk** option to enforce the values, if required, from the reference cluster to the target cluster. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/kubernetes-resource-browser/compare-manifest.gif) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/infra-management/resource-browser+/compare-sync/compare-manifest.gif)
Figure 12: Revert this Chunk
4. Click **Apply Changes**. diff --git a/docs/user-guide/resource-browser/manage-resources.md b/docs/user-guide/resource-browser/manage-resources.md index 1d70dee2c..271415eb4 100755 --- a/docs/user-guide/resource-browser/manage-resources.md +++ b/docs/user-guide/resource-browser/manage-resources.md @@ -8,7 +8,7 @@ Users need to have [access to the cluster](../global-configurations/authorizatio You can use the searchbox to browse the resources. -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/kubernetes-resource-browser/discover-resource.gif) +![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/infra-management/resource-browser+/manage-resources/discover-resource.gif)
Figure 1: Locate Resources using Searchbox
### Filter Resources @@ -36,7 +36,7 @@ Further resources in the cluster are grouped under the following categories: * Other Resources * Custom Resource -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/kubernetes-resource-browser/cluster-resources.jpg) +![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/infra-management/resource-browser+/manage-resources/cluster-resources.jpg)
Figure 2: Resources within Cluster
--- @@ -51,12 +51,12 @@ You can edit the [manifest](../../reference/glossary.md#manifest) of a Kubernete ### Edit using YAML -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/kubernetes-resource-browser/edit-live-manifest-yaml.gif) +![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/infra-management/resource-browser+/manage-resources/edit-live-manifest-yaml.gif)
Figure 3a: Editing Manifest (Using YAML)
### Edit using GUI -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/kubernetes-resource-browser/edit-live-manifest-gui.gif) +![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/infra-management/resource-browser+/manage-resources/edit-live-manifest-gui.gif)
Figure 3b: Editing Manifest (Using GUI)
:::info Note @@ -69,7 +69,7 @@ The fields displayed in GUI mode will be as per the GUI schema configured by the You can monitor activities like creation, deletion, updation, scaling, or errors in the resources involved. Refer [Events](https://kubernetes.io/docs/reference/kubernetes-api/cluster-resources/event-v1/) to learn more. -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/kubernetes-resource-browser/events.gif) +![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/infra-management/resource-browser+/manage-resources/events.gif)
Figure 4a: Viewing All Events
### AI-assistance on Events @@ -80,7 +80,7 @@ Refer [Devtron Intelligence](../devtron-intelligence.md) to enable this feature. 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. -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/kubernetes-resource-browser/ai-assist-eventfix.gif) +![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/infra-management/resource-browser+/manage-resources/ai-assist-eventfix.gif)
Figure 4b: AI-assistance
--- @@ -93,7 +93,7 @@ User needs to be an [admin of the Kubernetes resource](../global-configurations/ You can delete an unwanted resource if it is orphaned and no longer required by your applications. -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/kubernetes-resource-browser/delete.gif) +![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/infra-management/resource-browser+/manage-resources/delete.gif)
Figure 5: Deleting a Resource
--- @@ -110,7 +110,7 @@ Once you select a cluster in Resource Browser, click **+ Create Resource**, and In the below example, we have created a simple pod named `nginx`: -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/kubernetes-resource-browser/create-resource.gif) +![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/infra-management/resource-browser+/manage-resources/create-resource.gif)
Figure 6: Creating Resources within Cluster
Here's one more example that shows the required fields and object specifications for a Kubernetes Deployment: @@ -148,12 +148,12 @@ You can use the checkbox to select the resources/workloads you wish to delete or ### Bulk Delete -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/kubernetes-resource-browser/bulk-delete-resources.gif) +![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/infra-management/resource-browser+/manage-resources/bulk-delete-resources.gif)
Figure 7a: Deleting Resources in Bulk
### Bulk Restart -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/kubernetes-resource-browser/bulk-restart-resources.gif) +![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/infra-management/resource-browser+/manage-resources/bulk-restart-resources.gif)
Figure 7b: Restarting Workloads in Bulk
:::info Note diff --git a/docs/user-guide/resource-browser/nodes.md b/docs/user-guide/resource-browser/nodes.md index 2e5983129..39e3ab09a 100755 --- a/docs/user-guide/resource-browser/nodes.md +++ b/docs/user-guide/resource-browser/nodes.md @@ -6,7 +6,7 @@ The components on a typical node include the `kubelet`, a `container runtime`, a 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**. -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/kubernetes-resource-browser/cluster-nodes-db.jpg) +![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/infra-management/resource-browser+/nodes/cluster-nodes-db.jpg)
Figure 1: Searching and Filtering Nodes
| Fields | Description | @@ -29,7 +29,7 @@ Clicking on a node shows you a number of details such as: * Labels, Annotations, and Taints * Node IP -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/kubernetes-resource-browser/node-summary-db.jpg) +![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/infra-management/resource-browser+/nodes/node-summary-db.jpg)
Figure 2: Checking Node Summary
Further using the Devtron UI, you will be able to: @@ -54,12 +54,12 @@ You can debug a node via [Cluster Terminal](./cluster-terminal.md) by selecting * Click **Debug**. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/kubernetes-resource-browser/debug-db.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/infra-management/resource-browser+/nodes/debug-db.jpg)
Figure 3a: Debugging a Node
* Debug a node by selecting the terminal shell, i.e., `bash` or `sh`. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/kubernetes-resource-browser/debug-terminal-db.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/infra-management/resource-browser+/nodes/debug-terminal-db.jpg)
Figure 3b: Debug Terminal
--- @@ -68,17 +68,17 @@ You can debug a node via [Cluster Terminal](./cluster-terminal.md) by selecting Cordoning a node means making the node unschedulable. After [cordoning a node](https://kubernetes.io/docs/reference/kubectl/generated/kubectl_cordon/), new pods cannot be scheduled on this node. -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/kubernetes-resource-browser/cordon-visual.jpg) +![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/infra-management/resource-browser+/nodes/cordon-visual.jpg)
Figure 4a: Visual Representation - Cordoning a Node
* Click **Cordon**. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/kubernetes-resource-browser/cordon-db.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/infra-management/resource-browser+/nodes/cordon-db.jpg)
Figure 4b: Cordoning a Node
* A confirmation dialog box will appear, click **Cordon Node** to proceed. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/kubernetes-resource-browser/cordon-dialog-db.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/infra-management/resource-browser+/nodes/cordon-dialog-db.jpg)
Figure 4c: Cordon Confirmation
The status of the node shows `SchedulingDisabled` with `Unschedulable` parameter set as `true`. @@ -91,19 +91,19 @@ Similarly, you can uncordon a node by clicking `Uncordon`. After a node is uncor Before performing maintenance on a node, [draining a node](https://kubernetes.io/docs/tasks/administer-cluster/safely-drain-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). -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/kubernetes-resource-browser/drain-visual.jpg) +![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/infra-management/resource-browser+/nodes/drain-visual.jpg)
Figure 5a: Visual Representation - Draining a Node
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**. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/kubernetes-resource-browser/drain-db.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/infra-management/resource-browser+/nodes/drain-db.jpg)
Figure 5b: Draining a Node
* A confirmation dialog box will appear, click **Drain Node** to proceed. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/kubernetes-resource-browser/drain-dialog-db.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/infra-management/resource-browser+/nodes/drain-dialog-db.jpg)
Figure 5c: Drain Confirmation
You can also select from the following conditions before draining a node: @@ -122,19 +122,19 @@ You can also select from the following conditions before draining 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. -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/kubernetes-resource-browser/taint-visual.jpg) +![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/infra-management/resource-browser+/nodes/taint-visual.jpg)
Figure 6a: Visual Representation - Tainting a Node
**Note**: Make sure to check taint validations before you add a taint. * Click **Edit taints**. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/kubernetes-resource-browser/edit-taints-db.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/infra-management/resource-browser+/nodes/edit-taints-db.jpg)
Figure 6b: Tainting a Node
* Enter the `key:value` pairs and select the taint effect from the drop-down list. [Click here](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/#concepts) to read about taint effects. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/kubernetes-resource-browser/taint-dialog-db.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/infra-management/resource-browser+/nodes/taint-dialog-db.jpg)
Figure 6c: Adding Taints
* Click **Save**. @@ -147,7 +147,7 @@ You can also add more taints using **+ Add taint button**, or delete the existin 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. -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/kubernetes-resource-browser/edit-config.gif) +![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/infra-management/resource-browser+/nodes/edit-config.gif)
Figure 7: Editing Node Config
* Go to the `YAML` tab and click **Edit YAML**. @@ -161,10 +161,10 @@ This allows you to directly edit any node. It will open the editor which contain You can also delete a node by clicking the **Delete** button present on the right-hand side. -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/kubernetes-resource-browser/delete-node-db.jpg) +![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/infra-management/resource-browser+/nodes/delete-node-db.jpg)
Figure 8a: Deleting a Node
-![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/kubernetes-resource-browser/delete-dialog-db.jpg) +![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/infra-management/resource-browser+/nodes/delete-dialog-db.jpg)
Figure 8b: Delete Confirmation
The node will be deleted from the cluster. diff --git a/docs/user-guide/resource-browser/overview.md b/docs/user-guide/resource-browser/overview.md index 137784f37..7139ff53e 100755 --- a/docs/user-guide/resource-browser/overview.md +++ b/docs/user-guide/resource-browser/overview.md @@ -1,6 +1,6 @@ # Overview -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/kubernetes-resource-browser/resource-browser-overview.jpg) +![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/infra-management/resource-browser+/overview/resource-browser-overview.jpg)
Figure 1: Resource Browser - Overview Page
## Resource Utilization @@ -52,7 +52,7 @@ Whenever you upgrade your Kubernetes version, the API versions change and your w 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. -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/kubernetes-resource-browser/check-compatibility.jpg) +![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/infra-management/resource-browser+/overview/check-compatibility.jpg)
Figure 2: Checking Compatibility
### Walkthrough diff --git a/docs/user-guide/resource-browser/pods.md b/docs/user-guide/resource-browser/pods.md index 8c50555e7..c28baa248 100755 --- a/docs/user-guide/resource-browser/pods.md +++ b/docs/user-guide/resource-browser/pods.md @@ -34,7 +34,7 @@ In case any of your pod restarts, you can view its details from the pod listing * Container log before restart * Node status and events -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/kubernetes-resource-browser/restart-pod-log.gif) +![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/infra-management/resource-browser+/pods/restart-pod-log.gif)
Figure 1: Checking Restart Pod Log
--- @@ -61,7 +61,7 @@ This is a part of [Pod Terminal](#terminal). It is especially useful when `kubec You get 2 tabs: 1. **Basic** - It provides the bare minimum configurations required to launch an ephemeral container. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/debugging-deployment-and-monitoring/basic.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/infra-management/resource-browser+/pods/basic.jpg)
Figure 2: Basic Tab
It contains 3 mandatory fields: diff --git a/docs/user-guide/resource-browser/resource-recommender.md b/docs/user-guide/resource-browser/resource-recommender.md index 0cd006fb9..26a362b25 100755 --- a/docs/user-guide/resource-browser/resource-recommender.md +++ b/docs/user-guide/resource-browser/resource-recommender.md @@ -26,26 +26,26 @@ To inspect the resource recommendations, follow the steps below: 1. Navigate to **Resource Browser**. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/kubernetes-resource-browser/resource-recommender/resourse-recommender-resourse-browser.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/infra-management/resource-browser+/resource-recommender/resourse-recommender-resourse-browser.jpg)
Figure 1: Navigating to Resource Browser
2. Select the specific cluster for which you want to inspect the resource recommendations. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/kubernetes-resource-browser/resource-recommender/resourse-recommender-select-cluster.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/infra-management/resource-browser+/resource-recommender/resourse-recommender-select-cluster.jpg)
Figure 2: Selecting Cluster
3. Select the **Resource Recommender** tab to inspect the recommendations. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/kubernetes-resource-browser/resource-recommender/resourse-recommender-click-rr-button.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/infra-management/resource-browser+/resource-recommender/resourse-recommender-click-rr-button.jpg)
Figure 3: Selecting Resource Recommender
1. Each row displays workloads in that cluster, along with recommendations for CPU and memory. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/kubernetes-resource-browser/resource-recommender/resourse-recommender-each-workload.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/infra-management/resource-browser+/resource-recommender/resourse-recommender-each-workload.jpg)
Figure 4: Displaying Workloads along with Recommendations
2. Recommendations are shown as percentage changes by default. You can use the **Show absolute values** checkbox to see current v/s recommended values in actual units (e.g., 128Mi → 4900Ki). - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/kubernetes-resource-browser/resource-recommender/resourse-recommender-absolute-values.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/infra-management/resource-browser+/resource-recommender/resourse-recommender-absolute-values.jpg)
Figure 5: Toggling 'Show Absolute Values'
:::info @@ -58,15 +58,15 @@ To inspect the resource recommendations, follow the steps below: 4. You can inspect the resource recommendations for each workload within the cluster. 1. If you wish, you can filter the workloads based on their `Kind` and `Namespace`. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/kubernetes-resource-browser/resource-recommender/resourse-recommender-kind.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/infra-management/resource-browser+/resource-recommender/resourse-recommender-kind.jpg)
Figure 6a: Filtering via 'Kind'
- ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/kubernetes-resource-browser/resource-recommender/resourse-recommender-namespace.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/infra-management/resource-browser+/resource-recommender/resourse-recommender-namespace.jpg)
Figure 6b: Filtering via 'Namespace'
2. You can also search for a specific workload via the search bar based on `WORKLOAD`, `NAMESPACE`, `KIND`, `API VERSION`, and `CONTAINER NAME`. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/kubernetes-resource-browser/resource-recommender/resourse-recommender-search.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/infra-management/resource-browser+/resource-recommender/resourse-recommender-search.jpg)
Figure 7: Filtering via Search Bar
5. For each workload, recommendations can be of the following types: @@ -91,16 +91,16 @@ To inspect the resource recommendations, follow the steps below: 6. Hover the cursor over the specific resource of the particular workload to view the recommendation. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/kubernetes-resource-browser/resource-recommender/resourse-recommender-red.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/infra-management/resource-browser+/resource-recommender/resourse-recommender-red.jpg)
Figure 8a: Recommending for Increasing Resources
- ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/kubernetes-resource-browser/resource-recommender/resourse-recommender-green.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/infra-management/resource-browser+/resource-recommender/resourse-recommender-green.jpg)
Figure 8b: Recommending for Decreasing Resources
- ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/kubernetes-resource-browser/resource-recommender/resourse-recommender-zero.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/infra-management/resource-browser+/resource-recommender/resourse-recommender-zero.jpg)
Figure 8c: Recommending to not take any action
- ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/kubernetes-resource-browser/resource-recommender/resourse-recommender-no-recommendation.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/infra-management/resource-browser+/resource-recommender/resourse-recommender-no-recommendation.jpg)
Figure 8d: No Recommendation
### Rescan for Recommendations @@ -113,7 +113,7 @@ If you want to rescan for recommendations, use this option to fetch the most rec 3. Rescanning will start, and recommendations will be updated in few minutes. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/kubernetes-resource-browser/resource-recommender/resource-recommender-rescan.gif) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/infra-management/resource-browser+/resource-recommender/resource-recommender-rescan.gif)
Figure 9: Rescanning for Recommendations
## Apply Recommendations @@ -129,17 +129,17 @@ To apply recommended resources to a specific workload, follow the steps below: 1. Hover over the specific workload row and click the **Apply** button that appears on hover. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/kubernetes-resource-browser/resource-recommender/resourse-recommender-apply.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/infra-management/resource-browser+/resource-recommender/resourse-recommender-apply.jpg)
Figure 10: Selecting Workload
2. A modal window will open, displaying the comparison between the current and recommended resource values for that specific workload; review the recommended changes carefully. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/kubernetes-resource-browser/resource-recommender/resourse-recommender-compare.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/infra-management/resource-browser+/resource-recommender/resourse-recommender-compare.jpg)
Figure 11: Comparing Configurations
3. Click **Apply Changes** to update the resource configuration. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/kubernetes-resource-browser/resource-recommender/resourse-recommender-apply-changes.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/infra-management/resource-browser+/resource-recommender/resourse-recommender-apply-changes.jpg)
Figure 12: Applying Changes
### Bulk Apply @@ -148,17 +148,17 @@ If you wish, you can apply recommended resource configurations to multiple or al 1. Select the workloads for which you want to apply recommended resource configurations and click **Apply Changes**. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/kubernetes-resource-browser/resource-recommender/resourse-recommender-apply-changes-bulk.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/infra-management/resource-browser+/resource-recommender/resourse-recommender-apply-changes-bulk.jpg)
Figure 13: Selecting Workloads
2. A modal window will open, displaying the comparison between the current and recommended resource values for each workload; review the recommended changes for each workload carefully. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/kubernetes-resource-browser/resource-recommender/resourse-recommender-compare-bulk.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/infra-management/resource-browser+/resource-recommender/resourse-recommender-compare-bulk.jpg)
Figure 14: Comparing Configurations for each workload
3. Click **Apply Changes** to update the resource configuration. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/kubernetes-resource-browser/resource-recommender/resourse-recommender-apply-in-bulk.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/infra-management/resource-browser+/resource-recommender/resourse-recommender-apply-in-bulk.jpg)
Figure 15: Applying Changes
## Export Recommendations in CSV File @@ -169,11 +169,8 @@ You can also export resource recommendations to a CSV file. To do so, follow the 2. Click the **Download** button; a dialog box will appear displaying that your export is ready. By default, the file will be downloaded automatically to your system. If you wish you can select **Click Here To Download Manually** to download the file manually. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/kubernetes-resource-browser/resource-recommender/resourse-recommender-download.jpg) -
Figure 16a: Clicking Download Button
- - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/kubernetes-resource-browser/resource-recommender/resourse-recommender-manual-download.jpg) -
Figure 16b: Export Ready
+ ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/infra-management/resource-browser+/resource-recommender/resourse-recommender-download.jpg) +
Figure 16: Clicking Download Button
## Modify Resource Recommender Job Schedule @@ -186,22 +183,27 @@ To modify the schedule of the **Resource Recommender** background job, follow th 2. If you installed Devtron via Helm, select `devtron-cm` and click **Edit Live Manifest**. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/kubernetes-resource-browser/resource-recommender/resourse-recommender-devtron-cm.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/infra-management/resource-browser+/resource-recommender/resourse-recommender-devtron-cm.jpg)
Figure 17a: Selecting Devtron CM
- ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/kubernetes-resource-browser/resource-recommender/resourse-recommender-edit-live-manifest.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/infra-management/resource-browser+/resource-recommender/resourse-recommender-edit-live-manifest.jpg)
Figure 17b: Clicking 'Edit Live Manifest'
3. Edit the `KRR_SYNC_JOB_CRON_SCHEDULE` key and set the schedule according to your use case using a cron expression. -4. Click **Apply Changes** and manifest will be updated. +4. Click **Review and Save Changes** and a split-view will open for comparing changes. + + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/infra-management/resource-browser+/resource-recommender/resourse-recommender-compare-changes.jpg) +
Figure 18: Comparing Changes
+ +5. Click **Apply Changes** and manifest will be updated. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/kubernetes-resource-browser/resource-recommender/resourse-recommender-apply-changes-manifest.jpg) -
Figure 18: Applying Changes
+ ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/infra-management/resource-browser+/resource-recommender/resourse-recommender-apply-changes-manifest.jpg) +
Figure 19: Applying Changes
-5. Restart the `orchestrator` or `devtron` pod to implement the changes. +6. Restart the `orchestrator` or `devtron` pod to implement the changes. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/kubernetes-resource-browser/resource-recommender/resourse-recommender-restart-pod.jpg) -
Figure 19: Restarting Pods
+ ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/infra-management/resource-browser+/resource-recommender/resourse-recommender-restart-pod.jpg) +
Figure 20: Restarting Pods
From e686a24c2f976bc37843c9385697bbbb31625e4a Mon Sep 17 00:00:00 2001 From: Hii-Arpit Date: Fri, 21 Nov 2025 03:02:22 +0530 Subject: [PATCH 09/10] docs: updated resource browser --- docs/user-guide/operations/edit-gui-schema.md | 8 ++++---- .../user-guide/operations/edit-lock-schema.md | 8 ++++---- .../resource-browser/cluster-terminal.md | 2 +- .../resource-browser/kubectl-local.md | 20 +++++++++---------- .../resource-browser/monitoring-graphs.md | 7 +++---- 5 files changed, 22 insertions(+), 23 deletions(-) diff --git a/docs/user-guide/operations/edit-gui-schema.md b/docs/user-guide/operations/edit-gui-schema.md index f0ae0a8a6..0853db0a3 100755 --- a/docs/user-guide/operations/edit-gui-schema.md +++ b/docs/user-guide/operations/edit-gui-schema.md @@ -17,22 +17,22 @@ Only a [Super-Admin](../global-configurations/authorization/user-access.md#grant 2. Use the searchbox labelled 'Jump to Kind' and search for `Guischema`. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/kubernetes-resource-browser/search-gui-schema.gif) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/infra-management/resource-browser+/configure-gui-schema/search-gui-schema.gif)
Figure 1: Searching GUI Schema
3. Click the GUI schema you wish to edit. In case no GUI schema exists, you may [create a GUI schema](#create-your-own-gui-schema) for your resource kind. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/kubernetes-resource-browser/click-schema.gif) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/infra-management/resource-browser+/configure-gui-schema/click-schema.gif)
Figure 2: Click GUI Schema
4. Click **Edit Live Manifest** to modify the YAML. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/kubernetes-resource-browser/edit-live-manifest.gif) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/infra-management/resource-browser+/configure-gui-schema/edit-live-manifest.gif)
Figure 3: Edit Live Manifest
5. Locate the `schema` object and customize it according to your requirements. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/kubernetes-resource-browser/locate-schema.gif) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/infra-management/resource-browser+/configure-gui-schema/locate-schema.gif)
Figure 4: Modifying Schema
6. Click **Apply Changes**. diff --git a/docs/user-guide/operations/edit-lock-schema.md b/docs/user-guide/operations/edit-lock-schema.md index 8fd524d2d..033d2b8db 100755 --- a/docs/user-guide/operations/edit-lock-schema.md +++ b/docs/user-guide/operations/edit-lock-schema.md @@ -17,22 +17,22 @@ Only a [Super-Admin](../global-configurations/authorization/user-access.md#grant 2. Use the searchbox labelled 'Jump to Kind' and search for `LockSchema`. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/kubernetes-resource-browser/search-lock-schema.gif) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/infra-management/resource-browser+/configure-lock-schema/search-lock-schema.gif)
Figure 1: Searching Lock Schema
3. Click the Lock Schema you wish to edit. In case no Lock Schema exists, you may [create a Lock Schema](#create-your-own-lock-schema) for your resource kind. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/kubernetes-resource-browser/click-lock-schema.gif) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/infra-management/resource-browser+/configure-lock-schema/click-lock-schema.gif)
Figure 2: Click Lock Schema
4. Click **Edit Live Manifest** to modify the YAML. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/kubernetes-resource-browser/edit-live-manifest-lock.gif) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/infra-management/resource-browser+/configure-lock-schema/edit-live-manifest-lock.gif)
Figure 3: Edit Live Manifest
5. Locate the `lockedPaths` list and specify the fields/paths you wish to lock from unwanted edits by non-superadmins in the manifest. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/kubernetes-resource-browser/locate-lockedpaths.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/infra-management/resource-browser+/configure-lock-schema/locate-lockedpaths.jpg)
Figure 4: Modifying Schema
6. Click **Apply Changes**. diff --git a/docs/user-guide/resource-browser/cluster-terminal.md b/docs/user-guide/resource-browser/cluster-terminal.md index 749a6e348..09e24679b 100755 --- a/docs/user-guide/resource-browser/cluster-terminal.md +++ b/docs/user-guide/resource-browser/cluster-terminal.md @@ -8,7 +8,7 @@ User with [super-admin](../global-configurations/authorization/user-access.md#gr To troubleshoot a cluster or a specific node in a cluster, click the terminal icon on the right side. -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/kubernetes-resource-browser/cluster-terminal.gif) +![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/infra-management/resource-browser+/cluster-terminal/cluster-terminal.gif)
Figure 1: Terminal Icon
* You will see the user-defined name for the cluster in Devtron. E.g. `default-cluster`. diff --git a/docs/user-guide/resource-browser/kubectl-local.md b/docs/user-guide/resource-browser/kubectl-local.md index 1a9d06c11..728d8c12e 100755 --- a/docs/user-guide/resource-browser/kubectl-local.md +++ b/docs/user-guide/resource-browser/kubectl-local.md @@ -4,8 +4,8 @@ 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. -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/kubernetes-resource-browser/kubeconfig.jpg) -
Figure 21: Kubeconfig File
+![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/infra-management/resource-browser+/kubectl-local/kubeconfig.jpg) +
Figure 1: Kubeconfig File
--- @@ -33,8 +33,8 @@ Devtron helps in reducing the challenges and simplifying the maintenance of kube If you are not a super-admin and can't generate a token yourself, you can find the session token (argocd.token) using the Developer Tools available in your web browser as shown below. -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/kubernetes-resource-browser/argocd-token-v1.gif) -
Figure 22: Using Session Token
+![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/infra-management/resource-browser+/kubectl-local/argocd-token.gif) +
Figure 2: Using Session Token
There are 2 methods of getting kubeconfig in your system: * [Quick Method](#quick-method) @@ -44,8 +44,8 @@ There are 2 methods of getting kubeconfig in your system: 1. In Resource Browser, hover on the cluster name and click the `Get kubeconfig` icon. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/kubernetes-resource-browser/getkubeconfig.gif) -
Figure 23: Get Kubeconfig
+ ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/infra-management/resource-browser+/kubectl-local/getkubeconfig.gif) +
Figure 3: Get Kubeconfig
2. Copy the commands and run them on your terminal. @@ -83,8 +83,8 @@ There are 2 methods of getting kubeconfig in your system: | `` | Name of the cluster (or cluster ID) | devtron-cluster | [Applications Page](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/kubernetes-resource-browser/applications-page.jpg) | | `` | API token or session token | \- | [Authorization Page](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/kubernetes-resource-browser/authorization-page.jpg) | - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/kubernetes-resource-browser/kubeconfig.gif) -
Figure 23: Editing Kubeconfig File
+ ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/infra-management/resource-browser+/kubectl-local/kubeconfig.gif) +
Figure 4: Editing Kubeconfig File
3. Test the connection to the cluster by running any kubectl command, e.g., `kubectl get ns` or `kubectl get po -A` @@ -100,5 +100,5 @@ Assume your applications are running in a Kubernetes cluster on cloud. Now, if y Once you have successfully connected to the cluster, you may run the port-forward command. Refer [kubectl port-forward](https://kubernetes.io/docs/reference/kubectl/generated/kubectl_port-forward/) to see a few examples. -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/kubernetes-resource-browser/port-forward.gif) -
Figure 24: Example - Port Forwarding
\ No newline at end of file +![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/infra-management/resource-browser+/kubectl-local/port-forward.gif) +
Figure 5: Example - Port Forwarding
\ No newline at end of file diff --git a/docs/user-guide/resource-browser/monitoring-graphs.md b/docs/user-guide/resource-browser/monitoring-graphs.md index d4857d78c..b603a2a5c 100755 --- a/docs/user-guide/resource-browser/monitoring-graphs.md +++ b/docs/user-guide/resource-browser/monitoring-graphs.md @@ -6,9 +6,8 @@ The Resource Browser allows you to integrate monitoring graphs and dashboards fr It works similarly to a 'Single Pane of Glass (SPOG)' that displays data coming from different sources in a single unified view. -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/kubernetes-resource-browser/monitoring-graphs.gif) +![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/infra-management/resource-browser+/monitoring-graphs/monitoring-graphs.gif)
Adding Monitoring Visualizations
- --- ## Tutorial @@ -23,12 +22,12 @@ It works similarly to a 'Single Pane of Glass (SPOG)' that displays data coming 2. Click the graph icon as shown below and click the **Add Panel** button. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/kubernetes-resource-browser/add-graph1.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/infra-management/resource-browser+/monitoring-graphs/add-graph.jpg)
Adding Monitoring
3. Give a name to the monitoring dashboard and add the `iframe` code supplied by your graph/dashboard tool. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/kubernetes-resource-browser/fields-filled.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/infra-management/resource-browser+/monitoring-graphs/add-panel.jpg)
Adding Monitoring
4. Click **Save**. From 3c88d12304e6ef2d8a6d16f2e0484f778ed404e2 Mon Sep 17 00:00:00 2001 From: Hii-Arpit Date: Fri, 21 Nov 2025 06:00:19 +0530 Subject: [PATCH 10/10] docs: chart store updated --- docs/user-guide/deploy-chart/README.md | 8 ++-- docs/user-guide/deploy-chart/chart-group.md | 38 ++++++++++++------- .../deploy-chart/deployment-of-charts.md | 34 ++++++++--------- 3 files changed, 46 insertions(+), 34 deletions(-) diff --git a/docs/user-guide/deploy-chart/README.md b/docs/user-guide/deploy-chart/README.md index 874ab7f32..891b2a5fd 100755 --- a/docs/user-guide/deploy-chart/README.md +++ b/docs/user-guide/deploy-chart/README.md @@ -6,7 +6,7 @@ A [Helm Chart](../../reference/glossary.md#helm-chartspackages) is like a bluepr Navigate to the **Chart Store**. -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/deploy-chart/chart-store-without-chartgroup.jpg) +![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/infra-management/chart-store/chart-store-without-chartgroup.jpg)
Figure 1: Chart Store
--- @@ -19,7 +19,7 @@ The **Chart Store** populates charts from two sources: * The OCI registry (only if **Use as chart repository** checkbox is enabled) added to the [Container/OCI Registry](../global-configurations/container-registries.md) section of the **Global Configurations** page. -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/deploy-chart/charts-chartsource.jpg) +![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/infra-management/chart-store/charts-chartsource.jpg)
Figure 2: Charts and Chart Sources
When you add a chart repository and/or an OCI registry, the sources along with the associated charts are automatically populated in the **Chart Store**. The chart sources are displayed in the **Chart Source** drop-down box, and the charts are displayed in the **All Charts** section. @@ -39,7 +39,7 @@ To add a chart repository or an OCI registry as a chart source, follow the instr 2. Click the **Add** button. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/deploy-chart/chart-sources.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/infra-management/chart-store/chart-sources.jpg)
Figure 3: Chart Sources
3. Click on **Add Chart Repository** . It will take you to the [Chart Repositories](../global-configurations/chart-repo.md#add-chart-repository) page in the **Global Configurations** page. @@ -54,7 +54,7 @@ To quickly search for a chart, perform any of the following actions: * Navigate to the search bar at the top-left corner of the screen. Enter the chart name you're looking for and press Enter. The chart will be displayed in the All Charts section. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/deploy-chart/search-charts.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/infra-management/chart-store/search-charts.jpg)
Figure 4: Search Charts
* Select your preferred chart source(s) using the checkboxes in the **Chart Source** drop-down box. The charts associated with that chart source will be displayed in the All Charts section. diff --git a/docs/user-guide/deploy-chart/chart-group.md b/docs/user-guide/deploy-chart/chart-group.md index 9973ac97f..2b3fb13c1 100755 --- a/docs/user-guide/deploy-chart/chart-group.md +++ b/docs/user-guide/deploy-chart/chart-group.md @@ -29,8 +29,11 @@ To create a chart group, follow the instructions below: 2. Click the **Create Group** button. The **Create Chart Group** page is displayed. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/deploy-chart/create-chart-group.jpg) -
Figure 1: Create Chart Group
+ ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/infra-management/chart-store/chart-group/create-chart-groups.jpg) +
Figure 1a: Create Chart Group
+ + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/infra-management/chart-store/chart-group/create-chart-groups-1.jpg) +
Figure 1b: Create Chart Group
3. Enter your preferred chart group name in the **Name** field. @@ -40,20 +43,23 @@ To create a chart group, follow the instructions below: 6. Select your preferred charts from the list of charts available in the **Edit group** page. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/deploy-chart/edit-group.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/infra-management/chart-store/chart-group/select-charts.jpg)
Figure 2: Edit Group
7. Click **Save**. The chart group is now saved. 8. Navigate back to the chart group page. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/deploy-chart/deploy-to.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/infra-management/chart-store/chart-group/deploy-to.jpg)
Figure 3: Chart Group
9. Click on the **Deploy to...** button. The **Deploy Selected Charts** screen is displayed. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/deploy-chart/deploy-selected-charts.jpg) -
Figure 4: Deploy Selected Charts
+ ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/infra-management/chart-store/chart-group/deploy-selected-charts.jpg) +
Figure 4a: Deploy Selected Charts
+ + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/infra-management/chart-store/chart-group/deploy-selected-charts-1.jpg) +
Figure 4b: Deploy Selected Charts
10. Select the project in the **Project** drop-down box. @@ -63,7 +69,7 @@ To create a chart group, follow the instructions below: If you prefer to change the chart values in the `.yaml` file or change chart configurations, click **Advanced Options**. Refer to [Advanced Options](#advanced-options) for more information. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/deploy-chart/deployment-initiated.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/infra-management/chart-store/chart-group/deployment-initiated.jpg)
Figure 5: Deployment Initiated
--- @@ -81,17 +87,23 @@ If you want to add/remove a chart to your existing chart group, or change the ch 1. Select your preferred chart group in the **Chart Store**. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/deploy-chart/deploy-to.jpg) -
Figure 6: Edit a Chart Group
+ ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/infra-management/chart-store/chart-group/select-chart-group-edit.jpg) +
Figure 6: Select a Chart Group
2. Click the **Edit** button. The **Edit group** page is displayed. + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/infra-management/chart-store/chart-group/chart-group-edit.jpg) +
Figure 7: Edit a Chart Group
+ 3. Add or remove charts based on your needs from the list of charts available in the **Edit group** page. 4. Enter your new chart group name (if required) in the **Group name** field. 5. Click **Save** to save the changes. + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/infra-management/chart-store/chart-group/chart-group-save-edit.jpg) +
Figure 8: Save a Chart Group
+ --- ## Delete a Chart Group @@ -105,8 +117,8 @@ When you delete a chart group, only the chart group is deleted. Application depl 1. Select your preferred chart group in the **Chart Store**. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/deploy-chart/delete-chart-group.gif) -
Figure 7: Delete a Chart Group
+ ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/infra-management/chart-store/chart-group/delete-chart-group.gif) +
Figure 9: Delete a Chart Group
2. Click the **Delete** button. A pop-up window will appear, asking for confirmation to delete the chart group. @@ -118,8 +130,8 @@ When you delete a chart group, only the chart group is deleted. Application depl The **Advanced Options** page enables you to change the chart values, chart configurations, use preset values (if already configured) for your charts. -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/deploy-chart/advanced-options.jpg) -
Figure 8: Advanced Options
+![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/infra-management/chart-store/chart-group/advanced-options.jpg) +
Figure 10: Advanced Options
1. Enter your preferred application name in the **App name** field. diff --git a/docs/user-guide/deploy-chart/deployment-of-charts.md b/docs/user-guide/deploy-chart/deployment-of-charts.md index 634842447..e83aaecb8 100755 --- a/docs/user-guide/deploy-chart/deployment-of-charts.md +++ b/docs/user-guide/deploy-chart/deployment-of-charts.md @@ -21,7 +21,7 @@ To configure and deploy Helm, follow the instructions below: 3. Select your preferred chart. The chart page is displayed. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/deploy-chart/configure-deploy.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/infra-management/chart-store/deploy-chart/select-chart.jpg)
Figure 1: Discover a Chart
| Section | Description | @@ -30,12 +30,12 @@ To configure and deploy Helm, follow the instructions below: | **README.md** | Contains the instructions, configurations, and everything related to the configuration and deployment of the chart | | **Deployments** | Displays the list of projects under which the chart is deployed | -4. Click **Configure & Deploy**. Configuring a Helm chart gives you the flexibility to customize it to your needs instead of relying on the default values of the chart. +4. Click **Deploy Chart**. Configuring a Helm chart gives you the flexibility to customize it to your needs instead of relying on the default values of the chart. To predefine configurations and make future deployments across environments easier, refer to [Preset Values](#preset-values). - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/deploy-chart/deploy-chart.jpg) -
Figure 2: Configure & Deploy
+ ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/infra-management/chart-store/deploy-chart/deploy-chart.jpg) +
Figure 2: Deploy Chart
5. Enter your application name in the **App Name** field. @@ -43,7 +43,7 @@ To configure and deploy Helm, follow the instructions below: 7. Select the environment where you want to deploy the chart in the **Deploy to Environment** drop-down box. When you select an environment, the **How do you want to deploy?** section is displayed. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/deploy-chart/deployment-methods.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/infra-management/chart-store/deploy-chart/deployment-methods.jpg)
Figure 3: Deployment Methods
**How do you want to deploy?** @@ -67,7 +67,7 @@ The deployment method cannot be changed once the chart is deployed. Once you have deployed a chart, you will be redirected automatically to the **App Details** tab where the deployment status is shown. -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/deploy-chart/app-installation-success.jpg) +![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/infra-management/chart-store/deploy-chart/chart-deploy-success.jpg)
Figure 4: Check Deployment Status
The Application Status should be `Healthy`, indicating that the application has been successfully deployed. @@ -82,7 +82,7 @@ To check the latest charts and chart versions, follow the instructions below: 1. Navigate to the **Configure** tab of your helm application. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/deploy-chart/deployment-of-charts/update-chart.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/infra-management/chart-store/deploy-chart/refetch-charts.jpg)
Figure 5: Update Charts
2. Click **Refetch Charts**. All the latest charts are displayed in the **Helm Chart** drop-down box and all the latest versions of a chart will be displayed in the **Chart Version** drop-down box. @@ -106,7 +106,7 @@ Follow the below instructions to update a Helm chart: You can also compare the existing configured values of the previous chart version with the default values of the newer chart version by clicking the **Compare Values** button in the top-right corner of the page. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/deploy-chart/compare-values.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/infra-management/chart-store/deploy-chart/compare-values.jpg)
Figure 6: Compare Values
3. Click **Update And Deploy**. @@ -128,7 +128,7 @@ Follow the below instructions to upgrade a Helm chart: 2. Select your preferred chart from the **Helm Chart** drop-down box. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/deploy-chart/upgrade-chart.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/infra-management/chart-store/deploy-chart/update-chart.jpg)
Figure 7: Upgrade Chart
:::info Note @@ -159,7 +159,7 @@ Disabling a Helm chart source (e.g., Bitnami) does not display all associated ch 2. Disable the toggle next to your preferred chart source (e.g., Bitnami). - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/deploy-chart/disable-charts.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/infra-management/chart-store/deploy-chart/disable-charts.jpg)
Figure 8: Disable chart repository
The chart source (e.g., Bitnami) will no longer be displayed in the **Chart Source** drop-down box, and all its associated charts will no longer be displayed in the **All Charts** section of the **Chart Store** page. @@ -202,12 +202,12 @@ To predefine the configurations for a chart, follow the instructions below: 1. Click the **Preset Values** button. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/deploy-chart/configure-deploy.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/infra-management/chart-store/deploy-chart/preset-value-tab.jpg)
Figure 9: Preset Values
2. Enter your preferred preset value name in the **Name** field. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/deploy-chart/preset-values.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/infra-management/chart-store/deploy-chart/preset-values.jpg)
Figure 10: Editing Preset Values
3. Select the chart version for which you'd like to create a preset value from the **Chart Version** drop-down box. @@ -228,7 +228,7 @@ A preset value for the selected chart version is now created and will be display 1. Navigate to **Chart Store**. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/deploy-chart/discover-chart.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/infra-management/chart-store/deploy-chart/discover-chart.jpg)
Figure 11: Chart Store
2. Enter `mySQL` in the search bar at the top-left corner of the **Chart Store** page. @@ -241,12 +241,12 @@ Once you have clicked on the `bitnami/mySQL`, follow the set of instructions bel 1. Read the **README.md** file to know more about the chart configurations. - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/deploy-chart/configure-deploy.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/infra-management/chart-store/deploy-chart/readme.jpg)
Figure 12: Configure and Deploy Chart
2. Refer to the tables below and fill in the details: - ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/deploy-chart/configure-values.jpg) + ![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/infra-management/chart-store/deploy-chart/configure-values.jpg)
Figure 13: Configure Values
| Key | Description | @@ -270,7 +270,7 @@ Once you have clicked on the `bitnami/mySQL`, follow the set of instructions bel When you deploy the chart, you will be redirected to the **App Details** tab of the Helm application. -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/deploy-chart/application-status.jpg) +![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/infra-management/chart-store/deploy-chart/application-status.jpg)
Figure 14: Deployment Status
The **Application Status** should be `Healthy`, indicating that the application has been successfully deployed. @@ -279,5 +279,5 @@ The **Application Status** should be `Healthy`, indicating that the application Service names makes it easier to find, connect to, and interact with your application. To extract the service name, navigate to **K8s Resources** → **Networking** → **Service**. The service name(s) are displayed in the **Name** column along with the URL in the **URL** column. -![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/deploy-chart/service-name.gif) +![](https://devtron-public-asset.s3.us-east-2.amazonaws.com/images/devtron-v2/infra-management/chart-store/deploy-chart/service-name.gif)
Figure 15: Service Name
\ No newline at end of file