Install UCS Tools

Make sure you have followed the prerequisites first for generating your NGC Personal Key.

Debian Installation

The latest UCS tool release can be downloaded from https://catalog.ngc.nvidia.com/orgs/nvidia/teams/ucs-ms/resources/ucs_tools

After downloading the package using the link above, run:

$ sudo apt remove ucs-tools  # remove old version
$ rm -rf ~/.ucf_workspace/
$ rm -rf ~/.cache/ucf_registry/ # Clear old cache
$ rm -rf ~/.config/ucf/ # Remove old config file
$ sudo dpkg -i ucf_tools_2.5.0-drop-24.06.2_ubuntu22.04_3c41522.deb
$ ucf_app_builder_cli registry repo set-api-key -a <NGC-API-KEY> # NGC Personal key with scopes appropriate scopes added
$ ucf_app_builder_cli registry repo sync


## It installs tools to /opt/nvidia/ucf-tools

UCS Tools Container Image

The ucs_tools_public container is available on NGC.

Get the NGC API Key - Refer to Generating Your NGC API Key

Setup NGC API Key

ucf_app_builder_cli registry repo set-api-key -a <NGC-API-KEY>
ucf_app_builder_cli registry repo sync

Verify the installation

MS Builder

$ ucf_ms_builder_cli --help
usage: ucf_ms_builder_cli [-h] [-v] [-va]  ...

positional arguments:

    service           Perform actions on a microservice
    registry          Perform actions on registry
    component         Perform actions on components

optional arguments:
  -h, --help          show this help message and exit
  -v, --version       Print MS Builder Version
  -va, --version-all  Print all versions
$ ucf_ms_builder_cli --version
Version:
        MS Builder: v2.5.0
$ ucf_ms_builder_cli --version-all
Versions:
        MS Builder: v2.5.0
        UCS MS Spec: v2.5.0

App Builder

$ ucf_app_builder_cli --help
usage: ucf_app_builder_cli [-h] [-v] [-va]  ...

positional arguments:

    app               Perform actions on apps
    service           Perform actions on a microservice

optional arguments:
  -h, --help          show this help message and exit
  -v, --version       Print MS Builder Version
  -va, --version-all  Print all versions
$ ucf_app_builder_cli --version
Version:
        App Builder: v2.5.0
$ ucf_app_builder_cli --version-all
Versions:
        App Builder: v2.5.0
        UCS MS Spec: v2.5.0