Document the conflict with /etc/docker/daemon.json
This commit is contained in:
parent
5d2a1f141e
commit
7856177eb5
13
README.md
13
README.md
|
@ -37,6 +37,9 @@ sudo yum remove nvidia-docker
|
|||
|
||||
## Installation
|
||||
|
||||
**If you have a custom `/etc/docker/daemon.json`, the `nvidia-docker2` package will override it.**
|
||||
**In this case, it is recommended to install [nvidia-container-runtime](https://github.com/nvidia/nvidia-container-runtime#installation) instead and register the new runtime manually.**
|
||||
|
||||
#### Ubuntu distributions
|
||||
|
||||
1. Install the repository for your distribution by following the instructions [here](http://nvidia.github.io/nvidia-docker/).
|
||||
|
@ -82,16 +85,16 @@ docker run --runtime=nvidia -e NVIDIA_VISIBLE_DEVICES=all --rm debian:stretch nv
|
|||
To help transitioning code from 1.0 to 2.0, a bash script is provided in `/usr/bin/nvidia-docker` for backward compatibility.
|
||||
It will automatically inject the `--runtime=nvidia` argument and convert `NV_GPU` to `NVIDIA_VISIBLE_DEVICES`.
|
||||
|
||||
#### Environment variables
|
||||
The behavior of the runtime can be modified through environment variables (such as `NVIDIA_VISIBLE_DEVICES`).
|
||||
Those environment variables are consumed by [nvidia-container-runtime](https://github.com/nvidia/nvidia-container-runtime) and are documented [here](https://github.com/nvidia/nvidia-container-runtime#environment-variables-oci-spec).
|
||||
Our official CUDA images use default values for these variables.
|
||||
|
||||
#### Default runtime
|
||||
The default runtime used by the Docker® Engine is [runc](https://github.com/opencontainers/runc), our runtime can become the default one by configuring the docker daemon with `--default-runtime=nvidia`.
|
||||
Doing so will remove the need to add the `--runtime=nvidia` argument to `docker run`.
|
||||
It is also the only way to have GPU access during `docker build`.
|
||||
|
||||
#### Environment variables
|
||||
The behavior of the runtime can be modified through environment variables (such as `NVIDIA_VISIBLE_DEVICES`).
|
||||
Those environment variables are consumed by [nvidia-container-runtime](https://github.com/nvidia/nvidia-container-runtime) and are documented [here](https://github.com/nvidia/nvidia-container-runtime#environment-variables-oci-spec).
|
||||
Our official CUDA images use default values for these variables.
|
||||
|
||||
## Issues and Contributing
|
||||
|
||||
A signed copy of the [Contributor License Agreement](https://raw.githubusercontent.com/NVIDIA/nvidia-docker/master/CLA) needs to be provided to <a href="mailto:digits@nvidia.com">digits@nvidia.com</a> before any change can be accepted.
|
||||
|
|
Loading…
Reference in a new issue