Prerequisites
- .
- Read the orientation in .
-
Give your environment a quick test run to make sure you’re all set up:
docker run hello-world
Introduction
It’s time to begin building an app the Docker way.
We start at the bottom of the hierarchy of such an app, which is a container, which we cover on this page.
Above this level is a service, which defines how containers behave in production, covered in .
Finally, at the top level is the stack, defining the interactions of all the services, covered in .
- Stack
- Services
- Container (you are here)
Your new development environment
In the past, if you were to start writing a Python app,your first order of business was to install a Python runtime onto your machine. But, that creates a situation where the environment on your machine needs to be perfect for your app to run as expected, and also needs to match your production environment.
With Docker, you can just grab a portable Python runtime as an image, no installation necessary.
Then, your build can include the base Python image right alongside your app code, ensuring that your app, its dependencies, and the runtime, all travel together.
These portable images are defined by something called a
Dockerfile
.Define a container with
Dockerfile
Dockerfile
defines what goes on in the environment inside your container.Access to resources like networking interfaces and disk drives is virtualized inside this environment, which is isolated from the rest of your system,
so you need to map ports to the outside world,
and be specific about what files you want to “copy in” to that environment.
However, after doing that, you can expect that the build of your app defined in this
Dockerfile
behaves exactly the same wherever it runs.Dockerfile
Create an empty directory. Change directories (
cd
) into the new directory, create a file calledDockerfile
, copy-and-paste the following content into that file, and save it. Take note of the comments that explain each statement in your new Dockerfile.# Use an official Python runtime as a parent imageFROM python:2.7-slim# Set the working directory to /appWORKDIR /app# Copy the current directory contents into the container at /appADD . /app# Install any needed packages specified in requirements.txtRUN pip install --trusted-host pypi.python.org -r requirements.txt# Make port 80 available to the world outside this containerEXPOSE 80# Define environment variableENV NAME World# Run app.py when the container launchesCMD ["python", "app.py"]
This
Dockerfile
refers to a couple of files we haven’t created yet, namelyapp.py
andrequirements.txt
.Let’s create those next.
The app itself
Create two more files,
requirements.txt
andapp.py
, and put them in the same folder with theDockerfile
. This completes our app, which as you can see is quite simple.When the above
Dockerfile
is built into an image,app.py
andrequirements.txt
is present because of thatDockerfile
’sADD
command,and the output from
app.py
is accessible over HTTP thanks to theEXPOSE
command.requirements.txt
FlaskRedis
app.py
from flask import Flaskfrom redis import Redis, RedisErrorimport osimport socket# Connect to Redisredis = Redis(host="redis", db=0, socket_connect_timeout=2, socket_timeout=2)app = Flask(__name__)@app.route("/")def hello(): try: visits = redis.incr("counter") except RedisError: visits = "cannot connect to Redis, counter disabled" html = "
Hello {name}!
" \ "Hostname: {hostname}" \ "Visits: {visits}" return html.format(name=os.getenv("NAME", "world"), hostname=socket.gethostname(), visits=visits)if __name__ == "__main__": app.run(host='0.0.0.0', port=80)Now we see that
pip install -r requirements.txt
installs the Flask and Redis libraries for Python,and the app prints the environment variable
NAME
,as well as the output of a call to
socket.gethostname()
.Finally, because Redis isn’t running (as we’ve only installed the Python library, and not Redis itself), we should expect that the attempt to use it here fails and produces the error message.
Note: Accessing the name of the host when inside a container retrieves the container ID, which is like the process ID for a running executable.
That’s it! You don’t need Python or anything in
requirements.txt
on your system, nor does building or running this image install them on your system.It doesn’t seem like you’ve really set up an environment with Python and Flask, but you have(in image or container,but not in system).
Build the app
We are ready to build the app. Make sure you are still at the top level of your new directory. Here’s what
ls
should show:$ lsDockerfile app.py requirements.txt
Now run the build command. This creates a Docker image, which we’re going to tag using
-t
so it has a friendly name.docker build -t friendlyhello .
Where is your built image? It’s in your machine’s local Docker image registry:
$ docker image lsREPOSITORY TAG IMAGE IDfriendlyhello latest 326387cea398
Troubleshooting for Linux users
Proxy server settings
Proxy servers can block connections to your web app once it’s up and running.
If you are behind a proxy server, add the following lines to your Dockerfile, using the
ENV
command to specify the host and port for your proxy servers:# Set proxy server, replace host:port with values for your serversENV http_proxy host:portENV https_proxy host:port
DNS settings
DNS misconfigurations can generate problems with
pip
.You need to set your own DNS server address to make
pip
work properly.You might want to change the DNS settings of the Docker daemon. You can edit (or create) the configuration file at
/etc/docker/daemon.json
with thedns
key, as following:{ "dns": ["your_dns_address", "8.8.8.8"]}
In the example above,
the first element of the list is the address of your DNS server.
The second item is the Google’s DNS which can be used when the first one is not available.
Before proceeding, save
daemon.json
and restart the docker service.sudo service docker restart
Once fixed, retry to run the
build
command.Run the app
Run the app, mapping your machine’s port 4000 to the container’s published port 80 using
-p
:docker run -p 4000:80 friendlyhello
You should see a message that Python is serving your app at
http://0.0.0.0:80
. But that message is coming from inside the container, which doesn’t know you mapped port 80 of that container to 4000, making the correct URLhttp://localhost:4000
.Go to that URL in a web browser to see the display content served up on a web page.
Note: If you are using Docker Toolbox on Windows 7, use the Docker Machine IP instead of
localhost
. For example, http://192.168.99.100:4000/. To find the IP address, use the commanddocker-machine ip
.You can also use the
curl
command in a shell to view the same content.$ curl http://localhost:4000
Hello World!
Hostname: 8fc990912a14Visits: cannot connect to Redis, counter disabled This port remapping of 4000:80 is to demonstrate the difference between what you EXPOSE within the Dockerfile, and what you publish using docker run -p. In later steps, we just map port 80 on the host to port 80 in the container and use http://localhost.Hit
CTRL+C
in your terminal to quit.On Windows, explicitly stop the container
On Windows systems,
CTRL+C
does not stop the container.So, first type
CTRL+C
to get the prompt back (or open another shell),then type
docker container ls
to list the running containers,followed by
docker container stop <Container NAME or ID>
to stop the container. Otherwise, you get an error response from the daemon when you try to re-run the container in the next step.Now let’s run the app in the background, in detached mode:
docker run -d -p 4000:80 friendlyhello
You get the long container ID for your app and then are kicked back to your terminal.
Your container is running in the background.
You can also see the abbreviated container ID with
docker container ls
(and both work interchangeably when running commands):$ docker container lsCONTAINER ID IMAGE COMMAND CREATED1fa4ab2cf395 friendlyhello "python app.py" 28 seconds ago
Notice that
CONTAINER ID
matches what’s onhttp://localhost:4000
.Now use
docker container stop
to end the process, using theCONTAINER ID
, like so:docker container stop 1fa4ab2cf395
Share your image
To demonstrate the portability of what we just created, let’s upload our built image and run it somewhere else.
After all, you need to know how to push to registries when you want to deploy containers to production.
A registry is a collection of repositories, and a repository is a collection of images—sort of like a GitHub repository, except the code is already built.
An account on a registry can create many repositories.
The
docker
CLI uses Docker’s public registry by default.Note: We use Docker’s public registry here just because it’s free and pre-configured,
but there are many public ones to choose from,
and you can even set up your own private registry using .
Log in with your Docker ID
If you don’t have a Docker account, sign up for one at . Make note of your username.
Log in to the Docker public registry on your local machine.
$ docker login
Tag the image
The notation for associating a local image with a repository on a registry is
username/repository:tag
.The tag is optional, but recommended, since it is the mechanism that registries use to give Docker images a version.
Give the repository and tag meaningful names for the context, such as
get-started:part2
. This puts the image in theget-started
repository and tag it aspart2
.Now, put it all together to tag the image. Run
docker tag image
with your username, repository, and tag names so that the image uploads to your desired destination.The syntax of the command is:
docker tag image username/repository:tag
For example:
docker tag friendlyhello gordon/get-started:part2
Run to see your newly tagged image.
$ docker image lsREPOSITORY TAG IMAGE ID CREATED SIZEfriendlyhello latest d9e555c53008 3 minutes ago 195MBgordon/get-started part2 d9e555c53008 3 minutes ago 195MBpython 2.7-slim 1c7128a655f6 5 days ago 183MB...
Publish the image
Upload your tagged image to the repository:
docker push username/repository:tag
Once complete, the results of this upload are publicly available.
If you log in to , you see the new image there, with its pull command.
Pull and run the image from the remote repository
From now on, you can use
docker run
and run your app on any machine with this command:docker run -p 4000:80 username/repository:tag
If the image isn’t available locally on the machine, Docker pulls it from the repository.
$ docker run -p 4000:80 gordon/get-started:part2Unable to find image 'gordon/get-started:part2' locallypart2: Pulling from gordon/get-started10a267c67f42: Already existsf68a39a6a5e4: Already exists9beaffc0cf19: Already exists3c1fe835fb6b: Already exists4c9f1fa8fcb8: Already existsee7d8f576a14: Already existsfbccdcced46e: Already existsDigest: sha256:0601c866aab2adcc6498200efd0f754037e909e5fd42069adeff72d1e2439068Status: Downloaded newer image for gordon/get-started:part2 * Running on http://0.0.0.0:80/ (Press CTRL+C to quit)
No matter where
docker run
executes, it pulls your image, along with Python and all the dependencies fromrequirements.txt
, and runs your code.It all travels together in a neat little package, and you don’t need to install anything on the host machine for Docker to run it.
Conclusion of part two
That’s all for this page. In the next section, we learn how to scale our application by running this container in a service.
Recap and cheat sheet (optional)
Here’s :
Here is a list of the basic Docker commands from this page,
and some related ones if you’d like to explore a bit before moving on.
docker build -t friendlyhello . # Create image using this directory's Dockerfiledocker run -p 4000:80 friendlyhello # Run "friendlyname" mapping port 4000 to 80docker run -d -p 4000:80 friendlyhello # Same thing, but in detached modedocker container ls # List all running containersdocker container ls -a # List all containers, even those not runningdocker container stop
# Gracefully stop the specified containerdocker container kill # Force shutdown of the specified containerdocker container rm # Remove specified container from this machinedocker container rm $(docker container ls -a -q) # Remove all containersdocker image ls -a # List all images on this machinedocker image rm # Remove specified image from this machinedocker image rm $(docker image ls -a -q) # Remove all images from this machinedocker login # Log in this CLI session using your Docker credentialsdocker tag username/repository:tag # Tag for upload to registrydocker push username/repository:tag # Upload tagged image to registrydocker run username/repository:tag # Run image from a registry