Containerising Omniverse services

Omniverse Services can be containerised, and to help with this an official Omniverse Kit SDK container is available on NGC: Omniverse Kit SDK container That container contains the Kit SDK that is also available on the Omniverse Launcher, and comes with support for GPU and non-GPU workloads alike.

Getting started

The Kit SDK container is behind a sign-in wall on NGC, NVIDIA’s container registry, and the Docker engine will need to be configured with an API key. Instructions for setting up environments are available on the NGC website.

• Non-GPU containers: It is possible to use the Kit SDK container without needing a GPU for non-GPU workloads (e.g.: a service that copies some files around). For those use cases, the standard Docker runtime can be used.

• GPU containers: The Kit SDK container comes with the necessary libraries and configuration to support GPUs Docker, however needs to be configured to support GPU passthrough. Documentation can be found on the nvidia-docker website.

Using the vanilla Kit SDK container

The Kit SDK container can be used as is and comes with a bash shell embedded as well as the Kit SDK container installed under /opt/nvidia/omniverse/kit-sdk-launcher. At the root of the container are also two example scripts: startup.sh and startup_nogpu.sh.

When running a GPU workload, it is important to note some of the details in the startup.sh script that perform configuration that will need to be replicated in case custom startup scripts are used:

startup.sh

#!/usr/bin/env bash

# Check for libGLX_nvidia.so.0 (needed for Vulkan)
ldconfig -p | grep libGLX_nvidia.so.0 || NOTFOUND=1
if [[ -v NOTFOUND ]]; then
    cat << EOF > /dev/stderr

Fatal Error: Cannot find libGLX_nvidia.so.0...

Ensure running with NVIDIA runtime (--gpus all) or (--runtime nvidia).
If no GPU is required, please run `startup_nogpu.sh` as the entrypoint.

EOF
    exit 1
fi

# Detect NVIDIA Vulkan API version, and create ICD:
export VK_DRIVER_FILES=/tmp/nvidia_icd.json
LD_LIBRARY_PATH=/opt/nvidia/omniverse/kit-sdk-launcher/plugins/carb_gfx \
    /opt/nvidia/omniverse/vkapiversion/bin/vkapiversion \
    "${VK_DRIVER_FILES}"

Building a Hello World Omniverse service container

Standard Docker container workflows can be used for installing and configuring an Omniverse services container.

Using the example from our the “Getting started” guide, we’ll assume the following Hello World service, saved in hello_world.py:

hello_world.py

from omni.services.core import main

def hello_world():
    return "hello world"

main.register_endpoint("get", "/hello-world", hello_world)

Alongside of it in the same directory, we create a Dockerfile with the following content:

Dockerfile

# syntax=docker/dockerfile:1

FROM nvcr.io/nvidia/omniverse/kit:104.0.0

# Install Kit services dependencies.
# This code is pulled from a extension registry and the `--ext-precache-mode` will pull down the extensions and exit.
RUN /opt/nvidia/omniverse/kit-sdk-launcher/kit \
    --ext-precache-mode \
    --enable omni.services.core \
    --enable omni.services.transport.server.http \
    --/exts/omni.kit.registry.nucleus/registries/0/name=kit/services \
    --/exts/omni.kit.registry.nucleus/registries/0/url=https://dw290v42wisod.cloudfront.net/exts/kit/services \
    --allow-root

COPY hello_world.py /hello_world.py
EXPOSE 8011/tcp

ENTRYPOINT [ \
    "/opt/nvidia/omniverse/kit-sdk-launcher/kit", \
        "--exec", "hello_world.py", \
        "--enable", "omni.services.core", \
        "--enable", "omni.services.transport.server.http", \
        "--allow-root" \
 ]

Building and running the example:

docker build -t kit-service .
docker run -it -p 8011:8011 kit-service:latest

By default, an API documentation page is created to list the services exposed, and accessible at http://localhost:8011/docs

It is possible to exercise the API from that webpage by using the Try it out feature within the different endpoints.

Advanced services

It is possible to use all the usual techniques when building Omniverse Extensions and Omniverse app files when building a containerised version. The deep dive into omniverse services , and the extension demo’d in there, can be copied and built into a container in a similar way and run in an identical way. When using extensions requiring a GPU, make sure to refer back to the block on using a vanilla container and the requirements of a startup script to configure the Kit SDK to be able to detect drivers.

Container startup time and Shader caches

It is important to note that this container does not ship with shader caches. Shader caches are likely to be different based on the GPU and drivers that are used. This means that a container startup time, when using the RTX rendering in the service, may take time to start up as the cache gets generated on the first run. If the container is going to be running on the same driver/GPU hardware it is worth running the container once on that hardware and using docker commit to capture the state of the container after the first run which will significantly reduce the startup time of the container