Deploy to Kit App Streaming#

OVAS API banner for Kit App Streaming deployment guide

After your web client works as expected against a local Omniverse Kit App, deploying to an Omniverse Kit App Streaming instance requires only a stream configuration update. Your application code, messaging logic, and event handlers carry over unchanged. This page walks you through locating your Application and ApplicationProfile, creating a stream, connecting the client, and cleaning up when you finish.

Background information

Before you follow the deployment steps, review how an Omniverse Kit App Streaming instance manages Kit Applications.

The Manage Kit applications in the cluster guide walks through how Application, ApplicationVersion, and ApplicationProfile are used to deploy a Kit App to an instance. These are key concepts you need to integrate your application with an Omniverse Kit App Streaming instance.

The ApplicationProfile determines how a Omniverse Kit App will run in the cluster on a GPU Worker Node. Understanding how it specifies the required resources (for example, CPU, memory) and configuration options will be important, as you must specify an ApplicationProfile when requesting a Kit App stream.

Step 1 - Find your application and version

Verify that the Application and ApplicationVersion you want to stream exist on your Omniverse Kit App Streaming instance.

Find your application and version

Step 2 - Find an application profile

Verify that an appropriate ApplicationProfile exists for your application and version.

Find an application profile

Step 3 - Create the stream

Request a new Kit App stream from the Streaming Session service.

Create a streaming session

Step 4 - Connect to the stream

After the stream is ready, connect your web client using the Omniverse WebRTC Streaming Library.

Step 5 - Disconnect the client

When you finish with the stream, disconnect the client.

Disconnect from the stream

Step 6 - Terminate the stream

Terminate the Kit App stream when it is no longer needed. Streams are not garbage collected automatically.

Terminate the stream


Summary#

You have walked through locating application metadata, creating a stream, connecting with the WebRTC library, disconnecting the client, and terminating the session. Return to Web development overview when you need the full local-to-cloud workflow.