AWS Deployment

Requirements

Here are the requirements for running Omniverse Isaac Sim on Amazon Web Services (AWS):

  1. An AWS account that is able to launch an EC2 instance with RTX GPU support.

  2. An AWS EC2 Instance with the following specifications:

Setup

Follow these steps below to launch an AWS EC2 instance:

  1. Create your Key Pair PEM file by following the eight steps in this Key Pair Guide.

    Note

    Follow these steps to prevent permission errors when trying to SSH into the AWS instance:

    • On Linux, remember to use chmod 400 yourkey.pem as instructed in the link above.

    • On Windows, right-click the yourkey.pem file and select Properties:

      1. Go to the Security tab and click Advanced.

      2. Click Disable inheritance.

      3. Set ownership of the file to the current user and give full permissions to only that user.

  2. From your AWS EC2 Console, click Launch Instance. Next, go to the Application and OS Images (Amazon Machine Image) section and search for NVIDIA Omniverse.

    Select AMI
  3. Select “NVIDIA Omniverse GPU-Optimized AMI” from the AWS Marketplace AMIs section.

    Note

    • This AMI may not be visible to Hong Kong, Africa Cape Town, Middle East Bahrain and Milan zones.

    • This AMI is based on Ubuntu 20.04.

    Select AMI
  4. In the Instance type section, click on the instance type to search for a g4dn or g5 instance type.

    Note

    • Select a g4dn.2xlarge or higher instance type for a NVIDIA T4 GPU or g5.2xlarge or higher instance type for a NVIDIA A10G GPU.

    • The G5 instance may not be available in all regions (e.g. us-west-1).

    • The NVIDIA A10G GPU (g5.2xlarge) is recommended for heavy workloads.

    NVIDIA T4:

    ../_images/isaac_main_gpu_instance_t4.png

    NVIDIA A10G:

    ../_images/isaac_main_gpu_instance_a10.png
  5. In the Key pair (login) section, click Create new key pair to create a new pem file or select an existing key pair.

    Note

    Is it recommended to secure your instances with a key pair.

    ../_images/isaac_main_create_key_pair.png
  6. In the Network settings section, click Edit

    ../_images/isaac_main_network_settings_edit.png
  7. Next, set Inbound security groups rules to All traffic for “Type” and My IP for “Source type”.

    Note

    This will allow the current machine to connect to the instance and livestreaming to the instance.

    ../_images/isaac_main_all_traffic.png
  8. In the Configure storage section, set the Root volume size to 100GB or more.

    Note

    Isaac Sim can operate on an Instance with 30GB, but you may run out of space when running the Python Samples.

    ../_images/isaac_main_storage.png
  9. Click Launch Instance.

    ../_images/isaac_main_launch.png

    Note

    If you see “You have requested more vCPU capacity than your current vCPU limit”, you might need to stop your running instances to free up vCPU usage and try again.

Connect

  1. In the “Instances” section, click Connect after selected the recently launched instance. Select the SSH client tab to view the instructions to connect.

    ../_images/isaac_main_connect.png
    ../_images/isaac_main_connect_ssh_client.png
  2. Follow these steps to SSH into the AWS instance using an SSH client:

    1. As shown above, on Linux or Windows, run this command from where your PEM key folder is. Replace ubuntu@ec2-3-141-12-46.us-east-2.compute.amazonaws.com with your instance:

    $ ssh -i "yourkey.pem" ec2-3-141-12-46.us-east-2.compute.amazonaws.com
    
    1. On Windows, you can also use Putty to SSH:

      Convert your PEM key to a Putty key. See Connecting to Your Linux Instance from Windows Using PuTTY for more details.

      Put your instance name above in the host name:

      ../_images/isaac_main_host_name_putty.png

      Select SSH/Auth, point Browse to your converted Putty key, then click Open and Yes. You should be able to SSH into the AWS instance now.

      ../_images/isaac_main_auth.png

Container Deployment

  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:2023.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 \
        -e "PRIVACY_CONSENT=Y" \
        -v ~/docker/isaac-sim/cache/kit:/isaac-sim/kit/cache:rw \
        -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/data:/root/.local/share/ov/data:rw \
        -v ~/docker/isaac-sim/documents:/root/Documents:rw \
        nvcr.io/nvidia/isaac-sim:2023.1.1
    

    Note

    • By using the -e "ACCEPT_EULA=Y" flag, you accept the license agreement of the image found at NVIDIA Omniverse License Agreement.

    • By using the -e "PRIVACY_CONSENT=Y" flag, you opt-in to the data collection agreement found at Omniverse Data Collection & Use FAQ. You may opt-out by not setting this flag.

    • The -e "PRIVACY_USERID=<email>" flag can optionally be set for tagging the session logs.

    • 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 Enterprise Nucleus Server.

    • 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 -v
    

    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.

    • The -v flag is used to show additional logs while the shader cache is being warmed up.

    • 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 will 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.

  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.

  • 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 Technical Requirements for recommended drivers.

  • See also Isaac Sim Dockerfiles to build your own custom Isaac Sim container.