Installation Overview#

VSS is compatible with a variety of platforms, including:

  • x86 Machines/Servers: Equipped with NVIDIA dGPUs.

  • NVIDIA Jetson: ARM-based platforms.

  • Enterprise Platforms: Available on CSPs like AWS, GCP, Azure, Oracle, and more.

More details in supported platforms can be found in Supported Platforms.

Note

  1. VSS can be deployed on NVIDIA servers across any cloud provider using the helm or docker compose deployment documentation for bare-metal setups.

  2. VSS can deployed using one-click deployment on Cloud: AWS, GCP.

Common Prerequisites#

Obtain NGC API Key#

To obtain your NGC API key, follow these steps:

  1. Login to NGC: Go to https://ngc.nvidia.com and sign in to your account

  2. Navigate to API Keys: Go to the NGC API Keys page

  3. Navigate to Legacy API Key: Scroll to the bottom of the page and expand the Legacy Keys section. Then click on Generate Legacy Key like in the image below. This should open a pop up window and no key has been generated yet.

NGC API Key

  1. Generate Legacy API Key: In the pop-up window, click the + Generate Legacy Key button. Copy the generated key and store it in a safe place for later use.

Generate Legacy API Key

More information about NGC API keys can be found in the NGC User Guide.

After the above prerequisites have been met, either:

  1. Complete the Helm prerequisites below or

  2. Continue to deploy the VSS Blueprint using Docker Compose.

Deployment Types#

The following deployment types are supported:

  • Helm Chart Deployment

  • Docker Compose Deployment

  • Once click deployment on Cloud: AWS, GCP

Helm Chart Deployment#

The Helm Chart deployment is a deployment type that is used to deploy the Video Search and Summarization (VSS) Agent Blueprint on a Kubernetes cluster.

Helm is a package manager specifically designed for Kubernetes that excels in managing complex, scalable applications by bundling multiple Kubernetes resources into reusable charts. It provides powerful features like versioning, rollbacks, and templating, making it particularly valuable for production environments and CI/CD pipelines. Helm’s ability to maintain consistency across different environments (dev, staging, production) while simplifying resource management makes it an essential tool for organizations deploying applications at scale in Kubernetes clusters.

More details can be found in Deploy Using Helm.

Docker Compose Deployment#

Docker Compose is a tool primarily designed for orchestrating multi-container Docker applications, making it ideal for development environments, testing, and simple deployments. Its key advantages include simple configuration through docker-compose.yaml files, quick setup/teardown of containers, and built-in support for networking and volumes. While Docker Compose excels in local development and testing scenarios due to its simplicity and portability across teams, it’s less suitable for complex production deployments that require high scalability and multi-host orchestration.

More details can be found in Deploy Using Docker Compose X86.

On this page