From 2737813794b3bee741a1edf338afd11e81615a90 Mon Sep 17 00:00:00 2001 From: bhushannemade Date: Wed, 3 Jul 2024 11:47:57 +0530 Subject: [PATCH 1/9] doc: jenkins-plugin --- docs/user-guide/plugins/jenkins.md | 51 ++++++++++++++++++++++++++++++ 1 file changed, 51 insertions(+) create mode 100644 docs/user-guide/plugins/jenkins.md diff --git a/docs/user-guide/plugins/jenkins.md b/docs/user-guide/plugins/jenkins.md new file mode 100644 index 0000000000..3271aeefa4 --- /dev/null +++ b/docs/user-guide/plugins/jenkins.md @@ -0,0 +1,51 @@ +# Jenkins + +## Introduction +The Jenkins Plugin for Devtron offers seamless integration of Jenkins jobs into Devtron's CI/CD pipeline workflow. This plugin allows users to trigger external Jenkins jobs directly from the Devtron dashboard, streamlining workflow management. By incorporating this plugin, teams can centralize their CI/CD operations. + +### Prerequisites +Before integrating the Jenkins plugin, ensure that you have properly configured your Jenkins jobs. + +--- + +## Steps +1. Go to Applications → Devtron Apps (tab). +2. Click on your app. +3. Go to App Configuration (tab) → Workflow Editor. +4. Click on your CI pipeline and navigate to the Pre-Deployment stage or Post-Deployment stage depending on where you want to integrate the K6 load testing. +5. Under 'TASKS', click the Add task button. +6. Click the Codacy plugin. +--- + +## User Inputs + +### Task Name +Enter the name of your task. + +`e.g. Jenkins_Job` + +### 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. Trigger the build Job of Jenkins` + +### Input Variables + +| Variable | Format | Description | Sample Value | +| ------------------------ | ------------ | ----------- | ------------ | +| URL | STRING | The base URL of the Jenkins server. | https://jenkins.example.com | +| USERNAME | STRING | The username for authenticating with the Jenkins server,with appropriate permissions | admin_user | +| PASSWORD | STRING | The password for the Jenkins user. | securePass123! | +| JOB_NAME | STRING | The name of the Jenkins job to be triggered. | CI-build-job | +| JOB_TRIGGER_PARAMS | STRING | Parameters passed when triggering a job. | branch=main&environment=production | +| JENKINS_PLUGIN_TIMEOUT | INTEGER | The maximum time (in seconds) to wait for a Jenkins plugin operation to complete before timing out. | 300 | + +### 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 +Jenkins will not be generating an output variable. + +Click **Update Pipeline**. + + From 046852d6ac9150edb4b6e2a36ee3232f5117d0a8 Mon Sep 17 00:00:00 2001 From: bhushannemade Date: Thu, 25 Jul 2024 15:42:14 +0530 Subject: [PATCH 2/9] doc: created doc for copacetic plugin --- docs/SUMMARY.md | 1 + docs/user-guide/plugins/copacetic.md | 56 ++++++++++++++++++++++++++++ docs/user-guide/plugins/jenkins.md | 51 ------------------------- 3 files changed, 57 insertions(+), 51 deletions(-) create mode 100644 docs/user-guide/plugins/copacetic.md delete mode 100644 docs/user-guide/plugins/jenkins.md diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index 7e21b9c8bc..c022b5bf29 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -131,6 +131,7 @@ * [Create Your Plugin](user-guide/plugins/create-plugin.md) * [Our Plugins](user-guide/plugins/plugin-list.md) * [Codacy](user-guide/plugins/codacy.md) + * [Copacetic](user-guide/plugins/copacetic.md) * [Copy Container Image](user-guide/plugins/copy-container-image.md) * [Dependency track - Maven & Gradle](user-guide/plugins/dependency-track-maven-gradle.md) * [Dependency track - NodeJS](user-guide/plugins/dependency-track-nodejs.md) diff --git a/docs/user-guide/plugins/copacetic.md b/docs/user-guide/plugins/copacetic.md new file mode 100644 index 0000000000..ee22d853ef --- /dev/null +++ b/docs/user-guide/plugins/copacetic.md @@ -0,0 +1,56 @@ +# Copacetic + +## Introduction +The Copacetic plugin of Devtron helps you patch your container image vulnerabilities traced by the security scan Devtron performed on your container image. By integrating the **Copacetic** plugin into your workflow, and enabling the **Scan for vulnerabilities** at your **Build stage** you can: +- Trace the vulnerabilities of your container images and the **Copacetic** plugin will automatically patch the contaier image vulnerabilities for you. + +### Prerequisites +No prerequisites are required for integrating **Copacetic** plugin. + +--- + +## Steps +1. Go to Applications → **Devtron Apps**. +2. Click on your **application**. +3. Go to **App Configuration** → **Workflow Editor**. +4. Click on **New Workflow** and navigate to the **Build and Deploy from Source Code**. +5. Enter the following fields on the **Create build pipeline** window and navigate to **Post-build stage**. + +{% hint style="warning" %} +if you have already configured workflow, on your **Workflow Editor** click **Build** → **Edit build pipeline** and navigate to the **Post-build stage**. +{% endhint %} + +6. Click on **Task to be executed** under 'TASKS', click the **Add task** button. +7. Click the **Copacetic** plugin. +8. Enter the following fields with appropriate values. + +--- + +## User Inputs + +### Task Name +Enter the name of your task. + +`e.g. Patch container image vulnerability` + +### 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 Copacetic plugin is configured to patch the vulnerabilities in container image` + +### Input Variables + +| Variable | Format | Description | Sample Value | +| ------------------------ | ------------ | ----------- | ------------ | +| CopaTimeout | STRING | Provide timeout for copa patch command, default time is 5 minutes | 10m | + + +### 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 +Copacetic will not be generating an output variable. + +Click **Update Pipeline**. + + diff --git a/docs/user-guide/plugins/jenkins.md b/docs/user-guide/plugins/jenkins.md deleted file mode 100644 index 3271aeefa4..0000000000 --- a/docs/user-guide/plugins/jenkins.md +++ /dev/null @@ -1,51 +0,0 @@ -# Jenkins - -## Introduction -The Jenkins Plugin for Devtron offers seamless integration of Jenkins jobs into Devtron's CI/CD pipeline workflow. This plugin allows users to trigger external Jenkins jobs directly from the Devtron dashboard, streamlining workflow management. By incorporating this plugin, teams can centralize their CI/CD operations. - -### Prerequisites -Before integrating the Jenkins plugin, ensure that you have properly configured your Jenkins jobs. - ---- - -## Steps -1. Go to Applications → Devtron Apps (tab). -2. Click on your app. -3. Go to App Configuration (tab) → Workflow Editor. -4. Click on your CI pipeline and navigate to the Pre-Deployment stage or Post-Deployment stage depending on where you want to integrate the K6 load testing. -5. Under 'TASKS', click the Add task button. -6. Click the Codacy plugin. ---- - -## User Inputs - -### Task Name -Enter the name of your task. - -`e.g. Jenkins_Job` - -### 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. Trigger the build Job of Jenkins` - -### Input Variables - -| Variable | Format | Description | Sample Value | -| ------------------------ | ------------ | ----------- | ------------ | -| URL | STRING | The base URL of the Jenkins server. | https://jenkins.example.com | -| USERNAME | STRING | The username for authenticating with the Jenkins server,with appropriate permissions | admin_user | -| PASSWORD | STRING | The password for the Jenkins user. | securePass123! | -| JOB_NAME | STRING | The name of the Jenkins job to be triggered. | CI-build-job | -| JOB_TRIGGER_PARAMS | STRING | Parameters passed when triggering a job. | branch=main&environment=production | -| JENKINS_PLUGIN_TIMEOUT | INTEGER | The maximum time (in seconds) to wait for a Jenkins plugin operation to complete before timing out. | 300 | - -### 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 -Jenkins will not be generating an output variable. - -Click **Update Pipeline**. - - From f7b4d8fbd0791250627872bced8725fe09c217ef Mon Sep 17 00:00:00 2001 From: ashokdevtron <141001279+ashokdevtron@users.noreply.github.com> Date: Fri, 26 Jul 2024 17:30:29 +0530 Subject: [PATCH 3/9] Fixed lang issues --- docs/user-guide/plugins/copacetic.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/user-guide/plugins/copacetic.md b/docs/user-guide/plugins/copacetic.md index ee22d853ef..718853f880 100644 --- a/docs/user-guide/plugins/copacetic.md +++ b/docs/user-guide/plugins/copacetic.md @@ -10,17 +10,17 @@ No prerequisites are required for integrating **Copacetic** plugin. --- ## Steps -1. Go to Applications → **Devtron Apps**. -2. Click on your **application**. +1. Go to **Applications** → **Devtron Apps**. +2. Click your application. 3. Go to **App Configuration** → **Workflow Editor**. -4. Click on **New Workflow** and navigate to the **Build and Deploy from Source Code**. +4. Click **New Workflow** and navigate to the **Build and Deploy from Source Code**. 5. Enter the following fields on the **Create build pipeline** window and navigate to **Post-build stage**. {% hint style="warning" %} -if you have already configured workflow, on your **Workflow Editor** click **Build** → **Edit build pipeline** and navigate to the **Post-build stage**. +If you have already configured workflow, edit the build pipeline, and navigate to **Pre-build stage**. {% endhint %} -6. Click on **Task to be executed** under 'TASKS', click the **Add task** button. +6. Click **Task to be executed** under 'TASKS', and click the **Add task** button. 7. Click the **Copacetic** plugin. 8. Enter the following fields with appropriate values. @@ -31,12 +31,12 @@ if you have already configured workflow, on your **Workflow Editor** click **Bui ### Task Name Enter the name of your task. -`e.g. Patch container image vulnerability` +e.g., `Patch container image vulnerability` ### 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 Copacetic plugin is configured to patch the vulnerabilities in container image` +e.g., `The Copacetic plugin is configured to patch the vulnerabilities in container image` ### Input Variables From d52928dea99291018f4deaf846988e82bdfceebb Mon Sep 17 00:00:00 2001 From: ashokdevtron <141001279+ashokdevtron@users.noreply.github.com> Date: Fri, 26 Jul 2024 17:41:10 +0530 Subject: [PATCH 4/9] Lang fix 2 --- docs/user-guide/plugins/copacetic.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/user-guide/plugins/copacetic.md b/docs/user-guide/plugins/copacetic.md index 718853f880..c440dac227 100644 --- a/docs/user-guide/plugins/copacetic.md +++ b/docs/user-guide/plugins/copacetic.md @@ -14,15 +14,15 @@ No prerequisites are required for integrating **Copacetic** plugin. 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. Enter the following fields on the **Create build pipeline** window and navigate to **Post-build stage**. +5. Fill the required fields in the **Create build pipeline** window and navigate to the **Post-build stage**. {% hint style="warning" %} If you have already configured workflow, edit the build pipeline, and navigate to **Pre-build stage**. {% endhint %} -6. Click **Task to be executed** under 'TASKS', and click the **Add task** button. +6. Under 'TASKS', click the **+ Add task** button. 7. Click the **Copacetic** plugin. -8. Enter the following fields with appropriate values. +8. Enter the following [user inputs](#user-inputs) with appropriate values. --- From 09a87aee4a1cd3f8746dc5ff88a402f636ff9d7a Mon Sep 17 00:00:00 2001 From: ashokdevtron <141001279+ashokdevtron@users.noreply.github.com> Date: Tue, 30 Jul 2024 14:08:01 +0530 Subject: [PATCH 5/9] Changed hintblock type --- docs/user-guide/plugins/copacetic.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/user-guide/plugins/copacetic.md b/docs/user-guide/plugins/copacetic.md index c440dac227..5b690c10e6 100644 --- a/docs/user-guide/plugins/copacetic.md +++ b/docs/user-guide/plugins/copacetic.md @@ -16,7 +16,7 @@ No prerequisites are required for integrating **Copacetic** plugin. 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 **Post-build stage**. -{% hint style="warning" %} +{% hint style="info" %} If you have already configured workflow, edit the build pipeline, and navigate to **Pre-build stage**. {% endhint %} From 6a71373184d9f8f61faa0a59692f3a394f6d0417 Mon Sep 17 00:00:00 2001 From: bhushannemade Date: Sun, 4 Aug 2024 21:04:30 +0530 Subject: [PATCH 6/9] minor-fixes in copacetic --- docs/user-guide/plugins/copacetic.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/docs/user-guide/plugins/copacetic.md b/docs/user-guide/plugins/copacetic.md index 5b690c10e6..48d45a7e28 100644 --- a/docs/user-guide/plugins/copacetic.md +++ b/docs/user-guide/plugins/copacetic.md @@ -2,11 +2,10 @@ ## Introduction The Copacetic plugin of Devtron helps you patch your container image vulnerabilities traced by the security scan Devtron performed on your container image. By integrating the **Copacetic** plugin into your workflow, and enabling the **Scan for vulnerabilities** at your **Build stage** you can: -- Trace the vulnerabilities of your container images and the **Copacetic** plugin will automatically patch the contaier image vulnerabilities for you. +- Trace the vulnerabilities of your container images and the **Copacetic** plugin will automatically patch the container image vulnerabilities for you. ### Prerequisites -No prerequisites are required for integrating **Copacetic** plugin. - +Before integrating the **Copacetic** plugin, make sure you have enabled **Scan for vulnerabilities** at the **Build stage** or integrated the **Code-Scan** plugin in the **Pre-build stage**. --- ## Steps From 714d559703e249e2bca8aa874b4efd94b391d2b3 Mon Sep 17 00:00:00 2001 From: bhushannemade Date: Sun, 4 Aug 2024 21:13:34 +0530 Subject: [PATCH 7/9] fixes in copacetic --- docs/user-guide/plugins/copacetic.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/user-guide/plugins/copacetic.md b/docs/user-guide/plugins/copacetic.md index 48d45a7e28..89dc3ee97d 100644 --- a/docs/user-guide/plugins/copacetic.md +++ b/docs/user-guide/plugins/copacetic.md @@ -6,6 +6,7 @@ The Copacetic plugin of Devtron helps you patch your container image vulnerabili ### Prerequisites Before integrating the **Copacetic** plugin, make sure you have enabled **Scan for vulnerabilities** at the **Build stage** or integrated the **Code-Scan** plugin in the **Pre-build stage**. + --- ## Steps From 664e16f7361ecce45f86762e540c52d3d4413b77 Mon Sep 17 00:00:00 2001 From: bhushannemade Date: Mon, 5 Aug 2024 17:01:58 +0530 Subject: [PATCH 8/9] fixes in prerequisites --- docs/user-guide/plugins/copacetic.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/user-guide/plugins/copacetic.md b/docs/user-guide/plugins/copacetic.md index 89dc3ee97d..c922d347c9 100644 --- a/docs/user-guide/plugins/copacetic.md +++ b/docs/user-guide/plugins/copacetic.md @@ -1,11 +1,11 @@ # Copacetic ## Introduction -The Copacetic plugin of Devtron helps you patch your container image vulnerabilities traced by the security scan Devtron performed on your container image. By integrating the **Copacetic** plugin into your workflow, and enabling the **Scan for vulnerabilities** at your **Build stage** you can: -- Trace the vulnerabilities of your container images and the **Copacetic** plugin will automatically patch the container image vulnerabilities for you. +The Copacetic plugin of Devtron helps you patch your container image vulnerabilities traced by the security scan Devtron performed on your container image. By integrating the **Copacetic** plugin into your workflow and enabling the **Scan for vulnerabilities** at your **Build stage**, you can: +- Trace the vulnerabilities of your container images, and the **Copacetic** plugin will automatically patch the container image vulnerabilities for you. ### Prerequisites -Before integrating the **Copacetic** plugin, make sure you have enabled **Scan for vulnerabilities** at the **Build stage** or integrated the **Code-Scan** plugin in the **Pre-build stage**. +Before integrating the **Copacetic** plugin, install the `Vulnerability Scanning (Trivy/Clair)` integration from Devtron Stack Manager. Once the integration is installed, make sure you have enabled **Scan for vulnerabilities** at the **Build stage** or integrated the **Code-Scan** plugin in the **Pre-build stage**. --- From ba7d4179d36746dcc093378239d5b16ba1fb1b6a Mon Sep 17 00:00:00 2001 From: bhushannemade Date: Mon, 5 Aug 2024 18:13:02 +0530 Subject: [PATCH 9/9] linked code-scan plugin at prerequisites --- docs/user-guide/plugins/copacetic.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/user-guide/plugins/copacetic.md b/docs/user-guide/plugins/copacetic.md index c922d347c9..0a8d688ac0 100644 --- a/docs/user-guide/plugins/copacetic.md +++ b/docs/user-guide/plugins/copacetic.md @@ -5,7 +5,7 @@ The Copacetic plugin of Devtron helps you patch your container image vulnerabili - Trace the vulnerabilities of your container images, and the **Copacetic** plugin will automatically patch the container image vulnerabilities for you. ### Prerequisites -Before integrating the **Copacetic** plugin, install the `Vulnerability Scanning (Trivy/Clair)` integration from Devtron Stack Manager. Once the integration is installed, make sure you have enabled **Scan for vulnerabilities** at the **Build stage** or integrated the **Code-Scan** plugin in the **Pre-build stage**. +Before integrating the **Copacetic** plugin, install the `Vulnerability Scanning (Trivy/Clair)` integration from Devtron Stack Manager. Once the integration is installed, make sure you have enabled **Scan for vulnerabilities** at the **Build stage** or integrated the [Code-Scan](./code-scan.md) plugin in the **Pre-build stage**. ---