userdocker 1.0.0.dev2

No project description provided

userdocker allows admins to grant restricted docker command access to users.

Feedback welcome:
https://github.com/joernhees/userdocker

Home-page: https://github.com/joernhees/userdocker
Author: Jörn Hees
Author-email: [e-mail]
License: MIT
Description: Userdocker
==========

Userdocker is a wrapper that allows admins to grant restricted docker commandline access to users.

Userdocker is aimed towards scientific high performance computing and cluster setups, as they exist in most universities or research groups. Often, such scientific computations have peculiar dependencies that are difficult to satisfy across linux distributions (and drive admins crazy ;) ).

In theory such use-cases could largely benefit from docker, as it would allow users to easily define environments themselves and run them basically without negative performance impact, as they run directly on the host's kernel. In reality however granting docker commandline access to users effectively makes them root equivalent on the host (root in container, volume mount...), making this prohibitive for cluster computing.

Userdocker solves this problem by wrapping the docker command and just making the safe parts available to users. Admins can decide what they consider safe (with sane defaults).


Sample Usage:
=============

# command line help (including subcommands the user is allowed to execute)
sudo userdocker -h

# (docker images) list images (and useful tree visualization)
sudo userdocker images
sudo userdocker dockviz

# (docker run) run a debian image with user mounted home
sudo userdocker run -it --rm -v $HOME:$HOME:ro debian bash

# (docker ps) list running containers
sudo userdocker ps

# (docker pull / load) pull or load
sudo userdocker pull debian
sudo userdocker load < image.tar.gz


Features:
=========

- Similar commandline interface as `docker ...` called `userdocker ...`
- Support for several docker commands (docker, nvidia-docker)
- Fine granular configurability for admins in `/etc/userdocker/` allow to:
- restrict runnable images if desired (allows admin reviews)
- restrict run to locally available images
- restrict available mount points (or enforce them, or default mount)
- probe mounts (to make sure nfs automounts don't make docker sad)
- enforce non-root user in container (same uid:gid as on host)
- enforce dropping caps
- enforce environment vars
- enforce docker args
- restrict port publishing
- explicitly white-list available args to user
- System wide config + overrides for individual groups, gids, users, uids.
- Easily extensible to further subcommands and args.


Installation:
=============

The installation of userdocker works in three steps:

1. Install package:
-------------------
First make sure that docker is installed:

sudo docker version


Afterwards, as userdocker is written in python3 and available as python package:

sudo pip3 install userdocker

This will give you a `userdocker` command that you can test with:

userdocker -h

The above is the preferable way of installation.

Alternatively, you can clone this repo and execute:

sudo python3 setup.py install


2. Configuration:
-----------------
Copy the default config to `/etc/userdocker/config.py`, then edit the file. The config contains tons of comments and explanations to help you make the right decisions for your scenario.

sudo cp /etc/userdocker/default.py /etc/userdocker/config.py


3. Allowing users to run `sudo userdocker`:
-------------------------------------------
You should now allow the users in question to run `sudo userdocker`. This is basically done by adding a line to `/etc/sudoers`. If you want to grant this permission to all users in group `users`, add one of the following two lines to your `/etc/sudoers` (depending on if you want them to type their password first):

%users ALL=(root) /usr/local/bin/userdocker
%users ALL=(root) NOPASSWD: /usr/local/bin/userdocker


In case you want to grant userdocker rights only to some users, we suggest to add a `userdocker` group and then allow users in that group to execute `sudo userdocker`:

# add a group called userdocker:
sudo addgroup userdocker

# add someuser to the group:
sudo adduser someuser userdocker

After that allow users in group userdocker to execute `sudo userdocker` by adding one of the following lines to your `/etc/sudoers` (depending on if you want them to type their password first):

%userdocker ALL=(root) /usr/local/bin/userdocker
%userdocker ALL=(root) NOPASSWD: /usr/local/bin/userdocker


FAQ:
====

Why sudo?
---------
Because it supports logging and is in general a lot more configurable than the alternatives. For example if you only want to make `userdocker` available on some nodes in your cluster, you can use the Host_List field:

%userdocker node1,node2,node4=(root) /usr/local/bin/userdocker


Keywords: docker user limit admin hpc cluster computing permissions
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Security
Classifier: Topic :: Software Development
Classifier: Topic :: System
Classifier: Topic :: System :: Clustering
Classifier: Topic :: System :: Distributed Computing
Classifier: Topic :: System :: Emulators
Classifier: Topic :: System :: Operating System
Classifier: Topic :: System :: Systems Administration
Classifier: Topic :: System :: Systems Administration :: Authentication/Directory
Classifier: Topic :: Utilities