Repository navigation
docs(onprem): fix self-hosted install and upgrade pages from a clean 3.4.0 install - #16301
Merged
Merged
Conversation
…4.0 install - Keep the license's registry key (container_token) out of terminal output, and explain what it is. - Log in to the chart registry without switching the active gcloud account. - Correct the chart-managed Secret name, the required key count, the log-verbosity and pre-upgrade render commands, and the pod lists. - Use one name for the chart bundle, add a signature check that matches what each release publishes, and fix the runbook's cosign command. - Use the working light health check instead of /login/. - Compose: container list and internal port bindings for current releases, wizard defaults, sudo on root commands, an OS update step, the real name of the standalone backup utility, and a working upload-size command. - Provider-neutral prerequisites, consistent connectors-secret instructions, current version examples, the bootstrap script path, and the changelog link in place of a release page readers cannot open. - Move Sandbox Mode out from under the Kubernetes section in the sidebar. - Render mailto links as plain anchors so the minifier no longer glues the next word onto the address. - Relabel and copy slips on the FIPS, sizing and About pages; the About page links the self-hosted install; the changelog intro covers self-hosted releases. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
1 task done
blakeaowens
approved these changes
Oct 10, 2026
devGregA
approved these changes
Oct 10, 2026
- Check the release signing key's fingerprint before trusting it, say where to get the key, and explain gpg's "not certified" warning. - Note that cosign's transparency-log lookup needs internet access. - Point to the bootstrap scripts where the extracted bundle has them. - Show how to copy the ddorch certificates out of the release's ConfigMap for the pre-upgrade render. - Name the chart Secret for other release names, link the on-prem upgrade page, and say "database server" instead of "RDS instance". - Mark the two Helm pages as carrying hand edits pending a chart sync. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
5 tasks done
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
We ran a clean, docs-only install of DefectDojo Pro 3.4.0 and kept a list of everything in the self-hosted pages that was wrong, stale or failed as written. This PR fixes each item still present on
dev. Each one was checked against the page first, then against the current chart, compose files and CLI.Fixed
jqcommand printed the whole payload,container_tokenincluded. It now drops that field. The page explains thatcontainer_tokenis the registry key (a base64 Google Cloud service-account key), and shows how to pipe it intodocker login/helm registry loginwith--password-stdinwithout printing it.--password-stdin, without touchinggcloud. Option B (gcloud auth login) now warns that it changes the active account and shows how to switch back.dojopro), notdojopro-defectdojo. Checked withhelm templateagainst chart 3.4.0.helm upgradeleft out the ddorch certificates, so it failed withddorch.tls.rootCa is required. It now uses--reuse-values, checked against a 3.4.0 release on a local cluster.helm templatewas missing the same three--set-fileflags, and mixed$CHART_REFwith$CHART.KEY=VALUEform that the CLI rejects. It now uses--key/--value.9142and9871are bound to127.0.0.1from 3.3.300 on. The page used to say they were published on every interface.head -n 9on output that is not in a fixed order. It now filters for the two keys by name.DD_CONNECTORS_SHARED_SECRETtakes the same value asCLOUD_PORTAL_SECRET_KEY. With inline values, leave it empty and the chart fills in that value./login/returns 404. The upgrade check now uses/api/v2/health_check/light/, which needs no login and returns 200.3.4.0or placeholders. The Known Issues heading is no longer pinned to 2.57.1; its intro says which chart the issues were confirmed on.helm-chart-<version>.zipand the upgrade page useddojo-pro-helm-bundled-<version>.zip; both now use the second name. Each release does publish a detached GPG signature and the public key, plus a cosign signature for the chart package, so the install guide gains a short "Verify the Bundle Signature" section. The bundle carries its own copy of the signing key, so the section first checks the key's fingerprint (69D5 A6D7 01E6 6415 03F2 8E9B 2227 78D8 18CC 8FAB) and says to get the key from support or from a bundle already verified. It explains gpg's "not certified" warning, and notes that cosign's transparency-log lookup needs internet access. The migration runbook's cosign command pointed at a.zip.sigthat is not published; it now verifies the chart.tgz.bootstrap/bootstrap-aws-eks.shandbootstrap/bootstrap-gcp-gke.shin the extracted bundle, which is where operators have them.brew install awscli ... eksctlplus an AWS identity check. It is now a platform-neutral list, with per-platform extras. The pre-install checklist no longer assumes RDS and ElastiCache.sudo. Root commands on the Compose install, upgrade, sizing, FIPS, storage and upload-size pages now usesudoorsudo -E. The air-gapped install page is unchanged on purpose: it adds the operator to thedockeranddojosrvgroups during setup, says the remaining CLI commands then run withoutsudo, and usessudoonly for file operations under/optand/etc. That page is consistent with itself.dojo-db-backupis not the tool's name. The standalone utility isdojo-backup, anddojo-compose-cli2.1.5 has no backup command of its own.-copy_extensions(reproduced).$NAMESPACEbefore using it.*andhttp://localhost) and says to replace them.<release>-orch-certs-configmapif you no longer have the files.dojoprofor this guide's release name, or<release>-dojoprofor a release name that does not containdojopro.<script>/<noscript>pair, and the minifier dropped the space after it. A project-levelrender-link.htmlnow renders mailto links as plain anchors, the way the site footer already does. This turns off the theme's script-based address obfuscation for every mailto link on the site, roughly 280 links. That is acceptable because they all point to role addresses (support@, hello@ and info@defectdojo.com), and support@ already appears as a plain link in every page's footer.Already fixed on
devLeft alone
installing_on_kubernetes.mdandupgrading_on_kubernetes.mdare generated from the Helm chart's own guides. Their header comment now says this copy carries hand edits pending a sync. The same fixes are open against the chart's source guides in chart repository PR 244.Checks
npm ci && npm run build -- --environment developmentindocs/: exit 0, no warnings or errors.hugo --minify --gc --config config/production/hugo.tomlindocs/: exit 0, no warnings or errors.🤖 Generated with Claude Code