Introduction

NVIDIA® GPU Cloud (NGC) containers leverage the power of GPUs based on the NVIDIA Pascal™ and Volta™ architecture. NGC containers can run in virtual machines (VMs) configured with NVIDIA virtual GPU (vGPU) software in NVIDIA vGPU and GPU pass-through deployments.

The document describes how to set up a VM configured with NVIDIA virtual GPU sofware to run NGC containers. Open the command line in the VM and paste the code blocks into the command line.

Prerequisites

These instructions assume that the following prerequisites are met:
  • A guest VM running a supported Linux release is configured with an NVIDIA vGPU or a pass-through GPU.
  • The NVIDIA virtual GPU software graphics driver is installed in the guest VM.
    Note: Ensure that the driver that is installed is the graphics driver bundled with the NVIDIA virtual GPU software.
  • Any NVIDIA virtual GPU software products that you are using have been licensed with NVIDIA Quadro® Virtual Data Center Workstation (Quadro vDWS).
For instructions, visit https://docs/nvidia.com/grid.

Supported Software and Hardware

Only NVIDIA virtual GPU software release 7.0 is supported.

In NVIDIA vGPU deployments, the following vGPU types are supported:
  • P40-8Q
  • P40-24Q
  • P100-16Q
  • V100-32Q

In GPU pass-through deployments, all GPUs based on the NVIDIA Pascal and Volta architecture that support NVIDIA vGPU software are supported.

Supported guest operating system: Ubuntu 16.04 LTS

The following hypervisor software releases are supported.
  • Citrix XenServer 7.5, 7.0, and 7.1
  • Microsoft Windows Server with Hyper-V role 2016 1709 and 2016 1607
  • Nutanix AHV 5.5 and 5.6
  • Red Hat Enterprise Linux with Kernel Virtual Machine (KVM) 7.0-7.5
  • Red Hat Virtualization (RHV) 4.2
  • VMware vSphere 6.7, 6.5, and 6.0

Installing Docker and the NVIDIA Container Runtime for Docker

The Docker runtime is required to run NGC containers. In addition, the NVIDIA Container Runtime for Docker (nvidia-docker2) ensures that the high performance power of the GPU is leveraged when running NVIDIA-optimized Docker containers.

Installing the Docker Repository

The following code block

  1. Installs apt-transport-https.
  2. Installs curl.
  3. Installs the Docker prerequisites.
  4. Adds the Docker official GPG key.
  5. Adds the official stable Docker repository. Refer to https://docs.docker.com/engine/installation/linux/docker-ce/ubuntu/#install-docker-ce for more information.
sudo apt-get install -y apt-transport-https\
 curl ca-certificates\
 software-properties-common
curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add -
sudo add-apt-repository \
 "deb [arch=amd64] https://download.docker.com/linux/ubuntu $(lsb_release -cs) stable"

Installing the NVIDIA Container Runtime for Docker

  1. Issue the following commands to install the NVIDIA Container Runtime for Docker (nvidia-docker2) repository, install nvidia-docker2, and then set up permissions to use Docker without sudo each time (where $USER refers to the user name).
    curl -s -L https://nvidia.github.io/nvidia-docker/gpgkey | \
      sudo apt-key add -
    curl -s -L https://nvidia.github.io/nvidia-docker/ubuntu16.04/amd64/nvidia-docker.list | \
      sudo tee /etc/apt/sources.list.d/nvidia-docker.list
    sudo apt update
    sudo apt install -y nvidia-docker2
    sudo usermod -aG docker $USER
    

    For more information, see https://github.com/NVIDIA/nvidia-docker.

  2. Reboot the system.
    sudo reboot
    
  3. Upon reboot, test nvidia-smi with the latest official CUDA image.
    docker run --runtime=nvidia --rm nvcr.io/nvidia/cuda:latest nvidia-smi
    

    Docker pulls the nvidia/cuda container image layer by layer, then runs nvidia-smi.

    When completed, the output should show the NVIDIA Driver version and a description of each installed GPU

Using NGC Containers

Make sure you have performed the following steps from the NGC website (see the NGC Getting Started Guide)
  • Signed up for an NGC account at https://ngc.nvidia.com/signup.
  • Created an NGC API key for access to the NGC container registry.
  • Browsed the NGC website and identified an available NGC container and tag to run.
See the following documents for detailed instructions on using NGC Containers.

Notices

Notice

THE INFORMATION IN THIS GUIDE AND ALL OTHER INFORMATION CONTAINED IN NVIDIA DOCUMENTATION REFERENCED IN THIS GUIDE IS PROVIDED “AS IS.” NVIDIA MAKES NO WARRANTIES, EXPRESSED, IMPLIED, STATUTORY, OR OTHERWISE WITH RESPECT TO THE INFORMATION FOR THE PRODUCT, AND EXPRESSLY DISCLAIMS ALL IMPLIED WARRANTIES OF NONINFRINGEMENT, MERCHANTABILITY, AND FITNESS FOR A PARTICULAR PURPOSE. Notwithstanding any damages that customer might incur for any reason whatsoever, NVIDIA’s aggregate and cumulative liability towards customer for the product described in this guide shall be limited in accordance with the NVIDIA terms and conditions of sale for the product.

THE NVIDIA PRODUCT DESCRIBED IN THIS GUIDE IS NOT FAULT TOLERANT AND IS NOT DESIGNED, MANUFACTURED OR INTENDED FOR USE IN CONNECTION WITH THE DESIGN, CONSTRUCTION, MAINTENANCE, AND/OR OPERATION OF ANY SYSTEM WHERE THE USE OR A FAILURE OF SUCH SYSTEM COULD RESULT IN A SITUATION THAT THREATENS THE SAFETY OF HUMAN LIFE OR SEVERE PHYSICAL HARM OR PROPERTY DAMAGE (INCLUDING, FOR EXAMPLE, USE IN CONNECTION WITH ANY NUCLEAR, AVIONICS, LIFE SUPPORT OR OTHER LIFE CRITICAL APPLICATION). NVIDIA EXPRESSLY DISCLAIMS ANY EXPRESS OR IMPLIED WARRANTY OF FITNESS FOR SUCH HIGH RISK USES. NVIDIA SHALL NOT BE LIABLE TO CUSTOMER OR ANY THIRD PARTY, IN WHOLE OR IN PART, FOR ANY CLAIMS OR DAMAGES ARISING FROM SUCH HIGH RISK USES.

NVIDIA makes no representation or warranty that the product described in this guide will be suitable for any specified use without further testing or modification. Testing of all parameters of each product is not necessarily performed by NVIDIA. It is customer’s sole responsibility to ensure the product is suitable and fit for the application planned by customer and to do the necessary testing for the application in order to avoid a default of the application or the product. Weaknesses in customer’s product designs may affect the quality and reliability of the NVIDIA product and may result in additional or different conditions and/or requirements beyond those contained in this guide. NVIDIA does not accept any liability related to any default, damage, costs or problem which may be based on or attributable to: (i) the use of the NVIDIA product in any manner that is contrary to this guide, or (ii) customer product designs.

Other than the right for customer to use the information in this guide with the product, no other license, either expressed or implied, is hereby granted by NVIDIA under this guide. Reproduction of information in this guide is permissible only if reproduction is approved by NVIDIA in writing, is reproduced without alteration, and is accompanied by all associated conditions, limitations, and notices.

Trademarks

NVIDIA, the NVIDIA logo, and Volta are trademarks and/or registered trademarks of NVIDIA Corporation in the Unites States and other countries.

Docker and the Docker logo are trademarks or registered trademarks of Docker, Inc. in the United States and/or other countries.

Other company and product names may be trademarks of the respective companies with which they are associated.