docs(onprem): add the dojo-helm-cli guide to the Kubernetes section - #16094
Merged
Merged
Conversation
dojo-helm-cli shipped with no published docs. Compose customers get a full page for dojo-compose-cli; Helm customers had the chart guides and nothing on the tool that pulls the chart for them. The new page sits under Kubernetes (Helm) next to the installation guide. It covers registry auth, deploy and its platform bootstrap scripts, preflight, download-artifacts for air-gapped staging, diag, and update-binary, and links into the installation guide rather than repeating it. Flags and defaults come from the 4.0.0 binary's --help output, and the per-platform requirements and DOJO_* variables come from the bootstrap scripts it embeds. The README was not the source. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
paulOsinski
approved these changes
Sep 25, 2026
blakeaowens
approved these changes
Sep 25, 2026
Maffooch
approved these changes
Sep 25, 2026
devGregA
approved these changes
Sep 25, 2026
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
5 participants
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.
Description
dojo-helm-cli is out and has no docs. Compose customers get a full page for dojo-compose-cli. Helm customers had the chart guides and nothing on the tool that actually pulls the chart for them. This fills that gap.
The new page is
get_started/pro/onprem/kubernetes/installing_with_dojo_helm_cli.md, under Kubernetes (Helm), sitting just after the installation guide. It covers:register, and when you actually need itdeploy: the four platforms, what each expects to exist already, the flags, and theDOJO_*variables the bootstrap scripts read. It also points out that leaving the database unset gets you an embedded PostgreSQL.deploy statusanddeploy uninstall, and what uninstall leaves behindpreflightand its four checksdownload-artifactsfor air-gapped staging, then pushing the images to a private registrydiag, its collectors and redactionupdate-binaryand the update noticeIt links into the installation guide (ddorch database, Verify, Uninstalling, Private Registry) rather than repeating it. The section's
_index.mdgets one extra clause mentioning the CLI.One thing reviewers may trip over:
diagdefaults to thedefectdojonamespace, butdeployinstalls intodojopro. The page tells readers to pass--namespacetodiag. The mismatch is in the CLI itself and will be fixed there separately.Test results
Docs only. Flags and defaults were taken from the 4.0.0 binary's
--helpoutput, not the README. Platform requirements and variables come from the bootstrap scripts that release embeds. A localhugobuild succeeds: the page appears in the Kubernetes section nav, and all five anchor links into the installation guide resolve.Documentation
This is the documentation. English only, same as the Compose guide.
🤖 Generated with Claude Code