NVIDIA NGC

https://docs.nvidia.com/ngc
Admin
NVIDIA NGC is a cloud platform providing GPU-optimized software, containers, models, and AI/HPC...
Tokens:68,040
Snippets:953
Trust Score:10
Update:2 months ago
Show doc for...
Tokens:
Raw
### Run the new container

Source: https://docs.nvidia.com/ngc/latest/ngc-catalog-user-guide.html

Starts the newly created container to verify the installed software.

```bash
$ docker run --gpus all -ti nvidian_sas/caffe_octave:17.04
```

--------------------------------

### Execute MNIST Example in PyTorch

Source: https://docs.nvidia.com/ngc/ngc-deploy-public-cloud/latest/ngc-deploy-containers/index.html

Steps to navigate to the example directory, install dependencies, and run the training script.

```bash
$ cd /opt/pytorch/examples/upstream/mnist
$ pip install -r requirements.txt
$ python main.py
```

--------------------------------

### Start VM Instance

Source: https://docs.nvidia.com/ngc/ngc-deploy-public-cloud/latest/ngc-alibaba/index.html

Power on the specified VM instance.

```bash
aliyuncli ecs StartInstance --InstanceId "i-rj9a0iw25hryafj0fm4v"
```

--------------------------------

### Example verification command

Source: https://docs.nvidia.com/ngc/latest/ngc-catalog-user-guide.html

Concrete example of running the verification command with specific file paths.

```powershell
PS C:\Users\USER\> model_signing verify certificate --signature omni_paraview_connector_v201.1.0/result.sigstore --certificate_chain publicKey.pem omni_paraview_connector_v201.1.0
```

--------------------------------

### Container Startup Output

Source: https://docs.nvidia.com/ngc/latest/ngc-catalog-user-guide.html

Example output displayed upon starting the NVCaffe container.

```text
==================
== NVIDIA Caffe ==
==================

NVIDIA Release 17.04 (build 26740)

Container image Copyright (c) 2017, NVIDIA CORPORATION.  All rights reserved.
Copyright (c) 2014, 2015, The Regents of the University of California (Regents)
All rights reserved.

Various files include modifications (c) NVIDIA CORPORATION.  All rights reserved.
NVIDIA modifications are covered by the license terms that apply to the underlying project or file.

NOTE: The SHMEM allocation limit is set to the default of 64MB.  This may be insufficient for NVIDIA Caffe.
NVIDIA recommends the use of the following flags:
   nvidia-docker run --shm-size=1g --ulimit memlock=-1 --ulimit stack=67108864 ...

root@1fe228556a97:/workspace#
```

--------------------------------

### Execute MNIST Example in TensorFlow

Source: https://docs.nvidia.com/ngc/ngc-deploy-public-cloud/latest/ngc-deploy-containers/index.html

Steps to navigate to the tutorial directory and run the MNIST summaries example.

```bash
$ cd /opt/tensorflow/tensorflow/examples/tutorials/mnist
$ python mnist_with_summaries.py
```

--------------------------------

### Example CreateInstance Output

Source: https://docs.nvidia.com/ngc/ngc-deploy-public-cloud/latest/ngc-alibaba/index.html

Sample JSON output returned after creating a VM instance.

```json
{
  "InstanceId": "i-rj9a0iw25hryafj0fm4v",
  "RequestId": "440ECC70-09F9-492C-AB9E-21AA9C4E0531"
}
```

--------------------------------

### Install Alibaba ECS SDK

Source: https://docs.nvidia.com/ngc/ngc-deploy-public-cloud/latest/ngc-alibaba/index.html

Install the required Python SDK for Alibaba ECS.

```bash
sudo pip install aliyun-python-sdk-ecs
```

--------------------------------

### Verify Server Readiness

Source: https://docs.nvidia.com/ngc/latest/ngc-catalog-user-guide.html

Example of the console output indicating the server is ready to accept connections.

```text
"Accepting connection(s): [...]:11111"
```

--------------------------------

### Manage Instance Lifecycle

Source: https://docs.nvidia.com/ngc/ngc-deploy-public-cloud/latest/ngc-alibaba/index.html

Commands to stop, start, or delete an existing instance.

```bash
aliyuncli ecs StopInstance --InstanceId INSTANCE_ID
```

```bash
aliyuncli ecs StartInstance --InstanceId INSTANCE_ID
```

```bash
aliyuncli ecs DeleteInstance --InstanceId INSTANCE_ID
```

--------------------------------

### Sample download output

Source: https://docs.nvidia.com/ngc/latest/ngc-catalog-user-guide.html

Example JSON output returned after a successful resource download.

```json
{
    "download_end": "2025-07-08 08:00:58",
    "download_start": "2025-07-08 08:00:12",
    "download_time": "45s",
    "files_downloaded": 2,
    "local_path": "C:\\Users\\NVIDIA\\omni_paraview_connector_v201.1.0",
    "size_downloaded": "187.54 MB",
    "status": "COMPLETED"
}
```

--------------------------------

### Install model-signing tool

Source: https://docs.nvidia.com/ngc/latest/ngc-catalog-user-guide.html

Install the required package from PyPI using pip.

```bash
pip install model-signing
```

--------------------------------

### Install Helm Push Plugin

Source: https://docs.nvidia.com/ngc/latest/ngc-private-registry-user-guide.html

Install the required Helm plugin to enable pushing charts to the registry.

```bash
$ helm plugin install https://github.com/chartmuseum/helm-push
```

--------------------------------

### Install NVIDIA Container Toolkit

Source: https://docs.nvidia.com/ngc/latest/ngc-catalog-user-guide.html

Enables native GPU support on new Docker installations.

```bash
$ sudo apt-get install -y docker nvidia-container-toolkit
```

--------------------------------

### Start a Stopped VM

Source: https://docs.nvidia.com/ngc/ngc-deploy-public-cloud/latest/ngc-azure/index.html

Power on a previously deallocated virtual machine.

```bash
az vm start --resource-group $AZ_RESOURCE_GROUP --name $AZ_VM_NAME
```

--------------------------------

### Install Packages via Apt

Source: https://docs.nvidia.com/ngc/latest/ngc-catalog-user-guide.html

Commands to update the package list and install software within a running container.

```bash
# apt-get update
# apt install octave
```

--------------------------------

### Manage VM Lifecycle

Source: https://docs.nvidia.com/ngc/ngc-deploy-public-cloud/ngc-azure/index.html

Commands to stop, deallocate, or start existing VM instances.

```bash
az vm deallocate --resource-group $AZ_RESOURCE_GROUP --name $AZ_VM_NAME
```

```bash
az vm start --resource-group $AZ_RESOURCE_GROUP --name $AZ_VM_NAME
```

--------------------------------

### Start ParaView Holodeck Client

Source: https://docs.nvidia.com/ngc/latest/ngc-catalog-user-guide.html

Configures X access and launches the client container to connect to the specified server hostname.

```bash
XSOCK=/tmp/.X11-unix; XAUTH=/tmp/.docker.xauth
touch /tmp/.docker.xauth
xauth nlist :0 | sed -e 's/^..../ffff/' \
| xauth -f /tmp/.docker.xauth nmerge -

docker run --rm -it --runtime=nvidia \
-v /tmp/.X11-unix:/tmp/.X11-unix -v /tmp/.docker.xauth:/tmp/.docker.xauth \
-e XAUTHORITY=/tmp/.docker.xauth -e DISPLAY=:0 \
nvcr.io/nvidia-hpcvis/paraview-holodeck:glx-17.11.13-beta \
sh -c paraview\ --server-url=cs://your_server_hostname:11111
```

--------------------------------

### Examples of pulling container images

Source: https://docs.nvidia.com/ngc/latest/ngc-private-registry-user-guide.html

Various examples of pulling images from different registry spaces and organizations.

```bash
~$ sudo docker pull nvcr.io/nvidia/tensorflow:18.06-py3
```

```bash
~$ sudo docker pull nvcr.io/acme/custom-image:v2.0
```

```bash
~$ sudo docker pull nvcr.io/acme/zoom/custom-image:v2.0
```

--------------------------------

### Define Dockerfile

Source: https://docs.nvidia.com/ngc/latest/ngc-catalog-user-guide.html

Create a Dockerfile to install dependencies and set the working directory.

```dockerfile
FROM nvcr.io/nvidia/torch:17.03
RUN luarocks install nngraph
RUN luarocks install \
  https://raw.githubusercontent.com/szym/display/master/display-scm-0.rockspec
WORKDIR /source
```

--------------------------------

### CLI Info Command Output

Source: https://docs.nvidia.com/ngc/latest/ngc-catalog-user-guide.html

Example JSON response containing detailed release metadata including ReleaseType.

```json
{
  "architecture": "amd64",
  "architectureDetails": [
      {
          "architecture": "amd64",
          "compressedSize": 4154881881,
          "createdDate": "2026-01-28T19:20:56.611Z",
          "digest": "sha256:1234567890659ee9517028ea8cce54daf5573959abc998def4321c18c2b29e93e37",
          "malwareScanDate": "2026-01-28T19:22:21.000Z",
          "malwareScanStatus": "CLEAN",
          "modelNames": [],
          "os": "linux",
          "rating": "AAA",
          "scanDate": "2026-02-02T08:08:01.933Z"
      }
  ],
   "isSigned": true,
    "malwareScanDate": "2026-01-28T19:22:21.000Z",
    "malwareScanStatus": "CLEAN",
    "name": "nvidia/cuda-dl-base-pb25h2",
    "policy": [
        "Gov Ready"
    ],
    "ReleaseType": "PRODUCTION",
    "pushedDate": "2026-01-28T19:20:56.611Z",
    "requestStatus": {
        "requestId": "1234567890",
        "statusCode": "SUCCESS",
        "statusDescription": "ok"
    },
    "scanDate": "2026-02-03T02:01:20.278Z",
    "scanDetails": [],
    "scanEnabled": true,
    "scanStatus": "NOT_SCANNED",
    "schemaVersion": 1,
    "signatures": [],
    "size": 4154881881,
    "tag": "25.08.05-cuda13.0-runtime-ubuntu24.04-stig-fips-x86",
    "updatedDate": "2026-01-28T19:20:56.611Z",
    "user": "it_me"
}
```

--------------------------------

### Container verification output

Source: https://docs.nvidia.com/ngc/latest/ngc-catalog-user-guide.html

Example output showing the container startup and the successful execution of the octave command.

```text
==================
== NVIDIA Caffe ==
==================

NVIDIA Release 17.04 (build 26740)

Container image Copyright (c) 2017, NVIDIA CORPORATION.  All rights reserved. Copyright (c) 2014, 2015, The Regents of the University of California (Regents) All rights reserved.

Various files include modifications (c) NVIDIA CORPORATION.  All rights reserved. NVIDIA modifications are covered by the license terms that apply to the underlying project or file.

NOTE: The SHMEM allocation limit is set to the default of 64MB.  This may be insufficient for NVIDIA Caffe.  NVIDIA recommends the use of the following flags:
   nvidia-docker run --shm-size=1g --ulimit memlock=-1 --ulimit stack=67108864 ...

root@2fc3608ad9d8:/workspace# octave
octave: X11 DISPLAY environment variable not set
octave: disabling GUI features
GNU Octave, version 4.0.0
Copyright (C) 2015 John W. Eaton and others.
This is free software; see the source code for copying conditions.
There is ABSOLUTELY NO WARRANTY; not even for MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE.  For details, type 'warranty'.

Octave was configured for "x86_64-pc-linux-gnu".

Additional information about Octave is available at http://www.octave.org.

Please contribute if you find this software useful.
For more information, visit http://www.octave.org/get-involved.html

Read http://www.octave.org/bugs.html to learn how to submit bug reports.
For information about changes from previous versions, type 'news'.

octave:1>
```

--------------------------------

### Sample signature download output

Source: https://docs.nvidia.com/ngc/latest/ngc-catalog-user-guide.html

Example JSON output returned after a successful signature download.

```json
{
    "local_path":"C:\\Users\\NVIDIA/omniverse/omni_paraview_connector_v201.1.0\\result.sigstore",
    "status": "COMPLETED"
}
```

--------------------------------

### Configure umask for Singularity installation

Source: https://docs.nvidia.com/ngc/latest/ngc-catalog-user-guide.html

Adjust the system umask to ensure correct file permissions during Singularity installation on Amazon Machine Images.

```bash
$ umask 0022
```

```bash
$ umask 0077
```

--------------------------------

### View build output and verify image creation

Source: https://docs.nvidia.com/ngc/latest/ngc-catalog-user-guide.html

Example output of a successful Docker build process and the command to list local images.

```bash
$ docker build -t test1:latest .
Sending build context to Docker daemon 3.072 kB
Step 1/3 : FROM ubuntu:14.04
14.04: Pulling from library/ubuntu
...
Step 2/3 : RUN apt-get update && apt-get install -y curl
...
Step 3/3 : CMD echo "hello from inside a container"
 ---> Running in 1f491b9235d8
 ---> 934785072daf
Removing intermediate container 1f491b9235d8
Successfully built 934785072daf
```

```bash
Successfully built  934785072daf
```

```bash
$ docker images
REPOSITORY      TAG            IMAGE ID        CREATED                SIZE
test1           latest         934785072daf    19 minutes ago         222 MB
```

--------------------------------

### Start ParaView Holodeck Server

Source: https://docs.nvidia.com/ngc/latest/ngc-catalog-user-guide.html

Launches the ParaView Holodeck server container on the host machine with necessary X11 and runtime configurations.

```bash
docker run --rm -it --runtime=nvidia \
-v /tmp/.X11-unix:/tmp/.X11-unix -v /tmp/.docker.xauth:/tmp/.docker.xauth \
-e XAUTHORITY=/tmp/.docker.xauth -e DISPLAY=:0 \
-p 11111:11111 \
--shm-size=4g \
nvcr.io/nvidia-hpcvis/paraview-holodeck:glx-17.11.13-beta \
./service.sh externalvis pvserver
```

--------------------------------

### Example Public IP Output

Source: https://docs.nvidia.com/ngc/ngc-deploy-public-cloud/latest/ngc-alibaba/index.html

Sample JSON output showing the assigned IP address.

```json
{
  "IpAddress": "47.89.248.188",
  "RequestId": "65EB59AE-FA75-446F-B5C7-2BA0F9A77CDC"
}
```

--------------------------------

### Build NAMD Singularity Image

Source: https://docs.nvidia.com/ngc/latest/ngc-catalog-user-guide.html

Example command to convert the NAMD HPC application container into a Singularity image.

```shell
$ singularity build namd_2.12-171025.simg docker://nvcr.io/hpc/namd:2.12-171025
```

--------------------------------

### NVCaffe Container Output

Source: https://docs.nvidia.com/ngc/latest/ngc-catalog-user-guide.html

Example output displayed after starting the NVCaffe container.

```text
===========
== Caffe ==
===========

NVIDIA Release 16.12 (build 6217)

Container image Copyright (c) 2016, NVIDIA CORPORATION.  All rights reserved.
Copyright (c) 2014, 2015, The Regents of the University of California (Regents)
All rights reserved.

Various files include modifications (c) NVIDIA CORPORATION.  All rights reserved.
NVIDIA modifications are covered by the license terms that apply to the underlying project or file.
root@df57eb8e0100:/workspace#
```

--------------------------------

### Create VM Instance

Source: https://docs.nvidia.com/ngc/ngc-deploy-public-cloud/ngc-alibaba/index.html

Launch a new instance and view the resulting JSON response.

```bash
aliyuncli ecs CreateInstance \
  --RegionId us-west-1 \
  --ImageId "m-rj9iy0xjiod3ghkyhz4p" \
  --SecurityGroupId "sg-rj94krsusal2k5l6gnnz" \
  --InstanceType ecs.gn5-c4g1.xlarge \
  --InstanceName "my-instance" \
  --InternetMaxBandwidthOut 10 \
  --InstanceChargeType PostPaid \
  --KeyPairName alibaba-key
```

```json
{
  "InstanceId": "i-rj9a0iw25hryafj0fm4v",
  "RequestId": "440ECC70-09F9-492C-AB9E-21AA9C4E0531"
}
```

--------------------------------

### Initialize Project Directory

Source: https://docs.nvidia.com/ngc/latest/ngc-catalog-user-guide.html

Create and navigate to a local project directory.

```bash
mkdir Projects
$ cd ~/Projects
```

--------------------------------

### Launch VM Instance

Source: https://docs.nvidia.com/ngc/ngc-deploy-public-cloud/latest/ngc-alibaba/index.html

Create a new VM instance with specified configuration parameters.

```bash
aliyuncli ecs CreateInstance \
  --RegionId us-west-1 \
  --ImageId "m-rj9iy0xjiod3ghkyhz4p" \
  --SecurityGroupId "sg-rj94krsusal2k5l6gnnz" \
  --InstanceType ecs.gn5-c4g1.xlarge \
  --InstanceName "my-instance" \
  --InternetMaxBandwidthOut 10 \
  --InstanceChargeType PostPaid \
  --KeyPairName alibaba-key
```

--------------------------------

### Install NVIDIA Docker 2.0

Source: https://docs.nvidia.com/ngc/latest/ngc-catalog-user-guide.html

Use this script to remove existing NVIDIA Docker 1.0 installations and install version 2.0 on your instance.

```bash
# Install NVIDIA Docker 2.0
docker volume ls -q -f driver=nvidia-docker | \
  xargs -r -I{} -n1 docker ps -q -a -f volume={} | xargs -r docker rm -f
sudo apt-get purge -y nvidia-docker
curl -L https://nvidia.github.io/nvidia-docker/gpgkey | sudo apt-key add -
sudo tee /etc/apt/sources.list.d/nvidia-docker.list <<< \
"deb https://nvidia.github.io/libnvidia-container/ubuntu16.04/amd64 /
deb https://nvidia.github.io/nvidia-container-runtime/ubuntu16.04/amd64 /
deb https://nvidia.github.io/nvidia-docker/ubuntu16.04/amd64 /"

sudo apt-get -y update
sudo apt-get install -y nvidia-docker2
sudo pkill -SIGHUP dockerd

# Tests
#docker run --runtime=nvidia --rm nvidia/cuda nvidia-smi
```

--------------------------------

### Configure Alibaba CLI

Source: https://docs.nvidia.com/ngc/ngc-deploy-public-cloud/latest/ngc-alibaba/index.html

Initialize the CLI with your credentials.

```bash
aliyuncli configure
```

--------------------------------

### Launch VM Instance

Source: https://docs.nvidia.com/ngc/ngc-deploy-public-cloud/latest/ngc-aws/index.html

Execute the instance launch command and capture the resulting Instance ID.

```bash
NVAWS_LAUNCH_JSON=$(aws ec2 run-instances --image-id $NVAWS_IMAGE_ID \
 --instance-type $NVAWS_INSTANCE_TYPE \
 --region $NVAWS_REGION \
 --key-name $NVAWS_KEYNAME \
 --security-group-ids $NVAWS_SG_ID \
 --block-device-mapping "[{\"DeviceName\":\"/dev/sda1\",\"Ebs\":{\"VolumeSize\":$NVAWS_EBS_GB}}]" \
 --tag-specifications "ResourceType=instance,Tags=[{Key=Name,Value=$NVAWS_NAME_TAG}]")
NVAWS_INSTANCE_ID=$(echo $NVAWS_LAUNCH_JSON | jq .Instances[0].InstanceId | sed 's/\"//g') && echo NVAWS_INSTANCE_ID=$NVAWS_INSTANCE_ID
```

--------------------------------

### Launch a Custom GPU Instance

Source: https://docs.nvidia.com/ngc/ngc-deploy-public-cloud/latest/ngc-gcp/index.html

Use this command to create a new VM instance with specific GPU and machine configurations.

```bash
gcloud compute \
--project "<project-id>" \
instances create "<instance-name>" \
--zone "<zone>" \
--machine-type "<vCPU-mem-config>" \
--subnet "<subnet-name>" \
--metadata "<your-public-ssh-key>" \
--maintenance-policy "<maintenance-policy>" \
--service-account "<service-account-email>" \
--scopes "https://www.googleapis.com/auth/devstorage.read_only","https://www.googleapis.com/auth/logging.write","https://www.googleapis.com/auth/monitoring.write","https://www.googleapis.com/auth/servicecontrol","https://www.googleapis.com/auth/service.management.readonly","https://www.googleapis.com/auth/trace.append" \
--accelerator type=<accelerator-type> \
--min-cpu-platform "<CPU-platform>" \
--image "<nvidia-gpu-cloud-image>" \
--image-project "<project-name>" \
--boot-disk-size "32" \
--boot-disk-type "pd-standard" \
--boot-disk-device-name "<boot-disk-name>"
```

--------------------------------

### Launch VM Instance

Source: https://docs.nvidia.com/ngc/ngc-deploy-public-cloud/ngc-aws/index.html

Executes the instance launch command and captures the resulting Instance ID.

```bash
NVAWS_LAUNCH_JSON=$(aws ec2 run-instances --image-id $NVAWS_IMAGE_ID \
  --instance-type $NVAWS_INSTANCE_TYPE \
  --region $NVAWS_REGION \
  --key-name $NVAWS_KEYNAME \
  --security-group-ids $NVAWS_SG_ID \
  --block-device-mapping
 "[{\"DeviceName\":\"/dev/sda1\",\"Ebs\":{\"VolumeSize\":$NVAWS_EBS_GB}}]" \
  --tag-specifications
 "ResourceType=instance,Tags=[{Key=Name,Value=$NVAWS_NAME_TAG}]")
NVAWS_INSTANCE_ID=$(echo $NVAWS_LAUNCH_JSON | jq .Instances[0].InstanceId | sed 's/\"//g') && echo NVAWS_INSTANCE_ID=$NVAWS_INSTANCE_ID
```

--------------------------------

### Create ParaView Settings Directory

Source: https://docs.nvidia.com/ngc/latest/ngc-catalog-user-guide.html

Prepare a local directory to store ParaView configuration files.

```bash
mkdir pvsettings
```

--------------------------------

### Get Helm Chart Information

Source: https://docs.nvidia.com/ngc/latest/ngc-private-registry-user-guide.html

Retrieve metadata for a specific Helm chart.

```bash
$ ngc registry chart info nvidian/ngcdocstest
--------------------------------------------------
Chart Information
 Name: ngcdocstest
 Short Description: Doc testing chart
 Display Name: Helm Demo Chart
 Team:
 Publisher: test account
 Built By: my team
 Labels:
 Logo:
 Created Date: 2021-03-22 18:48:36 UTC
 Updated Date: 2021-03-22 18:54:44 UTC
 Read Only: False
 Latest Version ID: 0.1.0
 Latest Version Size (bytes): 10664
 Overview:
--------------------------------------------------
```

--------------------------------

### Create a GPU VM Instance

Source: https://docs.nvidia.com/ngc/ngc-deploy-public-cloud/latest/ngc-azure/index.html

Provision a new GPU-optimized virtual machine using the specified configuration variables.

```bash
az vm create \
 --name ${AZ_VM_NAME} \
 --resource-group ${AZ_RESOURCE_GROUP} \
 --image ${AZ_IMAGE} \
 --location ${AZ_LOCATION} \
 --size ${AZ_SIZE} \
 --ssh-key-value ${AZ_SSH_KEY} \
 --admin-username ${AZ_USER} \
 --nsg ${AZ_NSG}
```

--------------------------------

### VEX Manifest JSON Structure

Source: https://docs.nvidia.com/ngc/latest/ngc-catalog-user-guide.html

Example of the manifest returned after fetching a VEX artifact.

```json
{
   "schemaVersion": 2,
   "mediaType": "application/vnd.oci.image.manifest.v1+json",
   "artifactType": "doc/vex",
   "config": {
      "mediaType": "application/vnd.oci.empty.v1+json",
      "digest": "sha256:44136fa355b3678a1146ad16f7e8649e94fb4fc21fe77e8310c060f61caaff8a",
      "size": 2,
      "data": "e30="
   },
   "layers": [
      {
      "mediaType": "application/vnd.oci.image.layer.v1.tar",
      "digest": "sha256:b7f540429bba4110f9011439cef750a72ec9b44d16f3a52414e05c5f04d17e6f",
      "size": 1911,
      "annotations": {
         "org.opencontainers.image.title": "/usr/tmp/org/nvidia/repo/pytorch/tag/26.01-py3/digest/1b6dd8dc60741fb99b9aa343fa03fc897fbb64fbdcb1c8afcbd48c75cba57255/cyclonedx_vex.json"
      }
      }
   ],
   "annotations": {
      "org.opencontainers.image.created": "2026-02-03T21:05:42Z"
   }
}
```

--------------------------------

### Example Image ID Output

Source: https://docs.nvidia.com/ngc/ngc-deploy-public-cloud/latest/ngc-alibaba/index.html

Sample JSON output returned by the DescribeImages command.

```json
{
  "ImageId": "m-rj9iy0xjiod3ghkyhz4p"
}
```

--------------------------------

### Manage VM Instance Lifecycle

Source: https://docs.nvidia.com/ngc/ngc-deploy-public-cloud/latest/ngc-gcp/index.html

Commands to stop or start/restart an existing VM instance.

```bash
gcloud compute instances stop <instance-name>
```

```bash
gcloud compute instances start <instance-name> <zone>
```

--------------------------------

### Prepare EBS for Data Upload

Source: https://docs.nvidia.com/ngc/ngc-deploy-public-cloud/latest/ngc-aws/index.html

Create the mount directory and set permissions to allow data transfer.

```bash
sudo mkdir /data
sudo mount /dev/xvdf /data
sudo chmod 777 /data
```

--------------------------------

### Run Containers with NVIDIA Container Runtime

Source: https://docs.nvidia.com/ngc/latest/ngc-catalog-user-guide.html

Methods for running GPU-accelerated containers when nvidia-docker2 is installed.

```bash
$ sudo docker run --runtime=nvidia ...
```

```bash
$ sudo nvidia-docker run ...
```

--------------------------------

### Create a Helm chart template

Source: https://docs.nvidia.com/ngc/latest/ngc-private-registry-user-guide.html

Initializes a new Helm chart directory structure.

```bash
$ helm create <chart-name>
```

```bash
$ helm create ngcdocstest
```

--------------------------------

### Update Team-Scoped API Path

Source: https://docs.nvidia.com/ngc/latest/ngc-deprecated-api.html

Example of migrating a team-scoped API path to an organization-scoped path.

```text
/v2/orgs/{org}/teams/{team}/nvcf/functions/**
```

```text
/v2/orgs/{org}/nvcf/functions/**
```

--------------------------------

### Run ParaView OptiX GLX Container

Source: https://docs.nvidia.com/ngc/latest/ngc-catalog-user-guide.html

Launch the GLX-enabled container with local directory mounting.

```bash
docker run --rm -it --runtime=nvidia -v /tmp/.X11-unix:/tmp/.X11-unix -v /tmp/.docker.xauth:/tmp/.docker.xauth -e XAUTHORITY=/tmp/.docker.xauth -e DISPLAY=:0 -v $(pwd):/work:rw nvcr.io/nvidia-hpcvis/paraview-optix-glx-beta:17.11.10 sh -c paraview
```

--------------------------------

### NGC CLI Download Output

Source: https://docs.nvidia.com/ngc/latest/ngc-catalog-user-guide.html

Example output confirming the successful completion of a model download operation.

```text
Downloaded 230.92 MB in 38s, Download speed: 6.07 MB/s
----------------------------------------------------
Transfer id: trt_onnx_vgg16_v100_16g_int8_v1 Download status: Completed.
Downloaded local path: C:\ngcdocsmodel
Total files downloaded: 3
Total downloaded size: 230.92 MB
Started at: 2019-03-18 14:09:31.664000
Completed at: 2019-03-18 14:10:09.712000
Duration taken: 38s seconds
----------------------------------------------------
```

--------------------------------

### Configure X-Forwarding Variables

Source: https://docs.nvidia.com/ngc/latest/ngc-catalog-user-guide.html

Set up X authentication files to allow container access to the host display.

```bash
XSOCK=/tmp/.X11-unix; XAUTH=/tmp/.docker.xauth
touch /tmp/.docker.xauth
xauth nlist :0 | sed -e 's/^..../ffff/' \
| xauth -f /tmp/.docker.xauth nmerge
```

--------------------------------

### Update Helm Chart via CURL

Source: https://docs.nvidia.com/ngc/latest/ngc-private-registry-user-guide.html

Example CURL command to patch Helm chart metadata.

```bash
curl -X PATCH --header 'Content-Type: application/json' \
   --header 'Accept: application/json' \
   --header 'Authorization: Bearer <<BEARER_TOKEN>>' \
   -d '{ "builtBy": "NVIDIA", "description": "#Le Chart", "displayName": "NGC DOCS TEST", "labels": [ "Helm Chart", "Documentation" ], "shortDescription": "This chart is for the docs&#33;" }' \
   'https://api.ngc.nvidia.com/v2/org/nvidian/helm-charts/ngcdocstest'
```

--------------------------------

### Pull and Run NVCaffe 17.04

Source: https://docs.nvidia.com/ngc/latest/ngc-catalog-user-guide.html

Commands to pull and start an interactive session in the NVCaffe 17.04 container.

```bash
$ docker pull nvcr.io/nvidia/caffe:17.04
```

```bash
$ docker run --gpus all -ti nvcr.io/nvidia/caffe:17.04
```

--------------------------------

### User ID Warning Message

Source: https://docs.nvidia.com/ngc/latest/ngc-catalog-user-guide.html

Example warning message when the host user does not exist within the container environment.

```text
groups: cannot find name for group ID 1000I have no name! @c177b61e5a93:/workspace$
```

--------------------------------

### Create a Helm Chart Record

Source: https://docs.nvidia.com/ngc/latest/ngc-private-registry-user-guide.html

Initialize a chart record in the registry before uploading. A short description is required.

```bash
$ ngc registry chart create <org>/[<team>/]<chart_name> --short-desc <description>
```

```bash
$ ngc registry chart create nvidian/ngcdocstest --short-desc "Doc testing chart"

Successfully created chart 'nvidian/ngcdocstest'.
--------------------------------------------------
Chart Information
 Name: ngcdocstest
 Short Description: Doc testing chart
 Display Name:
 Team:
 Publisher:
 Built By:
 Labels:
 Logo:
 Created Date: 2021-03-22 18:48:36 UTC
 Updated Date: 2021-03-22 18:48:36 UTC
 Read Only: False
 Latest Version ID:
 Latest Version Size (bytes):
 Overview:
--------------------------------------------------
```

--------------------------------

### Create VM and Capture Public IP

Source: https://docs.nvidia.com/ngc/ngc-deploy-public-cloud/latest/ngc-azure/index.html

Provision the VM and store the resulting public IP address in a variable for subsequent SSH access.

```bash
AZ_JSON=$(az vm create \
 --name ${AZ_VM_NAME} \
 --resource-group ${AZ_RESOURCE_GROUP} \
 --image ${AZ_IMAGE} \
 --location ${AZ_LOCATION} \
 --size ${AZ_SIZE} \
 --ssh-key-value ${AZ_SSH_KEY} \
 --admin-username ${AZ_USER} \
 --nsg ${AZ_NSG})
AZ_PUBLIC_IP=$(echo $AZ_JSON | jq .publicIpAddress | sed 's/\"//g') && \
 echo $AZ_JSON && echo AZ_PUBLIC_IP=$AZ_PUBLIC_IP
```

--------------------------------

### Run NVCaffe Container Interactively

Source: https://docs.nvidia.com/ngc/latest/ngc-catalog-user-guide.html

Example of running the 16.12 release of NVCaffe in interactive mode with automatic removal.

```bash
$ docker run --gpus all --rm -ti nvcr.io/nvidia/caffe:16.12
```

--------------------------------

### Create a registry resource

Source: https://docs.nvidia.com/ngc/latest/ngc-private-registry-user-guide.html

Initializes a new resource placeholder in the registry. Use the -h flag to view all available arguments.

```bash
$ ngc registry resource create nvidia/cmr_gnmt
```

```bash
$ ngc registry resource create -h
```

--------------------------------

### View VEX File Content

Source: https://docs.nvidia.com/ngc/latest/ngc-catalog-user-guide.html

Commands and example output for viewing the contents of the downloaded VEX JSON file.

```bash
C:\> cat vex.json
```

```json
{
  "bomFormat": "CycloneDX",
  "specVersion": "1.4",
  "serialNumber": "urn:uuid:29c84156-c742-49b8-9dc8-33cbcf105be0",
  "version": 1,
  "metadata": {
    "component": {
      "type": "container",
      "bom-ref": "sha256:1b6dd8dc60741fb99b9aa343fa03fc897fbb64fbdcb1c8afcbd48c75cba57255",
      "name": "pytorch:26.01-py3"
    }
  },
  "vulnerabilities": [
    {
      "bom-ref": "84b4db72-e6b5-461b-a575-f66fb3e28117",
      "id": "GHSA-7gcm-g887-7qv7",
      "analysis": {
        "state": "in_triage",
        "detail": "To mitigate potential Denial of Service risks associated with the Protocol Buffering (CVE-2026-0994), customers are advised to avoid using untrusted data sources when deserializing data. We recommend isolating internal orchestration and gRPC ports within a trusted private network (VPC), ensuring only secured API endpoints are exposed to external traffic."
      },
      "affects": [
        {
          "ref": "protobuf",
          "versions": [{"version": "6.33.4"}]
        }
      ]
    },
    {
      "bom-ref": "3011685e-040a-4531-94f8-4b01881ed0e4",
      "id": "GHSA-8rrh-rw8j-w5fx",
      "analysis": {
        "state": "in_triage",
        "detail": "The vulnerability requires explicit execution of wheel.cli.unpack on a malicious wheel file. Static analysis confirms zero calls to wheel.cli.unpack or setuptools._vendor.wheel in the specific container codebases. Container builds use pip install, which are not affected by this vector. This will be resolved in release 26.02."
      },
      "affects": [
        {
          "ref": "wheel",
          "versions": [{"version": "0.45.1"}]
        }
      ]
    },
    {
      "bom-ref": "25f77379-8f5c-4adf-b1d3-9f44acc67cda",
      "id": "GHSA-xm59-rqc7-hhvf",
      "analysis": {
        "state": "not_affected",
        "justification": "code_not_reachable",
        "detail": "Exploit does not impact our containers as the vulnerability relies on executing a malicious Windows batch file (inkscape.bat). Since our containers are Linux-based, we do not execute batch files and do not include the working directory in the system $PATH by default."
      },
      "affects": [
        {
          "ref": "nbconvert",
          "versions": [{"version": "7.16.6"}]
        }
      ]
    }
  ],
  "$schema": "http://cyclonedx.org/schema/bom-1.4.schema.json"
}
```

--------------------------------

### Mount Local Directory to Container

Source: https://docs.nvidia.com/ngc/latest/ngc-catalog-user-guide.html

Example of mapping a host directory to a container directory using the -v flag.

```bash
-v /home/jsmith/data/mnist:/data/mnist
```

--------------------------------

### CLI List Command Output

Source: https://docs.nvidia.com/ngc/latest/ngc-catalog-user-guide.html

Example JSON output returned when listing releases via the NGC CLI.

```json
[{
    "createdByUser": "ngc-123456789",
    "createdDate": "2026-01-09T23:59:00.730Z",
    "isSigned": true,
    "malwareScanDate": "2025-12-03T21:55:12.000Z"
    "malwareScanStatus": "CLEAN",
    "policy": [],
    "releaseNotes": " Kit 109.0.1 Release Notes"
    "releaseType": "FEATURE",
    "status": "UPLOAD_COMPLETE",
    "storageVersion": "V2",
    "totalFileCount": 1,
    "totalSizeInBytes": `1413212300`,
    "versionId": "109.0.1"
},
{
    "createdByUser": "ngc-123456789",
    "createdDate": "2025-11-14T23:59:00.730Z",
    "isSigned": true,
    "malwareScanDate": "2025-11-14T21:55:12.000Z"
    "malwareScanStatus": "CLEAN",
    "policy": [],
    "releaseNotes": " Kit 109.0 Release Notes"
    "releaseType": "FEATURE",
    "status": "UPLOAD_COMPLETE",
    "storageVersion": "V1",
    "totalFileCount": 1,
    "totalSizeInBytes": `1413122300`,
    "versionId": "109.0.0"
},
]
```

--------------------------------

### Connect GLX Client to Remote Server

Source: https://docs.nvidia.com/ngc/latest/ngc-catalog-user-guide.html

Configure X access and launch the client container to connect to a remote ParaView server instance.

```bash
XSOCK=/tmp/.X11-unix; XAUTH=/tmp/.docker.xauth
touch /tmp/.docker.xauth
xauth nlist :0 | sed -e 's/^..../ffff/' \
| xauth -f /tmp/.docker.xauth nmerge -

docker run --rm -it --runtime=nvidia \
-v /tmp/.X11-unix:/tmp/.X11-unix -v /tmp/.docker.xauth:/tmp/.docker.xauth \
-e XAUTHORITY=/tmp/.docker.xauth -e DISPLAY=:0 \
nvcr.io/nvidia-hpcvis/paraview-index:glx-17.11.13-beta \
sh -c paraview\ --server-url=cs://your.server.address:11111
```

--------------------------------

### Start interactive shell in Singularity

Source: https://docs.nvidia.com/ngc/latest/ngc-catalog-user-guide.html

Launches an interactive bash session or default shell inside the container environment.

```bash
$ singularity exec --nv <app_tag>.simg /bin/bash
```

```bash
$ singularity exec --nv namd_2.12-171025.simg
```
Tokens:
Raw