Docker

General Notes

Warning

Important

Please note that Cache is still in Beta. Flaws in authentication, security and data loss are possible. We reccomenend using Nucleus for evaluation purposes and on prem only at this time. As we move towards release, we will update this notice. As per EULA, no cloud services to 3rd parties are allowed at this time.

System Requirements

Omniverse Cache is a basic HTTP daemon and it’s resourcing should be based on expected load.

General considerations:

  • CPU: enough to cover basic networking needs. Cache doesn’t do any CPU intensive work

  • RAM: cache itself uses minimal amounts of RAM. Filesystem cache is a consideration of course. Use your judgement, and monitor

  • Disk type and size: depends on bandwidth served. Ideally, should be balanced with network speeds and RAM size (slower disk should probably mean more RAM to have a bigger filesystem cache)

Registering and Access

Omniverse Containers are available to members of Omniverse Early Access Program.

To register, please proceed to EAP Registration on developer.nvidia.com and follow the steps on the page to join the NVIDIA Developer Program and then submit your application to the Omniverse Early Access Program.

You will receive a notification email for joining the NVIDIA Developer Program and once your application to the EAP is approved, you will receive a notification email with further instructions.

Docker Compose Stacks

Each compose “setup” has two parts to it - .yml (which is the actual compose file) and .env (which contains most common settings for the compose file).

Trying to keep our documentation as close to the code as possible, the bulk of information necessary to successfully deploy a stack is contained in the .env file. Please make sure to read comments located inside the .env file, and make sure you understand them completely. That’s where the actual documentation lives. Not doing so is virtually guaranteed to arrive at a broken deployment.

Note: these compose files are designed for docker-compose setups, and will not run on Swarms, though they can be easily adopted to run there.

Just a quick reminder on starting a docker-compose setup:

docker-compose --env-file <.env file path> -f <.yml file path> up

Add -d option to ‘daemonize’ your stack.

Firewalls

We do not run firewalls on our Docker hosts. We have observed in-the-field situations where enabled firewalls (ie, ufw) caused problems (services not being accessible, crashloops of some services, etc).

Stack Releases, Notes, and Downloads