Skip to navigation

This page covers Helm values for the nvidia-lipsync-h4m-operator chart (controller pod) and fields for the NvidiaLipsyncMediaFunction custom resource (LipSync NIM workload).

Pipeline tuning semantics on the custom resource match the Pipeline Configuration Helm keys.


Operator Helm Chart (nvidia-lipsync-h4m-operator)

Values for the operator controller pod (not the NIM Deployment).

ConfigurationHelm KeyComment
Operator imageimage.repository, image.tag, image.pullPolicyDefault: repo nvcr.io/nim/nvidia/lipsync-h4m-operator, tag 1.0.0, pull Always.
Pull secretsimagePullSecretsDefault: [{name: ngc-secret-key}].
Default NIM image for operandsmediaFunctionImageSingle fully-qualified image reference (for example, nvcr.io/nim/nvidia/lipsync-h4m-nim:1.0.0). Passed to the manager as MEDIA_FUNCTION_IMAGE.
Default NIM schedulerdefaultSchedulerNameDefault: default-scheduler: used when the CR omits spec.parameters.schedulerName. For NUMA and topo-aware-scheduler, see Scheduler Requirements for NUMA-aware Clusters.
Leader electionleaderElectionDefault: true.
Operator pod resourcesresources.*Default: limits 500m CPU / 128Mi memory; requests 10m CPU / 64Mi memory.

The media function is configured when the operator is installed, so NvidiaLipsyncMediaFunction instances managed by an operator use the same validated operator and media-function image combination. This ensures the operator and workload are always supported together and avoids compatibility issues.

As a result, CRs managed by an operator share the chart-level mediaFunctionImage and imagePullSecrets configured at install time. To run multiple custom resources with different NIM image tags, deploy multiple operators, each configured with its own mediaFunctionImage.


Custom Resource (NvidiaLipsyncMediaFunction)

Full YAML example: Example Manifest in Kubernetes Operator Chart.

Scheduling and Cluster

ConfigurationCR PathComment
Node selectorspec.parameters.nodeSelectorKubernetes node labels (for example, kubernetes.io/hostname).
Pod schedulerspec.parameters.schedulerNameOptional. Kubernetes schedulerName for the LipSync NIM operand Pod (for example, default-scheduler or topo-aware-scheduler).

Parameters: Network, Resources, Secrets, Security, Storage

ConfigurationCR PathComment
High-speed networksspec.parameters.highSpeedNetworkDefault name: media-a-tx-net; for Multus, list of {name, ip?}.
NGC model downloadspec.parameters.ngcApiKeySecretModel download Secret: name, key; default key: NGC_API_KEY.
Model cache / logsspec.parameters.nimModelCache, spec.parameters.serverLogsFields: enabled, claimName, size, storageClassName; refer to Advanced Usage.
Security contextspec.parameters.securityContextExample: runAsUser: 1000, capabilities for Rivermax and RTP; refer to Getting Started.
NMOS metadataspec.parameters.label, spec.parameters.descriptionNMOS IS-04 registration strings.

Parameters: CR

ConfigurationCR Path (spec.parameters.*)Environment Variable (on NIM Pod)Comment
Logging levelloggingLevelLIPSYNC_LOGGING_LEVELRange: 0–4; 0 FATAL, 1 ERROR, 2 WARNING, 3 INFO (default), 4 DEBUG.
Model head movement speedmodelHeadMovementSpeedLIPSYNC_MODEL_HEAD_MOVEMENT_SPEEDRange: 0…100; default: 0.
NIM process enablenim.enabledNIM_ENABLEDAccepts 0 or 1; default: 1.
Input ancillary data enable (optional)inputAncillaryDataEnabledLIPSYNC_INPUT_ANCILLARY_DATA_ENABLEDtrue or false; default: false. Use with spec.inputs.ancillary_data_input.

Inputs and Outputs

AreaCR PathComment
Video inspec.inputs.video_inputUses control, transport, and format.video.
Audio inspec.inputs.audio_inputSingle audio stream.
Ancillary in (optional)spec.inputs.ancillary_data_inputOptional ancillary/metadata input (control, transport, format.data).
Video outspec.outputs.video_outputLip-synced program video.

Video Format Subfields

These subfields apply to video input and video output.

FieldExample ValueComment
media_typevideo/rawFixed for uncompressed ST 2110-20.
frame_width1920Must match NIM video.width.
frame_height1080Must match NIM video.height.
frame_rate"30"Allowed values (CRD admission); set the same value on input and output video.
interlace_modeprogressiveCRD enum: progressive, interlaced_tff, interlaced_bff, interlaced_psf; refer to the kubectl explain paths in CR Schema Reference.
component_depth10CRD enum: 8, 10, 12; must match NIM video.componentDepth.
color_samplingYCbCr-4:2:2
colorspaceBT709
transfer_characteristicSDR

Video Frame Rate

spec.inputs.video_input.format.video.frame_rate and spec.outputs.video_output.format.video.frame_rate must be identical. Invalid values are rejected when the CR is applied.

Supported values: "24", "25", "30000/1001", "30", "50", "60000/1001", "60"

Use a plain integer string for whole rates (for example "30") and a numerator/denominator string for fractional rates ("30000/1001", "60000/1001"). Quote values in YAML so that fractions are not parsed as numbers.

Audio Format Subfields

These subfields apply to audio input streams.

FieldExample ValueComment
sample_rate48000Must match NIM audio.samplingRate.
channel_count1Mono per stream; must match NIM audio.numChannels.
sample_depth24Bits; corresponds to PCM L24.
media_typeaudio/L24Fixed for ST 2110-30 mono L24.

CR Schema Reference

With the nvidialipsyncmediafunctions.nvidia.com CRD installed, inspect field types and OpenAPI details from the cluster:

kubectl explain nvidialipsyncmediafunctions.nvidia.com --recursive
kubectl explain nvidialipsyncmediafunctions.nvidia.com.spec
kubectl explain nvidialipsyncmediafunctions.nvidia.com.spec.inputs.video_input.format.video
kubectl explain nvidialipsyncmediafunctions.nvidia.com.spec.outputs.video_output.format.video

Some validation rules might not appear in kubectl explain output but are still enforced when the CR is applied.

Status Conditions (status.conditions)

Status Overview

The operator reports health using Kubernetes conditions in status.conditions (type, status, reason, message).

A media function is considered healthy and ready when the following are all True:

  • Provisioned: Deployment and pod are running.
  • Registered: Successfully registered with NMOS/SDP.
  • Configured: Required configuration has been applied.

Important Statuses

StatusWhat It Means
ProvisionedApp deployment is running.
RegisteredRegistration succeeded.
ConfiguredConfiguration applied successfully.
ConnectedConnections are established.
ActiveReserved for future media-flow status.
DegradedReserved for future health reporting.

When to Alert

Alert if any of the following stay False:

  • Provisioned
  • Registered
  • Configured

Most important failure reason values:

  • DeploymentNotAvailable
  • NmosQueryFailed

Connected False is usually informational or transient and can occur when connections are still being established.

Ignore Active and Degraded for now.

Check Status

Use the custom resource metadata.name (not a Pod name).

kubectl get nvidialipsyncmediafunction <cr-name> \
-o jsonpath='{range .status.conditions[*]}{.type}{"\t"}{.status}{"\t"}{.reason}{"\n"}{end}'

See Also