Architecture#
The diagram below is the full suite of Omniverse Storage services that represent the feature set of Omniverse Enterprise Nucleus Server.
(Left) Client Applications: On the left side of the diagram are client-side applications. These clients interact with the system through a consistent interface, connecting to service adapters via gRPC or REST APIs. This abstraction allows you to swap or update service adapter implementations without requiring changes to the client applications.
(Center) Service Adapters and Core Services: The center of the diagram highlights the core services and service adapters. Green icons indicate services and adapters developed by NVIDIA, available through NGC. Red icons represent third-party services that can be integrated as needed. Each service adapter is modular, enabling you to tailor the architecture to your specific infrastructure requirements.
(Right)Infrastructure Services: On the right, the diagram shows infrastructure services typically managed by your Cloud Service Provider (CSP) or internal infrastructure team. These components can be replaced or extended based on your deployment environment.
For more detailed documentation on each API and service adapter, refer to the overview section of this guide.
This architecture is designed for flexibility: you can replace or extend any of the generalized services shown in the diagram with your own custom service adapters or infrastructure components to best fit your deployment needs.
—
Service and API Spec Compatibility#
The table below shows which API capabilities each service implements and the corresponding API spec version. Use this to ensure the services and client adapters you deploy speak the same API contract.
API Capability |
Storage Service |
Event Aggregation Service |
Event Consumer Service |
Client Library |
Storage Navigator |
|---|---|---|---|---|---|
Storage Capabilities |
v1alpha, v1beta |
— |
v1beta |
v1alpha |
v1alpha |
Storage FileObject |
v1alpha, v1beta |
— |
v1beta |
v1alpha |
v1alpha |
Storage FileFolder |
v1alpha, v1beta |
— |
v1beta |
v1alpha |
v1alpha |
Storage Versioning |
v1alpha, v1beta |
— |
v1beta |
v1alpha |
v1alpha |
Storage Metadata |
v1alpha, v1beta |
— |
v1beta |
v1alpha |
v1alpha |
Permission |
v1beta |
v1beta |
v1beta |
— |
— |
Notification Publishing |
v1beta |
v1beta |
— |
— |
— |
Notification Consuming |
— |
— |
v1beta |
v1beta |
v1beta |
Note
API spec versions and service image versions are versioned independently. The spec version reflects the interface contract; the image version reflects the service implementation. Always match the service image version listed here with the corresponding spec version when building a custom adapter or client integration.
Download the API spec resources from NGC:
# Storage API spec
ngc registry resource download-version \
"nvidia/omniverse/storage-api:1.0.0-beta.4"
# Notifications Aggregation API spec
ngc registry resource download-version \
"nvidia/omniverse/event-aggregation-api:1.0.0-beta-1"
# Notifications Consumer API spec
ngc registry resource download-version \
"nvidia/omniverse/event-consumer-api:1.0.0-beta-1"