Skip to content

Commit ba02845

Browse files
doc: Vulnerability Scanning Plugin doc (#5722)
* vulnerability scanning plugin doc * summary.md added
1 parent 1540271 commit ba02845

File tree

2 files changed

+52
-0
lines changed

2 files changed

+52
-0
lines changed

docs/SUMMARY.md

+1
Original file line numberDiff line numberDiff line change
@@ -151,6 +151,7 @@
151151
* [Semgrep](user-guide/plugins/semgrep.md)
152152
* [SonarQube](user-guide/plugins/sonarqube.md)
153153
* [SonarQube v1.1.0](user-guide/plugins/sonarqube-v1.1.0.md)
154+
* [Vulnerability Scanning](user-guide/plugins/vulnerability-scanning.md)
154155

155156

156157
## Resources
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
# Vulnerability-Scanning
2+
3+
## Introduction
4+
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.
5+
6+
### Prerequisites
7+
Before integrating the Vulnerability Scanning plugin, ensure that you have installed the `Vulnerability Scanning (Trivy/Clair)` integration from Devtron Stack Manager.
8+
9+
---
10+
11+
## Steps
12+
1. Go to **Applications****Devtron Apps**.
13+
2. Click your application.
14+
3. Go to **App Configuration****Workflow Editor**.
15+
4. Click **New Workflow** and navigate to the **CREATE JOB PIPELINE**.
16+
5. Enter the required fields in the **Basic configuration** window.
17+
6. Click **Task to be executed**.
18+
7. Under 'TASKS', click the **+ Add task** button.
19+
8. Click the **Vulnerability Scanning** plugin.
20+
9. Enter the following [user inputs](#user-inputs) with appropriate values.
21+
---
22+
23+
## User Inputs
24+
25+
### Task Name
26+
Enter the name of your task
27+
28+
e.g., `Vulnerability Scanning for External CI `
29+
30+
### Description
31+
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.
32+
33+
e.g., `The Vulnerability Scanning plugin is integrated for detecting vulnerabilities in applications.`
34+
35+
### Input Variables
36+
37+
| Variable | Format | Description | Sample Value |
38+
| ------------------------ | ------------ | ----------- | ------------ |
39+
| IMAGE_SCAN_MAX_RETRIES | STRING | Maximum retries for image scanning. | 2 |
40+
| IMAGE_SCAN_RETRY_DELAY | STRING | Delay between image scanning retries (seconds). | 120 |
41+
42+
### Trigger/Skip Condition
43+
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.
44+
45+
### Output Variables
46+
Vulnerability Scanning will not be generating an output variable.
47+
48+
Click **Update Pipeline**.
49+
50+
51+

0 commit comments

Comments
 (0)