-
Notifications
You must be signed in to change notification settings - Fork 548
doc: fixes in Copacetic plugin doc #5622
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 12 commits
Commits
Show all changes
14 commits
Select commit
Hold shift + click to select a range
2737813
doc: jenkins-plugin
bhushan0501 15226c0
Merge branch 'devtron-labs:main' into main
bhushan-nemade-dt 6965cf2
Merge branch 'devtron-labs:main' into main
bhushan-nemade-dt 046852d
doc: created doc for copacetic plugin
bhushan-nemade-dt f7b4d8f
Fixed lang issues
ashokdevtron d52928d
Lang fix 2
ashokdevtron 09a87ae
Changed hintblock type
ashokdevtron aee7e34
Merge branch 'main' into Copacetic
ashokdevtron 2f3d61c
Merge branch 'main' into Copacetic
ashokdevtron 6a71373
minor-fixes in copacetic
bhushan-nemade-dt 714d559
fixes in copacetic
bhushan-nemade-dt 664e16f
fixes in prerequisites
bhushan-nemade-dt ba7d417
linked code-scan plugin at prerequisites
bhushan-nemade-dt b998073
Merge branch 'main' into Copacetic
ashokdevtron File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 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**. | ||
|
||
--- | ||
|
||
## 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**. | ||
|
||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.