Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/NVIDIA/libnvidia-container
NVIDIA container runtime library
https://github.com/NVIDIA/libnvidia-container
Last synced: about 2 months ago
JSON representation
NVIDIA container runtime library
- Host: GitHub
- URL: https://github.com/NVIDIA/libnvidia-container
- Owner: NVIDIA
- License: apache-2.0
- Created: 2017-04-14T23:45:54.000Z (over 7 years ago)
- Default Branch: main
- Last Pushed: 2024-08-01T09:36:10.000Z (about 2 months ago)
- Last Synced: 2024-08-01T10:35:12.796Z (about 2 months ago)
- Language: C
- Size: 2.36 GB
- Stars: 780
- Watchers: 45
- Forks: 194
- Open Issues: 75
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: COPYING
Awesome Lists containing this project
README
# libnvidia-container
[](https://raw.githubusercontent.com/NVIDIA/libnvidia-container/main/LICENSE)
[](https://github.com/NVIDIA/libnvidia-container/releases)
[](https://nvidia.github.io/libnvidia-container)
[](https://travis-ci.org/NVIDIA/libnvidia-container)
[](https://scan.coverity.com/projects/nvidia-libnvidia-container)
[](https://lgtm.com/projects/g/NVIDIA/libnvidia-container/alerts/)
This repository provides a library and a simple CLI utility to automatically configure GNU/Linux containers leveraging NVIDIA hardware.\
The implementation relies on kernel primitives and is designed to be agnostic of the container runtime.
## Installing the library
### From packages
Configure the [package repository](https://nvidia.github.io/libnvidia-container/) for your Linux distribution.
Install the packages:
```bash
libnvidia-container1
libnvidia-container-tools
```
### From sources
With Docker:
```bash
# Generate docker images for a supported
make {ubuntu18.04, ubuntu16.04, debian10, debian9, centos7, amazonlinux2, opensuse-leap15.1}
# Or generate docker images for all supported distributions in the dist/ directory
make docker
````
The resulting images have the name `nvidia/libnvidia-container/:`
Without Docker:
```bash
make install
# Alternatively in order to customize the installation paths
DESTDIR=/path/to/root make install prefix=/usr
```
## Using the library
### Container runtime example
Refer to the [nvidia-container-runtime](https://github.com/NVIDIA/nvidia-container-runtime) project.
### Command line example
```bash
# Setup a new set of namespaces
cd $(mktemp -d) && mkdir rootfs
sudo unshare --mount --pid --fork
# Setup a rootfs based on Ubuntu 16.04 inside the new namespaces
curl http://cdimage.ubuntu.com/ubuntu-base/releases/16.04/release/ubuntu-base-16.04.6-base-amd64.tar.gz | tar -C rootfs -xz
useradd -R $(realpath rootfs) -U -u 1000 -s /bin/bash nvidia
mount --bind rootfs rootfs
mount --make-private rootfs
cd rootfs
# Mount standard filesystems
mount -t proc none proc
mount -t sysfs none sys
mount -t tmpfs none tmp
mount -t tmpfs none run
# Isolate the first GPU device along with basic utilities
nvidia-container-cli --load-kmods configure --ldconfig=@/sbin/ldconfig.real --no-cgroups --utility --device 0 $(pwd)
# Change into the new rootfs
pivot_root . mnt
umount -l mnt
exec chroot --userspec 1000:1000 . env -i bash
# Run nvidia-smi from within the container
nvidia-smi -L
```
## Copyright and License
This project is released under the [BSD 3-clause license](https://github.com/NVIDIA/libnvidia-container/blob/main/LICENSE).
Additionally, this project can be dynamically linked with libelf from the elfutils package (https://sourceware.org/elfutils), in which case additional terms apply.\
Refer to [NOTICE](https://github.com/NVIDIA/libnvidia-container/blob/main/NOTICE) for more information.
## Issues and Contributing
[Checkout the Contributing document!](CONTRIBUTING.md)
* Please let us know by [filing a new issue](https://github.com/NVIDIA/libnvidia-container/issues/new)
* You can contribute by opening a [pull request](https://help.github.com/articles/using-pull-requests/)