Parameters#
The Omniverse renderer microservice offers various configuration parameters, that can be found together with their description in the UCS microservice manifest and in the overview below:
Note
You can scroll the parameter table with the bottom slider to reveal more columns.
Parameter Name |
Description |
UCS Parameter Name |
Type |
UCS Default Value |
Environment Variable Name |
Docker Arguments |
|---|---|---|---|---|---|---|
Kit Settings |
Additional Kit settings passed at startup (e.g. ‘–/app/my/setting=42 –/app/my/other/setting=true’). |
kit.settings |
string |
“” |
–/app/my/setting= |
|
Print Kit Setttings |
Print Kit settings on startup. |
kit.printSettings |
boolean |
false |
–/app/printConfig= |
|
HTTP Server Port |
The port where the http API server is served. |
httpServer.port |
integer |
8020 |
–/exts/omni.services.transport.server.http/port= |
|
Memory Request |
Resource memory request for container. |
deployment.memoryRequest |
string |
“2Gi” |
||
Memory Limit |
Resource memory limit for container. |
deployment.memoryLimit |
string |
“4Gi” |
||
GPU Disable Allocation |
When set to true, the GPU allocation is switched from hardcoded to dynamic. |
deployment.gpuDisableAlloc |
boolean |
false |
GPU_DISABLE_ALLOC |
|
GPU Allocation LImit |
Controls how many replicas run on a single GPU. |
deployment.gpuAllocLimit |
integer |
1 |
GPU_ALLOC_LIMIT |
|
Asset Persistent Volume Size |
The size of the asset volume required to store the USD scene and all its dependencies. |
deployment.persistentVolumeSizeAssets |
string |
“5Gi” |
||
Storage Class Name |
The storage class for the persistent volume claims. |
deployment.storageClassName |
string |
“mdx-local-path” |
||
Storage Access Mode |
The access mode for the persistent volume claims. |
deployment.storageAccessMode |
string |
“ReadWriteOnce” |
||
Remote Resource Path |
The remote resource path with the USD scene assets. Will be provided as “REMOTE_RESOURCE_PATH” env variable to the resource download init container. E.g. for NGC resources looks like “<NGC_ORG>/<NGC_TEAM>/<NGC_RESOURCE_NAME>:<NGC_RESOURCE_VERSION>”. |
resourceDownload.remoteResourcePath |
string |
“” |
REMOTE_RESOURCE_PATH (only for init container) |
|
Secret Name |
Name of the secret, that will be mounted into the resource download init container to provide credentials. E.g. for NGC the “NGC_CLI_API_KEY”. |
resourceDownload.secretName |
string |
“” |
||
Image |
Name of the image for the resource download init container. E.g. “nvcr.io/nvidia/ace/ngc-resource-downloader:1.2.0” |
resourceDownload.image |
string |
“” |
||
Animation Server Port |
The port where the animation data server is served. |
animationServer.port |
integer |
51000 |
IAAGMS_ANIMATION_SERVER_PORT |
|
Animation Server Max Capacity |
The max number of parallel streams, that are supported for each instance of the microservice. |
animationServer.maxCapacity |
integer |
3 |
IAAGMS_ANIMATION_SERVER_MAX_CAPACITY |
|
Scene Filename |
The name of the USD asset (e.g. Avatar_Scene.usda). This can be a .usda or a .usd file. |
scene.filename |
string |
“Avatar_Scene.usda” |
IAAGMS_SCENE_FILENAME |
|
Debug Logs |
Enable debug logs. |
debug.logEnabled |
boolean |
true |
IAAGMS_DEBUG_LOG_ENABLED |
|
Debug Log Each Received Animation Data Message |
Log each animation data message that is received on the grpc stream. |
debug.logEachReceivedAnimationDataMessage |
boolean |
false |
IAAGMS_DEBUG_LOG_EACH_RECEIVED_ANIMATION_DATA_MESSAGE |
|
Debug Log Each Sent Animation Data Message |
Log each animation data message that is sent on the grpc stream. |
debug.logEachSentAnimationDataMessage |
boolean |
false |
IAAGMS_DEBUG_LOG_EACH_SENT_ANIMATION_DATA_MESSAGE |
|
Debug Log Each Redis Animation Graph Event |
Log each animation graph event that is sent to a redis stream. |
debug.logEachRedisAnimationGraphEvent |
boolean |
false |
IAAGMS_DEBUG_LOG_EACH_REDIS_ANIMATION_GRAPH_EVENT |
|
Debug Frame Interval |
Enable debug output of each x-th frame. |
debug.logFrameInterval |
integer |
30 |
IAAGMS_DEBUG_LOG_FRAME_INTERVAL |
|
Trace Json Exporter Enabled |
Enable exporting traces to a file in json format. |
trace.jsonExporter.enabled |
boolean |
false |
IAAGMS_TRACE_JSON_EXPORTER_ENABLED |
|
Trace Json Exporter Filename |
Filename, where the traces are written to. |
trace.jsonExporter.filename |
string |
“_trace.json” |
IAAGMS_TRACE_JSON_EXPORTER_FILENAME |
|
Trace OTLP Exporter Enabled |
Enable exporting traces to an OTLP compliant server (defined in egress). |
trace.otlpExporter.enabled |
boolean |
false |
IAAGMS_TRACE_OTLP_EXPORTER_ENABLED |
|
Trace OTLP Destination Host |
The OTLP destination host address |
string |
IAAGMS_OTLP_HOST |
|||
Trace OTLP Destination Host Port |
The OTLP destination host port |
integer |
IAAGMS_OTLP_PORT |
|||
Trace Capture Detail |
The trace levels to capture. LOW=16, MID=8, HIGH=4, VERBOSE=2, FULL=1. The values are added together to get the final trace level. E.g. LOW + MID = 24. |
trace.captureDetail |
integer |
24 |
IAAGMS_TRACE_CAPTURE_DETAIL |
|
Animation Source Buffer Size |
The buffer size of animation data input stream in seconds. |
animationSource.bufferSize |
number |
0.1 |
IAAGMS_ANIMATION_SOURCE_BUFFER_SIZE |
|
Animation Output Frame Rate |
The frames per second rate at which the data is sampled and streamed. |
animationOutput.frameRate |
number |
30.0 |
IAAGMS_ANIMATION_OUTPUT_FRAME_RATE |
|
Animation Output Audio Sample Rate |
The sample rate of the audio clip. |
animationOutput.audioSampleRate |
number |
16000 |
IAAGMS_ANIMATION_OUTPUT_AUDIO_SAMPLE_RATE |
By default the UCS app configures the microservices to download the avatar scene from NGC. However, there are also alternative methods to download resources and you can also create your own resource downloader init container as described in the Resource Downloader section.