Getting Started#

This section introduces the Holoscan for Media reference containers and covers the prerequisites for application deployment.

Reference Containers#

Holoscan for Media offers a collection of reference containers to help you get started with common media workflows. Container can be used as is on standard platform or deployed on Holoscan for Media using Helm charts.

An overview of the available reference applications is provided below.

Platform Tools#

Helm Dashboard – Helm Dashboard is an open-source project which offers a UI-driven way to view, manage and install Helm charts, the deployment method for Holoscan for Media. The Helm Dashboard container is also on NGC.
Chrome Remote Desktop – Set up remote access to a desktop environment running on the cluster and allow access to the high-speed network. It’s particularly useful to access NMOS Controller UI which can leverage the high-speed network to communicate with NMOS Nodes not available through the external network but also provides a secured access to your cluster through the Internet.

NMOS Tools#

NMOS Registry – This Helm chart installs a containerized implementation of an AMWA Networked Media Open Specifications (NMOS) Registry, with a JavaScript-based NMOS Client/Controller and an embedded NMOS Virtual Node. For more information refer to the associated Getting Help section. The NMOS Registry container is also on NGC.
NMOS Controller – This Helm chart installs a browser-based application that uses NMOS APIs to discover, connect and manage resources within a networked media system. The NMOS Controller container is also on NGC.

Media Gateway#

Media Gateway – Media Gateway is a reference application for Holoscan for Media, built on DeepStream. It provides NMOS registration and control of ST 2110 sinks and sources in a flexible GStreamer pipeline passed to the container. Regular GStreamer encoding/decoding/streaming capabilities can be leveraged to receive and send ST 2110 from/to any supported streaming protocol. The Media Gateway container is also on NGC and the source code can be downloaded from the associated Media Gateway resource.

API Keys and License Files#

NGC API Key#

An NGC API key is required. If you do not already have one, create it following the NGC user guide.

Important

Legacy NGC API Keys are not supported.

Rivermax License#

Rivermax is an optimized networking SDK that leverages ConnectX and BlueField DPU hardware-streaming acceleration technology and supports GPUDirect, in bare metal and virtualized environments. It is used by Holoscan for Media applications to comply with the stringent timing and traffic flow requirements of ST 2110.

A Rivermax license is required to use ST 2110 in Holoscan for Media reference containers.

Request a development license at Rivermax Download and store the file at appropriate location (for example, /home/user/rivermax.lic) on the host.

Note

If you are using a purchased Rivermax license, rather than a time-limited development license, you must enable NIC serial number validation using VF_VPD_ENABLE. Check the VF_VPD_ENABLE setting by following the instructions for either production or local developer setup.

Best practice when deploying Rivermax on Holoscan for Media is to create a Secret. This can be accomplished using the Application Deployment automation or manually as follows:

Create Rivermax license secret, replacing <path_to_license> with the actual path:

kubectl create secret generic rivermax-license --from-file=<path_to_license>

Verify that the secret was created:
```
kubectl get secret rivermax-license
```

Note

For production installations, you may also use oc as a drop-in replacement for kubectl.