Microservice Parameters#
The Unreal renderer microservice offers various configuration parameters, that can be found together with their description in the UCS microservice manifest and in the overview below:
Parameter Name |
Description |
UCS Parameter Name |
Type |
UCS Default Value |
Environment Variable Name |
|---|---|---|---|---|---|
HTTP Server Port |
The port where the HTTP API server is served. |
httpServer.port |
integer |
8021 |
IAUEMS_HTTP_SERVER_PORT |
Signalling Server Streamer Port |
The port that the Signalling and Web Server listens to for incoming connections from the Unreal Engine application. |
signallingServer.streamerPort |
integer |
8888 |
IAUEMS_SIGNALLING_SERVER_STREAMER_PORT |
Signalling Server HTTP Port |
The port that the Signalling and Web Server uses for HTTP connections with client browsers. |
signallingServer.httpPort |
integer |
8080 |
IAUEMS_SIGNALLING_SERVER_HTTP_PORT |
Signalling Server HTTP Node Port |
The node port that the Signalling and Web Server uses for HTTP connections with client browsers. |
signallingServer.httpNodePort |
integer |
30080 |
|
Signalling Server Peer Connection Options |
Specifies the hostnames or IP addresses of any STUN and TURN servers you want the Unreal Engine application and browser to query when they need to discover their own external IP addresses. |
signallingServer.peerConnectionOptions |
string |
{ “iceServers”:[ { “urls”: [“turn:127.0.0.1:3478”], “username”: “user”, “credential”: “password” } ], “iceTransportPolicy”: “relay”} |
IAUEMS_SIGNALLING_SERVER_PEER_CONNECTION_OPTIONS |
Unreal Engine Version |
The short release number of the Unreal Engine used in the UE application, e.g. “5.3”. |
unrealEngine.version |
number |
5.3 |
|
Resource Download Remote Resource Path Unreal Engine Project |
The remote path to the Unreal Engine packed project. |
resourceDownload.remoteResourcePath.unrealEngineProject |
string |
||
Resource Download Remote Resource Path MetaHuman PAK |
[Optional] The remote path to the packed MetaHuman PAK file to replace the MetaHuman assets in the project. |
resourceDownload.remoteResourcePath.metahumanPak |
string |
||
Resource Download Remote Resource Path Scene PAK |
[Optional] The remote path to the packed scene PAK file to replace the scene assets in the project. |
resourceDownload.remoteResourcePath.scenePak |
string |
||
Resource Download Destination |
The folder, where the remote resources are downloaded to. |
resourceDownload.destination |
string |
/home/unreal-renderer |
IAUEMS_RESOURCE_DOWNLOAD_DESTINATION |
Resource Download SecretName |
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 |
||
Resource Download Image |
Name of the image for the resource download init container. E.g. “nvcr.io/nvidia/ace/ngc-resource-downloader:1.1.4” |
resourceDownload.image |
string |
||
Resource Download Persistent Volume Size |
The size of the volume required to store the UE resources and all its dependencies. |
resourceDownload.persistentVolumeSize |
string |
5000Mi |
|
Window Width |
The rendered video width. |
window.width |
integer |
1280 |
IAUEMS_WINDOW_WIDTH |
Window Height |
The rendered video height. |
window.height |
integer |
720 |
IAUEMS_WINDOW_HEIGHT |
Deployment Memory Request |
Resource memory request for container. |
deployment.memoryRequest |
string |
1Gi |
|
Deployment Memory Limit |
Resource memory limit for container. |
deployment.memoryLimit |
string |
4Gi |
|
Deployment GPU Disable Allocation |
When set to true, the GPU allocation is switched from hardcoded to dynamic. |
deployment.gpuDisableAlloc |
boolean |
False |
GPU_DISABLE_ALLOC |
Deployment GPU Allocation Limit |
Controls how many replicas run on a single GPU. |
deployment.gpuAllocLimit |
integer |
1 |
GPU_ALLOC_LIMIT |
Additional Arguments |
Provide additional arguments that are passed to the startup command (e.g. -logcmds=”LogACERuntime VeryVerbose”). |
params.deployment.additionalStartupArgs |
string |
||
Propagate API Route |
API route, where the other component servers their API (http://<host>:<port>/<route>). |
propagateApi.route |
string |
/ue/ |
IAUEMS_PROPAGATE_API_ROUTE |
ACE Plugin Config Num Connection Attempts |
Max number of connection attempts to the animation data source microservice. |
acePluginConfig.numConnectionAttempts |
integer |
900 |
IAUEMS_ACE_PLUGIN_CONFIG_NUM_CONNECTION_ATTEMPTS |
ACE Plugin Config Time Between Retry Seconds |
Time between connection retries to the animation data source microservice (seconds). |
acePluginConfig.timeBetweenRetrySeconds |
number |
1 |
IAUEMS_ACE_PLUGIN_CONFIG_TIME_BETWEEN_RETRY_SECONDS |
ACE Plugin Config Buffer Length In Seconds |
How many seconds of received animation data to buffer before beginning playback. |
acePluginConfig.bufferLengthInSeconds |
number |
0.1 |
IAUEMS_ACE_PLUGIN_CONFIG_BUFFER_LENGTH_IN_SECONDS |
IAUEMS_SIGNALLING_SERVER_STREAMER_HOST |
|||||
IAUEMS_ANIM_SOURCE_HOST |
|||||
IAUEMS_ANIM_SOURCE_PORT |
|||||
IAUEMS_PROP_API_HOST |
|||||
IAUEMS_PROP_API_PORT |
|||||
CUDA_DISABLE_CONTROL |
|||||
IAUEMS_STREAMER_ID |
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.