From a689e3e7757ef27ab9f135c5da1695343cad3b80 Mon Sep 17 00:00:00 2001 From: bhushannemade Date: Tue, 27 Aug 2024 14:03:32 +0530 Subject: [PATCH 1/8] devtron-cd-trigger plugin doc --- docs/SUMMARY.md | 1 + docs/user-guide/plugins/devtron-cd-trigger.md | 61 +++++++++++++++++++ 2 files changed, 62 insertions(+) create mode 100644 docs/user-guide/plugins/devtron-cd-trigger.md diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index 7412526613..787afd4ec7 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -138,6 +138,7 @@ * [Dependency track - Maven & Gradle](user-guide/plugins/dependency-track-maven-gradle.md) * [Dependency track - NodeJS](user-guide/plugins/dependency-track-nodejs.md) * [Dependency track - Python](user-guide/plugins/dependency-track-python.md) + * [Devtron CD Trigger](user-guide/plugins/devtron-cd-trigger.md) * [GoLang-migrate](user-guide/plugins/golang-migrate.md) * [Jenkins](user-guide/plugins/jenkins.md) * [K6 Load Testing](user-guide/plugins/k6-load-testing.md) diff --git a/docs/user-guide/plugins/devtron-cd-trigger.md b/docs/user-guide/plugins/devtron-cd-trigger.md new file mode 100644 index 0000000000..6a22deea24 --- /dev/null +++ b/docs/user-guide/plugins/devtron-cd-trigger.md @@ -0,0 +1,61 @@ +# Devtron CD Trigger + +## Introduction +The **Devtron CD Trigger** plugin allows you to trigger the PRE, DEPLOY, or POST CD stages of Devtron Apps from within your current application workflow. This plugin offers flexibility in managing application application dependencies and deployment sequences. For example, by incorporating this plugin at the pre-deployment stage of your application workflow, you can deploy applications that contain dependencies required by your current application, ensuring a smooth and coordinated deployment process. + +### Prerequisites +Before integrating the Devtron CD Trigger plugin, you need to properly configure the target Devtron App to ensure smooth execution. + +--- + +## Steps +1. Go to **Applications** → **Devtron Apps**. +2. Click your application. +3. Go to **App Configuration** → **Workflow Editor**. +4. Click **New Workflow** and navigate to the **Build and Deploy from Source Code**. +5. Fill the required fields in the **Create build pipeline** window and navigate to the **Create deployment pipeline**. +6. Fill the required fields in the **Deployment Stage** window and navigate to the **Post-Deployment stage**. + +{% hint style="warning" %} +If you have already configured workflow, edit the deployment pipeline, and navigate to **Post-Deployment stage**. +{% endhint %} + +6. Under 'TASKS', click the **+ Add task** button. +7. Select the **Devtron CD Trigger** plugin. +8. Enter the following [user inputs](#user-inputs) with appropriate values. +--- + +## User Inputs + +### Task Name +Enter the name of your task + +e.g., `Triggers CD Pipeline` + +### Description +Add a brief explanation of the task and the reason for choosing the plugin. Include information for someone else to understand the purpose of the task. + +e.g., `The Devtron CD Trigger plugin is integrated for triggering the CD stage of another application.` + +### Input Variables + +| Variable | Format | Description | Sample Value | +| ------------------------ | ------------ | ----------- | ------------ | +| DevtronApiToken | STRING | Enter Devtron API token. | abc123xyz456token789 | +| DevtronEndpoint | STRING | Enter the URL of Devtron. | https://devtron.example.com | +| DevtronApp | STRING | Enter the Devtron Application name/Id | plugin-demo | +| DevtronEnv | STRING | Enter the Environment name/Id. Required if JobPipeline is not given | preview | +| StatusTimeoutSeconds | STRING | Enter the maximum time(in seconds) a user can wait for the application to deploy. Enter a positive integer value | 120 | +| GitCommitHash | STRING | Enter the git hash from which user wants to deploy its application. By default it takes latest Artifact ID to deploy the application | cf19e4fd348589kjhsdjn092nfse01d2234235sdsg | +| TargetTriggerStage | STRING | Enter the Trigger Stage PRE/DEPLOY/POST, Default Deploy | PRE | + +### Trigger/Skip Condition +Here you can set conditions to execute or skip the task. You can select `Set trigger conditions` for the execution of a task or `Set skip conditions` to skip the task. + +### Output Variables +Devtron CD Trigger will not be generating an output variable. + +Click **Update Pipeline**. + + + From 973ed71c278b8d51b4d9583029a76cab7af50368 Mon Sep 17 00:00:00 2001 From: bhushannemade Date: Tue, 27 Aug 2024 14:16:10 +0530 Subject: [PATCH 2/8] minor update --- docs/user-guide/plugins/devtron-cd-trigger.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/user-guide/plugins/devtron-cd-trigger.md b/docs/user-guide/plugins/devtron-cd-trigger.md index 6a22deea24..7b41d72399 100644 --- a/docs/user-guide/plugins/devtron-cd-trigger.md +++ b/docs/user-guide/plugins/devtron-cd-trigger.md @@ -1,4 +1,4 @@ -# Devtron CD Trigger +# Devtron-CD-Trigger ## Introduction The **Devtron CD Trigger** plugin allows you to trigger the PRE, DEPLOY, or POST CD stages of Devtron Apps from within your current application workflow. This plugin offers flexibility in managing application application dependencies and deployment sequences. For example, by incorporating this plugin at the pre-deployment stage of your application workflow, you can deploy applications that contain dependencies required by your current application, ensuring a smooth and coordinated deployment process. From c0e306d105f072bd7b3cfc6f0770847d6288be02 Mon Sep 17 00:00:00 2001 From: ashokdevtron <141001279+ashokdevtron@users.noreply.github.com> Date: Tue, 27 Aug 2024 15:39:35 +0530 Subject: [PATCH 3/8] Proofreading done --- docs/user-guide/plugins/devtron-cd-trigger.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/user-guide/plugins/devtron-cd-trigger.md b/docs/user-guide/plugins/devtron-cd-trigger.md index 7b41d72399..f13a830403 100644 --- a/docs/user-guide/plugins/devtron-cd-trigger.md +++ b/docs/user-guide/plugins/devtron-cd-trigger.md @@ -1,7 +1,7 @@ # Devtron-CD-Trigger ## Introduction -The **Devtron CD Trigger** plugin allows you to trigger the PRE, DEPLOY, or POST CD stages of Devtron Apps from within your current application workflow. This plugin offers flexibility in managing application application dependencies and deployment sequences. For example, by incorporating this plugin at the pre-deployment stage of your application workflow, you can deploy applications that contain dependencies required by your current application, ensuring a smooth and coordinated deployment process. +The **Devtron CD Trigger** plugin allows you to trigger the PRE-CD, CD, or POST-CD stages of other Devtron Apps from within your current application workflow. This plugin offers flexibility in managing application, application dependencies, and deployment sequences. For example, by incorporating this plugin at the pre-deployment stage of your application workflow, you can deploy another application that contains dependencies required by your current application, ensuring a coordinated deployment process. ### Prerequisites Before integrating the Devtron CD Trigger plugin, you need to properly configure the target Devtron App to ensure smooth execution. @@ -41,13 +41,13 @@ e.g., `The Devtron CD Trigger plugin is integrated for triggering the CD stage o | Variable | Format | Description | Sample Value | | ------------------------ | ------------ | ----------- | ------------ | -| DevtronApiToken | STRING | Enter Devtron API token. | abc123xyz456token789 | -| DevtronEndpoint | STRING | Enter the URL of Devtron. | https://devtron.example.com | -| DevtronApp | STRING | Enter the Devtron Application name/Id | plugin-demo | -| DevtronEnv | STRING | Enter the Environment name/Id. Required if JobPipeline is not given | preview | +| DevtronApiToken | STRING | Enter target Devtron API token. | abc123xyz456token789 | +| DevtronEndpoint | STRING | Enter the target URL of Devtron. | https://devtron.example.com | +| DevtronApp | STRING | Enter the target Devtron Application name/ID | plugin-demo | +| DevtronEnv | STRING | Enter the target Environment name/ID. Required if JobPipeline is not given | preview | | StatusTimeoutSeconds | STRING | Enter the maximum time(in seconds) a user can wait for the application to deploy. Enter a positive integer value | 120 | | GitCommitHash | STRING | Enter the git hash from which user wants to deploy its application. By default it takes latest Artifact ID to deploy the application | cf19e4fd348589kjhsdjn092nfse01d2234235sdsg | -| TargetTriggerStage | STRING | Enter the Trigger Stage PRE/DEPLOY/POST, Default Deploy | PRE | +| TargetTriggerStage | STRING | Enter the Trigger Stage PRE/DEPLOY/POST. Default value is `Deploy`. | PRE | ### Trigger/Skip Condition Here you can set conditions to execute or skip the task. You can select `Set trigger conditions` for the execution of a task or `Set skip conditions` to skip the task. From 534c7f81f9591e673a13ca28add228fca12fa440 Mon Sep 17 00:00:00 2001 From: ashokdevtron <141001279+ashokdevtron@users.noreply.github.com> Date: Tue, 27 Aug 2024 15:41:07 +0530 Subject: [PATCH 4/8] Update devtron-cd-trigger.md --- docs/user-guide/plugins/devtron-cd-trigger.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/user-guide/plugins/devtron-cd-trigger.md b/docs/user-guide/plugins/devtron-cd-trigger.md index f13a830403..b12ee8a729 100644 --- a/docs/user-guide/plugins/devtron-cd-trigger.md +++ b/docs/user-guide/plugins/devtron-cd-trigger.md @@ -45,7 +45,7 @@ e.g., `The Devtron CD Trigger plugin is integrated for triggering the CD stage o | DevtronEndpoint | STRING | Enter the target URL of Devtron. | https://devtron.example.com | | DevtronApp | STRING | Enter the target Devtron Application name/ID | plugin-demo | | DevtronEnv | STRING | Enter the target Environment name/ID. Required if JobPipeline is not given | preview | -| StatusTimeoutSeconds | STRING | Enter the maximum time(in seconds) a user can wait for the application to deploy. Enter a positive integer value | 120 | +| StatusTimeoutSeconds | STRING | Enter the maximum time (in seconds) a user can wait for the application to deploy. Enter a positive integer value | 120 | | GitCommitHash | STRING | Enter the git hash from which user wants to deploy its application. By default it takes latest Artifact ID to deploy the application | cf19e4fd348589kjhsdjn092nfse01d2234235sdsg | | TargetTriggerStage | STRING | Enter the Trigger Stage PRE/DEPLOY/POST. Default value is `Deploy`. | PRE | From e46fdc1b403bbdfb2d2086a27722c20e952a7a1f Mon Sep 17 00:00:00 2001 From: ashokdevtron <141001279+ashokdevtron@users.noreply.github.com> Date: Tue, 27 Aug 2024 15:48:18 +0530 Subject: [PATCH 5/8] Removed unwanted phrase --- docs/user-guide/plugins/devtron-cd-trigger.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/user-guide/plugins/devtron-cd-trigger.md b/docs/user-guide/plugins/devtron-cd-trigger.md index b12ee8a729..06c0899695 100644 --- a/docs/user-guide/plugins/devtron-cd-trigger.md +++ b/docs/user-guide/plugins/devtron-cd-trigger.md @@ -1,7 +1,7 @@ # Devtron-CD-Trigger ## Introduction -The **Devtron CD Trigger** plugin allows you to trigger the PRE-CD, CD, or POST-CD stages of other Devtron Apps from within your current application workflow. This plugin offers flexibility in managing application, application dependencies, and deployment sequences. For example, by incorporating this plugin at the pre-deployment stage of your application workflow, you can deploy another application that contains dependencies required by your current application, ensuring a coordinated deployment process. +The **Devtron CD Trigger** plugin allows you to trigger the PRE-CD, CD, or POST-CD stages of other Devtron Apps from within your current application workflow. This plugin offers flexibility in managing application dependencies and deployment sequences. For example, by incorporating this plugin at the pre-deployment stage of your application workflow, you can deploy another application that contains dependencies required by your current application, ensuring a coordinated deployment process. ### Prerequisites Before integrating the Devtron CD Trigger plugin, you need to properly configure the target Devtron App to ensure smooth execution. From 864882c3a5c3360dae3a4fe294b1a395d3c77f38 Mon Sep 17 00:00:00 2001 From: ashokdevtron <141001279+ashokdevtron@users.noreply.github.com> Date: Tue, 27 Aug 2024 16:52:01 +0530 Subject: [PATCH 6/8] Changed wording --- docs/user-guide/plugins/devtron-cd-trigger.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/user-guide/plugins/devtron-cd-trigger.md b/docs/user-guide/plugins/devtron-cd-trigger.md index 06c0899695..0936683e94 100644 --- a/docs/user-guide/plugins/devtron-cd-trigger.md +++ b/docs/user-guide/plugins/devtron-cd-trigger.md @@ -1,7 +1,7 @@ # Devtron-CD-Trigger ## Introduction -The **Devtron CD Trigger** plugin allows you to trigger the PRE-CD, CD, or POST-CD stages of other Devtron Apps from within your current application workflow. This plugin offers flexibility in managing application dependencies and deployment sequences. For example, by incorporating this plugin at the pre-deployment stage of your application workflow, you can deploy another application that contains dependencies required by your current application, ensuring a coordinated deployment process. +The **Devtron CD Trigger** plugin allows you to trigger the PRE-CD, CD, or POST-CD stages of target Devtron Apps from within your current application workflow. This plugin offers flexibility in managing application dependencies and deployment sequences. For example, by incorporating this plugin at the pre-deployment stage of your application workflow, you can deploy another application that contains dependencies required by your current application, ensuring a coordinated deployment process. ### Prerequisites Before integrating the Devtron CD Trigger plugin, you need to properly configure the target Devtron App to ensure smooth execution. From 7b1f24726a375070dde71a140e78bc8e211c73eb Mon Sep 17 00:00:00 2001 From: ashokdevtron <141001279+ashokdevtron@users.noreply.github.com> Date: Tue, 27 Aug 2024 16:52:33 +0530 Subject: [PATCH 7/8] Changed plurality --- docs/user-guide/plugins/devtron-cd-trigger.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/user-guide/plugins/devtron-cd-trigger.md b/docs/user-guide/plugins/devtron-cd-trigger.md index 0936683e94..80bf68c980 100644 --- a/docs/user-guide/plugins/devtron-cd-trigger.md +++ b/docs/user-guide/plugins/devtron-cd-trigger.md @@ -1,7 +1,7 @@ # Devtron-CD-Trigger ## Introduction -The **Devtron CD Trigger** plugin allows you to trigger the PRE-CD, CD, or POST-CD stages of target Devtron Apps from within your current application workflow. This plugin offers flexibility in managing application dependencies and deployment sequences. For example, by incorporating this plugin at the pre-deployment stage of your application workflow, you can deploy another application that contains dependencies required by your current application, ensuring a coordinated deployment process. +The **Devtron CD Trigger** plugin allows you to trigger the PRE-CD, CD, or POST-CD stages of target Devtron App from within your current application workflow. This plugin offers flexibility in managing application dependencies and deployment sequences. For example, by incorporating this plugin at the pre-deployment stage of your application workflow, you can deploy another application that contains dependencies required by your current application, ensuring a coordinated deployment process. ### Prerequisites Before integrating the Devtron CD Trigger plugin, you need to properly configure the target Devtron App to ensure smooth execution. From 5f972b50ee5339f812b9c6c6790b2acc1ecd4bfa Mon Sep 17 00:00:00 2001 From: Bhushan Nemade Date: Fri, 30 Aug 2024 10:03:39 +0530 Subject: [PATCH 8/8] Updated devtron token --- docs/user-guide/plugins/devtron-cd-trigger.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/user-guide/plugins/devtron-cd-trigger.md b/docs/user-guide/plugins/devtron-cd-trigger.md index 80bf68c980..8f7cbfcd7d 100644 --- a/docs/user-guide/plugins/devtron-cd-trigger.md +++ b/docs/user-guide/plugins/devtron-cd-trigger.md @@ -41,7 +41,7 @@ e.g., `The Devtron CD Trigger plugin is integrated for triggering the CD stage o | Variable | Format | Description | Sample Value | | ------------------------ | ------------ | ----------- | ------------ | -| DevtronApiToken | STRING | Enter target Devtron API token. | abc123xyz456token789 | +| DevtronApiToken | STRING | Enter target Devtron API token. | abc123DEFxyz456token789 | | DevtronEndpoint | STRING | Enter the target URL of Devtron. | https://devtron.example.com | | DevtronApp | STRING | Enter the target Devtron Application name/ID | plugin-demo | | DevtronEnv | STRING | Enter the target Environment name/ID. Required if JobPipeline is not given | preview |