Kubernetes Operator Chart
Overview
The nvidia-lipsync-h4m-operator Helm chart installs the LipSync Kubernetes operator. The operator watches NvidiaLipsyncMediaFunction custom resources and reconciles the required components, including the LipSync NIM deployment, SDP ConfigMaps, and status.
-
Operator: Deploys the controller and CRDs only. It does not create a
NvidiaLipsyncMediaFunctionresource or deploy the LipSync NIM workload. After installation, apply a custom resource (CR) to provision the NIM. -
Operand: Each
NvidiaLipsyncMediaFunctioncustom resource defines and drives a single LipSync NIM workload based on the specified inputs, outputs, and parameters.
Installation
Prerequisites
Complete all prerequisite steps (Rivermax license, image pull and model pull secrets, GPU node, Multus attachment for SMPTE ST 2110) before running helm install. For more information, refer to Getting Started.
Operator Installation
If not already done, add the Helm repository and pull the chart:
For the full repository setup, refer to Pull Helm Charts.
Helm Installation
The chart installs the operator Deployment and registers the NvidiaLipsyncMediaFunction CRD. For all available Helm values and --set keys, refer to Operator Configuration.
The chart expects a pre-created image pull secret for nvcr.io (default name ngc-secret-key). If your secret names differ, override as follows:
The same image pull secret is used for the operator, the custom resource, and the media function container image.
The model pull secret and node hostname are set on the custom resource, not Helm values (spec.parameters.ngcApiKeySecret, spec.parameters.nodeSelector). Refer to Custom Resource Installation.
When the defaults match your cluster, you can use the following command:
Wait Until the Controller Is Ready
On Red Hat OpenShift, replace kubectl with oc.
Custom Resource Installation
After the operator controller is ready, save a manifest (for example, lipsync-media-function.yaml) and change the following parameters to match your cluster:
Apply the CR:
Applying the CR reconciles and starts the LipSync NIM in NMOS mode. For NMOS Connection Manager UI access and setup steps, refer to Chrome Remote Desktop.
Example Manifest (lipsync-media-function.yaml)
Reference a custom resource with a placeholder node name, model-download-api-key for model download, and common video format defaults.
Extended Parameters (Optional)
As needed, you can add optional spec.parameters fields, including resources (CPU, memory, GPU, hugepages) and nimLogs / nimModelCache PVC settings. For field-by-field details, refer to Operator Configuration in the Configuration Reference. For PVC configuration, refer to Advanced Usage.
Verify and Check Logs
After applying the CR:
Inspect CR status:
For workload logs:
For operator logs:
Uninstall
First, delete all NvidiaLipsyncMediaFunction instances so the operator can remove managed deployments and ConfigMaps; then uninstall the Helm release. Delete the CRD cluster-wide only if coordinated with cluster administrators; it affects all namespaces.
Troubleshooting
For troubleshooting and known limitations, refer to Advanced Usage.
See Also
- Getting Started: Prerequisites, secrets, and chart pulls.
- Installation: Sample, service, and operator installation patterns.
- Limitations and Known Behaviors: NMOS connection order and known issues.
- Configuration Reference: Helm and operator field reference.