40a/dockerize-me

This tool lets you Dockerize your applications using best practices to define your Dockerfile and Docker entry point files.

Dockerize Me

Tired of copy/pasting Dockerfiles around? Not sure about best practices for Dockerfiles or Docker entry points? This tool lets you Dockerize your applications using best practices to define your Dockerfile and Docker entry point files.

You just need to mount your app into the /code folder and follow the instructions. It'll generate a valid Dockerfile, and, if needed, a valid docker-entrypoint.sh file to be used as entry point.

Example

You can run this utility with Docker

$ docker run -it --rm -v $PWD:/code fiunchinho/dockerize-me

Your email: [email protected]
Your full name: Alice Wonderland
Does the container run Java? [False] 
Which file/folder needs to be copied to the container? It'll be copied into '/code' [.] 
Which port do you want to expose? [No ports exposed] 
Do you need an entrypoint to do stuff before running the app? [False] 
Which command needs to be executed to start your application? Your app lives in '/code' python /code/dockerize-me/dockerize.py
System dependencies (f.e python=2.7.11-r3 py-pip=7.1.2-r0): python=2.7.11-r3 py-pip=7.1.2-r0
App dependencies command (f.e pip install -r requirements.txt): [False] pip install -r requirements.txt

You can build your container running the following command: 
docker build \ 
    --build-arg git_repository=`git config --get remote.origin.url` \ 
    --build-arg git_branch=`git rev-parse --abbrev-ref HEAD` \ 
    --build-arg git_commit=`git rev-parse HEAD` \ 
    --build-arg built_on=`date -u +"%Y-%m-%dT%H:%M:%SZ"` \ 
    -t your_image .

This has generated a Dockerfile. If you have selected to use a docker entrypoint, a file called docker-entrypoint.sh will be generated. Before building your image, give execution permissions to this file.

Motivation

This project allow people to easily create nice Dockerfiles to dockerize their applications. Besides, it's a way to document how to craft good Docker images.

Images

This tool uses the following images to keep your Docker images as tiny as possible

• anapsix/alpine-java When selecting a Java project
• alpine For the rest

Init system

We use tini as init system, so you don't have problems with signals or zombie processes.

Metadata

All our images have special labels that help us determine which is inside the image. This tool also copies the Dockerfile used to build the image inside the container. The labels added to the images are

• git.repository url of the git repository
• git.commit sha1 hash of the commit when the image was built
• git.branch git branch when the image was built
• build.dockerfile path to the Dockerfile inside the container. Normally /Dockerfile
• build.on date and time when the image was built

Once you've generated the Dockerfile, you can build your image with

docker build \ 
    --build-arg git_repository=`git config --get remote.origin.url` \ 
    --build-arg git_branch=`git rev-parse --abbrev-ref HEAD` \ 
    --build-arg git_commit=`git rev-parse HEAD` \ 
    --build-arg built_on=`date -u +"%Y-%m-%dT%H:%M:%SZ"` \ 
    -t your_image_name .

Developer Experience

Trying to make life easier for developers, images that need a docker entry point and images that don't, they both accept commands the same way. Images created with this tool let you

• Run the default command docker run -it --rm -v $PWD:/code fiunchinho/dockerize-me
• Get an shell docker run -it --rm -v $PWD:/code fiunchinho/dockerize-me sh
• Use a different command docker run -it --rm -v $PWD:/code fiunchinho/dockerize-me python --version

Credits

I learn many of these concepts thanks to garethr, jpetazzo or jbaruch. You should definitely listen to them.