Dockeri arendus WorkFlow - juhend kolbi ja Postgresiga

Docker, üks viimastest hullustest, on hämmastav ja võimas tööriist rakenduste pakkimiseks, saatmiseks ja käitamiseks. Kuid Dockeri mõistmine ja seadistamine teie konkreetse rakenduse jaoks võib võtta natuke aega. Kuna internet on täis kontseptuaalseid juhendeid, ei lähe ma konteinerite osas kontseptuaalselt liiga sügavale. Selle asemel selgitan, mida iga kirjutatud rida tähendab ja kuidas seda oma konkreetse rakenduse ja konfiguratsiooni jaoks rakendada.

Miks just Docker?

Olen osa UIUCi üliõpilaste juhitud mittetulundusühingust Hack4Impact, kus töötame välja mittetulundusühingute jaoks tehnilisi projekte, et aidata neil oma missioone edasi arendada. Igal semestril on meil mitu projektimeeskonda, mis koosnevad 5–7 üliõpilastarkvara arendajast, erineva oskustasemega, sealhulgas üliõpilased, kes on alles lõpetanud esimese kõrgkoolide arvutiteaduse kursuse.

Kuna paljud mittetulundusühingud palusid sageli veebirakendusi, kureerisin kolbkatlaplaadi, et meeskonnad saaksid oma taustaprogrammi REST API teenused kiiresti tööle panna. Pakutakse ühiseid utiliidifunktsioone, rakenduste struktuuri, andmebaaside ümbriseid ja ühendusi koos seadistamise dokumentatsiooniga, parimate kodeerimistavade ja Heroku juurutamise sammudega.

Arengukeskkonna ja sõltuvustega seotud probleemid

Kuid kuna me kasutame igal semestril uusi õpilastarkvara arendajaid, kulutaksid meeskonnad palju aega keskkonnaprobleemide seadistamiseks ja tõrkeotsinguks. Meil oleks sageli mitu opsüsteemiga arendavat liiget ja neil tekkis arvukalt probleeme (Windows, ma osutan teile). Kuigi paljud neist probleemidest olid tühised, näiteks õige PostgreSQL andmebaasi versiooni käivitamine koos õige kasutaja / parooliga, raiskas see aega, mida oleks võinud toote endasse panna.

Lisaks sellele kirjutasin MacOS-i kasutajatele ainult bash-juhistega dokumente (mul on Mac) ja jätsin Windowsi ja Linuxi kasutajad sisuliselt kuivama. Ma oleksin võinud mõned virtuaalsed masinad kokku keerata ja iga OS-i seadistamise uuesti dokumenteerida, aga miks ma seda teeksin, kui seal on Docker?

Sisestage Docker

Dockeri abil saab kogu rakenduse isoleerida konteineritesse, mida saab masinast masinasse teisaldada. See võimaldab püsivaid keskkondi ja sõltuvusi. Seega saate "üks kord ehitada, kõikjal joosta" ja arendajad saavad nüüd rakenduse käivitamiseks installida ainult ühe asja - Dockeri - ja käivitada paar käsku. Uustulnukad saavad kiiresti areneda, muretsemata oma keskkonna pärast. Ka mittetulundusühingud saavad tulevikus kiiresti muudatusi teha.

Dockeril on ka palju muid eeliseid, näiteks kaasaskantav ja ressursitõhus olemus (võrreldes virtuaalsete masinatega) ning see, kuidas saate valutult seadistada pidevat integreerimist ja oma rakendust kiiresti juurutada.

Lühiülevaade Dockeri põhikomponentidest

Internetis on palju ressursse, mis selgitavad Dockerit paremini kui ma oskan, nii et ma ei hakka neid liiga üksikasjalikult üle vaatama. Siin on vinge ajaveebipostitus selle kontseptsioonide kohta ja veel üks spetsiaalselt Dockeri kohta. Vaatan siiski üle mõned Dockeri põhikomponendid, mis on vajalikud selle blogi ülejäänud postituse mõistmiseks.

Dockeri pildid

Dockeri pildid on kirjutuskaitstud mallid, mis kirjeldavad Dockeri konteinerit. Need sisaldavad Dockerfile'i kirjutatud konkreetseid juhiseid, mis määratlevad rakenduse ja selle sõltuvused. Mõelge neist kui oma rakenduse hetktõmmist teatud ajahetkel. Saate pilte, kui teete docker build.

Dockeri konteinerid

Dockeri konteinerid on Dockeri piltide eksemplarid. Need hõlmavad operatsioonisüsteemi, rakenduskoodi, käitust, süsteemitööriistu, süsteemiteeke ja nii edasi. Saate ühendada mitu Dockeri konteinerit, näiteks Node.js-i rakenduse olemasolu ühes konteineris, mis on ühendatud Redise andmebaasi konteineriga. Juhtite Dockeri konteinerit koos docker start.

Dockeri registrid

Dockeri register on koht, kus saate Dockeri pilte salvestada ja levitada. Aluskujutistena kasutame Docker Images DockerHubi, Dockeri enda hostitud tasuta registrit.

Docker Komponeeri

Docker Compose on tööriist, mis võimaldab teil korraga luua ja käivitada mitu Docker Images'i. Selle asemel, et iga kord, kui soovite oma rakenduse käivitada, käivitada samu mitu käsku, saate need kõik teha ühe käsuga - kui olete konkreetse konfiguratsiooni andnud.

Dockeri näide kolbi ja Postgresiga

Kõiki Dockeri komponente silmas pidades alustame Dockeri arenduskeskkonna seadistamist Flask Applicationiga, kasutades oma andmesalvestina Postgresi. Ülejäänud ajaveebi postituse osas viitan Flask Boilerplate'ile, mida ma varem mainisin Hack4Impactile.

Selles konfiguratsioonis kasutame Dockerit kahe pildi ehitamiseks:

  • app - kolvirakendus, mida teenindatakse sadamas 5000
  • postgres - Postgresi andmebaas teenindatakse sadamas 5432

Kui vaatate ülemist kataloogi, on selle konfiguratsiooni määratlenud kolm faili:

  • Dockerfile - skript, mis koosneb juhistest appkonteinerite seadistamiseks . Iga käsk on automaatne ja täidetakse järjestikku. See fail asub kataloogis, kus sa jooksed app ( python manage.py runservervõi python app.pyvõi npm starton mõned näited). Meie puhul on see ülemist kataloogi (kus manage.pyasub). Dockerfile aktsepteerib Dockeri juhiseid.
  • .dockerignore - määrab, milliseid faile konteinerisse lisada ei tohi. See on nagu .gitignoreDockeri konteinerite jaoks. See fail on seotud Dockerfile'iga.
  • docker-compose.yml - Docker Compose'i konfiguratsioonifail. See võimaldab meil ehitada nii appja postgrespilte korraga, määratleda mahud ja märgitakse, et appsõltub postgres, ja määrata nõutud keskkonnamuutusi.

Märkus . Kahe pildi jaoks on ainult üks Dockerfile, sest me võtame DockerHubist ametliku Docker Postgresi pildi! Võite lisada oma Postgresi pildi, kirjutades selle jaoks oma Dockerfile'i, kuid pole mõtet.

Dockerfile

Lihtsalt uuesti selgitamiseks on see Dockerfile appkonteiner. Ülevaadena on siin kogu Dockerfile - see saab sisuliselt baaspildi, kopeerib rakenduse, installib sõltuvused ja määrab konkreetse keskkonnamuutuja.

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 võimaldab meeskondadel tõepoolest palju kiiremini areneda tänu oma teisaldatavusele ja järjepidevale keskkonnale kogu platvormil. Kuigi olen Dockerit kasutanud ainult arendamiseks, on Docker hiilgav, kui kasutate seda pidevaks integreerimiseks / testimiseks ja juurutamiseks.

Võiksin lisada veel paar rida ja mul oleks Nginxi ja Gunicorniga täielik tooteseadistus. Kui ma sooviksin Redist kasutada seansside vahemällu salvestamiseks või järjekorrana, saaksin seda teha väga kiiresti ja kõigil minu meeskonna liikmetel oleks Docker Images'i ülesehitamisel sama keskkond.

Vähe sellest, ma saaksin soovi korral mõne sekundi jooksul 20 kolbirakenduse eksemplari üles keerata. Täname lugemast! :)

Kui teil on mõtteid ja kommentaare, jätke julgelt kommentaar allpool või saatke mulle e-kiri aadressil [email protected]! Kasutage ka julgelt minu koodi või jagage seda oma eakaaslastega!