Custom Image Guideline

Enterprise Applicable to Enterprise Edition

Community Applicable to Community Edition

Build Custom Images

With Image feature, administrators can build custom images for users according to requirements of environment such as pre-installed python packages, environmental variables configurations, and so on. Those prerequisites which were required to set up manually every time can be set up once in images. Users are able to re-use images to proceed to projects without spending time on environment setup after images are instantiated as containers.

Basically, we can use Images to build any images we want; in terms of images for PrimeHub, we use images for two conditions, one is for Job Submission, the other is for JupyterHub.

For Job Submission

Since requirements for running jobs are varied with tasks. As long as images are valid to be instantiated as containers, we can select those images as environments for running jobs.

For JupyterHub

Only images which are installed with JupyterHub environment are able to be used for launching JupyterHub in PrimeHub. PrimeHub expects installed JupyterHub inside the image; after starting the container, PrimeHub tries to launch Jupyter environment.

For the sake of building images with JupyterHub, we must use base images which are JupyterHub-compatible; we can have them from official registries.

Official Registry

There are two official registries where we can have JupyterHub-compatible base images, one is from Jupyter, the other is from InfuseAI.

Please refer to the Available Images List for details on images maintained by InfuseAI.

Provider	Registry	Reference
Jupyter	jupyter/docker-stacks	Jupyter Docker Stacks
InfuseAI	registry.gitlab.com/infuseai/docker-stacks/	A read_registry token is required to access the registry, please contact InfuseAI to acquire the token.
InfuseAI	infuseai/docker-stacks/	InfuseAI Docker Stacks

Build Images via Images

We can build images via Images by specification of a base image with required packages, please goes to Images feature for details and try a build image quickstart.

Build Images via Dockerfile

From Jupyter

E.g. a Dockerfile using a existing Jupyter image.

FROM jupyter/minimal-notebook
# Get the latest image tag at:
# https://hub.docker.com/r/jupyter/minimal-notebook/tags/
# Inspect the Dockerfile at:
# https://github.com/jupyter/docker-stacks/tree/master/minimal-notebook/Dockerfile


# install additional package for customization
RUN pip install --no-cache-dir astropy

From InfuseAI

E.g. a Dockerfile using a existing image provided by InfuseAI.

FROM infuseai/docker-stacks/<image>

Please refer to Available Images List for the latest InfuseAI provided images.

Dockerfile Reference

1. Dockerfile reference
2. Best practices for writing Dockerfiles

Images Built by repo2docker

For tech savvy users who want to try repo2docker for building images. Please see our technical document repo2docker image to make sure it can be used by PrimeHub.