Skip to content

docs(onprem): hardware-sizing tuning knobs + deep-link edition routing - #15986

Open
Maffooch wants to merge 2 commits into
bugfixfrom
docs/onprem-sizing-tuning-edition-routing
Open

Maffooch wants to merge 2 commits into
bugfixfrom
docs/onprem-sizing-tuning-edition-routing

Conversation

@Maffooch

@Maffooch Maffooch commented Sep 16, 2026

Copy link
Copy Markdown
Contributor

Shortcut: sc-15512

Two small, independent docs changes on top of the on-prem Pro restructure (#15959), kept as separate commits.

1. Hardware sizing: tuning knobs and their effects

docs/content/get_started/pro/onprem/hardware_sizing.md

Readers asked what to actually turn and what each setting does. This adds:

  • A "what each knob does" table for the application-tier levers (DD_UWSGI_NUM_OF_PROCESSES, DD_UWSGI_NUM_OF_THREADS, DD_CELERY_WORKER_CONCURRENCY, DD_CELERY_WORKER_AUTOSCALE_MAX) with starting points and the effect of raising each.
  • A new "Tuning the database" section for the PostgreSQL settings that matter most for DefectDojo's aggregation-heavy reads: shared_buffers, effective_cache_size, work_mem, maintenance_work_mem, max_connections, with starting points and what each controls.
  • A "Keep the connection budget balanced" subsection tying the two tiers together via (uWSGI processes × threads) + Celery concurrency.

The guidance is grounded in a dojo-compose-cli deployment exercised across finding volumes (300K → 5M): read latency is flat from 300K to 1M (app-CPU bound on concurrent users), then the database becomes the constraint as query cost grows with row count — which is what the existing per-tier DB scaling already accounts for. No table figures changed; this fills the "how do I tune it" gap.

2. Deep links land in the page's own edition

docs/layouts/_partials/head/custom-head.html

The docs have an Open Source / Pro edition toggle keyed off html[data-dd-version], sourced only from localStorage (default opensource). A deep link to a Pro page therefore left a reader in whatever edition they had, so the Pro page rendered with the OS sidebar around it — you were "on a Pro page" without being "in the Pro section."

This stamps data-dd-version from the page's own audience before first paint and persists it: a Pro page switches the reader into Pro (matching sidebar), an Open Source page into OS, and general pages keep the stored preference.

Testing

  • hugo --gc --minify: clean build, no errors.
  • Browser (matching origin): Kubernetes/Compose tabs toggle and sync across groups; new sizing sections and anchors render.
  • Edition routing verified all three ways: OS reader → Pro page flips to Pro; Pro reader → OS page flips to OS; general page keeps the stored edition.

🤖 Generated with Claude Code

Maffooch and others added 2 commits September 16, 2026 13:55
…e sizing

Add a "what each knob does" table for the uWSGI/Celery application-tier
settings, and a new "Tuning the database" section covering the PostgreSQL
settings that matter most for DefectDojo's aggregation-heavy reads
(shared_buffers, effective_cache_size, work_mem, maintenance_work_mem,
max_connections), plus a connection-budget subsection tying the application
tier and database together.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Pages carry an audience (pro/opensource); general pages have none. Stamp
data-dd-version from the page's own audience before first paint and persist
it, so a deep link to a Pro page puts the reader in the Pro section (with the
matching sidebar) instead of leaving them in their stored edition's nav around
Pro content. General pages keep the stored preference.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>

@accesslint accesslint Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Found 5 issues across 5 rules (3 WCAG, 2 Best Practice).

Reviewed by AccessLint, which checks every pull request for accessibility issues.

Comment thread docs/layouts/_partials/head/custom-head.html
@github-actions github-actions Bot added the docs label Sep 16, 2026
@Maffooch
Maffooch enabled auto-merge September 16, 2026 20:28
@Maffooch Maffooch added this to the 3.3.200 milestone Sep 17, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant