docs(enterprise-portal): document namespace prop for HelmInstallAssets - #4331
docs(enterprise-portal): document namespace prop for HelmInstallAssets#4331kriscoleman wants to merge 5 commits into
Conversation
Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
✅ Deploy Preview for replicated-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
✅ Deploy Preview for replicated-docs-upgrade ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
…r name) Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
…ion components Covers HelmInstallAssets, HelmAirgapInstallAssets, and HelmUpdateAssets after the prop was extended to be comprehensive/unified across the Helm commands. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
|
Nits, not blockers:
|
…e no --create-namespace
|
Thanks @xavpaice, both addressed in 3adae71:
|
…behavior
Match the full-stack namespace implementation (vandoor #10306): namespace is an install-time prop on HelmInstallAssets/HelmAirgapInstallAssets only; upgrades auto-target the persisted install namespace (no prop on HelmUpdateAssets); install adds --create-namespace; per-customer namespaces use the {{entitlements.helm_namespace}} template form; invalid values surface a preview error (DNS-1123).
|
Heads-up on merge ordering: this doc now describes the full-stack namespace behavior shipping in vandoor #10306 (namespace as an install-time prop on |
|
|
||
| A customer whose license defines a `helm_namespace` custom field installs into that namespace. A customer without it installs into the default namespace. For more on custom license fields, see [Entitlements](#entitlements). | ||
|
|
||
| Namespace values are validated as DNS-1123 labels, so an invalid value surfaces an error in the portal preview instead of silently installing into the default namespace. |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Replicated.Passive] In general, use active voice instead of passive voice ('is created').


What
Documents a new optional
namespaceprop on the<HelmInstallAssets />component in the Enterprise Portal v2 content reference (docs/vendor/enterprise-portal-v2-content.mdx).When set, the generated Helm install command includes
--namespace <namespace>, so the app installs into that namespace. When omitted, the install uses the default namespace, so existing content is unchanged.Why
Some customers always install into a fixed namespace. Today the generated command uses the default namespace, so those customers have to hand-edit the copied command every time. The
namespaceprop lets vendors bake the right namespace straight into the install page and remove that friction.Examples added
The common case, a single fixed namespace for everyone:
And an extensible version that defaults to
my-namespacebut lets ahelm_namespacecustom license field override it per customer:<HelmInstallAssets namespace={entitlements.helm_namespace || "my-namespace"} />Notes
This pairs with the vandoor code PR that adds the
namespaceprop to<HelmInstallAssets />. The docs shouldn't land ahead of that, so I'm leaving this as a draft until the code side is in.🤖 Generated with Claude Code