Skip to content

Commit f108882

Browse files
secureCodeBoxBotsecureCodeBoxBot
committed
Updating Helm Docs
Signed-off-by: secureCodeBoxBot <securecodebox@iteratec.com>
1 parent 556201d commit f108882

2 files changed

Lines changed: 24 additions & 24 deletions

File tree

‎hooks/persistence-defectdojo/README.md‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -148,18 +148,18 @@ After, you can update `/etc/ssl/certs/java/cacerts` with your certificate.
148148

149149
You don't need any configuration for that to work, the hook will infer engagement & product names from the scan name. If you want more control over the names or add additional meta information like the version of the tested software you can add these via annotation to the scan. See examples below.
150150

151-
| Scan Annotation | Description | Default if not set | Notes |
152-
|--------------------------------------------------------------------|---------------------------------------------|----------------------------------------------------------------------|----------------------------------------------------------------------------------------|
153-
| `defectdojo.securecodebox.io/product-type-name` | Name of the Product Type | Product Type with ID 1 (typically "Research and Development") | Product Type will be automatically created if no Product Type under that name exists |
154-
| `defectdojo.securecodebox.io/product-name` | Name of the Product | ScheduledScan Name if Scheduled, Scan Name if it's a standalone Scan | Product will be automatically created if no Product under that name exists |
155-
| `defectdojo.securecodebox.io/product-description` | Description of the Product | Empty String | Only used when creating the Product not used for updating |
156-
| `defectdojo.securecodebox.io/product-tags` | Product Tags | Nothing | Only used when creating the Product not used for updating |
157-
| `defectdojo.securecodebox.io/engagement-name` | Name of the Engagement | Scan Name | Will be automatically created if no *engagement* with that name **and** version exists |
158-
| `defectdojo.securecodebox.io/engagement-version` | Engagement Version | Nothing | |
159-
| `defectdojo.securecodebox.io/engagement-deduplicate-on-engagement` | Deduplicate On Engagement | false | Only used when creating the Engagement not used for updating |
160-
| `defectdojo.securecodebox.io/engagement-tags` | Engagement Tags | Nothing | Only used when creating the Engagement not used for updating |
161-
| `defectdojo.securecodebox.io/test-title` | Test Title | Scan Name | |
162-
| `defectdojo.securecodebox.io/minimum_severity` | Minimum severity for findings created in DD | Nothing | Used to only create finding in DD, which are of a certain severity |
151+
| Scan Annotation | Description | Default if not set | Notes |
152+
|--------------------------------------------------------------------|---------------------------------------------|----------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------|
153+
| `defectdojo.securecodebox.io/product-type-name` | Name of the Product Type | Product Type with ID 1 (typically "Research and Development") | Product Type will be automatically created if no Product Type under that name exists. Product Type names need to be unique in the DefectDojo instance. |
154+
| `defectdojo.securecodebox.io/product-name` | Name of the Product | ScheduledScan Name if Scheduled, Scan Name if it's a standalone Scan | Product will be automatically created if no Product under that name exists. Product names need to be unique in the DefectDojo instance. |
155+
| `defectdojo.securecodebox.io/product-description` | Description of the Product | Empty String | Only used when creating the Product not used for updating |
156+
| `defectdojo.securecodebox.io/product-tags` | Product Tags | Nothing | Only used when creating the Product not used for updating |
157+
| `defectdojo.securecodebox.io/engagement-name` | Name of the Engagement | Scan Name | Will be automatically created if no *engagement* with that name **and** version exists |
158+
| `defectdojo.securecodebox.io/engagement-version` | Engagement Version | Nothing | |
159+
| `defectdojo.securecodebox.io/engagement-deduplicate-on-engagement` | Deduplicate On Engagement | false | Only used when creating the Engagement not used for updating |
160+
| `defectdojo.securecodebox.io/engagement-tags` | Engagement Tags | Nothing | Only used when creating the Engagement not used for updating |
161+
| `defectdojo.securecodebox.io/test-title` | Test Title | Scan Name | |
162+
| `defectdojo.securecodebox.io/minimum_severity` | Minimum severity for findings created in DD | Nothing | Used to only create finding in DD, which are of a certain severity |
163163

164164
### Read-only Mode
165165

‎hooks/persistence-defectdojo/docs/README.ArtifactHub.md‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -156,18 +156,18 @@ After, you can update `/etc/ssl/certs/java/cacerts` with your certificate.
156156

157157
You don't need any configuration for that to work, the hook will infer engagement & product names from the scan name. If you want more control over the names or add additional meta information like the version of the tested software you can add these via annotation to the scan. See examples below.
158158

159-
| Scan Annotation | Description | Default if not set | Notes |
160-
|--------------------------------------------------------------------|---------------------------------------------|----------------------------------------------------------------------|----------------------------------------------------------------------------------------|
161-
| `defectdojo.securecodebox.io/product-type-name` | Name of the Product Type | Product Type with ID 1 (typically "Research and Development") | Product Type will be automatically created if no Product Type under that name exists |
162-
| `defectdojo.securecodebox.io/product-name` | Name of the Product | ScheduledScan Name if Scheduled, Scan Name if it's a standalone Scan | Product will be automatically created if no Product under that name exists |
163-
| `defectdojo.securecodebox.io/product-description` | Description of the Product | Empty String | Only used when creating the Product not used for updating |
164-
| `defectdojo.securecodebox.io/product-tags` | Product Tags | Nothing | Only used when creating the Product not used for updating |
165-
| `defectdojo.securecodebox.io/engagement-name` | Name of the Engagement | Scan Name | Will be automatically created if no *engagement* with that name **and** version exists |
166-
| `defectdojo.securecodebox.io/engagement-version` | Engagement Version | Nothing | |
167-
| `defectdojo.securecodebox.io/engagement-deduplicate-on-engagement` | Deduplicate On Engagement | false | Only used when creating the Engagement not used for updating |
168-
| `defectdojo.securecodebox.io/engagement-tags` | Engagement Tags | Nothing | Only used when creating the Engagement not used for updating |
169-
| `defectdojo.securecodebox.io/test-title` | Test Title | Scan Name | |
170-
| `defectdojo.securecodebox.io/minimum_severity` | Minimum severity for findings created in DD | Nothing | Used to only create finding in DD, which are of a certain severity |
159+
| Scan Annotation | Description | Default if not set | Notes |
160+
|--------------------------------------------------------------------|---------------------------------------------|----------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------|
161+
| `defectdojo.securecodebox.io/product-type-name` | Name of the Product Type | Product Type with ID 1 (typically "Research and Development") | Product Type will be automatically created if no Product Type under that name exists. Product Type names need to be unique in the DefectDojo instance. |
162+
| `defectdojo.securecodebox.io/product-name` | Name of the Product | ScheduledScan Name if Scheduled, Scan Name if it's a standalone Scan | Product will be automatically created if no Product under that name exists. Product names need to be unique in the DefectDojo instance. |
163+
| `defectdojo.securecodebox.io/product-description` | Description of the Product | Empty String | Only used when creating the Product not used for updating |
164+
| `defectdojo.securecodebox.io/product-tags` | Product Tags | Nothing | Only used when creating the Product not used for updating |
165+
| `defectdojo.securecodebox.io/engagement-name` | Name of the Engagement | Scan Name | Will be automatically created if no *engagement* with that name **and** version exists |
166+
| `defectdojo.securecodebox.io/engagement-version` | Engagement Version | Nothing | |
167+
| `defectdojo.securecodebox.io/engagement-deduplicate-on-engagement` | Deduplicate On Engagement | false | Only used when creating the Engagement not used for updating |
168+
| `defectdojo.securecodebox.io/engagement-tags` | Engagement Tags | Nothing | Only used when creating the Engagement not used for updating |
169+
| `defectdojo.securecodebox.io/test-title` | Test Title | Scan Name | |
170+
| `defectdojo.securecodebox.io/minimum_severity` | Minimum severity for findings created in DD | Nothing | Used to only create finding in DD, which are of a certain severity |
171171

172172
### Read-only Mode
173173

0 commit comments

Comments
 (0)