Update README for docker 19.03 (#996)
Signed-off-by: Renaud Gaubert <rgaubert@nvidia.com>
This commit is contained in:
Renaud Gaubert
parent
e4a4524587
commit
36e7a11c52
137
README.md
137
README.md
|
|
@ -1,4 +1,4 @@
|
|||
# NVIDIA Container Runtime for Docker
|
||||
# NVIDIA Container Toolkit
|
||||
|
||||
[](https://raw.githubusercontent.com/NVIDIA/nvidia-docker/master/LICENSE)
|
||||
[](https://github.com/NVIDIA/nvidia-docker/wiki)
|
||||
|
|
@ -6,104 +6,77 @@
|
|||
|
||||
|
||||
|
||||
# Documentation
|
||||
|
||||
The full documentation and frequently asked questions are available on the [repository wiki](https://github.com/NVIDIA/nvidia-docker/wiki).
|
||||
|
||||
An introduction to the NVIDIA Container Runtime is also covered in our [blog post](https://devblogs.nvidia.com/gpu-containers-runtime/).
|
||||
## Quickstart
|
||||
The NVIDIA Container Toolkit allows users to build and run GPU accelerated Docker containers. The toolkit includes a container runtime [library](https://github.com/NVIDIA/libnvidia-container) and utilities to automatically configure containers to leverage NVIDIA GPUs. Full documentation and frequently asked questions are available on the [repository wiki](https://github.com/NVIDIA/nvidia-docker/wiki).
|
||||
|
||||
## Quickstart
|
||||
|
||||
**Make sure you have installed the [NVIDIA driver](https://github.com/NVIDIA/nvidia-docker/wiki/Frequently-Asked-Questions#how-do-i-install-the-nvidia-driver) and a [supported version](https://github.com/NVIDIA/nvidia-docker/wiki/Frequently-Asked-Questions#which-docker-packages-are-supported) of [Docker](https://docs.docker.com/engine/installation/) for your distribution (see [prerequisites](https://github.com/NVIDIA/nvidia-docker/wiki/Installation-(version-2.0)#prerequisites)).**
|
||||
**Make sure you have installed the [NVIDIA driver](https://github.com/NVIDIA/nvidia-docker/wiki/Frequently-Asked-Questions#how-do-i-install-the-nvidia-driver) and Docker 19.03 for your Linux distribution**
|
||||
|
||||
**If you have a custom `/etc/docker/daemon.json`, the `nvidia-docker2` package might override it.**
|
||||
Note that with the release of Docker 19.03, usage of nvidia-docker2 packages are deprecated since NVIDIA GPUs are now natively supported as devices in the Docker runtime.
|
||||
If you are an existing user of the nvidia-docker2 packages, review the instructions in the [“Upgrading with nvidia-docker2” section](https://github.com/NVIDIA/nvidia-docker/tree/master#upgrading-with-nvidia-docker2-deprecated).
|
||||
|
||||
#### Ubuntu 14.04/16.04/18.04, Debian Jessie/Stretch
|
||||
|
||||
Ubuntu will install `docker.io` by default which isn't the latest version of Docker Engine. This implies that you will need to pin the version of nvidia-docker. [See more information here](https://github.com/NVIDIA/nvidia-docker/wiki/Frequently-Asked-Questions#how-do-i-install-20-if-im-not-using-the-latest-docker-version).
|
||||
For first-time users of Docker 19.03 and GPUs, continue with the instructions for getting started below.
|
||||
|
||||
### Ubuntu 16.04/18.04, Debian Jessie/Stretch
|
||||
```sh
|
||||
# If you have nvidia-docker 1.0 installed: we need to remove it and all existing GPU containers
|
||||
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
|
||||
|
||||
# Add the package repositories
|
||||
curl -s -L https://nvidia.github.io/nvidia-docker/gpgkey | \
|
||||
sudo apt-key add -
|
||||
distribution=$(. /etc/os-release;echo $ID$VERSION_ID)
|
||||
curl -s -L https://nvidia.github.io/nvidia-docker/$distribution/nvidia-docker.list | \
|
||||
sudo tee /etc/apt/sources.list.d/nvidia-docker.list
|
||||
sudo apt-get update
|
||||
$ distribution=$(. /etc/os-release;echo $ID$VERSION_ID)
|
||||
$ curl -s -L https://nvidia.github.io/nvidia-docker/gpgkey | sudo apt-key add -
|
||||
$ curl -s -L https://nvidia.github.io/nvidia-docker/$distribution/nvidia-docker.list | sudo tee /etc/apt/sources.list.d/nvidia-docker.list
|
||||
|
||||
# Install nvidia-docker2 and reload the Docker daemon configuration
|
||||
sudo apt-get install -y nvidia-docker2
|
||||
sudo pkill -SIGHUP dockerd
|
||||
|
||||
# Test nvidia-smi with the latest official CUDA image
|
||||
docker run --runtime=nvidia --rm nvidia/cuda:9.0-base nvidia-smi
|
||||
$ sudo apt-get update && sudo apt-get install -y nvidia-container-toolkit
|
||||
$ sudo systemctl restart docker
|
||||
```
|
||||
|
||||
#### CentOS 7 (docker-ce), RHEL 7.4/7.5 (docker-ce), Amazon Linux 1/2
|
||||
|
||||
If you are **not** using the official `docker-ce` package on CentOS/RHEL, use the next section.
|
||||
|
||||
```sh
|
||||
# If you have nvidia-docker 1.0 installed: we need to remove it and all existing GPU containers
|
||||
docker volume ls -q -f driver=nvidia-docker | xargs -r -I{} -n1 docker ps -q -a -f volume={} | xargs -r docker rm -f
|
||||
sudo yum remove nvidia-docker
|
||||
|
||||
# Add the package repositories
|
||||
distribution=$(. /etc/os-release;echo $ID$VERSION_ID)
|
||||
curl -s -L https://nvidia.github.io/nvidia-docker/$distribution/nvidia-docker.repo | \
|
||||
sudo tee /etc/yum.repos.d/nvidia-docker.repo
|
||||
|
||||
# Install nvidia-docker2 and reload the Docker daemon configuration
|
||||
sudo yum install -y nvidia-docker2
|
||||
sudo pkill -SIGHUP dockerd
|
||||
|
||||
# Test nvidia-smi with the latest official CUDA image
|
||||
docker run --runtime=nvidia --rm nvidia/cuda:9.0-base nvidia-smi
|
||||
```
|
||||
If `yum` reports a conflict on `/etc/docker/daemon.json` with the
|
||||
`docker` package, you need to use the next section instead.
|
||||
$ distribution=$(. /etc/os-release;echo $ID$VERSION_ID)
|
||||
$ curl -s -L https://nvidia.github.io/nvidia-docker/$distribution/nvidia-docker.repo | sudo tee /etc/yum.repos.d/nvidia-docker.repo
|
||||
|
||||
For docker-ce on `ppc64le`, look at the [FAQ](https://github.com/nvidia/nvidia-docker/wiki/Frequently-Asked-Questions#do-you-support-powerpc64-ppc64le).
|
||||
|
||||
#### CentOS 7 (docker), RHEL 7.4/7.5 (docker)
|
||||
```sh
|
||||
# If you have nvidia-docker 1.0 installed: we need to remove it and all existing GPU containers
|
||||
docker volume ls -q -f driver=nvidia-docker | xargs -r -I{} -n1 docker ps -q -a -f volume={} | xargs -r docker rm -f
|
||||
sudo yum remove nvidia-docker
|
||||
|
||||
# Add the package repositories
|
||||
distribution=$(. /etc/os-release;echo $ID$VERSION_ID)
|
||||
curl -s -L https://nvidia.github.io/nvidia-container-runtime/$distribution/nvidia-container-runtime.repo | \
|
||||
sudo tee /etc/yum.repos.d/nvidia-container-runtime.repo
|
||||
|
||||
# Install the nvidia runtime hook
|
||||
sudo yum install -y nvidia-container-runtime-hook
|
||||
|
||||
# Test nvidia-smi with the latest official CUDA image
|
||||
# You can't use `--runtime=nvidia` with this setup.
|
||||
docker run --rm nvidia/cuda:9.0-base nvidia-smi
|
||||
$ sudo yum install -y nvidia-container-toolkit
|
||||
$ sudo systemctl restart docker
|
||||
```
|
||||
|
||||
#### Other distributions and architectures
|
||||
|
||||
Look at the [Installation section](https://github.com/nvidia/nvidia-docker/wiki/Installation-(version-2.0)) of the wiki.
|
||||
|
||||
## Changelog
|
||||
|
||||
New nvidia-docker packages have been released for docker 18.09.2 and 18.06.2 addressing [CVE-2019-5736](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2019-5736)
|
||||
|
||||
Update nvidia-docker to adress runc critical vulnerability that allows specially-crafted containers to gain administrative privileges on the host.
|
||||
```sh
|
||||
# On Ubuntu/Debian
|
||||
sudo apt upgrade
|
||||
|
||||
# On Centos/RHEL/Amazon Linux
|
||||
sudo yum upgrade
|
||||
## Usage
|
||||
```
|
||||
#### Test nvidia-smi with the latest official CUDA image
|
||||
$ docker run --gpus all nvidia/cuda:9.0-base nvidia-smi
|
||||
|
||||
# Start a GPU enabled container on two GPUs
|
||||
$ docker run --gpus 2 nvidia/cuda:9.0-base nvidia-smi
|
||||
|
||||
# Starting a GPU enabled container on specific GPUs
|
||||
$ docker run --gpus device=1,2 nvidia/cuda:9.0-base nvidia-smi
|
||||
$ docker run --gpus device=UUID-ABCDEF,1 nvidia/cuda:9.0-base nvidia-smi
|
||||
|
||||
# Specifying a capability (graphics, compute, ...) for my container
|
||||
# Note this is rarely if ever used this way
|
||||
$ docker run --gpus all,capabilities=utility nvidia/cuda:9.0-base nvidia-smi
|
||||
```
|
||||
|
||||
## Upgrading with nvidia-docker2 (Deprecated)
|
||||
|
||||
If you are running an old version of docker (< 19.03) check the instructions on installing the [`nvidia-docker2`](https://github.com/NVIDIA/nvidia-docker/wiki/Installation-(version-2.0)) package which supports Docker >= 1.12.
|
||||
If you already have the old package installed (nvidia-docker2), updating to the latest Docker version (>= 19.03) will still work and will give you access to the new CLI options for supporting GPUs:
|
||||
|
||||
```
|
||||
# On debian based distributions: Ubuntu / Debian
|
||||
$ sudo apt-get update
|
||||
$ sudo apt-get --only-upgrade install docker-ce nvidia-docker2
|
||||
$ sudo systemctl restart docker
|
||||
|
||||
# On RPM based distributions: Centos / RHEL / Amazon Linux
|
||||
$ sudo yum upgrade -y nvidia-docker2
|
||||
$ sudo systemctl restart docker
|
||||
|
||||
# All of the following options will continue working
|
||||
$ docker run --gpus all nvidia/cuda:9.0-base nvidia-smi
|
||||
$ docker run --runtime nvidia nvidia/cuda:9.0-base nvidia-smi
|
||||
$ nvidia-docker run nvidia/cuda:9.0-base nvidia-smi
|
||||
```
|
||||
|
||||
Note that in the future, nvidia-docker2 packages will no longer be supported.
|
||||
|
||||
## Issues and Contributing
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue