Registering a Kit Application

Registering an Omniverse Kit App begins by defining a Kubernetes Custom Resource (CR) based on the Application CRD. This resource is specified in a YAML file (e.g., application.yaml) and contains key details such as the application’s name, labels, and description, which are required for deploying it to an Omniverse Kit App Streaming instance.

Creating an Application CR

1. Create a new file called application.yaml

2. Set the apiVersion and Kind as indicated below:

   Sample application.yaml for the usd-viewer application

   apiVersion: omniverse.nvidia.com/v1
   kind: Application
   metadata:
     name: usd-viewer
     labels:
       USD: "true"
       visualisation: "true"
   spec:
     name: Omniverse USD Viewer
     description: View Universal Scene Description files.
   

3. Fill out the metadata and spec sections:

   metadata.name:

   A string ID for the application

   metadata.labels:

   A list of optional labels which can be used for filtering

   spec.name:

   A user-readable name for the application

   spec.description:

   Description of the application

4. Install the application using kubectl:

   kubectl apply -f application.yaml -n omni-streaming
   

5. List the created application:

   kubectl describe application.omniverse.nvidia.com usd-viewer -n omni-streaming
   

6. You can also list using the APS endpoint:

   curl http://<ingress url of the AP service>/cfg/apps