Dockerizing Flask With Compose and Machine – From Localhost to the Cloud (original) (raw)
Docker is a powerful tool for spinning up isolated, reproducible application environment containers. This piece looks at just that—how to containerize a Flask app for local development along with delivering the application to a cloud hosting provider via Docker Compose and Docker Machine.
Updates:
- 03/31/2019: Updated to the latest versions of Docker - Docker client (v18.09.2), Docker compose (v1.23.2), and Docker Machine (v0.16.1) Thanks Florian Dahlitz!
- 11/16/2015: Updated to the latest versions of Docker - Docker client (v1.9.0), Docker compose (v1.5.0), and Docker Machine (v0.5.0)
- 04/25/2015: Fixed small typo, and updated the docker-compose.yml file to properly copy static files.
- 04/19/2015: Added a shell script for copying static files.
Interested in creating a similar environment for Django? Check out this blog post.
Local Setup
Along with Docker (v18.09.2) we’ll be using -
- Docker Compose (v1.23.2) - previously known as fig - for orchestrating a multi-container application into a single app, and
- Docker Machine (v0.16.1) for creating Docker hosts both locally and in the cloud.
Follow the directions here and here to install Docker Compose and Machine, respectively.
Running either older Mac OS X or Windows versions, then your best bet is to install Docker Toolbox.
Test out the installs:
Next clone the project from the repository or create your own project based on the project structure found on the repo:
├── docker-compose.yml ├── nginx │ ├── Dockerfile │ └── sites-enabled │ └── flask_project └── web ├── Dockerfile ├── app.py ├── config.py ├── create_db.py ├── models.py ├── requirements.txt ├── static │ ├── css │ │ ├── bootstrap.min.css │ │ └── main.css │ ├── img │ └── js │ ├── bootstrap.min.js │ └── main.js └── templates ├── _base.html └── index.html
We’re now ready to get the containers up and running. Enter Docker Machine.
Docker Machine
To start Docker Machine, first make sure you’re in the project root and then simply run:
The create
command setup a “machine” (called dev) for Docker development. In essence, it downloaded boot2docker and started a VM with Docker running. Now just point the Docker client at the dev machine via:
Run the following command to view the currently running Machines:
Next, let’s fire up the containers with Docker Compose and get the Flask app and Postgres database up and running.
Docker Compose
Take a look at the docker-compose.yml file:
Here, we’re defining four services - web, nginx, postgres, and data.
- First, the web service is built via the instructions in the Dockerfile within the “web” directory - where the Python environment is setup, requirements are installed, and the Flask app is fired up on port 8000. That port is then forwarded to port 80 on the host environment - e.g., the Docker Machine. This service also adds environment variables to the container that are defined in the .env file.
- The nginx service is used for reverse proxy to forward requests either to the Flask app or the static files.
- Next, the postgres service is built from the the official PostgreSQL image from Docker Hub, which install Postgres and runs the server on the default port 5432.
- Finally, notice how there is a separate volume container that’s used to store the database data, db-data. This helps ensure that the data persists even if the Postgres container is completely destroyed.
Now, to get the containers running, build the images and then start the services:
Tip: You can even run the above commands combined in a single one:
Grab a cup of coffee. Or two. Check out the Real Python courses. This will take a while the first time you run it.
We also need to create the database table:
Open your browser and navigate to the IP address associated with Docker Machine (docker-machine ip
):
Nice!
To see which environment variables are available to the web service, run:
To view the logs:
You can also enter the Postgres Shell - since we forward the port to the host environment in the docker-compose.yml file - to add users/roles as well as databases via:
Once done, stop the processes via docker-compose down
.
Deployment
So, with our app running locally, we can now push this exact same environment to a cloud hosting provider with Docker Machine. Let’s deploy to a Digital Ocean droplet.
After you sign up for Digital Ocean, generate a Personal Access Token, and then run the following command:
This will take a few minutes to provision the droplet and setup a new Docker Machine called production:
Now we have two Machines running, one locally and one on Digital Ocean:
Then set production as the active machine and load the Docker environment into the shell:
Finally, let’s build the Flask app again in the cloud:
Grab the IP address associated with that Digital Ocean account from the control panel and view it in the browser. If all went well, you should see your app running.
Conclusion
Cheers!
- Grab the code from the Github repo (star it too!).
- Comment below with questions.
- Next time we’ll extend this workflow to include two more Docker containers running the Flask app and incorporate load balancing into the mix. Stay tuned!