/docker-terminator-devenv

Customising a docker image with Oh-my-zsh shell, Terminator and a non-root user while sharing X11 socket to run GUIs straight from the container

Primary LanguageShell

Docker Image Customization Example

This repository is an example of a Docker Image customization having as base image either

  • Ubuntu 16.04 (Xenial)
  • Ubuntu 16.04 (Xenial) with Nvidia CUDA toolkit and cuDNN library

The image is customized such that:

  • the docker image is created with a non-root user (default user-name docker)
  • Oh My ZSH is installed and configured for the non-root user
  • docker containers are launched with terminator as the default terminal emulator (as opposed to default gnome-terminal)
  • host mounted volumes are re-bound to a data folder within the container's user's $HOME folder
  • bash completion for Docker image names and tags when launching the container by using the ./run_docker.sh script

The user has the option of building three different types of Docker images

  1. a generic image for non-Nvidia based PCs
  2. an image with support for Nvidia Graphics and OpenGL by using nvidia-docker (1.0)
  3. an image with the Nvidia CUDA toolkit and cuDNN library and support for OpenGL by using nvidia-docker (1.0)

Purpose

Experimentation ...

Requirements

This docker image has been build and tested on a machine running Ubuntu 16.04 with docker version 17.09.0-ce

Dependencies

For the 2. and 3. type of images to successfully run GUIs or make use of the cuDNN library, the user must install nvidia-docker (1.0)

Building the image

The Makefile contained in the repository allows you to create either of the three images with the make command. The make utility will provide the auto-completion for the image name you want to build.

If you wish to give other names to the resulting docker images, modify the name argument in the Makefile for the corresponding image.

The ENTRYPOINT entrypoint.sh script

For each image / subfolder, the bash script entrypoint.sh will be copied at build time into the Docker image and will be ran as the default entrypoint when the container is launched. The script currently bind mounts the Dockerfile's extern volume into the $HOME/host_files folder of the non-root user.

Running a container

Navigate to the chosen image sub-folder. In a terminal type ./run_docker.sh followed by the name chosen in the previous step or with the default name assigned by the Makefile. This will run and remove the docker container upon exit (i.e., it is ran with the --rm flag).

./run_docker.sh GIVEN_IMAGE_NAME

e.g. for the second Docker image created with the make command, do

./run_docker.sh codookie/xenial:terminator-nvidia

Whatever data you require from the host, mount it in the container's extern folder, e.g. following the bellow structure

  -v $HOME/Projects/ROS:/extern/ROS

When the container is launched, the data in the extern folder will also be available in the docker user's $HOME/host_files folder.

The image also shares the X11 unix socket with the host and its network interface.

Running Firefox from within the container

Run the container and install Firefox from the terminal,

sudo apt install firefox

After installation, launch Firefox from the terminal. You are now running Firefox from a Docker container 😃.

Bash auto-completion for ./run_docker.sh

When using ./run_docker.sh in a bash shell to launch the container, source the configs/bash_docker_images_completion.sh script. Now you should be able to get the names of the available docker images on your system whenever you type

./run_docker.sh <TAB><TAB>

References

The Oh My ZSH, terminator configuration and Makefile structure based on

Build/run script(s) structure adapted from