Skip to content

docs(enterprise-portal): document namespace prop for HelmInstallAssets - #4331

Open
kriscoleman wants to merge 5 commits into
mainfrom
docs/helm-install-assets-namespace
Open

docs(enterprise-portal): document namespace prop for HelmInstallAssets#4331
kriscoleman wants to merge 5 commits into
mainfrom
docs/helm-install-assets-namespace

Conversation

@kriscoleman

@kriscoleman kriscoleman commented Aug 3, 2026

Copy link
Copy Markdown
Member

What

Documents a new optional namespace prop 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 namespace prop 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:

<HelmInstallAssets namespace="my-namespace" />

And an extensible version that defaults to my-namespace but lets a helm_namespace custom license field override it per customer:

<HelmInstallAssets namespace={entitlements.helm_namespace || "my-namespace"} />

Notes

This pairs with the vandoor code PR that adds the namespace prop 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

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

netlify Bot commented Aug 3, 2026

Copy link
Copy Markdown

Deploy Preview for replicated-docs ready!

Name Link
🔨 Latest commit a67ecc5
🔍 Latest deploy log https://app.netlify.com/projects/replicated-docs/deploys/6a751012b956500007875ddb
😎 Deploy Preview https://deploy-preview-4331--replicated-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
🤖 Make changes Run an agent on this branch

To edit notification comments on pull requests, go to your Netlify project configuration.

@netlify

netlify Bot commented Aug 3, 2026

Copy link
Copy Markdown

Deploy Preview for replicated-docs-upgrade ready!

Name Link
🔨 Latest commit a67ecc5
🔍 Latest deploy log https://app.netlify.com/projects/replicated-docs-upgrade/deploys/6a75101387b0ef0009e0340d
😎 Deploy Preview https://deploy-preview-4331--replicated-docs-upgrade.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
🤖 Make changes Run an agent on this branch

To edit notification comments on pull requests, go to your Netlify project configuration.

@github-actions github-actions Bot added type::docs Improvements or additions to documentation type::feature labels Aug 3, 2026
Comment thread docs/vendor/enterprise-portal-v2-content.mdx Outdated
Comment thread docs/vendor/enterprise-portal-v2-content.mdx Outdated
…r name)

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@kriscoleman
kriscoleman marked this pull request as ready for review August 4, 2026 01:27
@kriscoleman
kriscoleman requested a review from a team as a code owner August 4, 2026 01:27
@kriscoleman

kriscoleman commented Aug 4, 2026

Copy link
Copy Markdown
Member Author

UAT:
image
image

…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>
Comment thread docs/vendor/enterprise-portal-v2-content.mdx Outdated
Comment thread docs/vendor/enterprise-portal-v2-content.mdx Outdated
@xavpaice

xavpaice commented Aug 4, 2026

Copy link
Copy Markdown
Member

Nits, not blockers:

  • the description inline for the options is substantially more detailed than other options, can we narrow that down to the essential text given that it is explained properly in its own section?
  • there's no --create-namespace, which is fine, but we should probably mention that in the docs

@kriscoleman

Copy link
Copy Markdown
Member Author

Thanks @xavpaice, both addressed in 3adae71:

  • Trimmed the inline namespace descriptions on all three Helm components down to match the charts/exclude style, since the detail already lives in the "Installing into a specific namespace" section. As a bonus this clears the vale semicolon/sentence-length nits too, since those were flagging those same sentences.
  • Added a note in that section that the generated commands do not include --create-namespace, so the target namespace needs to exist first.

xavpaice
xavpaice previously approved these changes Aug 6, 2026
…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).
@kriscoleman

Copy link
Copy Markdown
Member Author

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 HelmInstallAssets/HelmAirgapInstallAssets, upgrades auto-targeting the persisted install namespace, --create-namespace on install, {{entitlements.helm_namespace}} for per-customer, DNS-1123 validation in preview). So this should merge with or after #10306, not before — otherwise the docs describe behavior that is not live yet. #10306 is CI-green and review-ready.


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.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

📝 [vale] reported by reviewdog 🐶
[Replicated.Passive] In general, use active voice instead of passive voice ('is created').

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

type::docs Improvements or additions to documentation type::feature

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants