Skip to content

Commit 5acd5f5

Browse files
Maffoochclaude
andcommitted
docs: move deduplication_execution_mode upgrade note to 3.1
The feature now ships in 3.1.0, not 2.60. Revert 2.60.md to its "no special instructions" state and fold the deduplication execution mode section into 3.1.md. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
1 parent 0533fe7 commit 5acd5f5

2 files changed

Lines changed: 43 additions & 42 deletions

File tree

docs/content/en/open_source/upgrading/2.60.md

Lines changed: 2 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -2,45 +2,6 @@
22
title: 'Upgrading to DefectDojo Version 2.60.x'
33
toc_hide: true
44
weight: -20260601
5-
description: New deduplication execution mode for import/reimport.
5+
description: No special instructions.
66
---
7-
8-
## Deduplication execution mode for import/reimport
9-
10-
This release adds a new `deduplication_execution_mode` setting that controls how
11-
import/reimport deduplication post-processing is dispatched and whether the API
12-
response waits for it. It can be set per user (profile) and overridden per request
13-
on the import and reimport endpoints.
14-
15-
Modes:
16-
17-
- `async` (default): deduplication and the rest of post-processing are dispatched
18-
to the background and the response returns immediately. This is the historical
19-
behavior; nothing changes for existing users.
20-
- `async_wait`: post-processing is still dispatched to the background, but the
21-
request waits for deduplication to finish before responding. As a result the
22-
`scan_added` notification and the statistics in the import/reimport response
23-
reflect the deduplicated state (findings that turned out to be duplicates are
24-
no longer counted/listed as new). JIRA push, product grading and other
25-
non-deduplication tasks remain asynchronous and are not awaited.
26-
- `sync`: import deduplication runs inline in the web request.
27-
28-
The wait in `async_wait` is bounded by the new `DD_DEDUPLICATION_ASYNC_WAIT_TIMEOUT`
29-
environment variable (default `60` seconds). If no worker picks up the work within
30-
the timeout, the request responds anyway (degrading to the `async` outcome) rather
31-
than hanging.
32-
33-
The import/reimport response now also includes a `deduplication_complete` boolean
34-
indicating whether deduplication had finished by the time the response was produced.
35-
36-
### Relationship to `block_execution`
37-
38-
The existing `block_execution` profile flag is unchanged. It remains the global
39-
switch that forces **all** of a user's asynchronous tasks (notifications, JIRA
40-
push, product grading, deduplication, ...) to run in the foreground.
41-
`deduplication_execution_mode` is independent and narrower — it only affects
42-
import/reimport deduplication post-processing. A user who has `block_execution`
43-
enabled continues to get fully synchronous imports; the upgrade migration seeds
44-
their `deduplication_execution_mode` to `sync` so behavior is unchanged.
45-
46-
No action is required to upgrade. Check the [Release Notes](https://github.com/DefectDojo/django-DefectDojo/releases/tag/2.60.0) for the contents of the release.
7+
There are no special instructions for upgrading to 2.60.x. Check the [Release Notes](https://github.com/DefectDojo/django-DefectDojo/releases/tag/2.60.0) for the contents of the release.

docs/content/en/open_source/upgrading/3.1.md

Lines changed: 41 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,50 @@
22
title: 'Upgrading to DefectDojo Version 3.1.x'
33
toc_hide: true
44
weight: -20260615
5-
description: New optional setting DD_OS_MESSAGE_ENABLED to control the open-source promo banner.
5+
description: New optional setting DD_OS_MESSAGE_ENABLED to control the open-source promo banner, and a new deduplication execution mode for import/reimport.
66
---
77
There are no breaking changes when upgrading to 3.1.x. Check the [Release Notes](https://github.com/DefectDojo/django-DefectDojo/releases/tag/3.1.0) for the contents of the release.
88

99
### New setting: `DD_OS_MESSAGE_ENABLED`
1010

1111
This release adds the `DD_OS_MESSAGE_ENABLED` setting (default `True`), which controls the open-source promotional ("Upgrade to Pro") banner. The default preserves the existing behavior. Set `DD_OS_MESSAGE_ENABLED=False` to hide the banner; when disabled, DefectDojo skips the outbound request that fetches the message.
12+
13+
## Deduplication execution mode for import/reimport
14+
15+
This release adds a new `deduplication_execution_mode` setting that controls how
16+
import/reimport deduplication post-processing is dispatched and whether the API
17+
response waits for it. It can be set per user (profile) and overridden per request
18+
on the import and reimport endpoints.
19+
20+
Modes:
21+
22+
- `async` (default): deduplication and the rest of post-processing are dispatched
23+
to the background and the response returns immediately. This is the historical
24+
behavior; nothing changes for existing users.
25+
- `async_wait`: post-processing is still dispatched to the background, but the
26+
request waits for deduplication to finish before responding. As a result the
27+
`scan_added` notification and the statistics in the import/reimport response
28+
reflect the deduplicated state (findings that turned out to be duplicates are
29+
no longer counted/listed as new). JIRA push, product grading and other
30+
non-deduplication tasks remain asynchronous and are not awaited.
31+
- `sync`: import deduplication runs inline in the web request.
32+
33+
The wait in `async_wait` is bounded by the new `DD_DEDUPLICATION_ASYNC_WAIT_TIMEOUT`
34+
environment variable (default `60` seconds). If no worker picks up the work within
35+
the timeout, the request responds anyway (degrading to the `async` outcome) rather
36+
than hanging.
37+
38+
The import/reimport response now also includes a `deduplication_complete` boolean
39+
indicating whether deduplication had finished by the time the response was produced.
40+
41+
### Relationship to `block_execution`
42+
43+
The existing `block_execution` profile flag is unchanged. It remains the global
44+
switch that forces **all** of a user's asynchronous tasks (notifications, JIRA
45+
push, product grading, deduplication, ...) to run in the foreground.
46+
`deduplication_execution_mode` is independent and narrower — it only affects
47+
import/reimport deduplication post-processing. A user who has `block_execution`
48+
enabled continues to get fully synchronous imports; the upgrade migration seeds
49+
their `deduplication_execution_mode` to `sync` so behavior is unchanged.
50+
51+
No action is required to upgrade.

0 commit comments

Comments
 (0)