3.2.1. Container DeploymentΒΆ

This section describes how to run the Omniverse Isaac Sim container remotely.

Steps:

  1. Connect to the machine via SSH.

  2. Run the command below to confirm your GPU driver version.

    $ nvidia-smi
    
  3. Get access to the Isaac Sim Container using your NVIDIA Developer Program credentials.

  4. Generate your NGC API Key.

  5. Use the command line to log in to NGC before pulling the Isaac Sim container.

    $ docker login nvcr.io
    Username: $oauthtoken
    Password: <Your NGC API Key>
    WARNING! Your password will be stored unencrypted in /home/username/.docker/config.json.
    Configure a credential helper to remove this warning. See
    https://docs.docker.com/engine/reference/commandline/login/#credentials-store
    Login Succeeded
    
  6. Pull the Isaac Sim container:

    $ docker pull nvcr.io/nvidia/isaac-sim:2022.1.1
    
  7. Run the Isaac Sim container with an interactive Bash session:

    $ docker run --name isaac-sim --entrypoint bash -it --gpus all -e "ACCEPT_EULA=Y" --rm --network=host \
    -v ~/docker/isaac-sim/cache/ov:/root/.cache/ov:rw \
    -v ~/docker/isaac-sim/cache/pip:/root/.cache/pip:rw \
    -v ~/docker/isaac-sim/cache/glcache:/root/.cache/nvidia/GLCache:rw \
    -v ~/docker/isaac-sim/cache/computecache:/root/.nv/ComputeCache:rw \
    -v ~/docker/isaac-sim/logs:/root/.nvidia-omniverse/logs:rw \
    -v ~/docker/isaac-sim/config:/root/.nvidia-omniverse/config:rw \
    -v ~/docker/isaac-sim/data:/root/.local/share/ov/data:rw \
    -v ~/docker/isaac-sim/documents:/root/Documents:rw \
    nvcr.io/nvidia/isaac-sim:2022.1.1
    

    Note

    • The Nucleus and Cache installer is no longer available in the Isaac Sim container. The recommended installation of Nucleus is via the Omniverse Launcher. For enterprise users, see Omniverse Nucleus Enterprise

    • The Isaac Sim container will use assets in the Cloud if no Nucleus server is available.

    When using a separate Nucleus server:

  8. Start Isaac Sim with native livestream mode:

    $ ./runheadless.native.sh
    

    Note

    • Before running a livestream client, make sure that the Isaac Sim app is loaded and ready. It may take a few minutes for Isaac Sim to be completely loaded.

    • To confirm this, look out for this line in the console or the logs:

      Isaac Sim Headless Native App is loaded.
      
    • The first time loading Isaac Sim will take a while for the shaders to be cached. Subsequent runs of Isaac Sim with be quick once the shaders are cached and the cache is mounted when the container runs.

    • See Save Isaac Sim Configs on Local Disk to make Isaac Sim configs and cache persistent when using containers.

    Warning

    • If you are on an NVIDIA A100 or A40 GPU, run Isaac Sim with the command below. This starts a WebSocket livestreaming server with software enconding that supports RTX GPUs with no NVENC encoder support.

      $ ./runheadless.websocket.h264.sh
      
    • Skip steps 9 and 10 below and connect to Isaac Sim using the WebSocket Browser Client:

      http://<ip address>:8211/streaming/client

  9. Install and launch the Omniverse Streaming Client from the Omniverse Launcher.

    Note

    • Only the Omniverse Streaming Client is supported for the best experience streaming to an AWS EC2 instance over the Internet.

    • See Omniverse Streaming Client for more information about the Omniverse Streaming Client.

  10. Enter the IP address of the machine or instance running the Isaac Sim container and click on the Connect button to begin live streaming.

  11. Proceed to Isaac Sim Interface to begin the first Basic Tutorial.

Note

  • Some tutorials that uses the Content Browser may not work when using the Isaac Sim container with no Nucleus connected.

  • It is recommended to use the Workstation Isaac Sim from the Omniverse Launcher to run all tutorials.

  • The Isaac Sim container supports running our python apps and standalone examples in headless mode only.

  • The latest NVIDIA drivers may not be fully supported for some features like livestreaming. See NVIDIA OMNIVERSE - Driver Requirements for recommended drivers.