Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 19 additions & 3 deletions docs/vendor/enterprise-portal-v2-content.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -351,13 +351,13 @@ Props: `installType` (`"linux"` or `"helm"`).

**`<LinuxInstallAssets />`**: Renders the full Linux/Embedded Cluster installation command sequence. Adapts to the customer's selected version and network availability. For air gap installations, includes an optional toggle for private registry image relocation. When enabled, the customer enters their registry hostname and the commands update to include image pull, tag, and push steps targeting that registry. Props: `stepNumber` (optional, starting step number).

**`<HelmInstallAssets />`**: Renders the full Helm installation command sequence. Props: `stepNumber` (optional), `charts` (optional, comma-separated list of chart names to include), `exclude` (optional, comma-separated list of chart names to hide).
**`<HelmInstallAssets />`**: Renders the full Helm installation command sequence. Props: `stepNumber` (optional), `charts` (optional, comma-separated list of chart names to include), `exclude` (optional, comma-separated list of chart names to hide), `namespace` (optional, string; when set, the generated install command includes `--namespace <namespace>` so the app installs into that namespace. When omitted, the install uses the default namespace).
Comment thread
kriscoleman marked this conversation as resolved.
Comment thread
kriscoleman marked this conversation as resolved.

When a customer selects limited or no registry access, `<HelmInstallAssets />` automatically includes browser download links for the Helm chart tarballs needed for their install. A download link for the preflight plugin binary is always included, regardless of registry access settings. No additional configuration is required.

**`<LinuxAirgapInstallAssets />`**: Linux air gap installation commands. Shows an unavailable notice if the air gap bundle is not yet built. Props: `stepNumber`.

**`<HelmAirgapInstallAssets />`**: Helm air gap installation commands. Props: `stepNumber`, `registryAvailability`, `charts` (optional), `exclude` (optional).
**`<HelmAirgapInstallAssets />`**: Helm air gap installation commands. Props: `stepNumber`, `registryAvailability`, `charts` (optional), `exclude` (optional), `namespace` (optional, string; when set, the generated install command includes `--namespace <namespace>` so the app installs into that namespace. When omitted, the install uses the default namespace).
Comment thread
kriscoleman marked this conversation as resolved.

When a customer selects limited or no registry access, `<HelmAirgapInstallAssets />` automatically includes browser download links for Helm chart tarballs. These links are also shown in the update flow for customers in the same registry mode.

Expand Down Expand Up @@ -395,6 +395,22 @@ For applications with multiple Helm charts, you can control which charts appear

The `charts` and `exclude` props accept comma-separated chart names. Use `charts` to include only the listed charts, or `exclude` to show all charts except the listed ones.

#### Installing into a specific namespace

By default, the Helm instruction components generate commands that use the default namespace. If your application always installs into a fixed namespace, set the `namespace` prop on `<HelmInstallAssets />`, `<HelmAirgapInstallAssets />`, or `<HelmUpdateAssets />` to add `--namespace <namespace>` to the generated install and upgrade commands:

```markdown
<HelmInstallAssets namespace="my-namespace" />
```

To set a default namespace while letting individual customers override it, reference a custom license field with a fallback:

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

This installs into `my-namespace` for most customers, but a customer whose license defines a `helm_namespace` custom field installs into that namespace instead. For more on custom license fields, see [Entitlements](#entitlements).

**`<InstallStep>`**: Wraps content in a numbered step container.

```markdown
Expand Down Expand Up @@ -449,7 +465,7 @@ The download components gate themselves on the same entitlements, so a customer

**`<LinuxUpdateAssets />`**: Renders Linux/Embedded Cluster upgrade instructions for the customer's current instance. For air gap upgrades, includes a registry hostname input for image relocation when the customer uses a private registry. Props: `stepNumber`.

**`<HelmUpdateAssets />`**: Renders Helm upgrade instructions. Props: `stepNumber`, `charts` (optional), `exclude` (optional).
**`<HelmUpdateAssets />`**: Renders Helm upgrade instructions. Props: `stepNumber`, `charts` (optional), `exclude` (optional), `namespace` (optional, string; when set, the generated upgrade command includes `--namespace <namespace>` so the upgrade targets that namespace. When omitted, the upgrade uses the default namespace).
Comment thread
kriscoleman marked this conversation as resolved.

**`<UpgradePath>`**: Conditionally shows content based on the customer's current version. Lets you show different upgrade instructions depending on which version the customer is upgrading *from*.

Expand Down