Application Deployment#

  1. Create a directory (for example, ~/application) to store the resources and navigate to it.

    mkdir ~/application
cd ~/application

  2. Download the applications-playbook.tar.gz from the Local Developer Setup resource using an NGC API Key.

    This can also be done on the command line as follows after setting the API_KEY environment variable.

    curl -fsSLO "https://api.ngc.nvidia.com/v2/org/nvidia/team/holoscan-for-media/resources/local-developer-setup/versions/0.4.0/files/applications-playbook.tar.gz" -H "Authorization: Bearer ${API_KEY}"

  3. Unarchive the downloaded package in the current directory.

    tar -xzvf applications-playbook.tar.gz

  4. Create a Persistent Volume Claim for Chrome Remote Desktop.

    Creating and using a persistent volume claim is optional, but is necessary for the remote access to still work in case the pod is restarted because an authorization code can only be used once. If needed, follow the steps mentioned in the Chrome Remote Desktop section to create a persistent volume claim.

  5. Edit config.yaml to specify the Persistent Volume Claim name if created above, along with the other required settings as needed including:

    • h4m_ngc to overwrite NGC org and teams to download applications from (default set to nvidia and team holoscan-for-media for proper download from public repositories)

    • rivermax_license_path to create a secret pointing to Rivermax license file

    • scheduler_name (if you use a local developer setup, default-scheduler is recommended while production deployment with OpenShift should typically use topo-aware-scheduler)

    • nmos_cpp_registry and nmos_controller to set appropriate IP addresses depending on the setup (local developer setup with a loop back cable can be made with the static IP addresses proposed as examples)

  6. Activate the Python virtual environment. This was created during the local developer or production platform setup.

  7. Get Chrome Remote Desktop Authorization Code.

    To get the Chrome Remote Desktop authorization code:

    1. Navigate to https://remotedesktop.google.com/headless in your web browser.

    2. Under the Set up via SSH section, click Begin, then Next, and then Authorize.

      picture of the begin button when setting up ssh in Chrome Remote Desktop window

    3. The page will display setup commands for various operating systems. Look for the section that contains the commands for Debian Linux.

      From the command shown, locate the value inside the code="" parameter and copy just that part.

      picture of the code page in Chrome Remote Desktop window

      For example, from the command:

      DISPLAY= /opt/google/chrome-remote-desktop/start-host --code="4/0AVMBsJgg...-mbSFG25g" --redirect-url="https://remotedesktop.google.com/_/oauthredirect" --name=$(hostname)"

      Copy only the part: 4/0AVMBsJgg...-mbSFG25g

    Important

    The authorization code is only valid for five minutes. If it expires, you’ll need to generate a new one.

  8. To run the automation, run the command:

    ANSIBLE_LOG_PATH=./application_$(date +'%Y%m%d_%H%M%S').log ansible-playbook install.yaml --extra-vars "NGC_API_KEY=<API-KEY> CHROME_REMOTE_DESKTOP_CODE=<CRD-CODE>" -vv

    where:

    • <API-KEY> is an NGC API Key (legacy NGC API keys are not supported)

    • <CRD-CODE> is a Chrome Remote Desktop Authorization Code

    • The -vv flag enables verbose output for debugging. You can change it to -v for less detail or -vvv or -vvvv for increasingly more detailed logs.

    Note

    For manual deployment steps, see the Manual Deployment section.

Test Connection#

  1. Go to the Chrome Remote Desktop web interface at https://remotedesktop.google.com/access.

  2. You’ll see your remote computer listed based on the hostname you specified for the chrome-remote-desktop (default: myvirtualdesktop).

    Click the name to connect.

    picture of the access page in Chrome Remote Desktop window

  3. Enter the PIN you configured for the chrome-remote-desktop (default: 123456) when prompted.

    picture of the PIN page in Chrome Remote Desktop window

  4. After connecting to Chrome Remote Desktop, click Application Finder in the dock at the bottom of the screen, search for Firefox, and click the icon to open it.

    picture of the application finder page in Chrome Remote Desktop window

  5. Navigate to the NMOS Controller UI at http://<controller-ui-ip-address>/, where <controller-ui-ip-address> is the high speed network IP specified at deployment time.

  6. In the NMOS Controller UI, you’ll see available devices listed in the left panel under Available.

    picture of the available devices in the NMOS Controller UI

    Note

    If the devices do not appear in the NMOS Controller UI, check the logs of each pod:

    kubectl logs <pod-name>

  7. Drag the sender and receiver devices from the left panel to the empty canvas.

  8. Drag a link between the receiver and the sender to make a connection.

    picture of Holoscan for Media UI connection testing page

  9. After some time, disconnect the link between sender and receiver using the context menu and check the video file saved in the workspace directory of the receiver container.

    Alternatively, you can copy the file to your local directory using the following command:

    kubectl cp <pod-name>:/workspace/recv.mp4 <destination-path>

    • Replace <pod-name> with the name of the receiver pod, can be found using the following command:

      kubectl get pods | grep receiver

      NAME                                                              READY   STATUS    RESTARTS   AGE
nvds-nmos-bin-receiver-nvds-nmos-bin-receiver-pipeline-dbd79rcb   1/1     Running   0          10m

    • Replace <destination-path> with the path to the directory where you want to save the file (for example, /home/user/recv.mp4).

On this page