Skip to content
Closed
2 changes: 1 addition & 1 deletion docs/about/release-notes/current-release.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -181,7 +181,7 @@ See [Setup](/documentation/get-started) for prerequisites and provider
configuration.

For self-managed Kubernetes, start with

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

@glody should this change to remove self managed or leave it as is?

[Install NeMo Platform Helm Chart](/documentation/self-managed-deployment/setup/helm/install).
[Install NeMo Platform Helm Chart](/documentation/kubernetes-deployment/setup/helm/install).

## Upgrade from v0.3.x

Expand Down
2 changes: 1 addition & 1 deletion docs/about/release-notes/release-0-3-0.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ See [Setup](/documentation/get-started) for prerequisites and provider
configuration.

For self-managed Kubernetes, start with
[Install NeMo Platform Helm Chart](/documentation/self-managed-deployment/setup/helm/install).
[Install NeMo Platform Helm Chart](/documentation/kubernetes-deployment/setup/helm/install).

## Upgrade from v0.2.x

Expand Down
2 changes: 1 addition & 1 deletion docs/customizer/grpo-training.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -454,7 +454,7 @@ GRPO fails at submit, before any GPU is claimed, unless the platform operator ha

If a submit fails on either of the first two, that is a platform configuration gap, not a problem with your package. Neither is settable per job.

Installing OpenSandbox is a separate operator task: [OpenSandbox](/documentation/self-managed-deployment/setup/helm/opensandbox), or [OpenSandbox with Kata](/documentation/self-managed-deployment/setup/helm/opensandbox-kata) for the Kata runtime.
Installing OpenSandbox is a separate operator task: [OpenSandbox](/documentation/kubernetes-deployment/setup/helm/opensandbox), or [OpenSandbox with Kata](/documentation/kubernetes-deployment/setup/helm/opensandbox-kata) for the Kata runtime.

## Next Steps

Expand Down
4 changes: 2 additions & 2 deletions docs/customizer/tutorials/grpo-environment-packages.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Do not put `.jsonl` in the environment package. If a Gym config lists `datasets[
Before packaging an environment, ensure you have:

1. **A NeMo Platform configured with `platform.runtime: kubernetes`** — GRPO provisions a Ray cluster and has no local Docker fallback
2. **Sandboxed Gym enabled on the cluster** by your platform operator (`sandbox_cluster_capable` and a job-storage PVC claim). Refer to [Cluster prerequisites](/documentation/customizer-reference/grpo-and-reward-environments#cluster-prerequisites); installing OpenSandbox is covered in [OpenSandbox](/documentation/self-managed-deployment/setup/helm/opensandbox)
2. **Sandboxed Gym enabled on the cluster** by your platform operator (`sandbox_cluster_capable` and a job-storage PVC claim). Refer to [Cluster prerequisites](/documentation/customizer-reference/grpo-and-reward-environments#cluster-prerequisites); installing OpenSandbox is covered in [OpenSandbox](/documentation/kubernetes-deployment/setup/helm/opensandbox)
3. **The `nemo` CLI on your `PATH`**, or a source checkout where `uv run --package nmp-rl` resolves
4. **The training image tag** your cluster runs — vendoring a wheel closure requires the `nemo-gym`, `ray`, and `openai` versions it reports
5. **A machine with internet access** for the packaging step. Training clusters consume uploaded FileSets only. For details on which environment type require internet access too, see details below.
Expand Down Expand Up @@ -430,7 +430,7 @@ nemo files upload ./weather-env/ weather-env --workspace default
nemo files list weather-env --workspace default
```

Job JSON: [GRPO and Reward Environments](/documentation/customizer-reference/grpo-and-reward-environments#submit-the-job). Sandboxed Gym is configured on the platform (`NMP_RL_SANDBOXED_GYM_DEFAULT`), not in the job payload. Cluster setup: [OpenSandbox](/documentation/self-managed-deployment/setup/helm/opensandbox).
Job JSON: [GRPO and Reward Environments](/documentation/customizer-reference/grpo-and-reward-environments#submit-the-job). Sandboxed Gym is configured on the platform (`NMP_RL_SANDBOXED_GYM_DEFAULT`), not in the job payload. Cluster setup: [OpenSandbox](/documentation/kubernetes-deployment/setup/helm/opensandbox).

## Next Steps

Expand Down
9 changes: 9 additions & 0 deletions docs/fern/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -36,3 +36,12 @@ redirects:
# Sphinx page URLs (foo.html); must follow all :path*/index.html rules above
- source: "/:path*.html"
destination: "/:path*"
# NV 6722623: published hrefs still use the old self-managed-deployment nav slug.
- source: "/documentation/self-managed-deployment/helm"
destination: "/documentation/kubernetes-deployment/setup/helm"
- source: "/latest/documentation/self-managed-deployment/helm"
destination: "/latest/documentation/kubernetes-deployment/setup/helm"
- source: "/documentation/self-managed-deployment/:path*"
destination: "/documentation/kubernetes-deployment/:path*"
- source: "/latest/documentation/self-managed-deployment/:path*"
destination: "/latest/documentation/kubernetes-deployment/:path*"
4 changes: 2 additions & 2 deletions docs/set-up/helm/file-storage.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ If using S3 storage, you must provision and manage your own bucket and credentia

## Local Storage (Default)

By default, the Files service uses local filesystem storage. Files are stored on the shared PVC configured in [Persistent Volumes](/documentation/self-managed-deployment/setup/helm/persistent-volumes).
By default, the Files service uses local filesystem storage. Files are stored on the shared PVC configured in [Persistent Volumes](/documentation/kubernetes-deployment/setup/helm/persistent-volumes).

The default configuration is equivalent to:

Expand All @@ -34,7 +34,7 @@ platformConfig:
path: /vol/files
```

You do not need to add this to your `values.yaml`. Once the PVC is set up as described in [Persistent Volumes](/documentation/self-managed-deployment/setup/helm/persistent-volumes), local storage works out of the box.
You do not need to add this to your `values.yaml`. Once the PVC is set up as described in [Persistent Volumes](/documentation/kubernetes-deployment/setup/helm/persistent-volumes), local storage works out of the box.

## S3 Object Storage

Expand Down
28 changes: 14 additions & 14 deletions docs/set-up/helm/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,95 +9,95 @@ description: ""

NeMo Platform is bundled in an all-in-one Helm chart for self-managed Kubernetes deployments. Use these guides to deploy the platform on local clusters such as minikube and kind, managed clusters such as EKS, AKS, GKE, and OKE, or on-prem Kubernetes.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

same question here


Start with [Prerequisites](/documentation/self-managed-deployment/setup/helm/prerequisites), then follow [Install](/documentation/self-managed-deployment/setup/helm/install). The install guide pins the chart with `NMP_HELM_CHART_VERSION` and uses the `nvidia/nemo-platform` NGC org for chart and image access.
Start with [Prerequisites](/documentation/kubernetes-deployment/setup/helm/prerequisites), then follow [Install](/documentation/kubernetes-deployment/setup/helm/install). The install guide pins the chart with `NMP_HELM_CHART_VERSION` and uses the `nvidia/nemo-platform` NGC org for chart and image access.

<Cards>

<Card title="Prerequisites" href="/documentation/self-managed-deployment/setup/helm/prerequisites">
<Card title="Prerequisites" href="/documentation/kubernetes-deployment/setup/helm/prerequisites">

Review the prerequisites for installing the NeMo Platform Helm Chart.

<small><span class="md-tag">cluster-admin</span></small>

</Card>
<Card title="Install" href="/documentation/self-managed-deployment/setup/helm/install">
<Card title="Install" href="/documentation/kubernetes-deployment/setup/helm/install">

Install the NeMo Platform using the Helm chart.

<small><span class="md-tag">cluster-admin</span> <span class="md-tag">on-prem</span> <span class="md-tag">cloud</span></small>

</Card>
<Card title="NetworkPolicy Smoke Test" href="/documentation/self-managed-deployment/setup/helm/network-policy-smoke-test">
<Card title="NetworkPolicy Smoke Test" href="/documentation/kubernetes-deployment/setup/helm/network-policy-smoke-test">

Verify Helm NetworkPolicies on a local Kind cluster with Calico and Chainsaw.

<small><span class="md-tag">cluster-admin</span> <span class="md-tag">kind</span> <span class="md-tag">networking</span></small>

</Card>
<Card title="Database Setup" href="/documentation/self-managed-deployment/setup/helm/database-setup">
<Card title="Database Setup" href="/documentation/kubernetes-deployment/setup/helm/database-setup">

Set up an external database for the NeMo Platform.

<small><span class="md-tag">cluster-admin</span> <span class="md-tag">on-prem</span> <span class="md-tag">cloud</span></small>

</Card>
<Card title="Ingress" href="/documentation/self-managed-deployment/setup/helm/ingress">
<Card title="Ingress" href="/documentation/kubernetes-deployment/setup/helm/ingress">

Set up Ingress for the NeMo Platform.

<small><span class="md-tag">cluster-admin</span> <span class="md-tag">on-prem</span> <span class="md-tag">cloud</span></small>

</Card>
<Card title="Persistent Volumes" href="/documentation/self-managed-deployment/setup/helm/persistent-volumes">
<Card title="Persistent Volumes" href="/documentation/kubernetes-deployment/setup/helm/persistent-volumes">

Set up persistent volumes for the NeMo Platform.

<small><span class="md-tag">cluster-admin</span> <span class="md-tag">on-prem</span> <span class="md-tag">cloud</span></small>

</Card>
<Card title="File Storage" href="/documentation/self-managed-deployment/setup/helm/file-storage">
<Card title="File Storage" href="/documentation/kubernetes-deployment/setup/helm/file-storage">

Configure storage options for the Files service.

<small><span class="md-tag">cluster-admin</span> <span class="md-tag">on-prem</span> <span class="md-tag">cloud</span></small>

</Card>
<Card title="Multinode Networking" href="/documentation/self-managed-deployment/setup/helm/multinode-networking">
<Card title="Multinode Networking" href="/documentation/kubernetes-deployment/setup/helm/multinode-networking">

Configure high-performance east-west networking (EFA, InfiniBand, TCP-XO, SR-IOV) for multi-node training.

<small><span class="md-tag">cluster-admin</span> <span class="md-tag">cloud</span></small>

</Card>
<Card title="Volcano" href="/documentation/self-managed-deployment/setup/helm/volcano">
<Card title="Volcano" href="/documentation/kubernetes-deployment/setup/helm/volcano">

Install the Volcano scheduler for multi-node jobs. The chart does not install Volcano.

<small><span class="md-tag">cluster-admin</span></small>

</Card>
<Card title="OpenSandbox" href="/documentation/self-managed-deployment/setup/helm/opensandbox">
<Card title="OpenSandbox" href="/documentation/kubernetes-deployment/setup/helm/opensandbox">

Install OpenSandbox with the shared-kernel / default runtime path and point jobs at the in-cluster server.

<small><span class="md-tag">cluster-admin</span></small>

</Card>
<Card title="OpenSandbox with Kata" href="/documentation/self-managed-deployment/setup/helm/opensandbox-kata">
<Card title="OpenSandbox with Kata" href="/documentation/kubernetes-deployment/setup/helm/opensandbox-kata">

Install Kata Containers and an OpenSandbox server that uses RuntimeClass kata-qemu.

<small><span class="md-tag">cluster-admin</span></small>

</Card>
<Card title="OpenShift" href="/documentation/self-managed-deployment/setup/helm/openshift">
<Card title="OpenShift" href="/documentation/kubernetes-deployment/setup/helm/openshift">

Install with OpenShift-compatible configuration.

<small><span class="md-tag">cluster-admin</span> <span class="md-tag">openshift</span></small>

</Card>
<Card title="Backup and Restore" href="/documentation/self-managed-deployment/setup/helm/backup-and-restore">
<Card title="Backup and Restore" href="/documentation/kubernetes-deployment/setup/helm/backup-and-restore">

Set up backup and restore configurations for the NeMo Platform.

Expand Down
12 changes: 6 additions & 6 deletions docs/set-up/helm/ingress.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ description: ""

The NeMo Platform Helm chart can expose the API service externally using **Kubernetes Ingress**, the **Gateway API HTTPRoute**, or on OpenShift an **OpenShift Route**. Choose one based on your cluster.

**Prerequisites:** Complete [Prerequisites](/documentation/self-managed-deployment/setup/helm/prerequisites) and [Install](/documentation/self-managed-deployment/setup/helm/install) (or [OpenShift](/documentation/self-managed-deployment/setup/helm/openshift)) so the platform is installed. Ensure your cluster has an [Ingress](https://kubernetes.io/docs/concepts/services-networking/ingress/) controller (e.g. Traefik, OpenShift IngressController) or a [Gateway API](https://gateway-api.sigs.k8s.io/) Gateway configured.
**Prerequisites:** Complete [Prerequisites](/documentation/kubernetes-deployment/setup/helm/prerequisites) and [Install](/documentation/kubernetes-deployment/setup/helm/install) (or [OpenShift](/documentation/kubernetes-deployment/setup/helm/openshift)) so the platform is installed. Ensure your cluster has an [Ingress](https://kubernetes.io/docs/concepts/services-networking/ingress/) controller (e.g. Traefik, OpenShift IngressController) or a [Gateway API](https://gateway-api.sigs.k8s.io/) Gateway configured.

## Kubernetes Ingress

Expand Down Expand Up @@ -52,7 +52,7 @@ To use standard Kubernetes [Ingress](https://kubernetes.io/docs/concepts/service

Install or upgrade with your values file so the Ingress resource is created. After installation, use the URL shown in the Helm notes (`helm status nemo-platform`) or the host you configured.

**Advanced:** For multiple hostnames or different paths per host, leave `defaultHost` unset and use `ingress.hosts` (each entry has `name` and `paths`). See the [NeMo Platform Helm Chart reference](/documentation/self-managed-deployment/helm/helm-reference) for the full structure.
**Advanced:** For multiple hostnames or different paths per host, leave `defaultHost` unset and use `ingress.hosts` (each entry has `name` and `paths`). See the [NeMo Platform Helm Chart reference](/documentation/kubernetes-deployment/helm/helm-reference) for the full structure.

## Gateway API HTTPRoute

Expand All @@ -72,7 +72,7 @@ On clusters that use the [Gateway API](https://gateway-api.sigs.k8s.io/), you ca

2. Install or upgrade with this values file. The HTTPRoute will be created and bound to the specified Gateway(s).

For full option details (e.g. `filters`, `labels`, `annotations`), see the [NeMo Platform Helm Chart reference](/documentation/self-managed-deployment/helm/helm-reference).
For full option details (e.g. `filters`, `labels`, `annotations`), see the [NeMo Platform Helm Chart reference](/documentation/kubernetes-deployment/helm/helm-reference).

## OpenShift Route

Expand All @@ -92,12 +92,12 @@ On Red Hat OpenShift you can expose the API using an [OpenShift Route](https://d

3. Install or upgrade with your values file. After installation, use the URL from the Helm notes (`helm status nemo-platform`) or the host you configured.

For all options (`targetPort`, `annotations`, `labels`), see the [NeMo Platform Helm Chart reference](/documentation/self-managed-deployment/helm/helm-reference).
For all options (`targetPort`, `annotations`, `labels`), see the [NeMo Platform Helm Chart reference](/documentation/kubernetes-deployment/helm/helm-reference).

## Related

- [Install](/documentation/self-managed-deployment/setup/helm/install) - Install steps and upgrade commands
- [OpenShift](/documentation/self-managed-deployment/setup/helm/openshift) - OpenShift: security context, and optional Route (`openshiftRoute.enabled`), Ingress, or HTTPRoute
- [Install](/documentation/kubernetes-deployment/setup/helm/install) - Install steps and upgrade commands
- [OpenShift](/documentation/kubernetes-deployment/setup/helm/openshift) - OpenShift: security context, and optional Route (`openshiftRoute.enabled`), Ingress, or HTTPRoute

## Cloud Provider Specific Ingress

Expand Down
18 changes: 9 additions & 9 deletions docs/set-up/helm/install.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ This setup deploys the full platform to Kubernetes. If you are just getting star

</Tip>

Complete [Prerequisites](/documentation/self-managed-deployment/setup/helm/prerequisites) before installing the chart.
Complete [Prerequisites](/documentation/kubernetes-deployment/setup/helm/prerequisites) before installing the chart.

## Set install variables

Expand Down Expand Up @@ -96,7 +96,7 @@ helm show values "$NMP_HELM_CHART_REF" \

## Configure values

At minimum, make sure the chart can use the image pull secret and NGC API secret from [Prerequisites](/documentation/self-managed-deployment/setup/helm/prerequisites):
At minimum, make sure the chart can use the image pull secret and NGC API secret from [Prerequisites](/documentation/kubernetes-deployment/setup/helm/prerequisites):

```yaml
existingSecret: ngc-api
Expand All @@ -105,14 +105,14 @@ imagePullSecrets:
- name: nvcrimagepullsecret
```

Review the [NeMo Platform Helm Chart reference](/documentation/self-managed-deployment/helm/helm-reference) before installing. The most common cluster-specific settings are:
Review the [NeMo Platform Helm Chart reference](/documentation/kubernetes-deployment/helm/helm-reference) before installing. The most common cluster-specific settings are:

| Cluster type | What to configure |
| ------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `minikube` or `kind` | Use for single-node smoke testing. Provide a StorageClass or static PersistentVolume that can satisfy the chart's shared PVC. Use port-forwarding or a local ingress addon to reach the API. |
| EKS | Use an RWX storage backend such as Amazon EFS for `core.storage`, a PostgreSQL-ready StorageClass such as `gp3` for embedded PostgreSQL, and IRSA or Kubernetes secrets for S3 credentials if you store files in S3. |
| AKS, GKE, OKE, or on-prem | Provide an RWX-capable StorageClass for shared jobs storage, configure an ingress or Gateway API route, and install the GPU and network operators required by your node pool. |
| OpenShift | Add the OpenShift security context overrides from [OpenShift](/documentation/self-managed-deployment/setup/helm/openshift). |
| OpenShift | Add the OpenShift security context overrides from [OpenShift](/documentation/kubernetes-deployment/setup/helm/openshift). |

### Local single-node clusters

Expand Down Expand Up @@ -190,15 +190,15 @@ platformConfig:
use_sdk_auth: true
```

For multi-node GPU jobs on EKS, also configure EFA networking as described in [Multinode Networking](/documentation/self-managed-deployment/setup/helm/multinode-networking).
For multi-node GPU jobs on EKS, also configure EFA networking as described in [Multinode Networking](/documentation/kubernetes-deployment/setup/helm/multinode-networking).

## Cluster engines

The chart does not install these. Install them before the workloads that need them:

- [Volcano](/documentation/self-managed-deployment/setup/helm/volcano), required for multi-node scheduling
- [Kyverno](/documentation/self-managed-deployment/setup/helm/multinode-networking), required for multi-node NCCL device injection
- [OpenSandbox](/documentation/self-managed-deployment/setup/helm/opensandbox) required for sandboxed GRPO; [Kata](/documentation/self-managed-deployment/setup/helm/opensandbox-kata) for VM-isolated sandboxes
- [Volcano](/documentation/kubernetes-deployment/setup/helm/volcano), required for multi-node scheduling
- [Kyverno](/documentation/kubernetes-deployment/setup/helm/multinode-networking), required for multi-node NCCL device injection
- [OpenSandbox](/documentation/kubernetes-deployment/setup/helm/opensandbox) required for sandboxed GRPO; [Kata](/documentation/kubernetes-deployment/setup/helm/opensandbox-kata) for VM-isolated sandboxes

## Install the chart

Expand Down Expand Up @@ -349,4 +349,4 @@ Deleting CRDs removes all custom resources of those types cluster-wide. Only do

## Troubleshooting

See [Volcano](/documentation/self-managed-deployment/setup/helm/volcano) if the Volcano admission webhook blocks pod creation cluster-wide after you apply the Volcano installer.
See [Volcano](/documentation/kubernetes-deployment/setup/helm/volcano) if the Volcano admission webhook blocks pod creation cluster-wide after you apply the Volcano installer.
Loading
Loading