Skip to content

Commit 85802f8

Browse files
Update config docs (#98)
Signed-off-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: dependencytrack-bot <106437498+dependencytrack-bot@users.noreply.github.com>
1 parent 1d01485 commit 85802f8

1 file changed

Lines changed: 22 additions & 136 deletions

File tree

docs/reference/configuration/properties.md

Lines changed: 22 additions & 136 deletions
Original file line numberDiff line numberDiff line change
@@ -1692,40 +1692,46 @@ Defines the HTTP write timeout for S3 requests in milliseconds.
16921692

16931693

16941694

1695-
## Task Execution
1695+
## Task Scheduling
16961696

1697-
<span id="dtworkerthreadmultiplier">**`dt.worker.thread.multiplier`** <strong style="color: red">*</strong> [](#dtworkerthreadmultiplier){ .headerlink }</span>
1697+
<span id="dttask-schedulerenabled">**`dt.task-scheduler.enabled`** [](#dttask-schedulerenabled){ .headerlink }</span>
16981698

1699-
Defines a multiplier that is used to calculate the number of threads used by the event subsystem. This property is only used when [`dt.worker.threads`](#dtworkerthreads) is set to 0. A machine with 4 cores and a multiplier of 4, will use (at most) 16 worker threads.
1699+
Defines whether the task scheduler should be enabled. <br/><br/> May be disabled on specific nodes in the cluster to limit the amount of background processing they're doing. Can help with dedicating nodes to only serve web traffic.
17001700

17011701
<table>
1702-
<tr><th>Type</th><td style="border-width: 0"><code>integer</code></td></tr>
1703-
<tr><th>Default</th><td><code>4</code></td></tr>
1704-
<tr><th>ENV</th><td><code>DT_WORKER_THREAD_MULTIPLIER</code></td></tr>
1702+
<tr><th>Type</th><td style="border-width: 0"><code>boolean</code></td></tr>
1703+
<tr><th>Default</th><td><code>true</code></td></tr>
1704+
<tr><th>ENV</th><td><code>DT_TASK_SCHEDULER_ENABLED</code></td></tr>
17051705
</table>
17061706

1707-
<span id="dtworkerthreads">**`dt.worker.threads`** <strong style="color: red">*</strong> [](#dtworkerthreads){ .headerlink }</span>
1707+
<span id="dttask-schedulerpoll-interval-ms">**`dt.task-scheduler.poll-interval-ms`** [](#dttask-schedulerpoll-interval-ms){ .headerlink }</span>
17081708

1709-
Defines the number of worker threads that the event subsystem will consume. Events occur asynchronously and are processed by the Event subsystem. This value should be large enough to handle most production situations without introducing much delay, yet small enough not to pose additional load on an already resource-constrained server. A value of 0 will instruct Alpine to allocate 1 thread per CPU core. This can further be tweaked using the [`dt.worker.thread.multiplier`](#dtworkerthreadmultiplier) property.
1709+
Defines the interval in milliseconds in which the task scheduler polls the database for due tasks.
17101710

17111711
<table>
17121712
<tr><th>Type</th><td style="border-width: 0"><code>integer</code></td></tr>
1713-
<tr><th>Default</th><td><code>0</code></td></tr>
1714-
<tr><th>ENV</th><td><code>DT_WORKER_THREADS</code></td></tr>
1713+
<tr><th>Default</th><td><code>30000</code></td></tr>
1714+
<tr><th>ENV</th><td><code>DT_TASK_SCHEDULER_POLL_INTERVAL_MS</code></td></tr>
17151715
</table>
17161716

1717+
<span id="dttask-schedulershutdown-max-wait-ms">**`dt.task-scheduler.shutdown-max-wait-ms`** [](#dttask-schedulershutdown-max-wait-ms){ .headerlink }</span>
17171718

1719+
Defines how long, in milliseconds, the task scheduler waits for running tasks to complete during shutdown. Tasks still running when this elapses are left in place and picked up by another node once their heartbeat expires.
17181720

1719-
## Task Scheduling
1721+
<table>
1722+
<tr><th>Type</th><td style="border-width: 0"><code>integer</code></td></tr>
1723+
<tr><th>Default</th><td><code>5000</code></td></tr>
1724+
<tr><th>ENV</th><td><code>DT_TASK_SCHEDULER_SHUTDOWN_MAX_WAIT_MS</code></td></tr>
1725+
</table>
17201726

1721-
<span id="dttask-schedulerenabled">**`dt.task-scheduler.enabled`** [](#dttask-schedulerenabled){ .headerlink }</span>
1727+
<span id="dttask-schedulerthreads">**`dt.task-scheduler.threads`** [](#dttask-schedulerthreads){ .headerlink }</span>
17221728

1723-
Defines whether the task scheduler should be enabled. <br/><br/> May be disabled on specific nodes in the cluster to limit the amount of background processing they're doing. Can help with dedicating nodes to only serve web traffic.
1729+
Defines the number of threads the task scheduler uses to execute due tasks. This is the maximum number of scheduled tasks that may run concurrently on a single node. <br/><br/> The scheduled task volume is low, but a few tasks can be long-running, so the value should be large enough to keep one slow task from blocking others. <br/><br/> Note that the grunt of asynchronous work is performed by the dex engine, not by the task scheduler. This is the wrong knob to tweak in most cases.
17241730

17251731
<table>
1726-
<tr><th>Type</th><td style="border-width: 0"><code>boolean</code></td></tr>
1727-
<tr><th>Default</th><td><code>true</code></td></tr>
1728-
<tr><th>ENV</th><td><code>DT_TASK_SCHEDULER_ENABLED</code></td></tr>
1732+
<tr><th>Type</th><td style="border-width: 0"><code>integer</code></td></tr>
1733+
<tr><th>Default</th><td><code>3</code></td></tr>
1734+
<tr><th>ENV</th><td><code>DT_TASK_SCHEDULER_THREADS</code></td></tr>
17291735
</table>
17301736

17311737
<span id="dttaskdefectdojouploadcron">**`dt.task.defect.dojo.upload.cron`** <strong style="color: red">*</strong> [](#dttaskdefectdojouploadcron){ .headerlink }</span>
@@ -1748,26 +1754,6 @@ Cron expression of the EPSS mirroring task.
17481754
<tr><th>ENV</th><td><code>DT_TASK_EPSS_MIRROR_CRON</code></td></tr>
17491755
</table>
17501756

1751-
<span id="dttaskepssmirrorlockmaxduration">**`dt.task.epss.mirror.lock.max.duration`** <strong style="color: red">*</strong> [](#dttaskepssmirrorlockmaxduration){ .headerlink }</span>
1752-
1753-
Maximum duration in ISO 8601 format for which the EPSS mirror task will hold a lock. <br/><br/> The duration should be long enough to cover the task's execution duration.
1754-
1755-
<table>
1756-
<tr><th>Type</th><td style="border-width: 0"><code>duration</code></td></tr>
1757-
<tr><th>Default</th><td><code>PT15M</code></td></tr>
1758-
<tr><th>ENV</th><td><code>DT_TASK_EPSS_MIRROR_LOCK_MAX_DURATION</code></td></tr>
1759-
</table>
1760-
1761-
<span id="dttaskepssmirrorlockminduration">**`dt.task.epss.mirror.lock.min.duration`** <strong style="color: red">*</strong> [](#dttaskepssmirrorlockminduration){ .headerlink }</span>
1762-
1763-
Minimum duration in ISO 8601 format for which the EPSS mirror task will hold a lock. <br/><br/> The duration should be long enough to cover eventual clock skew across API server instances.
1764-
1765-
<table>
1766-
<tr><th>Type</th><td style="border-width: 0"><code>duration</code></td></tr>
1767-
<tr><th>Default</th><td><code>PT1M</code></td></tr>
1768-
<tr><th>ENV</th><td><code>DT_TASK_EPSS_MIRROR_LOCK_MIN_DURATION</code></td></tr>
1769-
</table>
1770-
17711757
<span id="dttaskexpired-session-cleanupcron">**`dt.task.expired-session-cleanup.cron`** <strong style="color: red">*</strong> [](#dttaskexpired-session-cleanupcron){ .headerlink }</span>
17721758

17731759
Cron expression of the expired session cleanup task.
@@ -1798,36 +1784,6 @@ Cron expression of the vulnerability GitHub Advisories mirroring task.
17981784
<tr><th>ENV</th><td><code>DT_TASK_GIT_HUB_ADVISORY_MIRROR_CRON</code></td></tr>
17991785
</table>
18001786

1801-
<span id="dttaskinternalcomponentidentificationcron">**`dt.task.internal.component.identification.cron`** <strong style="color: red">*</strong> [](#dttaskinternalcomponentidentificationcron){ .headerlink }</span>
1802-
1803-
Cron expression of the internal component identification task.
1804-
1805-
<table>
1806-
<tr><th>Type</th><td style="border-width: 0"><code>cron</code></td></tr>
1807-
<tr><th>Default</th><td><code>25 */6 * * *</code></td></tr>
1808-
<tr><th>ENV</th><td><code>DT_TASK_INTERNAL_COMPONENT_IDENTIFICATION_CRON</code></td></tr>
1809-
</table>
1810-
1811-
<span id="dttaskinternalcomponentidentificationlockmaxduration">**`dt.task.internal.component.identification.lock.max.duration`** <strong style="color: red">*</strong> [](#dttaskinternalcomponentidentificationlockmaxduration){ .headerlink }</span>
1812-
1813-
Maximum duration in ISO 8601 format for which the internal component identification task will hold a lock. <br/><br/> The duration should be long enough to cover the task's execution duration.
1814-
1815-
<table>
1816-
<tr><th>Type</th><td style="border-width: 0"><code>duration</code></td></tr>
1817-
<tr><th>Default</th><td><code>PT15M</code></td></tr>
1818-
<tr><th>ENV</th><td><code>DT_TASK_INTERNAL_COMPONENT_IDENTIFICATION_LOCK_MAX_DURATION</code></td></tr>
1819-
</table>
1820-
1821-
<span id="dttaskinternalcomponentidentificationlockminduration">**`dt.task.internal.component.identification.lock.min.duration`** <strong style="color: red">*</strong> [](#dttaskinternalcomponentidentificationlockminduration){ .headerlink }</span>
1822-
1823-
Minimum duration in ISO 8601 format for which the internal component identification task will hold a lock. <br/><br/> The duration should be long enough to cover eventual clock skew across API server instances.
1824-
1825-
<table>
1826-
<tr><th>Type</th><td style="border-width: 0"><code>duration</code></td></tr>
1827-
<tr><th>Default</th><td><code>PT90S</code></td></tr>
1828-
<tr><th>ENV</th><td><code>DT_TASK_INTERNAL_COMPONENT_IDENTIFICATION_LOCK_MIN_DURATION</code></td></tr>
1829-
</table>
1830-
18311787
<span id="dttaskkennasecurityuploadcron">**`dt.task.kenna.security.upload.cron`** <strong style="color: red">*</strong> [](#dttaskkennasecurityuploadcron){ .headerlink }</span>
18321788

18331789
Cron expression of the Kenna Security upload task.
@@ -1848,26 +1804,6 @@ Cron expression of the metrics maintenance task. <br/><br/> The task creates n
18481804
<tr><th>ENV</th><td><code>DT_TASK_METRICS_MAINTENANCE_CRON</code></td></tr>
18491805
</table>
18501806

1851-
<span id="dttaskmetricsmaintenancelockmaxduration">**`dt.task.metrics.maintenance.lock.max.duration`** <strong style="color: red">*</strong> [](#dttaskmetricsmaintenancelockmaxduration){ .headerlink }</span>
1852-
1853-
Maximum duration in ISO 8601 format for which the metrics maintenance task will hold a lock. <br/><br/> The duration should be long enough to cover the task's execution duration.
1854-
1855-
<table>
1856-
<tr><th>Type</th><td style="border-width: 0"><code>duration</code></td></tr>
1857-
<tr><th>Default</th><td><code>PT15M</code></td></tr>
1858-
<tr><th>ENV</th><td><code>DT_TASK_METRICS_MAINTENANCE_LOCK_MAX_DURATION</code></td></tr>
1859-
</table>
1860-
1861-
<span id="dttaskmetricsmaintenancelockminduration">**`dt.task.metrics.maintenance.lock.min.duration`** <strong style="color: red">*</strong> [](#dttaskmetricsmaintenancelockminduration){ .headerlink }</span>
1862-
1863-
Minimum duration in ISO 8601 format for which the metrics maintenance task will hold a lock. <br/><br/> The duration should be long enough to cover eventual clock skew across API server instances.
1864-
1865-
<table>
1866-
<tr><th>Type</th><td style="border-width: 0"><code>duration</code></td></tr>
1867-
<tr><th>Default</th><td><code>PT1M</code></td></tr>
1868-
<tr><th>ENV</th><td><code>DT_TASK_METRICS_MAINTENANCE_LOCK_MIN_DURATION</code></td></tr>
1869-
</table>
1870-
18711807
<span id="dttasknistmirrorcron">**`dt.task.nist.mirror.cron`** <strong style="color: red">*</strong> [](#dttasknistmirrorcron){ .headerlink }</span>
18721808

18731809
Cron expression of the NIST / NVD mirroring task.
@@ -1978,26 +1914,6 @@ Cron expression of the portfolio vulnerability analysis task.
19781914
<tr><th>ENV</th><td><code>DT_TASK_VULNERABILITY_ANALYSIS_CRON</code></td></tr>
19791915
</table>
19801916

1981-
<span id="dttaskvulnerabilityanalysislockmaxduration">**`dt.task.vulnerability.analysis.lock.max.duration`** <strong style="color: red">*</strong> [](#dttaskvulnerabilityanalysislockmaxduration){ .headerlink }</span>
1982-
1983-
Maximum duration in ISO 8601 format for which the portfolio vulnerability analysis task will hold a lock. <br/><br/> The duration should be long enough to cover the task's execution duration.
1984-
1985-
<table>
1986-
<tr><th>Type</th><td style="border-width: 0"><code>duration</code></td></tr>
1987-
<tr><th>Default</th><td><code>PT15M</code></td></tr>
1988-
<tr><th>ENV</th><td><code>DT_TASK_VULNERABILITY_ANALYSIS_LOCK_MAX_DURATION</code></td></tr>
1989-
</table>
1990-
1991-
<span id="dttaskvulnerabilityanalysislockminduration">**`dt.task.vulnerability.analysis.lock.min.duration`** <strong style="color: red">*</strong> [](#dttaskvulnerabilityanalysislockminduration){ .headerlink }</span>
1992-
1993-
Minimum duration in ISO 8601 format for which the portfolio vulnerability analysis task will hold a lock. <br/><br/> The duration should be long enough to cover eventual clock skew across API server instances.
1994-
1995-
<table>
1996-
<tr><th>Type</th><td style="border-width: 0"><code>duration</code></td></tr>
1997-
<tr><th>Default</th><td><code>PT90S</code></td></tr>
1998-
<tr><th>ENV</th><td><code>DT_TASK_VULNERABILITY_ANALYSIS_LOCK_MIN_DURATION</code></td></tr>
1999-
</table>
2000-
20011917
<span id="dttaskvulnerabilitydatabasemaintenancecron">**`dt.task.vulnerability.database.maintenance.cron`** <strong style="color: red">*</strong> [](#dttaskvulnerabilitydatabasemaintenancecron){ .headerlink }</span>
20021918

20031919
Cron expression of the vulnerability database maintenance task. <br/><br/> The task deletes orphaned records from the `VULNERABLESOFTWARE` table.
@@ -2018,36 +1934,6 @@ Cron expression of the vulnerability metrics update task.
20181934
<tr><th>ENV</th><td><code>DT_TASK_VULNERABILITY_METRICS_UPDATE_CRON</code></td></tr>
20191935
</table>
20201936

2021-
<span id="dttaskworkflowmaintenancecron">**`dt.task.workflow.maintenance.cron`** <strong style="color: red">*</strong> [](#dttaskworkflowmaintenancecron){ .headerlink }</span>
2022-
2023-
Cron expression of the workflow maintenance task. <br/><br/> The task: <ul> <li>Transitions workflow steps from <code>PENDING</code> to <code>TIMED_OUT</code> state</li> <li>Transitions workflow steps from <code>TIMED_OUT</code> to <code>FAILED</code> state</li> <li>Transitions children of <code>FAILED</code> steps to <code>CANCELLED</code> state</li> <li>Deletes finished workflows according to the configured retention duration</li> </ul>
2024-
2025-
<table>
2026-
<tr><th>Type</th><td style="border-width: 0"><code>cron</code></td></tr>
2027-
<tr><th>Default</th><td><code>*/15 * * * *</code></td></tr>
2028-
<tr><th>ENV</th><td><code>DT_TASK_WORKFLOW_MAINTENANCE_CRON</code></td></tr>
2029-
</table>
2030-
2031-
<span id="dttaskworkflowmaintenancelockmaxduration">**`dt.task.workflow.maintenance.lock.max.duration`** <strong style="color: red">*</strong> [](#dttaskworkflowmaintenancelockmaxduration){ .headerlink }</span>
2032-
2033-
Maximum duration in ISO 8601 format for which the workflow maintenance task will hold a lock. <br/><br/> The duration should be long enough to cover the task's execution duration.
2034-
2035-
<table>
2036-
<tr><th>Type</th><td style="border-width: 0"><code>duration</code></td></tr>
2037-
<tr><th>Default</th><td><code>PT5M</code></td></tr>
2038-
<tr><th>ENV</th><td><code>DT_TASK_WORKFLOW_MAINTENANCE_LOCK_MAX_DURATION</code></td></tr>
2039-
</table>
2040-
2041-
<span id="dttaskworkflowmaintenancelockminduration">**`dt.task.workflow.maintenance.lock.min.duration`** <strong style="color: red">*</strong> [](#dttaskworkflowmaintenancelockminduration){ .headerlink }</span>
2042-
2043-
Minimum duration in ISO 8601 format for which the workflow maintenance task will hold a lock. <br/><br/> The duration should be long enough to cover eventual clock skew across API server instances.
2044-
2045-
<table>
2046-
<tr><th>Type</th><td style="border-width: 0"><code>duration</code></td></tr>
2047-
<tr><th>Default</th><td><code>PT1M</code></td></tr>
2048-
<tr><th>ENV</th><td><code>DT_TASK_WORKFLOW_MAINTENANCE_LOCK_MIN_DURATION</code></td></tr>
2049-
</table>
2050-
20511937

20521938

20531939
## Vulnerability Analysis

0 commit comments

Comments
 (0)