NVIDIA GPU Cloud Documentation

NGC User Guide

This document is a comprehensive guide to NVIDIA GPU Cloud (NGC), providing detailed instructions on setting up, managing, and optimizing your cloud environment, including creating accounts, managing users, accessing pre-trained models, and leveraging NGC’s suite of AI and HPC tools.

📋 Table of Contents

NGC User Guide

• 1. Overview
• 2. What is NVIDIA NGC?
• 3. Why NGC Software
• 4. NGC Organizations and Teams
  • 4.1. NVIDIA Cloud Accounts and NGC
  • 4.2. NGC Teams
  • 4.3. NGC Org Owner and Other Org Users
    • 4.3.1. Adding NGC Users to an Org
    • 4.3.2. Updating User Roles
    • 4.3.3. Removing a User from an NGC Org
    • 4.3.4. Securing the Owner Account with Multi-Factor Authentication
    • 4.3.5. Contacting your Org Owner
    • 4.3.6. External User Groups
  • 4.4. Transferring Your Product Activation Invitation
• 5. Accessing NGC Org
  • 5.1. Activating Your NGC Product from an NGC Email Invitation
    • 5.1.1. NGC Product Activation by Invitation - New User
    • 5.1.2. NGC Product Activation by Invitation - Existing User
  • 5.2. Activating NGC Product from an NVIDIA Commercial Entitlement Certificate
  • 5.3. Signing Up for a Free Individual NGC Org
  • 5.4. Setting up your NCA Account
    • 5.4.1. Setting Up NCA Recovery Email
  • 5.5. Accepting an NCA Invitation to Access NGC
• 6. Using an External SSO for NGC Org Authentication
  • 6.1. Federating IdP with NVIDIA Cloud Services
  • 6.2. Authenticating and Managing User Access
  • 6.3. NGC IdP Membership Rules
• 7. Activating Your Subscription (Offer Dependent)
• 8. Switching Orgs or Team After Logging into NGC
• 9. NGC API Keys
  • 9.1. Supported NGC Applications and API Key Types
  • 9.2. Generating NGC API Keys
    • 9.2.1. Generating a Personal API Key
    • 9.2.2. Generating a Service API Key
• 10. Secure Sharing Service
  • 10.1. Securely Sharing Secrets
  • 10.2. Receiving a Secure Share Link
  • 10.3. Finding your Organization Name
• 11. Notification Services
• 12. Appendix
  • 12.1. NVIDIA NGC Network Protocols

Open User Guide

NGC Catalog User Guide

Step-by-step guide to accessing NVIDIA’s curated collection of AI software, Docker containers, and pre-trained models from the NGC Catalog for faster AI development.

📋 Table of Contents

NGC Catalog Guide

• 1. Overview
• 2. What is the NGC Catalog?
• 3. Terms and Concepts
• 4. Why NGC Software
• 5. Accessing NGC Software
• 6. Registering and Activating a New NGC Org to Obtain Authenticated Access
  • 6.1. Signing Up for an NVIDIA Cloud Account and Activating an Individual NGC Org
  • 6.2. NGC API Keys
    • 6.2.1. Supported NGC Applications and API Key Types
    • 6.2.2. Generating NGC API Keys
• 7. Introduction to the NGC Catalog and NGC CLIs
  • 7.1. Installing NGC Catalog CLI
  • 7.2. Installing NGC Registry CLI
• 8. Docker Containers
  • 8.1. What Is a Docker Container?
  • 8.2. Why Use A Container?
  • 8.3. Searching and Filtering Containers
• 9. NGC Container Images in NGC Catalog
  • 9.1. Why NGC Container Images?
    • 9.1.1. NGC Container Security Policy
    • 9.1.2. NVIDIA Security Risk Scale
    • 9.1.3. GPU-performance Tests for NGC Catalog Container Images
  • 9.2. NVIDIA CUDA Toolkit
  • 9.3. Running Singularity Containers
    • 9.3.1. Prerequisites
    • 9.3.2. Converting to Singularity Image
    • 9.3.3. Running the Singularity Container
• 10. Prerequisites for Using NGC Catalog Container Images
  • 10.1. Prerequisites for Using NGC Containers on DGX Systems
  • 10.2. Prerequisites for Using NGC Containers on Cloud Platforms
  • 10.3. Prerequisites for Using NGC Containers on Other NVIDIA GPUs
  • 10.4. HPC Visualization Containers
    • 10.4.1. Prerequisites For HPC Visualization Containers
    • 10.4.2. Installing NVIDIA Docker 2.0
    • 10.4.3. ParaView With NVIDIA Holodeck
    • 10.4.4. ParaView With NVIDIA IndeX
    • 10.4.5. ParaView With NVIDIA OptiX
• 11. Pulling NGC Containers from NGC Catalog
  • 11.1. Key NGC Container Registry Terminology
  • 11.2. Accessing and Pulling an NGC Container Image via the Docker CLI
    • 11.2.1. Logging in to the NGC Container Registry
    • 11.2.2. Pulling a Container from NGC Container Registry Using Docker CLI
  • 11.3. Accessing and Pulling an NGC Catalog Container Using NGC CLI
    • 11.3.1. Viewing Container Image Information
    • 11.3.2. Pulling a Container Image
• 12. NGC Container Image Versions
• 13. NVIDIA Signed Container Images in NGC Catalog
  • 13.1. Checking for Signed Container Images
    • 13.1.1. Using the NGC Catalog UI
    • 13.1.2. Using the NGC CLI
  • 13.2. Finding NVIDIA’s Public Key
    • 13.2.1. Using the NGC Catalog UI
    • 13.2.2. Using the NGC CLI
  • 13.3. Verifying NVIDIA’s Signature
    • 13.3.1. Using Cosign
    • 13.3.2. Using an Admission Controller in Kubernetes Clusters
• 14. Running an NGC Container
  • 14.1. Enabling GPU Support for NGC Containers
  • 14.2. Running NGC Containers with Runtime Resources
    • 14.2.1. Specifying A User
    • 14.2.2. Setting The Remove Flag
    • 14.2.3. Setting The Interactive Flag
    • 14.2.4. Setting The Volumes Flag
    • 14.2.5. Setting The Mapping Ports Flag
    • 14.2.6. Setting The Shared Memory Flag
    • 14.2.7. Setting The Restricting Exposure Of GPUs Flag
    • 14.2.8. Container Lifetime
• 15. Multi-Architecture Support for NGC Container Images
  • 15.1. Manifest Lists and Tags
  • 15.2. Basic Docker Commands for Multi-Architecture Images
• 16. Customizing Containers
  • 16.1. Benefits and Limitations to Customizing a Container
  • 16.2. Example 1: Building a Container from Scratch
  • 16.3. Example 2: Customizing A Container Using Dockerfile
  • 16.4. Example 3: Customizing a Container Using docker commit
  • 16.5. Example 4: Developing a Container Using Docker
  • 16.6. Example 4.1: Package The Source into the Container
• 17. Models
  • 17.1. What are Models
  • 17.2. Searching and Filtering Models
  • 17.3. Downloading Models via NGC CLI
  • 17.4. Downloading Models via WGET/cURL
    • 17.4.1. Downloading Guest Access Models via WGET/cURL
    • 17.4.2. Downloading Authenticated Access Models via WGET/cURL
  • 17.5. Downloading Models via Web UI
    • 17.5.1. Downloading the Latest Version of a Model
    • 17.5.2. Downloading a Specific Version of a Model
  • 17.6. NVIDIA Signed Models in the NGC Catalog
    • 17.6.1. Checking for Signed Models
    • 17.6.2. Using the NGC Catalog UI
    • 17.6.3. Using the NGC CLI
    • 17.6.4. Finding NVIDIA’s Root Certificate
    • 17.6.5. Verifying Model Signature
• 18. Resources
  • 18.1. What are Resources?
  • 18.2. Searching and Filtering Resources
  • 18.3. Downloading Resources via the NGC CLI
  • 18.4. Downloading Resources via WGET/cURL
    • 18.4.1. Downloading Guest Access Resources via WGET/cURL
    • 18.4.2. Downloading Authenticated Access Resources via WGET/cURL
  • 18.5. Downloading Resources via Web UI
  • 18.6. Verifying Resource Signature
    • 18.6.1. Download Verification Tools
    • 18.6.2. Downloading Resource Version and Signature
    • 18.6.3. Verifying Resource Version Signature
• 19. Helm Charts
  • 19.1. Prerequisites
    • 19.1.1. Setting Up an NGC Helm Repository
  • 19.2. Searching for Available Helm Charts in the NGC Catalog
  • 19.3. Fetching Helm Charts
  • 19.4. Using the NGC Website to View the List of Helm Charts and Get Fetch Commands
• 20. Collections
  • 20.1. What is an NGC Collection?
  • 20.2. Navigating NGC Collections
  • 20.3. Filtering NGC Collections
  • 20.4. Collections Page Overview
  • 20.5. Building with NGC Collections
    • 20.5.1. Example Use Case: Building an Intelligent Video Analytics (IVA) Application
  • 20.6. Using NGC Collections CLI
• 21. SDK and AI Toolkits
• 22. Deep Learning Frameworks
  • 22.1. GPU Operator

Open Catalog Guide

NGC Private Registry User Guide

Enterprise guide to NGC Private Registry: Securely manage Docker containers, AI models, and collaborative workflows for data science teams using NVIDIA’s private cloud registry.

📋 Table of Contents

Private Registry Guide

• 1. Overview
• 2. NGC Private Registry For Enterprise
  • 2.1. Increased Collaboration
  • 2.2. Enterprise Ready
• 3. Getting Started
  • 3.1. Obtaining a Private Registry
  • 3.2. Activating a New NGC Account
    • 3.2.1. Joining an NGC Org or Team With an Existing NVIDIA Account
    • 3.2.2. Joining an Org or Team With a New NVIDIA Account
    • 3.2.3. Joining an Org as Org Owner
    • 3.2.4. Joining an Org or Team With an External SSO Company Account
    • 3.2.5. Switching Orgs or Teams After Logging into NGC
  • 3.3. NGC API Keys
    • 3.3.1. Supported NGC Applications and API Key Types
    • 3.3.2. Generating NGC API Keys
  • 3.4. Managing Users and Teams in NGC
    • 3.4.1. NGC Registry User Roles
    • 3.4.2. Creating Teams
    • 3.4.3. Creating Users
    • 3.4.4. Adding a New User to a Team
    • 3.4.5. Adding an Existing User to a Team
    • 3.4.6. Changing User Roles
  • 3.5. Introduction to the NGC Catalog and NGC CLIs
    • 3.5.1. Installing NGC Registry CLI
    • 3.5.2. Managing Users and Teams
• 4. Docker Containers
  • 4.1. What Is A Docker Container?
  • 4.2. Why Use A Container?
  • 4.3. Using NGC Container Registry from the Docker Command Line
    • 4.3.1. Accessing the NGC Container Registry
    • 4.3.2. Uploading an NVIDIA Container Image onto Your System
    • 4.3.3. Tagging and Pushing a Container Image
  • 4.4. Using the Container Registry
    • 4.4.1. Viewing Container Image Information
    • 4.4.2. Pulling a Container Image
    • 4.4.3. Pushing a Container Image
    • 4.4.4. Removing a Container Image
  • 4.5. Updating Container Metadata
    • 4.5.1. Updating Container Metadata Via the NGC Website
    • 4.5.2. Updating Container Metadata Using the NGC CLI
  • 4.6. Multi-Architecture Support for NGC Container Images
• 5. NGC Models
  • 5.1. Creating New NGC Models Using the NGC CLI
  • 5.2. Creating a New Model Using the NGC Website
  • 5.3. Uploading a New NGC Model Version Using the NGC CLI
  • 5.4. Uploading an NGC Model Version Using the NGC Website
  • 5.5. Editing NGC Model Information Using the NGC CLI
  • 5.6. Editing NGC Model Information Using the NGC Website
  • 5.7. Cloning NGC Model Version Using the NGC Website
  • 5.8. Creating a New NGC Model Version Using the NGC CLI
• 6. NGC Resources
  • 6.1. Before You Begin
  • 6.2. Uploading a Resource
  • 6.3. Updating a Resource
  • 6.4. Resource Commands
  • 6.5. Deleting a Resource
• 7. NGC Helm Charts
  • 7.1. Introduction to NGC and Helm Charts
  • 7.2. Creating and Packaging a Helm Chart
  • 7.3. Manage Helm Charts Using the NGC Web UI
    • 7.3.1. Viewing the List of Helm Charts and Getting Fetch Commands
    • 7.3.2. Adding Helm Charts Using the NGC Web UI
    • 7.3.3. Updating the Helm Chart Page From the Website
    • 7.3.4. Removing Helm Charts from the Web UI
  • 7.4. Manage Helm Charts Using the NGC CLI
    • 7.4.1. Searching for Available Helm Charts in an Org
    • 7.4.2. Fetching Helm Charts
    • 7.4.3. Adding Helm Charts to a Private Registry
    • 7.4.4. Getting Information about a Helm Chart
    • 7.4.5. Pushing a Helm Chart
    • 7.4.6. Listing Helm Chart Versions
    • 7.4.7. Removing Helm Charts from a Private Registry
  • 7.5. Manage Helm Charts Using the NGC API
    • 7.5.1. Updating Information on the Helm Chart Page
    • 7.5.2. Deleting Helm Charts Using the NGC API
  • 7.6. Manage Helm Charts Using the Helm CLI
    • 7.6.1. Setting Up an NGC Helm Repository
    • 7.6.2. Searching for Available Helm Charts
    • 7.6.3. Fetching Helm Charts
    • 7.6.4. Adding Helm Charts to a Private NGC Org/Team
    • 7.6.5. Removing Helm Charts from a Private NGC Org/Team
• 8. Private Registry Quotas and Limits
• 9. Getting Support for NGC container registry

Open Registry Guide

Appendix

Open Notices