Deploy with Helm
VSR NIM ST 2110 deployment provides two Helm chart paths:
nvidia-vsr-nim-h4m-service: VSR NIM media function only, for integration with existing ST 2110 endpoints.nvidia-vsr-nim-h4m-sample: end-to-end sample pipeline with sender, VSR NIM service, and receiver.
Use the service chart when upstream and downstream ST 2110 endpoints are already deployed. Use the sample chart when you want a packaged sender to VSR NIM to receiver pipeline for validation.
Pull Charts
Use the NGC org and team that host the charts for VSR NIM on Holoscan for Media.
Verify that the downloaded sample archive is the umbrella sample chart, not the service-only chart:
Deploy in NMOS mode:
Deploy in static ST 2110 mode:
For clusters without topo-aware-scheduler, clear the scheduler name:
Sample Pipeline Chart
Use the sample chart to deploy a sender to VSR NIM to receiver pipeline. The sample sender generates a live SMPTE color bars test pattern by default and requires no input asset.
Extract the sample values:
The sample chart provides the following values files:
The values-st2110.yaml overlay disables NMOS discovery. Stream connections are configured statically from global.vsrPipeline:
The values-nmos.yaml overlay enables DNS-SD based NMOS registration. To force an explicit registration URL, set nmos.registrationUrl for each component:
Deploy in NMOS mode:
Deploy in static ST 2110 mode:
On clusters in which the VSR service and the sample sender and receiver use different SR-IOV pools, set the media networks and pool resources explicitly. The following example gives the VSR service two virtual functions from the RX pool and places the sample sender and receiver on the TX pool. This pattern is useful on clusters that require single-numa-node placement and expose separate SR-IOV resource pools:
Use equivalent network-resource overrides in NMOS mode when the same SR-IOV placement constraints apply.
In NMOS mode, use DNS-SD registration by default. If DNS-SD is not available in the cluster, you can point each component directly at the NMOS IS-04 registration endpoint:
Set site-specific values for node selection, image pull secrets, network attachment names, multicast groups, ports, packet sizes, and Rivermax secret names before production use.
The sample sender and receiver pass nmos.registrationUrl directly to nvdsnmosbin. The VSR NIM service writes the value into config.json as nmos_config.registration_url. When you use an explicit registration URL, verify that the VSR NIM pod can reach the IS-04 registry endpoint and that the sender, VSR NIM service, and receiver all register in the NMOS registry.
For NMOS validation, deploy the receiver and VSR NIM first, wait for both pods to become ready, and then enable the sender. This procedure avoids filling the VSR output queue before the downstream receiver is connected.
Sender Input
The public sample chart path uses a live SMPTE color bars test pattern by default and requires no input asset.
Image Pull Secrets
Image pull secret names are configurable examples. Use names that match the secrets in your workload namespace.
The VSR NIM service chart leaves image.secret empty by default. Set it when the kubelet does not already have registry credentials:
For the sample chart, set the VSR NIM service image secret:
The sample sender and receiver default to ngc-secret-h4m as the image pull secret. If the sender or receiver use a different secret name, set those values too:
Network Attachments
The sample sender and receiver each use one NetworkAttachmentDefinition. The VSR NIM service uses network.rxName for the input-side media interface and network.txName for the output-side media interface:
The rxName and txName keys describe how the VSR NIM pod uses each interface. The underlying media networks do not have to be RX-only or TX-only as long as the selected attachments support the traffic direction used by the pod.
If your SR-IOV device plugin exposes named Rivermax resources, set the optional pool resource values:
When rxPoolResource and txPoolResource are the same device resource, the service chart aggregates the counts into one rendered resource request. When they are different, each resource is requested separately.
For a VSR pod that needs two virtual functions from the same SR-IOV pool, set one pool resource with count 2 and leave the other pool resource empty:
Do not collapse separate RX and TX pools into one logical resource unless the cluster exposes one shared pool. On single-numa-node clusters, hiding the resource split can cause scheduler or kubelet topology placement failures.
Verify
Check the deployments:
On Red Hat OpenShift, replace kubectl with oc.
For media-flow verification, see End-to-End Verification.
Troubleshooting
Uninstall
The values-nmos.yaml overlay enables DNS-SD based NMOS registration. To force an explicit registration URL, set nmos.registrationUrl for each component:
Deploy in NMOS mode:
Deploy in static ST 2110 mode:
On clusters in which the VSR service and the sample sender and receiver use different SR-IOV pools, set the media networks and pool resources explicitly. The following example gives the VSR service two virtual functions from the RX pool and places the sample sender and receiver on the TX pool. This pattern is useful on clusters that require single-numa-node placement and expose separate SR-IOV resource pools:
Use equivalent network-resource overrides in NMOS mode when the same SR-IOV placement constraints apply.
In NMOS mode, use DNS-SD registration by default. If DNS-SD is not available in the cluster, you can point each component directly at the NMOS IS-04 registration endpoint:
Set site-specific values for node selection, image pull secrets, network attachment names, multicast groups, ports, packet sizes, and Rivermax secret names before production use.
The sample sender and receiver pass nmos.registrationUrl directly to nvdsnmosbin. The VSR NIM service writes the value into config.json as nmos_config.registration_url. When you use an explicit registration URL, verify that the VSR NIM pod can reach the IS-04 registry endpoint and that the sender, VSR NIM service, and receiver all register in the NMOS registry.
For NMOS validation, deploy the receiver and VSR NIM first, wait for both pods to become ready, and then enable the sender. This procedure avoids filling the VSR output queue before the downstream receiver is connected.
Sender Input
The public sample chart path uses a live SMPTE color bars test pattern by default and requires no input asset.
Image Pull Secrets
Image pull secret names are configurable examples. Use names that match the secrets in your workload namespace.
The VSR NIM service chart leaves image.secret empty by default. Set it when the kubelet does not already have registry credentials:
For the sample chart, set the VSR NIM service image secret:
The sample sender and receiver default to ngc-secret-h4m as the image pull secret. If the sender or receiver use a different secret name, set those values too:
Network Attachments
The sample sender and receiver each use one NetworkAttachmentDefinition. The VSR NIM service uses network.rxName for the input-side media interface and network.txName for the output-side media interface:
The rxName and txName keys describe how the VSR NIM pod uses each interface. The underlying media networks do not have to be RX-only or TX-only as long as the selected attachments support the traffic direction used by the pod.
If your SR-IOV device plugin exposes named Rivermax resources, set the optional pool resource values:
When rxPoolResource and txPoolResource are the same device resource, the service chart aggregates the counts into one rendered resource request. When they are different, each resource is requested separately.
For a VSR pod that needs two virtual functions from the same SR-IOV pool, set one pool resource with count 2 and leave the other pool resource empty:
Do not collapse separate RX and TX pools into one logical resource unless the cluster exposes one shared pool. On single-numa-node clusters, hiding the resource split can cause scheduler or kubelet topology placement failures.
Verify
Check the deployments:
On Red Hat OpenShift, replace kubectl with oc.
For media-flow verification, see End-to-End Verification.