Skip to content

docs(onprem): safer ddorch certificate handling in the Helm upgrade render - #16303

Merged
Maffooch merged 1 commit into
devfrom
docs/onprem-review-followups
Oct 12, 2026
Merged

Maffooch merged 1 commit into
devfrom
docs/onprem-review-followups

Conversation

@Maffooch

Copy link
Copy Markdown
Contributor

Follow-up to #16301, from a review of the Helm upgrade and install pages it changed.

Fixed

  • Pre-upgrade render (upgrade guide, step 6). The previous text copied the ddorch private key out of a ConfigMap into the working directory, and rendered into /tmp.
    • The step now works in a private directory (mktemp -d, with umask 077).
    • It reads the three certificates back from the release's stored values with helm get values -o json and jq. That works because values passed with --set-file are kept in the release, which I checked against a test release.
    • It checks that each file is non-empty with test -s.
    • For an Argo CD-managed release, or one whose values do not hold the key, it falls back to the chart's own objects. That fallback works on both chart layouts: the key in the <fullname>-orch-certs-configmap ConfigMap, or in a <fullname>-orch-certs Secret. It also covers ddorch.tls.existingSecret, where the key is not copied at all. I tested both the values path and the fallback (ConfigMap and Secret layouts) against test releases.
    • The step ends by deleting the directory, which holds the key and the render.
  • Object and Secret names. These follow the chart's full name, not the release name. The full name is the release name when it contains dojopro, otherwise <release>-dojopro, and tenantPrefix or fullnameOverride change it. The upgrade step and the admin-password section now say so, and show how to list the exact names.
  • Chart source. Step 6 offered the extracted zip as $CHART, then ran helm pull regardless. The pull is now only for the registry path.
  • Wording. Removed the duplicated sentence about the ddorch certificate files. The link labelled "on-premise upgrade notes" now says what it is: the general on-premise upgrade procedure.
  • Install guide notes.
    • The bootstrap-script note no longer names the ConfigMap, so it is right whichever object holds the key.
    • The FIPS note drops a release number that could not be verified.
    • The cosign note names cosign 2.x's --insecure-ignore-tlog=true for networks without internet access. I checked that flag against cosign's own verify-blob reference for 2.0.0 and 2.4.1.

Not changed: translated pages

The translated copies of these pages (de, es, fr, it, ja, pt-br, zh-hans) did not get the #16301 fixes and still carry the older commands. Under docs/TRANSLATIONS.md, English is the source and translations are regenerated from it by the translation pipeline, so this PR does not edit them. The next translation refresh should pick up #16301 and this PR.

Checks

  • npm run build -- --environment development and hugo --minify --gc --config config/production/hugo.toml in docs/: both exit 0 with no warnings or errors.
  • Internal links and anchors on the changed pages resolve against the built site.

🤖 Generated with Claude Code

…ender

- Read the ddorch certificates back from the release's stored values in a
  private mktemp directory (umask 077), with a fallback to the chart's
  objects that works whether the private key is in the ConfigMap or the
  <fullname>-orch-certs Secret, and the ddorch.tls.existingSecret case.
- Name the chart's objects and Secret by its full name, which depends on
  the release name, tenantPrefix and fullnameOverride.
- Pull the chart only when upgrading from the registry, render into the
  private directory, and delete it afterwards.
- Name cosign 2.x's flag for skipping the transparency log, drop an
  unverified version from the FIPS note, word the bootstrap note so it
  holds for either key location, and label the upgrade-procedure link.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@Maffooch
Maffooch requested a review from blakeaowens as a code owner October 10, 2026 18:49
@Maffooch Maffooch added this to the 3.4.100 milestone Oct 10, 2026
@Maffooch Maffooch added the docs label Oct 10, 2026
@Maffooch
Maffooch added this pull request to the merge queue Oct 12, 2026
Merged via the queue into dev with commit e5d5374 Oct 12, 2026
31 checks passed
@Maffooch
Maffooch deleted the docs/onprem-review-followups branch October 12, 2026 16:21
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.

3 participants