Skip to content

Commit 92209d6

Browse files
committed
Merge origin/bugfix into sc-13651_servicedeskplus_docs
2 parents 3820ab6 + f386e52 commit 92209d6

28 files changed

Lines changed: 1299 additions & 44 deletions

File tree

.github/CODEOWNERS

Lines changed: 2 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,4 @@
1-
# Any kind of package updates only need 2 approvals,
2-
# So let's add three folks here
3-
requirements.txt @cneill @mtesauro @Maffooch
4-
# Any dockerfile or compose changes will need to be viewed by
5-
# these people
6-
Dockerfile.* @mtesauro @Maffooch
7-
docker-compose.* @mtesauro @Maffooch
8-
/docker/ @mtesauro @Maffooch
91
# Documentation changes
10-
/docs/content/ @paulOsinski @valentijnscholten @Maffooch
11-
# Kubernetes should be reviewed by reviewed first by those that know it
12-
/helm/ @cneill @kiblik @Maffooch
13-
# Anything UI related needs to be checked out by those with the eye for it
14-
/dojo/static/ @blakeaowens @Maffooch
15-
/dojo/templates/ @blakeaowens @Maffooch
16-
# Any model changes should be closely looked at
17-
/dojo/models.py @Maffooch
2+
/docs/content/ @paulOsinski @Maffooch
183
# All other code changes should be reviewed by someone
19-
* @Maffooch @mtesauro
4+
* @Maffooch @blakeaowens
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
title: "Upgrading DefectDojo Pro (On-Premise)"
3+
description: "Supported upgrade procedure for self-hosted DefectDojo Pro deployments using the Helm chart"
4+
draft: false
5+
weight: 5
6+
audience: pro
7+
---
8+
9+
This page describes the supported upgrade procedure for self-hosted DefectDojo Pro deployments that use the DefectDojo Pro Helm chart.
10+
11+
## Upgrade everything as one unit
12+
13+
Each DefectDojo Pro release consists of a Helm chart version, container image versions, and the Pro settings files. These are built and tested together and must be upgraded together as one unit.
14+
15+
Upgrading only the image tags is not supported and will break your deployment.
16+
17+
## Settings files and upgrades
18+
19+
DefectDojo Pro ships a `pro_settings.py` file with every release, and the file changes with nearly every version. Do not carry a copy of `pro_settings.py` forward across upgrades, and do not patch an older copy by hand. The application must always run the `pro_settings.py` that matches its version.
20+
21+
Put your own customizations in `local_settings.py`, never in `pro_settings.py`. Your `local_settings.py` is preserved across upgrades.
22+
23+
The Helm chart ships and mounts the matching `pro_settings.py` and your `local_settings.py` automatically. When you upgrade using the chart, there is nothing to copy or migrate by hand.
24+
25+
## Supported upgrade procedure
26+
27+
1. Review the release notes for every version between your current version and your target version, not just the target itself. See the [DefectDojo Pro Changelog](/releases/pro/changelog/) and the version-specific [upgrade notes](/releases/os_upgrading/upgrading_guide/).
28+
2. Back up your database.
29+
3. Upgrade to the Helm chart release that matches your target application version, reusing your existing values files. Do not change image tags independently of the chart version.
30+
31+
If you have questions about upgrading your on-premise deployment, contact [support@defectdojo.com](mailto:support@defectdojo.com).

docs/content/import_data/pro/connectors/about_connectors.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,9 +29,11 @@ We currently support Connectors for the following tools, with more on the way:
2929
* **Akamai API Security**
3030
* **Anchore**
3131
* **AWS Security Hub**
32+
* **Backstage** (asset inventory: builds Product hierarchy and team ownership from the Software Catalog)
3233
* **BurpSuite**
3334
* **Checkmarx ONE**
3435
* **Dependency-Track**
36+
* **Group-IB ASM**
3537
* **IriusRisk**
3638
* **JFrog Xray**
3739
* **Probely**

docs/content/import_data/pro/connectors/connectors_tool_reference.md

Lines changed: 536 additions & 0 deletions
Large diffs are not rendered by default.

docs/content/issue_tracking/jira/PRO__jira_guide.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -138,6 +138,38 @@ Note that DefectDojo cannot send any Issue\-specific metadata as Custom Fields,
138138

139139
Follow **[this guide](#custom-fields-in-jira)** to get started working with Custom Fields.
140140

141+
#### Close / Reopen Transition fields
142+
143+
Some Jira workflows **require** certain fields to be set as part of a transition — for example, a workflow that refuses to close an Issue unless a Resolution and a Justification field are provided on the close screen. The Custom fields setting above only applies when an Issue is *created*, so it cannot satisfy these workflows.
144+
145+
Without these settings, DefectDojo sends close / reopen transitions with no fields. A workflow that requires fields will reject that transition, and the Finding and the Jira Issue fall out of sync: the Finding shows as Mitigated in DefectDojo while the Issue remains open in Jira.
146+
147+
The **Close Transition fields** and **Reopen Transition fields** settings accept a JSON object that is sent as the `fields` payload of the close / reopen transition call. For example, to close Issues with a Resolution of *Won't Fix* plus a justification value:
148+
149+
```json
150+
{
151+
"resolution": {"name": "Won't Fix"},
152+
"customfield_10200": "Risk accepted by security team #report-false-positive"
153+
}
154+
```
155+
156+
Leave these settings as 'null' if your Jira workflow does not require fields on transitions.
157+
158+
**Which fields do you need?**
159+
160+
* Ask your Jira admin which fields are on the close / reopen **transition screens**, and which of them are enforced by a validator. The configured JSON must satisfy **every** required field: if any required field is missing from the payload, Jira rejects the whole transition and sets nothing — supplying only some of the required fields does not help.
161+
* Conversely, fields must be present **on the transition screen** to be sent at all: Jira rejects transitions that attempt to set fields that are not on the screen for that transition.
162+
* On workflows built with Jira Cloud's current workflow editor, Jira automatically fills in the site's default Resolution when an Issue moves to a done-category status. So, a required Resolution alone will not block a bare transition there, and the practical use of `"resolution"` in this payload is choosing a *meaningful* value (for example *False Positive*) instead of the site default. Workflows built with the classic editor, or with marketplace validator apps, can still hard-require Resolution.
163+
* Reopen transitions typically clear the Resolution via the workflow itself, so **Reopen Transition fields** usually only needs the custom fields your workflow requires.
164+
165+
**Notes:**
166+
167+
* The same JSON is sent for *every* close (or reopen) transition for the Product or Engagement — the values are static and do not vary per Finding. If you need different fields per disposition (for example, a different Resolution for False Positive findings than for remediated findings), use the DefectDojo Pro Jira Integrator, which supports per-status transition field mappings.
168+
* Values use the same format as Jira's REST API: strings for text fields, `{"name": ...}` for resolutions, `[{"name": ...}]` for multi-select fields, and so on.
169+
* If transitions were rejected while these settings were missing or incomplete, correcting the settings repairs the drift: the next status push for the Finding retries the transition with the configured fields.
170+
* Both settings are also available on the `/api/v2/jira_projects/` REST endpoint (`close_transition_fields` / `reopen_transition_fields`), so they can be managed via the API.
171+
* These fields are also applied when DefectDojo closes an Issue because its Finding was **deleted** — the values are captured at the moment the close is queued.
172+
141173
#### Jira labels
142174

143175
Select the relevant labels that you want the Issue to be created with in Jira, e.g. **DefectDojo**, **YourProductName..**

docs/content/issue_tracking/pro_integration/integrations.md

Lines changed: 18 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,15 @@ aliases:
1010
DefectDojo Pro's Integrations let you push your Findings and Finding Groups to ticket tracking systems to easily integrate security remediation with your teams existing development workflow.
1111

1212
Supported Integrations:
13-
- [Azure Devops](/issue_tracking/pro_integration/integrations/#azure-devops-boards)
14-
- [GitHub](/issue_tracking/pro_integration/integrations/#github)
15-
- [GitLab Boards](/issue_tracking/pro_integration/integrations/#gitlab)
16-
- [ServiceDesk Plus](/issue_tracking/pro_integration/integrations/#servicedesk-plus)
17-
- [ServiceNow](/issue_tracking/pro_integration/integrations/#servicenow)
13+
- Azure Devops
14+
- Bitbucket
15+
- Freshservice
16+
- GitHub
17+
- GitLab Boards
18+
- Jira
19+
- ServiceDesk Plus
20+
- ServiceNow
21+
- Shortcut
1822

1923
## Opening the Integrations page
2024

@@ -69,11 +73,15 @@ Project Integrations will have varying requirements for how DefectDojo will need
6973

7074
For the complete list of requirements, please open the vendor specific pages below:
7175

72-
- [Azure Devops](/issue_tracking/pro_integration/integrations/#azure-devops-boards)
73-
- [GitHub](/issue_tracking/pro_integration/integrations/#github)
74-
- [GitLab Boards](/issue_tracking/pro_integration/integrations/#gitlab)
75-
- [ServiceDesk Plus](/issue_tracking/pro_integration/integrations/#servicedesk-plus)
76-
- ServiceNow (Coming Soon)
76+
- [Azure Devops](/issue_tracking/pro_integration/integrations_toolreference/#azure-devops-boards)
77+
- [Bitbucket](/issue_tracking/pro_integration/integrations_toolreference/#bitbucket)
78+
- [Freshservice](/issue_tracking/pro_integration/integrations_toolreference/#freshservice)
79+
- [GitHub](/issue_tracking/pro_integration/integrations_toolreference/#github)
80+
- [GitLab Boards](/issue_tracking/pro_integration/integrations_toolreference/#gitlab)
81+
- [Jira](/issue_tracking/pro_integration/integrations_toolreference/#jira)
82+
- [ServiceDesk Plus](/issue_tracking/pro_integration/integrations_toolreference/#servicedesk-plus)
83+
- [ServiceNow](/issue_tracking/pro_integration/integrations_toolreference/#servicenow)
84+
- [Shortcut](/issue_tracking/pro_integration/integrations_toolreference/#shortcut)
7785

7886
## Error Handling and Debugging
7987

0 commit comments

Comments
 (0)