NGC with Helm Charts User Guide

This document describes how to use the NGC registry to manage Helm charts.

1. Introduction to NGC and Helm Charts

Helm is an application package manager running on top of Kubernetes. It lets you create Helm charts where you can define, install, and upgrade Kubernetes applications.

You can create Helm charts and push them to your NGC organization and team registry spaces for sharing with others. This document describes how to share Helm charts with others in your org or team using the NGC registry.

Prerequisites

These instructions assume the following prerequisites are met.

2. Creating and Packaging a Helm Chart

This section describes how to package a Helm chart for publishing to NGC.
There is no need to “deploy” the Helm chart in order to publish your chart to NGC. A .tgz file of the chart can be published to an org in NGC without being deployed first to the GPU infrastructure.
  1. Create the Helm chart by issuing the following.
    $ helm create <chart-name>
    Where <chart-name> is the name of your choosing. Example:
    $ helm create ngcdocstest
  2. Modify the contents of the template with your Helm chart data.
  3. Package the Helm chart by issuing the following.
    $ helm package <chart-name>
    Example:
    $ helm package ngcdocstest
    This example creates the tar package ngcdocstest-0.1.0.tgz.

3. Using the NGC Registry to Manage Helm Charts

3.1. Setting Up an NGC Helm Repository

  1. Obtain an NGC API Key.

    See Generating Your NGC API Key for instructions.

  2. Export the API Key for use in commands.
    $ export NGC_API_KEY=<your-api-key>
  3. Add the NGC org to your Helm repository.
    $ helm repo add <repo-name> https://helm.ngc.nvidia.com/<org-name> --username=\$oauthtoken --password=$NGC_API_KEY
    Where <repo-name> is a name of your choosing by which you will reference the repository.

3.2. Searching for Available Helm Charts

To view a list of available Chart packages in your org, issue the following.
$ helm search <repo-name> 

3.3. Fetching Helm Charts

To download (or ”fetch”) a Helm chart package from the repo, issue the following.
$ helm fetch <repo-name>/<chart-name> 

Adding Helm Charts to a Private NGC Org/Team

These instructions assume the Helm push plugin is installed. To install the plugin, issue the following.
$ helm plugin install https://github.com/chartmuseum/helm-push
To push (upload) a Helm chart to your org space, issue the following.
$ helm push <chart-name>.tgz <repo-name> 

Removing Helm Charts from a Private NGC Org/Team

To remove Helm charts from your org or team, you must use the NGC API. Refer to https://docs.ngc.nvidia.com/api/index.html#!/Model/proxyDeleteUsingDELETE for a description of the relevant API.
To delete a Helm chart from an org space, issue the following:
$ curl -X DELETE --header 'Accept: application/json' --header 'Authorization: Bearer <Bearer Token>' 'https://api.ngc.nvidia.com/v2/org/<org-name>/helm-charts/<chart-name>’
To delete a Helm chart from a Team space, issue the following:
$ curl -X DELETE --header 'Accept: application/json' --header 'Authorization: Bearer <Bearer Token>' 'https://api.ngc.nvidia.com/v2/org/<org-name>/team/<team-name>helm-charts/<chart-name>’

4. Using the NGC Website to View the List of Helm Charts and Get Fetch Commands

From the NGC website you can
  • View the contents of the Helm chart repository.
  • Get the push command for a specific Helm chart in the repository.
  1. From a browser, log in to https://ngc.nvidia.com.
  2. If you are a member of more than one org, select the one that contains the Helm charts that you are interested in, then click Sign In.
  3. Click Helm Charts from the left-side navigation pane.

    The page presents cards for each available Helm chart.

  4. Select one of the Helm chart cards.

    The page for each Helm chart provides information about the chart.

    The Fetch Command section shows the command to use for downloading the Helm chart package.

    Click either the Fetch download button from the upper right corner or the copy icon next to the fetch command to copy the fetch command to the clipboard.

    The File Browser tab lets you see the file content of the Helm chart package.

5. Updating Information on the Helm Chart Page

You can update the information presented for your Helm chart using either the NGC API or the NGC website. The following page elements can be edited.

Page Element JSON Field Description
Helm Chart name displayName The name of the Helm chart appearing in the title on the tile and Helm chart page
Publisher publisher The organization/entity responsible for creating the asset
Logo logo URL of the image to use as the logo for the asset
Description shortDescription A short description for the Helm chart
Labels labels Tags to enhance search results
Overview tab description Content of the “Overview” tab which can provide publishers to convey additional

The JSON column shows the corresponding JSON fields to use when updating the page using the NGC API.

Updating the Helm Chart Page From the Website

  1. To update the fields in the NGC Helm Chart page for a specific Heml chart, click Edit Details.

  2. Edit each field as needed, then click Save.

Updating the Helm Chart Page Using the NGC API

The NGC API lets you specify information about your Helm chart. Use the NGC API Explorer page (URL: https://docs.ngc.nvidia.com/models/index.html#!/Artifacts/updateArtifactInOrgUsingPATCH). You can use the page to build the JSON file for use in a CURL command.
The following shows the relevant fields in the JSON file.
{ "attributes": [
 {
 "key": "string",
 "value": "string"
 }
 ], 
 "builtBy": "string",
 "description": "string",
 "displayName": "string",
 "labels": [
 "string" ],
 "logo": "string",
 "publisher": "string",
 "shortDescription": "string"
 } 

Example

The following shows example JSON values.

{ "builtBy": "NVIDIA",
 "description": “#NGC Docs Chart”,
 "displayName": "NGC DOCS CHART TEST",
 "labels": [
 "Helm Chart", "Documentation"
 ],
 "shortDescription": "This charts is for the docs!"
 } 
The following is an example CURL command.
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'

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.