-
Notifications
You must be signed in to change notification settings - Fork 551
doc: Vulnerability Scanning Plugin doc #5722
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
ashokdevtron
merged 5 commits into
devtron-labs:main
from
bhushan-nemade-dt:vulnerability-scanning
Sep 3, 2024
Merged
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
cf19e4f
vulnerability scanning plugin doc
bhushan-nemade-dt 0125970
summary.md added
bhushan-nemade-dt 16e8054
Merge branch 'main' into vulnerability-scanning
bhushan-nemade-dt ddaed67
Merge branch 'main' into vulnerability-scanning
bhushan-nemade-dt c6000ab
Merge branch 'main' into vulnerability-scanning
bhushan-nemade-dt 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,51 @@ | ||
# Vulnerability-Scanning | ||
|
||
## Introduction | ||
The **Vulnerability Scanning** plugin by Devtron enables you to scan and detect vulnerabilities of your applications using Trivy/Clair. The Vulnerability Scanning plugin is recommended to be integrated into the Job Pipeline, especially when you are using external CI pipelines like Jenkins, Gitlab, or GitHub Actions. Based on Vulnerability Scanning results, you can enforce security policies to either proceed with or abort the deployment process, giving you more control over your deployment process. | ||
|
||
### Prerequisites | ||
Before integrating the Vulnerability Scanning plugin, ensure that you have installed the `Vulnerability Scanning (Trivy/Clair)` integration from Devtron Stack Manager. | ||
|
||
--- | ||
|
||
## 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 **CREATE JOB PIPELINE**. | ||
5. Enter the required fields in the **Basic configuration** window. | ||
6. Click **Task to be executed**. | ||
7. Under 'TASKS', click the **+ Add task** button. | ||
8. Click the **Vulnerability Scanning** plugin. | ||
9. Enter the following [user inputs](#user-inputs) with appropriate values. | ||
--- | ||
|
||
## User Inputs | ||
|
||
### Task Name | ||
Enter the name of your task | ||
|
||
e.g., `Vulnerability Scanning for External CI ` | ||
|
||
### 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 Vulnerability Scanning plugin is integrated for detecting vulnerabilities in applications.` | ||
|
||
### Input Variables | ||
|
||
| Variable | Format | Description | Sample Value | | ||
| ------------------------ | ------------ | ----------- | ------------ | | ||
| IMAGE_SCAN_MAX_RETRIES | STRING | Image scan max retry count. | 2 | | ||
| IMAGE_SCAN_RETRY_DELAY | STRING | Image scan retry delay (in seconds). | 120 | | ||
ashokdevtron marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
### 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 | ||
Vulnerability Scanning will not be generating an output variable. | ||
|
||
Click **Update Pipeline**. | ||
|
||
|
||
|
Oops, something went wrong.
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.