Skip to content

Commit

Permalink
doc: Copacetic plugin docs (devtron-labs#5564)
Browse files Browse the repository at this point in the history
* doc: jenkins-plugin

* doc: created doc for copacetic plugin

* Fixed lang issues

* Lang fix 2

* Changed hintblock type

---------

Co-authored-by: bhushannemade <[email protected]>
Co-authored-by: ashokdevtron <[email protected]>
  • Loading branch information
3 people authored Jul 30, 2024
1 parent 308596b commit ea73f74
Show file tree
Hide file tree
Showing 2 changed files with 57 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -133,6 +133,7 @@
* [Our Plugins](user-guide/plugins/plugin-list.md)
* [Codacy](user-guide/plugins/codacy.md)
* [Code-Scan](user-guide/plugins/code-scan.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)
Expand Down
56 changes: 56 additions & 0 deletions docs/user-guide/plugins/copacetic.md
Original file line number Diff line number Diff line change
@@ -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 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 **Post-build stage**.

{% hint style="info" %}
If you have already configured workflow, edit the build pipeline, and navigate to **Pre-build stage**.
{% endhint %}

6. Under 'TASKS', click the **+ Add task** button.
7. Click the **Copacetic** plugin.
8. Enter the following [user inputs](#user-inputs) 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**.


0 comments on commit ea73f74

Please sign in to comment.