Share Your Docker Image¶
Prerequisites: You should have access to a terminal with Docker installed, a Docker Hub account, and a GitHub account. You should also have a copy of pi.py
Now that you have containerized, tested, and tagged your code in a Docker image, the next step is to disseminate it so others can use it.
Commit to GitHub¶
In the spirit of promoting Reproducible Science, it is now a good idea to create a new GitHub repository for this project and commit our files. The steps are:
- Log in to GitHub and create a new repository called pi-estimator
- Do not add a README or license file at this time
- Then in your working folder, issue the following:
$ pwd /Users/username/python-container/ $ ls Dockerfile pi.py $ git init $ git add * $ git commit -m "first commit" $ git remote add origin https://github.com/username/pi-estimator.git $ git push -u origin master
Make sure to use the GitHub URL which matches your username and repo name. Let’s also tag the repo as ‘0.1’ to match our Docker image tag:
$ git tag -a 0.1 -m "first release" $ git push origin 0.1
Finally, navigate back to your GitHub repo in a web browser and make sure your files were uploaded and the tag exists.
Push to Docker Hub¶
Docker Hub is the de facto place to share an image you built. Remember, the image must be name-spaced with either your Docker Hub username or a Docker Hub organization where you have write privileges in order to push it:
$ docker login ... $ docker push username/pi-estimator:0.1
You and others will now be able to pull a copy of your container with:
$ docker pull username/pi-estimator:0.1
GitHub also has integrations to automatically update your image in the public container registry every time you commit new code.
For example, see: Set up automated builds
After the next hands-on exercise, we will set up the GitHub-Docker integration
Scenario: You have the great idea to update your python code to use argparse to better handle the command line arguments. Outside of the container, modify pi.py to look like:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26
#!/usr/bin/env python3 from random import random as r from math import pow as p from sys import argv # Use argparse to take command line options and generate help text import argparse parser = argparse.ArgumentParser() parser.add_argument("number", help="number of random points (int)", type=int) args = parser.parse_args() # Grab number of attempts from command line attempts = args.number inside=0 tries=0 ratio=0. # Try the specified number of random points while (tries < attempts): tries += 1 if (p(r(),2) + p(r(),2) < 1): inside += 1 # Compute and print a final ratio ratio=4.*(inside/(tries)) print("Final pi estimate from", attempts, "attempts =", ratio)
(New and modified lines are highlighted). With this change, the user can execute ‘pi.py -h’ to get usage information. You can also download this code from here:
Next, update the Dockerfile to include a new kind of instruction at the very end of the file - CMD:
1 2 3 4 5 6 7 8 9 10 11
FROM ubuntu:18.04 RUN apt-get update && apt-get upgrade -y && apt-get install -y python3 COPY pi.py /code/pi.py RUN chmod +x /code/pi.py ENV PATH "/code:$PATH" CMD ["pi.py", "-h"]
This command will be executed in the container if the user calls the container without any arguments.
Finally, rebuild the container and update the version tag to ‘0.2’. Test that the code in the new container has been updated, and that it is working as expected.
Set up a GitHub-Docker Hub Integration¶
Rather than commit to GitHub AND push to Docker Hub each time you want to release a new version, you can set up an integration between the two services that automates it. The key benefit is you only have to commit to one place (GitHub), and you know the image available on Docker Hub is always in sync.
To set up the integration, navigate to your new Docker repository in a web browser, which should be at an address similar to:
Click on Builds => Link to GitHub. (If this is your first time connecting a Docker repo to a GitHub repo, you will need to set it up. Press the ‘Connect’ link to the right of ‘GitHub’. If you are already signed in to both Docker and GitHub in the same browser, it takes about 15 seconds to set up).
Once you reach the Build Configurations screen, you will select your GitHub username and repository named pi-estimator.
Leaving all the defaults selected will cause this Docker image to rebuild every time you push code to the master branch of your GitHub repo. For this example, set the build to to trigger whenever a new release is tagged:
Click ‘Save and Build’ and check the ‘Timeline’ tab on Docker Hub to see if it is working as expected.
Commit to GitHub (Again)¶
Finally, push your modified code to GitHub and tag the release as 0.2 to trigger another automated build:
$ git add * $ git commit -m "using argparse to parse args" $ git push $ git tag -a 0.2 -m "release version 0.2" $ git push origin 0.2
By default, the git push command does not transfer tags, so we are explicitly telling git to push the tag we created (0.2) to the remote (origin).
Now, check the online GitHub repo to make sure your change / tag is there, and check the Docker Hub repo to see if your image is automatically rebuilding.
The best way to learn to build docker images is to practice building lots of images for tools you use. The online Docker documentation contains a lot of good advice on building images.
Some miscellaneous tips for building images include:
- Save your Dockerfiles – GitHub is a good place for this
- You probably don’t want to use ENTRYPOINT - turns an container into a black box
- If you use CMD, make it print the help text for the containerized code
- Usually better to use COPY instead of ADD
- Order of operations in the Dockerfile is important; combine steps where possible
- Remove temporary and unnecessary files to keep images small
- Avoid using latest tag; use explicit tag callouts
- The command docker system prune will help free up space in your local environment
- Use docker-compose for multi-container pipelines and microservices
- A good rule of thumb is one tool or process per container