Omniverse Storage API Developer Guide

The Omniverse Storage API are gRPC and REST API specifications for the data access layer within the Omniverse platform.

Using the Storage API, you are now able to overlay a Storage Adapter on top of your existing storage system and interface directly with Omniverse.

This guide is intended for developers that want to learn how to use or build adapters for customer storage systems to be used within the Omniverse platform.

The Service Example will show you how to build a Storage Adapter that can be used within the Omniverse platform.

The Client Example will show you how to connect to a Storage Adapter and access your data. The data access will be the same for any Storage Adapter that passes our Conformance Test Suite.

A full reference implementation of the APIs is provided in the filesystem_example directory, which serves versioned files from a filetree build to store head content and versions in separate subtrees.

To test any new storage service implementation for conformance to the API, especially return values in error conditions, there is a runnable conformance test suite in the conformance_tests subdirectory.

• Storage API Introduction
  • Understanding Resource Addressing and Identity
• Client examples
  • Discovery
  • REST
  • GRPC
• Service examples
  • REST service instance example
  • gRPC service example
• Omniverse Filesystem Storage Service
  • Features
  • Installation
  • Usage
  • Testing the Service
• Building a Docker container
  • Building a wheel
  • Building the container
• Conformance test suite
  • Installation
  • Usage
  • Configuration
  • Reporting and logs
  • Summary
• Changes
  • 1.0.0-beta.3
  • 1.0.0-beta.2
  • 1.0.0-beta.1