Docker Development WorkFlow - útmutató a lombikhoz és a Postgres-hez

A Docker, az egyik legújabb őrület, csodálatos és hatékony eszköz csomagoláshoz, szállításhoz és alkalmazások futtatásához. A Docker megértése és beállítása az adott alkalmazáshoz azonban eltarthat egy ideig. Mivel az internet tele van koncepcionális útmutatókkal, fogalmilag nem fogok elmélyülni a Containers kapcsán. Ehelyett elmagyarázom, hogy minden egyes általam írt sor mit jelent, és hogyan alkalmazhatja ezt az adott alkalmazásra és konfigurációra.

Miért éppen Docker?

A Hack4Impact nevű hallgató által működtetett nonprofit szervezet tagja vagyok az UIUC-nál, ahol nonprofit szervezetek számára technikai projekteket dolgozunk ki, hogy segítsük őket küldetéseik továbbjutásában. Minden félévben 5–7 hallgatói szoftverfejlesztőből álló projektcsoportok vannak, különféle készségszintekkel, beleértve azokat a hallgatókat is, akik csak az első főiskolai szintű informatikai tanfolyamot fejezték be.

Mivel sok nonprofit szervezet gyakran kért webalkalmazásokat, gondoztam egy lombik kazánlapot, amely lehetővé tette a csapatok számára, hogy gyorsan működésbe hozzák háttér-REST API-szolgáltatásaikat. A közüzemi funkciók, az alkalmazásstruktúra, az adatbázis-csomagolók és a kapcsolatok mind megtalálhatók a beállítással kapcsolatos dokumentációval, a legjobb kódolási gyakorlatokkal és a Heroku-telepítés lépéseivel.

A fejlesztési környezettel és a függőségekkel kapcsolatos kérdések

Mivel azonban minden félévben új hallgatói szoftverfejlesztőket vonunk be, a csapatok sok időt töltenének a környezeti problémák konfigurálásával és elhárításával. Gyakran több tagunk fejlődik különböző operációs rendszereken, és számtalan problémába ütközött (Windows, rád mutatok). Bár sok ilyen probléma triviális volt, például a helyes PostgreSQL adatbázis-verzió elindítása a megfelelő felhasználóval / jelszóval, időveszteséget okozott, amelyet magába a termékbe is be lehetett tölteni.

Ezen felül csak a MacOS felhasználóknak írtam dokumentációt, csak bash utasításokkal (van Mac-em), és lényegében a Windows és a Linux felhasználókat hagytam száradni. Felpörgethettem volna néhány virtuális gépet, és újra dokumentálhatnám az egyes operációs rendszerek telepítését, de miért tenném ezt, ha van Docker?

Írja be a Docker-t

A Docker segítségével a teljes alkalmazás elkülöníthető olyan konténerekben, amelyek gépről gépre hordozhatók. Ez lehetővé teszi a következetes környezeteket és függőségeket. Így „egyszer felépíthet, bárhová futtathat”, és a fejlesztők most csak egy dolgot telepíthetnek - a Dockert -, és futtathatnak pár parancsot az alkalmazás futtatásához. Az újonnan érkezők képesek lesznek gyorsan fejlődni, anélkül, hogy aggódnának a környezetük miatt. A nonprofit szervezetek a jövőben is gyorsan változtatni tudnak.

A Docker számos más előnnyel is jár, például hordozható és erőforrás-hatékony jellege (a virtuális gépekhez képest), valamint az, hogy hogyan állíthatja be fájdalommentesen a folyamatos integrációt és gyorsan telepítheti az alkalmazást.

A Docker alapkomponensek rövid áttekintése

Számos olyan online forrás található, amely jobban megmagyarázza Dockert, mint amennyire csak tudok, ezért nem fogom túl részletesen áttekinteni őket. Itt van egy fantasztikus blogbejegyzés a koncepcióiról, és egy másik a Docker-ről. Áttekintem azonban a Docker néhány alapkomponensét, amelyek szükségesek ahhoz, hogy megértsék a blog többi bejegyzését.

Docker Images

A Docker képek csak olvasható sablonok, amelyek egy Docker konténert írnak le. Ezek tartalmazzák a Dockerfile-be írt konkrét utasításokat, amelyek meghatározzák az alkalmazást és annak függőségeit. Gondoljon rájuk, mint az alkalmazás pillanatképének egy adott időpontban. Képeket kap, amikor docker build.

Docker konténerek

A Docker Containers a Docker képek példánya. Ide tartoznak az operációs rendszer, az alkalmazáskód, a futásideje, a rendszereszközök, a rendszerkönyvtárak és így tovább. Több Docker-tárolót is összekapcsolhat, például egy Node.js alkalmazást egy tárolóban, amely egy Redis adatbázis-tárolóhoz kapcsolódik. Futtat egy Docker konténert a docker start.

Docker Registries

A Docker Registry segítségével Docker képeket tárolhat és terjeszthet. A Docker Images-et fogjuk használni alapképként a DockerHub-ból, egy ingyenes nyilvántartásból, amelyet maga a Docker üzemeltet.

Docker Compose

A Docker Compose egy olyan eszköz, amely lehetővé teszi több Docker Image elkészítését és elindítását egyszerre. Ahelyett, hogy ugyanazt a több parancsot futtatná minden alkalommal, amikor el akarja indítani az alkalmazást, megteheti mindet egy parancsban - miután megad egy adott konfigurációt.

Docker példa a lombikkal és a Postgres-szel

A Docker összes összetevőjét szem előtt tartva kezdjük el beállítani a Docker fejlesztői környezetet a Lombik alkalmazással, a Postgres adattáraként. A blog bejegyzésének további részében hivatkozni fogok a Flask Boilerplate-re, a Hack4Impact korábban már említett adattárára.

Ebben a konfigurációban a Docker segítségével két képet készítünk:

  • app - az Lombik alkalmazás az 5000-es kikötőben szolgált
  • postgres - a Postgres adatbázis az 5432-es porton működik

A legfelső könyvtár megtekintésekor három fájl definiálja ezt a konfigurációt:

  • Dockerfile - egy parancsfájl, amely utasításokat apptartalmaz a tárolók beállításához . Mindegyik parancs automatikusan végrehajtásra kerül. Ezt a fájlt a könyvtárban található, ahol futtatja az alkalmazást ( python manage.py runservervagy python app.py, vagy npm startnéhány példát). Esetünkben a legfelső könyvtárban van (ahol manage.pytalálható). A Dockerfile elfogadja a Docker utasításokat.
  • .dockerignore - meghatározza, mely fájlokat ne vegye fel a tárolóba . Pontosan olyan, mint .gitignorea Docker konténerek esetében. Ez a fájl párosítva van a Dockerfile-lal.
  • docker-compose.yml - A Docker Compose konfigurációs fájlja. Ez lehetővé teszi számunkra, hogy építsenek a két appés postgresképet egyszerre, határozza kötetek és az állam, hogy appattól függ postgres, és beállított előírt környezeti változókat.

Megjegyzés: Két képhez csak egy Dockerfile tartozik, mert a DockerHubról hivatalos Docker Postgres képet készítünk! Saját Postgres-képét úgy is felveheti, hogy megírja a saját Docker fájlját, de nincs értelme.

Dockerfile

Csak még egyszer tisztázzuk, hogy ez a Dockerfile a appkonténerhez tartozik. Áttekintésképpen itt van a teljes Dockerfile - lényegében egy alapképet kap, átmásolja az alkalmazást, telepíti a függőségeket és beállít egy adott környezeti változót.

FROM python:3.6
LABEL maintainer "Timothy Ko "
RUN apt-get update
RUN mkdir /app
WORKDIR /app
COPY . /app
RUN pip install --no-cache-dir -r requirements.txt
ENV FLASK_ENV="docker"
EXPOSE 5000

Because this Flask Application uses Python 3.6, we want an environment that supports it and already has it installed. Fortunately, DockerHub has an official image that’s installed on top of Ubuntu. In one line, we will have a base Ubuntu image with Python 3.6, virtualenv, and pip. There are tons of images on DockerHub, but if you would like to start off with a fresh Ubuntu image and build on top of it, you could do that.

FROM python:3.6

I then note that I’m the maintainer.

LABEL maintainer "Timothy Ko "

Now it’s time to add the Flask application to the image. For simplicity, I decided to copy the application under the /app directory on our Docker Image.

RUN mkdir /app
COPY . /app
WORKDIR /app

WORKDIR is essentially a cd in bash, and COPY copies a certain directory to the provided directory in an image. ADD is another command that does the same thing as COPY , but it also allows you to add a repository from a URL. Thus, if you want to clone your git repository instead of copying it from your local repository (for staging and production purposes), you can use that. COPY, however, should be used most of the time unless you have a URL. Every time you use RUN, COPY, FROM, or CMD, you create a new layer in your docker image, which affects the way Docker stores and caches images. For more information on best practices and layering, see Dockerfile Best Practices.

Now that we have our repository copied to the image, we will install all of our dependencies, which is defined in requirements.txt

RUN pip install --no-cache-dir -r requirements.txt

But say you had a Node application instead of Flask — you would instead write RUN npm install. The next step is to tell Flask to use Docker Configurations that I hardcoded into config.py. In that configuration, Flask will connect to the correct database we will set up later on. Since I had production and regular development configurations, I made it so that Flask would choose the Docker Configuration whenever the FLASK_ENV environment variable is set to docker. So, we need to set that up in our app image.

ENV FLASK_ENV="docker"

Then, expose the port(5000) the Flask application runs on:

EXPOSE 5000

And that’s it! So no matter what OS you’re on, or how bad you are at following documentation instructions, your Docker image will be same as your team members’ because of this Dockerfile.

Anytime you build your image, these following commands will be run. You can now build this image with sudo docker build -t app .. However, when you run it with sudo docker run app to start a Docker Container, the application will run into a database connection error. This is is because you haven’t provisioned a database yet.

docker-compose.yml

Docker Compose will allow you to do that and build your app image at the same time. The entire file looks like this:

version: '2.1'services: postgres: restart: always image: postgres:10 environment: - POSTGRES_USER=${POSTGRES_USER} - POSTGRES_PASSWORD=${POSTGRES_PASSWORD} - POSTGRES_DB=${POSTGRES_DB} volumes: - ./postgres-data/postgres:/var/lib/postgresql/data ports: - "5432:5432" app: restart: always build: . ports: - 5000:5000 volumes: - .:/app

For this specific repository, I decided to use version 2.1 since I was more comfortable with it and it had a few more guides and tutorials on it — yeah, that’s my only reasoning for not using version 3. With version 2, you must provide “services” or images you want to include. In our case, it is app and postgres(these are just names that you can refer to when you use docker-compose commands. You call them database and api or whatever floats your boat).

Postgres Image

Looking at the Postgres Service, I specify that it is a postgres:10 image, which is another DockerHub Image. This image is an Ubuntu Image that has Postgres installed and will automatically start the Postgres server.

postgres: restart: always image: postgres:10 environment: - POSTGRES_USER=${USER} - POSTGRES_PASSWORD=${PASSWORD} - POSTGRES_DB=${DB} volumes: - ./postgres-data/postgres:/var/lib/postgresql/data ports: - "5432:5432"

If you want a different version, just change the “10” to something else. To specify what user, password, and database you want inside Postgres, you have to define environment variables beforehand — this is implemented in the official postgres Docker image’s Dockerfile. In this case, the postgres image will inject the $USER, $PASSWORD, and $DB environment variables and make them the POSTGRES_USER, POSTGRES_PASSWORD, and POSTGRES_DB envrionment variables inside the postgres container. Note that $USER and the other environment variables injected are environment variables specified in your own computer (more specifically the command line process you are using to run the docker-compose up command. By injecting your credentials, this allows you to not commit your credentials into a public repository.

Docker-compose will also automatically inject environment variables if you have a .env file in the same directory as your docker-compose.yml file. Here’s an example of a .env file for this scenario:

USER=testusrPASSWORD=passwordDB=testdb

Thus our PostgreSQL database will be named testdb with a user called testusr with password password.

Our Flask application will connect to this specific database, because I wrote down its URL in the Docker Configurations I mentioned earlier.

Every time a container is stopped and removed, the data is deleted. Thus, you must provide a persistent data storage so none of the database data is deleted. There are two ways to do it:

  • Docker Volumes
  • Local Directory Mounts

I’ve chosen to mount it locally to ./postgres-data/postgres , but it can be anywhere. The syntax is always[HOST]:[CONTAINER]. This means any data from /var/lib/postgresql/data is actually stored in ./postgres-data.

volumes:- ./postgres-data/postgres:/var/lib/postgresql/data

We will use the same syntax for ports:

ports:- "5432:5432"

app Image

We will then define the app image.

app: restart: always build: . ports: - 5000:5000 volumes: - .:/app depends_on: - postgres entrypoint: ["python", "manage.py","runserver"]

We first define it to have restart: always. This means that it will restart whenever it fails. This is especially useful when we build and start these containers. app will generally start up before postgres, meaning that app will try to connect to the database and fail, since the postgres isn’t up yet. Without this property, app would just stop and that’s the end of it.

We then define that we want this build to be the Dockerfile that is in this current directory:

build: .

This next step is pretty important for the Flask server to restart whenever you change any code in your local repository. This is very helpful so you don’t need to rebuild your image over and over again every time to see your changes. To do this, we do the same thing we did for postgres : we state that the /app directory inside the container will be whatever is in .(the current directory). Thus, any changes in your local repo will be reflected inside the container.

volumes: - .:/app

After this, we need to tell Docker Compose that app depends on the postgres container. Note that if you change the name of the image to something else like database, you must replace that postgres with that name.

depends_on: - postgres

Finally, we need to provide the command that is called to start our application. In our case, it’s python manage.py runserver.

entrypoint: ["python", "manage.py","runserver"]

One caveat for Flask is that you must explicitly note which host (port) you want to run it in, and whether you want it to be in debug mode when you run it. So in manage.py, I do that with:

def runserver(): app.run(debug=True, host=’0.0.0.0', port=5000)

Finally, build and start your Flask app and Postgres Database using your Command Line:

docker-compose builddocker-compose up -ddocker-compose exec app python manage.py recreate_db

The last command essentially creates the database schema defined by my Flask app in Postgres.

And that’s it! You should be able to see the Flask application running on //localhost:5000!

Docker Commands

Remembering and finding Docker commands can be pretty frustrating in the beginning, so here’s a list of them! I’ve also written a bunch of commonly used ones in my Flask Boilerplate Docs if you want to refer to that.

Conclusion

Docker truly allows teams to develop much faster with its portability and consistent environments across platforms. Although I’ve only gone through using Docker for development, Docker excels when you use it for Continuous Integration/testing and in Deployment.

I could add a couple more lines and have a full production setup with Nginx and Gunicorn. If I wanted to use Redis for session caching or as a queue, I could do that very quickly and everyone on my team would be able to have the same environment when they rebuilt their Docker Images.

Not only that, I could spin up 20 instances of the Flask Application in seconds if I wanted to. Thanks for reading! :)

If you have any thoughts and comments, feel free to leave a comment below or email me at [email protected]! Also, feel free to use my code or share this with your peers!