OpenShift follow-up for NVBug 6218358

[kheiss-uwzoo]

Summary

• Adds nemo_retriever/helm/openshift.md as the 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 linking to ./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 to defer Helm audio/video and OpenShift config to the Helm chart README sections (per review); docs/mkdocs.yml nav links to the Helm-local OpenShift guide on GitHub.
• Addresses Randy OCR review on prerequisites-support-matrix.md: Helm default is Nemotron OCR v2 (nemotron-ocr-v2:1.4.0) on main.

Related

• Remaining OCR v2 documentation and Helm chart implementation: #2259 (multimodal extraction, release notes, README/CLI, chart templates/values, tests).

NVBugs

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

PR scope check

• Base: main
• Files changed: nemo_retriever/helm/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)

Test plan

• Confirm mkdocs nav OpenShift deployment (Helm) links to nemo_retriever/helm/openshift.md on GitHub
• Verify Helm README #openshift-deployment stub links to ./openshift.md
• Confirm prerequisites matrix Software Requirements has no Helm/OpenShift/air-gap deploy prose
• Confirm prerequisites matrix OCR note documents OCR v2 (nemotron-ocr-v2:1.4.0)
• Confirm deployment-options.md Kubernetes/Helm section defers audio/video and OpenShift details to Helm README section headers
• Spot-check OpenShift install examples read as user procedures (no QA references)

[greptile-apps]

Greptile Summary

This PR adds nemo_retriever/helm/openshift.md as a dedicated OpenShift install guide (restricted-v2 / PSA restricted) and trims the Helm README's OpenShift section to a stub that links to it. Other changes redirect audio/video and OpenShift Kubernetes prose to the new guide, update the mkdocs nav, and fix the air-gapped snippet to explicitly clear ngcImagePullSecret.name.

• New openshift.md: covers SCC/PSA overrides, prebuilt ffmpeg image, internal-registry pull secrets, full NIM env lists (addressing the previous LD_LIBRARY_PATH list-replacement issue), Omni NIM direct-call example, service-only and NIM Operator install flows, and vectordb/otel patch procedures.
• OCR v1 → v2 update in prerequisites-support-matrix.md: the support matrix table and note now document nemotron-ocr-v2:1.4.0 as the Helm default, but values.yaml and the Helm README's mirror table still reference nemotron-ocr-v1:1.3.0 — the chart update is deferred to PR Switch default OCR from v1 to v2 on main #2259.
• ngcImagePullSecret.name: "" added to the air-gapped values snippet in README.md to explicitly clear the "ngc-secret" default (addresses previous review comment).

Confidence Score: 4/5

Safe to merge once the OCR version discrepancy between the support matrix and the chart/README is resolved or explicitly gated on PR #2259.

The support matrix now documents nemotron-ocr-v2:1.4.0 as the Helm default, but values.yaml still deploys nemotron-ocr-v1:1.3.0 and the Helm README air-gapped mirror table still lists v1. Users installing the current chart while following these updated docs will get the wrong OCR NIM with no warning.

docs/docs/extraction/prerequisites-support-matrix.md and nemo_retriever/helm/README.md — OCR version references need to be aligned with the actual chart default (values.yaml line 961) before or alongside this merge.

Important Files Changed

Filename	Overview
nemo_retriever/helm/openshift.md	New OpenShift install guide (restricted-v2 / PSA restricted): covers SCC overrides, prebuilt ffmpeg image, internal-registry pull secrets, NIM env defaults, and install examples. Env snippets correctly list chart defaults inline to avoid list-replacement surprises.
nemo_retriever/helm/README.md	OpenShift section trimmed to stub pointing to openshift.md; air-gapped snippet now explicitly sets name: "" to clear the ngc-secret default; service image updated from staging to GA. OCR v1 references remain in the air-gapped mirror table and NIM Operator sub-stack table, conflicting with the support matrix update in this PR.
docs/docs/extraction/prerequisites-support-matrix.md	OCR default updated from nemotron-ocr-v1:1.3.0 to nemotron-ocr-v2:1.4.0 in the support matrix table and notes. The chart's values.yaml still deploys nemotron-ocr-v1:1.3.0, creating a docs/code mismatch until PR #2259 lands.
docs/docs/extraction/deployment-options.md	Trims audio/video and OpenShift prose, replacing with cross-links to the Helm README sections. Clean change.
docs/mkdocs.yml	Adds OpenShift deployment (Helm) nav entry pointing to the new openshift.md via a GitHub blob URL, consistent with the existing pattern for other Helm chart links.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A[User: OpenShift Helm Install] --> B{Image source?}
    B -->|NGC NIM images| C[ngcImagePullSecret.name = ngc-secret]
    B -->|Internal registry service image| D[ngcImagePullSecret.name = empty string]
    B -->|Both| E[List both secrets under imagePullSecrets]

    A --> F{Audio/video needed?}
    F -->|Yes| G[Build custom image with ffmpeg baked in]
    F -->|No| H[service.installFfmpeg: false]

    A --> I[Apply openshift-restricted.yaml]

    I --> J{NIM Operator?}
    J -->|Service-only| K[nims.enabled=false]
    J -->|In-cluster NIMs| L[NIM Operator + GPU Operator pre-installed]

    L --> M{Optional NIMs crash?}
    M -->|CrashLoopBackOff + missing .so| N[Add LD_LIBRARY_PATH to nimOperator env with chart defaults]
    M -->|No issues| O[Ready]
    K --> O

Loading

%%{init: {'theme': 'base', 'themeVariables': {"darkMode": true, "background": "#0d1117", "primaryColor": "#21262d", "primaryTextColor": "#e6edf3", "primaryBorderColor": "#8b949e", "lineColor": "#8b949e", "textColor": "#e6edf3", "edgeLabelBackground": "#161b22", "actorBkg": "#21262d", "actorBorder": "#8b949e", "actorTextColor": "#e6edf3", "actorLineColor": "#8b949e", "signalColor": "#8b949e", "signalTextColor": "#e6edf3", "noteBkgColor": "#373320", "noteBorderColor": "#d4a72c", "noteTextColor": "#f0e6c0", "labelBoxBkgColor": "#21262d", "labelBoxBorderColor": "#8b949e", "labelTextColor": "#e6edf3", "loopTextColor": "#e6edf3", "activationBkgColor": "#30363d", "activationBorderColor": "#8b949e"}}}%%
flowchart TD
    A[User: OpenShift Helm Install] --> B{Image source?}
    B -->|NGC NIM images| C[ngcImagePullSecret.name = ngc-secret]
    B -->|Internal registry service image| D[ngcImagePullSecret.name = empty string]
    B -->|Both| E[List both secrets under imagePullSecrets]

    A --> F{Audio/video needed?}
    F -->|Yes| G[Build custom image with ffmpeg baked in]
    F -->|No| H[service.installFfmpeg: false]

    A --> I[Apply openshift-restricted.yaml]

    I --> J{NIM Operator?}
    J -->|Service-only| K[nims.enabled=false]
    J -->|In-cluster NIMs| L[NIM Operator + GPU Operator pre-installed]

    L --> M{Optional NIMs crash?}
    M -->|CrashLoopBackOff + missing .so| N[Add LD_LIBRARY_PATH to nimOperator env with chart defaults]
    M -->|No issues| O[Ready]
    K --> O

Loading

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