Skip to content

Commit 87bddc9

Browse files
devGregAclaudeMaffooch
authored
docs: put what readers come for at the top of six heavily skimmed pages (#16327)
* docs: point Findings intro readers to triage and risk acceptance sooner Add a short opener that links to the triage, risk acceptance and manual creation tasks, and move Example Finding Workflows above the Notes section. No content removed. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * docs: answer what an Asset is and how to scope it at the top of Assets (OS) Add a short opener and move Asset Boundaries up next to Asset Examples so the scoping guidance sits together. No content removed. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * docs: put demo, install and edition links at the top of About DefectDojo Add a short opener linking to the online demos, installation guides and feature comparison, and move Online Demos up under What is DefectDojo. No content removed. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * docs: summarize each hierarchy level at the top of Asset Hierarchy (OS) Add a two paragraph summary of Organizations, Assets, Engagements, Tests and Findings, restating facts already on the page, with links to the planning sections. No content removed. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * docs: summarize Reimport outcomes up front and move Reimport Deduplication up Add a short opener naming the four Reimport outcomes with links, and move Reimport Deduplication directly after the Reimport Logic section. The moved paragraph swaps an em dash pair for parentheses. No content removed. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * docs: add a Quick Path to the Pro Kubernetes install guide Add an ordered Quick Path near the top linking to the existing install sections, plus links to registry login, private registry mirroring, known issues and troubleshooting. This page is generated from the Pro Helm chart repository, so the same change has to land in its docs/INSTALLATION_GUIDE.md. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com> Co-authored-by: Cody Maffucci <46459665+Maffooch@users.noreply.github.com>
1 parent c9a33e4 commit 87bddc9

6 files changed

Lines changed: 142 additions & 110 deletions

File tree

‎docs/content/asset_modelling/OS_hierarchy/OS__asset_hierarchy.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,10 @@ DefectDojo uses five main data classes to organize your work: **Organizations, A
1313

1414
DefectDojo is made to be flexible to conform to your team, rather than making your team conform to the tool. You'll be able to design a robust, adaptable workspace once you understand how these data classes can be used to organize your work.
1515

16+
An Organization groups related Assets, for example by business domain or by team. An Asset is a project, program or application that you are testing, and it holds all of the testing history for it. An Engagement is a testing effort on an Asset, either Interactive or CI/CD, and contains one or more Tests. A Test holds the results of one testing activity, such as an imported scan, and each flaw it reports is a Finding.
17+
18+
Access control is applied to Organizations and Assets, not to Engagements, and deduplication only applies within a single Asset. When you plan your structure, start with [What can an Organization represent?](#what-can-an-organization-represent) and [What can an Asset represent?](#what-can-an-asset-represent), then read [What can an Engagement represent?](#what-can-an-engagement-represent) for examples of grouping Tests.
19+
1620
### Asset Hierarchy Diagram
1721
![image](images/Asset_Hierarchy_Full.png)
1822

‎docs/content/asset_modelling/engagements_tests/OS__assets.md‎

Lines changed: 46 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@ aliases:
99
---
1010
Organizations → **ASSETS** → Engagements → Tests → Findings
1111

12+
An Asset is the thing whose security posture you want to track over time, such as an application, an API or a cloud environment. It holds every Engagement, Test and Finding for that thing, and its settings decide the SLA, permissions and deduplication scope those Findings use. To decide how broad each Asset should be, read [Asset Examples](#asset-examples) and [Asset Boundaries](#asset-boundaries). To add an Asset, see [Create Assets](#create-assets).
13+
1214
## Overview
1315

1416
**Assets** sit at the center of how security work is organized within DefectDojo’s object hierarchy. Assets represent any project, program, software, or physical asset that your security team is testing, and host all of the security work and testing history related to the testing goal. Examples of Assets can include:
@@ -37,6 +39,50 @@ Assets can become even more granular depending on the needs of your organization
3739

3840
While you may also elect to represent these variations as Engagements within a single Asset, access can only be granted at the level of Assets or Organizations, which may limit users’ access to the appropriate Engagement (as well as the Tests and Findings within those Engagements) if they’re organized as such. For more information, see [Open-Source Permissions](/admin/user_management/os__authorized_users/).
3941

42+
## Asset Boundaries
43+
44+
### Deduplication
45+
46+
Assets are “walled-off” and do not interact with other Assets. DefectDojo’s Smart Features, such as Deduplication, only apply within the context of a single Asset. Findings across different Assets will not be automatically deduplicated.
47+
48+
### Metrics
49+
50+
Most reporting and metrics aggregate data at the Asset level, making Assets the primary unit for measuring and tracking risk.
51+
52+
As a result, many key metrics are calculated per Asset, including:
53+
54+
- Total number of Findings (by severity or status)
55+
- Mean time to remediate (MTTR)
56+
- SLA compliance and breach rates
57+
- Risk trends over time
58+
59+
This means that how Assets are structured will directly impact the accuracy and usefulness of reports. For example, grouping multiple unrelated systems under a single Asset may obscure risk visibility, while overly granular Asset structures can fragment reporting, making it difficult to identify broader trends.
60+
61+
Asset-specific metrics can be accessed from the **Metrics** button in the top bar of the chosen Asset’s view.
62+
63+
![image](images/asset_ss8.png)
64+
65+
### CI/CD Pipeline
66+
67+
CI/CD pipelines automate the import of scan results. Regardless of the integration method, all scan imports must be associated with an Asset, making the Asset the anchor point for pipeline-driven security data.
68+
69+
When a pipeline submits scan results, it must either:
70+
71+
- Specify an existing Asset (and optionally an Engagement), or
72+
- Be configured in a way that consistently maps results to the correct Asset
73+
74+
All imported Findings will inherit the Asset’s context, including ownership, permissions, SLA configuration, and reporting scope.
75+
76+
In practice, Assets should be defined to reflect how systems are built and deployed within CI/CD to ensure that security results are consistently associated with the correct application or service.
77+
78+
### Jira Relationships
79+
80+
Assets can be mapped directly to Jira Projects, which push the Asset’s Findings into a Jira instance.
81+
82+
Because Findings inherit risk, priority, and ownership from their parent Asset, the Asset effectively determines the remediation context that flows into Jira tickets and Downstream Connector workflows.
83+
84+
Importantly, Assets are also the primary determining factor in a Finding’s SLA characteristics. Therefore, the SLA of a Finding depends on the SLA configuration of its parent Asset. More information about SLA configurations can be found [here](/asset_modelling/os_hierarchy/os__sla_configuration/#main-content).
85+
4086
## Asset Data
4187

4288
Assets will always include the following components:
@@ -134,47 +180,3 @@ Deleting an Asset will also delete the following:
134180
- All associated security history, including Findings and integrations
135181
- Any linked Jira Epics
136182
- All notes and file uploads associated with the Asset’s Engagements and Tests
137-
138-
## Asset Boundaries
139-
140-
### Deduplication
141-
142-
Assets are “walled-off” and do not interact with other Assets. DefectDojo’s Smart Features, such as Deduplication, only apply within the context of a single Asset. Findings across different Assets will not be automatically deduplicated.
143-
144-
### Metrics
145-
146-
Most reporting and metrics aggregate data at the Asset level, making Assets the primary unit for measuring and tracking risk.
147-
148-
As a result, many key metrics are calculated per Asset, including:
149-
150-
- Total number of Findings (by severity or status)
151-
- Mean time to remediate (MTTR)
152-
- SLA compliance and breach rates
153-
- Risk trends over time
154-
155-
This means that how Assets are structured will directly impact the accuracy and usefulness of reports. For example, grouping multiple unrelated systems under a single Asset may obscure risk visibility, while overly granular Asset structures can fragment reporting, making it difficult to identify broader trends.
156-
157-
Asset-specific metrics can be accessed from the **Metrics** button in the top bar of the chosen Asset’s view.
158-
159-
![image](images/asset_ss8.png)
160-
161-
### CI/CD Pipeline
162-
163-
CI/CD pipelines automate the import of scan results. Regardless of the integration method, all scan imports must be associated with an Asset, making the Asset the anchor point for pipeline-driven security data.
164-
165-
When a pipeline submits scan results, it must either:
166-
167-
- Specify an existing Asset (and optionally an Engagement), or
168-
- Be configured in a way that consistently maps results to the correct Asset
169-
170-
All imported Findings will inherit the Asset’s context, including ownership, permissions, SLA configuration, and reporting scope.
171-
172-
In practice, Assets should be defined to reflect how systems are built and deployed within CI/CD to ensure that security results are consistently associated with the correct application or service.
173-
174-
### Jira Relationships
175-
176-
Assets can be mapped directly to Jira Projects, which push the Asset’s Findings into a Jira instance.
177-
178-
Because Findings inherit risk, priority, and ownership from their parent Asset, the Asset effectively determines the remediation context that flows into Jira tickets and Downstream Connector workflows.
179-
180-
Importantly, Assets are also the primary determining factor in a Finding’s SLA characteristics. Therefore, the SLA of a Finding depends on the SLA configuration of its parent Asset. More information about SLA configurations can be found [here](/asset_modelling/os_hierarchy/os__sla_configuration/#main-content).

‎docs/content/get_started/about/about_defectdojo.md‎

Lines changed: 20 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@ aliases:
2222

2323
<span style="background-color:rgba(242, 86, 29, 0.3)">DefectDojo, Inc. and open-source contributors maintain this documentation to support both the Community and Pro editions of DefectDojo.</span>
2424

25+
To try DefectDojo without installing anything, log in to one of the [Online Demos](#online-demos). To install the Open-Source edition, start with the [Installation](/get_started/open_source/installation/) guide, and for Pro, see [Self-Hosting DefectDojo Pro](/get_started/pro/onprem/installation_options/). The [Feature comparison](/get_started/about/defectdojo_versions/) lists what each edition includes.
26+
2527
## What is DefectDojo?
2628

2729
DefectDojo is a Developer Security Operations (DevSecOps) platform. DefectDojo streamlines DevSecOps by serving as an automatic aggregator for your suite of security tools, allowing you to easily organize your security work and report your organization’s security posture to other stakeholders.
@@ -44,6 +46,24 @@ DefectDojo has smart features to enhance and tune the results from your security
4446

4547
Ultimately, DefectDojo's Asset:Engagement model allows you to take inventory of your development environment and immediately place new security Findings in context.
4648

49+
## Online Demos
50+
51+
Online demos for both Open-Source and Pro versions of DefectDojo are available. Both can be accessed using the following credentials:
52+
53+
- Username: `admin`
54+
- Password: `1Defectdojo@demo#appsec`
55+
56+
These demos come loaded with sample data, and are reset on a daily basis.
57+
58+
### Open-Source Demo
59+
60+
A running example of DefectDojo (Open-Source Edition) is available at [https://demo.defectdojo.org/](https://demo.defectdojo.org/).
61+
62+
### Pro Demo
63+
64+
A running example of DefectDojo Pro is available at
65+
[https://pro.demo.defectdojo.com/](https://pro.demo.defectdojo.com/).
66+
4767
---
4868
Here are some examples of ways DefectDojo can be implemented, with DefectDojo co-founder and CTO Matt Tesauro:
4969
<iframe width="560" height="315" src="https://www.youtube.com/embed/44vv-KspHBs?si=OwfGHs2VTQ886-FB" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe>
@@ -94,24 +114,6 @@ The Pro edition is available as a cloud-hosted SaaS offering, and is also availa
94114

95115
For more information on DefectDojo Pro, check out our [Pricing page](https://defectdojo.com/pricing).
96116

97-
## Online Demos
98-
99-
Online demos for both Open-Source and Pro versions of DefectDojo are available. Both can be accessed using the following credentials:
100-
101-
- Username: `admin`
102-
- Password: `1Defectdojo@demo#appsec`
103-
104-
These demos come loaded with sample data, and are reset on a daily basis.
105-
106-
### Open-Source Demo
107-
108-
A running example of DefectDojo (Open-Source Edition) is available at [https://demo.defectdojo.org/](https://demo.defectdojo.org/).
109-
110-
### Pro Demo
111-
112-
A running example of DefectDojo Pro is available at
113-
[https://pro.demo.defectdojo.com/](https://pro.demo.defectdojo.com/).
114-
115117
## Learning DefectDojo
116118

117119
Whether you’re a Pro or an Open-Source user, we have many resources to help you get started with DefectDojo.

‎docs/content/get_started/pro/onprem/kubernetes/installing_on_kubernetes.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,26 @@ aliases:
1818
Covers deployment on AWS EKS and OpenShift (ROSA). The workflow is the same
1919
for both: set up infrastructure, create secrets, install the chart.
2020

21+
## Quick Path
22+
23+
1. Gather the values in the [Pre-Install Checklist](#pre-install-checklist)
24+
and install the tools listed under [Prerequisites](#prerequisites).
25+
2. [Extract the Chart Package](#extract-the-chart-package) and
26+
[Prepare Your Values File](#prepare-your-values-file).
27+
3. [Generate Secrets](#generate-secrets) and
28+
[Create Internal TLS Certificates](#create-internal-tls-certificates).
29+
4. Supply your [License](#license).
30+
5. [Validate the templates](#pre-flight-validate-templates), then
31+
[Deploy](#deploy) and [Verify](#verify). To deploy through ArgoCD instead,
32+
see [Deploy with ArgoCD](#deploy-with-argocd).
33+
34+
To log in to the DefectDojo registry by hand with the key in your license, see
35+
[Inspecting Your License](#inspecting-your-license). If your cluster can't pull
36+
from the default DefectDojo registry, see
37+
[Private Registry / Air-Gapped Environments](#private-registry--air-gapped-environments).
38+
For problems after the install, see [Known Issues](#known-issues) and
39+
[Troubleshooting](#troubleshooting).
40+
2141
---
2242

2343
## Pre-Install Checklist

‎docs/content/import_data/import_intro/reimport.md‎

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@ When a Test is created in DefectDojo (either in advance or by importing a scan f
99

1010
For example, let’s say you have a CI/CD pipeline, which is designed to send a new report to DefectDojo every day. Rather than create a new Test or Engagement for each ‘run’ of the pipeline, you could have each report flow into the same Test using **Reimport**.
1111

12+
A Reimport creates Findings that are new in the report, leaves matching Findings in place, can close Findings that are missing from the report, and reopens closed Findings that come back. Each of these outcomes, and the settings that turn closing and reopening off, is described under [Reimport Logic](#reimport-logic-create-ignore-close-or-reopen). Whether an incoming item matches an existing Finding is decided by [Reimport Deduplication](#reimport-deduplication). To start a Reimport from the UI, see [Opening the Reimport form](#opening-the-reimport-form).
13+
1214
## Reimport: Process Summary
1315

1416
Reimporting data does not replace any old data in the Test, instead, it compares the incoming scan file with the existing scan data in a test to make informed decisions:
@@ -81,6 +83,14 @@ If you want a Risk Accepted or Duplicate Finding to become Active again, you nee
8183

8284
The **Scan Date** field on the Reimport form starts empty. Left empty, each Finding that the Reimport creates keeps the date from the report (or today's date if the report has none). If you select a Scan Date, it is applied to every Finding the Reimport creates. Findings that already exist in the Test keep their dates either way.
8385

86+
## Reimport Deduplication
87+
88+
Reimport decides whether an incoming item matches an existing Finding using **[Reimport Deduplication](/triage_findings/finding_deduplication/about_deduplication/)** settings. This is separate from “Same Tool Deduplication” and “Cross Tool Deduplication,” which operate after Findings exist. [How DefectDojo Deduplicates Findings Across Security Tools](/triage_findings/finding_deduplication/deduplication_across_tools/) explains how the two steps fit together.
89+
90+
If you are seeing Reimport close old Findings and create new Findings when only a minor attribute changes (for example, a line number shift), tune **Reimport Deduplication** for that tool to use stable identifiers that ignore those attributes (such as Unique ID From Tool).
91+
92+
**DefectDojo Pro** can solve this directly for tools without reliable unique IDs: enabling **[Location Drift Matching](/triage_findings/finding_deduplication/pro__location_drift_matching/)** makes Reimport recognize a Finding whose location moved (a line shift, file rename, URL move, or dependency version bump) as the *same* Finding, updating it in place and preserving its location history.
93+
8494
## Why Findings Close and Reopen
8595

8696
A Finding that keeps closing and coming back is usually reimport doing exactly what it was asked to, on data that does not match what the user expects. The evidence is on two pages:
@@ -121,14 +131,6 @@ This header indicates the actions taken by an Import/Reimport.
121131
* **\# left untouched shows the count of Open Findings which were unchanged by a Reimport (because they also existed in the incoming report).**
122132
* **\#** **reactivated** shows any Closed Findings which were reopened by an incoming Reimport.
123133

124-
## Reimport Deduplication
125-
126-
Reimport decides whether an incoming item matches an existing Finding using **[Reimport Deduplication](/triage_findings/finding_deduplication/about_deduplication/)** settings. This is separate from “Same Tool Deduplication” and “Cross Tool Deduplication,” which operate after Findings exist. [How DefectDojo Deduplicates Findings Across Security Tools](/triage_findings/finding_deduplication/deduplication_across_tools/) explains how the two steps fit together.
127-
128-
If you are seeing Reimport close old Findings and create new Findings when only a minor attribute changes (for example, a line number shift), tune **Reimport Deduplication** for that tool to use stable identifiers that ignore those attributes (such as Unique ID From Tool).
129-
130-
**DefectDojo Pro** can solve this directly for tools without reliable unique IDs: enabling **[Location Drift Matching](/triage_findings/finding_deduplication/pro__location_drift_matching/)** makes Reimport recognize a Finding whose location moved — a line shift, file rename, URL move, or dependency version bump — as the *same* Finding, updating it in place and preserving its location history.
131-
132134
## Reimport via API - special note
133135

134136
Note that the /reimport API endpoint can both **extend an existing Test** (apply the method in this article) **or create a new Test** with new data \- an initial call to `/import`, or setting up a Test in advance is not required.

0 commit comments

Comments
 (0)