NGC Container Registry for DGX User Guide
Documentation for NVIDIA DGX customers using NVIDIA NGC container registry that explains how to administer and use the registry.
1. NGC Container Registry for Enterprise Overview
The content of this user guide has been moved to https://docs.nvidia.com/ngc/ngc-private-registry-user-guide/index.html.
If you are using the DGX registry at https://compute.nvidia.com, then be sure to get an NGC account and migrate your container images according to the instructions in the next section.
2. Migrating from the DGX Registry to NGC
The legacy DGX Container Registry at https://compute.nvidia.com will soon be shut down and no longer available. All container images will be removed. At that time, if you attempt to access the DGX Container Registry service you will be redirected to the NGC website at https://ngc.nvidia.com.
The following is a summary of the process for migrating your container images from the DGX registry to the NGC registry.
-
Obtain an NGC private registry account.
-
Get an API Key for the NGC account.
-
Log in to nvcr.io using your DGX registry API key.
-
Pull your container from the registry.
-
Log out of the DGX registry and then log into the NGC registry at nvcr.io.
-
Push your container images to the NGC registry.
Obtaining an NGC Private Registry Account
Refer to the information at https://docs.nvidia.com/ngc/ngc-private-registry-user-guide/index.html for instructions on obtaining an NGC private registry account.
Get a New API Key for the NGC Registry
-
Log in to https://ngc.nvidia.com.
-
In the top right corner, click your user account icon and select Setup.
-
Click Get API key to open the Setup > API Key page.
The API Key is the mechanism used to authenticate your access to the NGC container registry.
-
Click Generate API Key to generate your API key. A warning message appears to let you know that your old API key will become invalid if you create a new key.
-
Click Confirm to generate the key.
Your API key appears.
You only need to generate an API Key once. NGC does not save your key, so store it in a secure place. (You can copy your API Key to the clipboard by clicking the copy icon to the right of the API key. )
Should you lose your API Key, you can generate a new one from the NGC website. When you generate a new API Key, the old one is invalidated.
Migrate Container Images to the NGC Registry
-
Log in using old API Key from compute.nvidia.com
$ docker login nvcr.io
Username ($oauthtoken):
Password: <enter-old-compute-API-key>
Login Succeeded
-
Pull image from nvcr.io
$ docker pull nvcr.io/ <path-to-repository>/<image>:<tag>
Perform this step for each container image that you need to transfer.
-
Log out of the registry.
$ docker logout nvcr.io
-
Log in using new API Key from ngc.nvidia.com
$ docker login nvcr.io
Username ($oauthtoken):
Password: <enter-new-NGC-API-key>
Login Succeeded
-
Push image to nvcr.io
$ docker push nvcr.io/ <org-name>/<image>:<tag>
Or, if pushing to a team
$ docker push nvcr.io/ <org-name>/<team>/<image>:<tag>
If you are pushing to a team ensure that team is created and users are added to the team first in ngc.nvidia.com. To find your org name, see the top right hand of the screen after you log in.
Repeat this step for all the container images that you need to transfer.
Notices
Notice
This document is provided for information purposes only and shall not be regarded as a warranty of a certain functionality, condition, or quality of a product. NVIDIA Corporation (“NVIDIA”) makes no representations or warranties, expressed or implied, as to the accuracy or completeness of the information contained in this document and assumes no responsibility for any errors contained herein. NVIDIA shall have no liability for the consequences or use of such information or for any infringement of patents or other rights of third parties that may result from its use. This document is not a commitment to develop, release, or deliver any Material (defined below), code, or functionality.
NVIDIA reserves the right to make corrections, modifications, enhancements, improvements, and any other changes to this document, at any time without notice.
Customer should obtain the latest relevant information before placing orders and should verify that such information is current and complete.
NVIDIA products are sold subject to the NVIDIA standard terms and conditions of sale supplied at the time of order acknowledgement, unless otherwise agreed in an individual sales agreement signed by authorized representatives of NVIDIA and customer (“Terms of Sale”). NVIDIA hereby expressly objects to applying any customer general terms and conditions with regards to the purchase of the NVIDIA product referenced in this document. No contractual obligations are formed either directly or indirectly by this document.
NVIDIA products are not designed, authorized, or warranted to be suitable for use in medical, military, aircraft, space, or life support equipment, nor in applications where failure or malfunction of the NVIDIA product can reasonably be expected to result in personal injury, death, or property or environmental damage. NVIDIA accepts no liability for inclusion and/or use of NVIDIA products in such equipment or applications and therefore such inclusion and/or use is at customer’s own risk.
NVIDIA makes no representation or warranty that products based on this document will be suitable for any specified use. Testing of all parameters of each product is not necessarily performed by NVIDIA. It is customer’s sole responsibility to evaluate and determine the applicability of any information contained in this document, ensure the product is suitable and fit for the application planned by customer, and perform 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 document. NVIDIA accepts no 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 document or (ii) customer product designs.
No license, either expressed or implied, is granted under any NVIDIA patent right, copyright, or other NVIDIA intellectual property right under this document. Information published by NVIDIA regarding third-party products or services does not constitute a license from NVIDIA to use such products or services or a warranty or endorsement thereof. Use of such information may require a license from a third party under the patents or other intellectual property rights of the third party, or a license from NVIDIA under the patents or other intellectual property rights of NVIDIA.
Reproduction of information in this document is permissible only if approved in advance by NVIDIA in writing, reproduced without alteration and in full compliance with all applicable export laws and regulations, and accompanied by all associated conditions, limitations, and notices.
THIS DOCUMENT AND ALL NVIDIA DESIGN SPECIFICATIONS, REFERENCE BOARDS, FILES, DRAWINGS, DIAGNOSTICS, LISTS, AND OTHER DOCUMENTS (TOGETHER AND SEPARATELY, “MATERIALS”) ARE BEING PROVIDED “AS IS.” NVIDIA MAKES NO WARRANTIES, EXPRESSED, IMPLIED, STATUTORY, OR OTHERWISE WITH RESPECT TO THE MATERIALS, AND EXPRESSLY DISCLAIMS ALL IMPLIED WARRANTIES OF NONINFRINGEMENT, MERCHANTABILITY, AND FITNESS FOR A PARTICULAR PURPOSE. TO THE EXTENT NOT PROHIBITED BY LAW, IN NO EVENT WILL NVIDIA BE LIABLE FOR ANY DAMAGES, INCLUDING WITHOUT LIMITATION ANY DIRECT, INDIRECT, SPECIAL, INCIDENTAL, PUNITIVE, OR CONSEQUENTIAL DAMAGES, HOWEVER CAUSED AND REGARDLESS OF THE THEORY OF LIABILITY, ARISING OUT OF ANY USE OF THIS DOCUMENT, EVEN IF NVIDIA HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. Notwithstanding any damages that customer might incur for any reason whatsoever, NVIDIA’s aggregate and cumulative liability towards customer for the products described herein shall be limited in accordance with the Terms of Sale for the product.