OpenShift follow-up for NVBug 6218358

[kheiss-uwzoo]

Summary

• Adds docs/docs/extraction/openshift.md as the canonical OpenShift install guide (restricted-v2 / PSA restricted): openshift-restricted.yaml profile, prebuilt ffmpeg service image, internal registry pull secrets (ngcImagePullSecret.name: ""), optional NIM LD_LIBRARY_PATH overrides, direct Omni NIM /v1/chat/completions example, service-only and NIM Operator install flows, and post-install pod/NIMService checks.
• Trims nemo_retriever/helm/README.md to a short #openshift-deployment stub plus cross-links into openshift.md; chart values and generic Kubernetes guidance stay in the Helm README.
• Fixes deploy leakage in prerequisites-support-matrix.md (Software Requirements ffmpeg bullet → one line to audio-video.md; removed matrix Omni smoke-test cross-link).
• Updates deployment-options.md and docs/mkdocs.yml nav to point at openshift.md.
• Addresses Randy review: no QA phrasing; install sections describe user actions; OpenShift content moved out of the Helm README per follow-up request.

NVBugs

6218358 — OpenShift Helm chart SCC/PodSecurity documentation follow-up (comment #6).

PR scope check

• Base: main
• Files changed: docs/docs/extraction/openshift.md (new), docs/docs/extraction/deployment-options.md, docs/docs/extraction/prerequisites-support-matrix.md, docs/mkdocs.yml, nemo_retriever/helm/README.md
• Red flags: none (docs only; no .cursor/, link-audit artifacts, chart/code changes)

Test plan

• Confirm openshift.md renders on docs site (mkdocs nav entry under Deployment options)
• Verify Helm README #openshift-deployment stub links to openshift.md
• Confirm prerequisites matrix Software Requirements has no Helm/OpenShift/air-gap deploy prose
• Spot-check OpenShift install examples read as user procedures (no QA references)

[greptile-apps]

Greptile Summary

This PR moves the OpenShift deployment guide out of the Helm README into a new canonical page (docs/docs/extraction/openshift.md) and trims the Helm README's OpenShift section to a cross-linking stub. It also fixes the air-gapped values snippet by explicitly setting ngcImagePullSecret.name: "" to prevent the ngc-secret default from being injected on mirror-only installs.

• New openshift.md: covers restricted-v2/PSA-restricted value overrides, prebuilt ffmpeg image Dockerfile, internal registry pull-secret scenarios, full copy-paste-safe env lists for Parakeet and Omni NIMs, service-only and NIM Operator install examples, and vectordb/OTel post-install patches.
• Helm README: OpenShift prose collapsed to a one-sentence stub + cross-link; air-gapped snippet gains name: "" fix; "see" → "refer to" wording pass throughout.
• mkdocs.yml: new nav entry under "3. Deployment options" pointing at extraction/openshift.md.

Confidence Score: 5/5

Documentation-only change; no code, chart templates, or CI paths are modified.

All five changed files are Markdown or a YAML nav file. The new OpenShift guide is technically accurate, the previously flagged ngcImagePullSecret.name: "" fix is correctly applied in the air-gapped snippet, and the optional-NIM env lists are now copy-paste complete. No runtime behaviour changes.

No files require special attention.

Important Files Changed

Filename	Overview
docs/docs/extraction/openshift.md	New canonical OpenShift guide covering restricted-v2/PSA-restricted overrides, prebuilt ffmpeg image, internal registry pull secrets, full env lists for optional NIMs, and install examples for service-only and NIM Operator flows.
nemo_retriever/helm/README.md	OpenShift section collapsed to a one-paragraph stub with cross-link; air-gapped snippet now sets name: "" to clear the ngc-secret default; "see" → "refer to" wording pass; OpenShift ffmpeg note added to the audio/video section.
docs/docs/extraction/deployment-options.md	ffmpeg paragraph now names OpenShift restricted-v2 as a blocked path and links to openshift.md; minor "see" → "refer to" wording clean-up.
docs/docs/extraction/prerequisites-support-matrix.md	ffmpeg bullet trimmed to a single line pointing to audio-video.md; "see" → "refer to" wording pass across footnotes and notes.
docs/mkdocs.yml	Added "OpenShift deployment" nav entry under "3. Deployment options", pointing at the new extraction/openshift.md page.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[User: Install on OpenShift] --> B{Audio/Video needed?}
    B -- No --> C[Use openshift-restricted.yaml\nservice.installFfmpeg=false]
    B -- Yes --> D[Build custom ffmpeg image\nFROM nrl-service + apt install ffmpeg]
    D --> E[Push to internal registry or NGC]
    E --> F[Set service.image.repository/tag\nin openshift-restricted.yaml]
    C --> G{In-cluster NIMs?}
    F --> G
    G -- No --> H[helm install\n--set nims.enabled=false\n--set persistence.enabled=false]
    G -- Yes --> I[Install NIM Operator + GPU Operator\nthen helm install with NIM Operator flags]
    H --> J[oc get pods\nVerify SCC-assigned numeric UID]
    I --> K[oc get pods\noc get nimservice]
    K --> L{ASR/Omni CrashLoop?}
    L -- Yes --> M[Add LD_LIBRARY_PATH overrides\nto nimOperator.audio.env /\nnimOperator.nemotron_3_nano_omni.env]
    L -- No --> N[Ready]
    M --> N
    J --> N

Loading

_{Reviews (12): Last reviewed commit: "Merge branch 'main' into docs/6218358-op..." | Re-trigger Greptile}