Skip to content

Commit ea73f74

Browse files
bhushan-nemade-dtbhushan0501ashokdevtron
authored
doc: Copacetic plugin docs (#5564)
* doc: jenkins-plugin * doc: created doc for copacetic plugin * Fixed lang issues * Lang fix 2 * Changed hintblock type --------- Co-authored-by: bhushannemade <bhushannemade40@gmail.com> Co-authored-by: ashokdevtron <141001279+ashokdevtron@users.noreply.github.com>
1 parent 308596b commit ea73f74

File tree

2 files changed

+57
-0
lines changed

2 files changed

+57
-0
lines changed

docs/SUMMARY.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -133,6 +133,7 @@
133133
* [Our Plugins](user-guide/plugins/plugin-list.md)
134134
* [Codacy](user-guide/plugins/codacy.md)
135135
* [Code-Scan](user-guide/plugins/code-scan.md)
136+
* [Copacetic](user-guide/plugins/copacetic.md)
136137
* [Copy Container Image](user-guide/plugins/copy-container-image.md)
137138
* [Dependency track - Maven & Gradle](user-guide/plugins/dependency-track-maven-gradle.md)
138139
* [Dependency track - NodeJS](user-guide/plugins/dependency-track-nodejs.md)

docs/user-guide/plugins/copacetic.md

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
# Copacetic
2+
3+
## Introduction
4+
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:
5+
- Trace the vulnerabilities of your container images and the **Copacetic** plugin will automatically patch the contaier image vulnerabilities for you.
6+
7+
### Prerequisites
8+
No prerequisites are required for integrating **Copacetic** plugin.
9+
10+
---
11+
12+
## Steps
13+
1. Go to **Applications****Devtron Apps**.
14+
2. Click your application.
15+
3. Go to **App Configuration****Workflow Editor**.
16+
4. Click **New Workflow** and navigate to the **Build and Deploy from Source Code**.
17+
5. Fill the required fields in the **Create build pipeline** window and navigate to the **Post-build stage**.
18+
19+
{% hint style="info" %}
20+
If you have already configured workflow, edit the build pipeline, and navigate to **Pre-build stage**.
21+
{% endhint %}
22+
23+
6. Under 'TASKS', click the **+ Add task** button.
24+
7. Click the **Copacetic** plugin.
25+
8. Enter the following [user inputs](#user-inputs) with appropriate values.
26+
27+
---
28+
29+
## User Inputs
30+
31+
### Task Name
32+
Enter the name of your task.
33+
34+
e.g., `Patch container image vulnerability`
35+
36+
### Description
37+
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.
38+
39+
e.g., `The Copacetic plugin is configured to patch the vulnerabilities in container image`
40+
41+
### Input Variables
42+
43+
| Variable | Format | Description | Sample Value |
44+
| ------------------------ | ------------ | ----------- | ------------ |
45+
| CopaTimeout | STRING | Provide timeout for copa patch command, default time is 5 minutes | 10m |
46+
47+
48+
### Trigger/Skip Condition
49+
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.
50+
51+
### Output Variables
52+
Copacetic will not be generating an output variable.
53+
54+
Click **Update Pipeline**.
55+
56+

0 commit comments

Comments
 (0)