Docker Compose: опростяване на работата с използване на Makefile

На всеки няколко години в индустрията на софтуерната разработка настъпва смяна на парадигмата. Едно от такива явления е нарастващият интерес към концепцията за микросервизи. Макар микросервисите да не са най-новата технология, едва наскоро популярността им буквално се изстреля в небесата.

Днес големите монолитни услуги се заменят с независими автономни микросервизи. Микросервисът може да се разглежда като приложение, което служи за единствена и много специфична цел. Например – това може да бъде релационна СУБД, приложение на Express, Solr услуга.

В наши дни е трудно да си представим разработването на нова софтуерна система без използването на микросервизи. А тази ситуация, от своя страна, ни води към платформата Docker.

Docker

Платформа Docker, в разработването и разгръщането на микросервизи, стана практически индустриален стандарт. На сайта на проекта може да се научи, че Docker е единствената независима платформа за контейнеризация, която позволява на организациите лесно да създават всякакви приложения, а също и да ги разпространяват и стартират в различни среди – от хибридни облаци до边边дж системи.

Docker Compose

Технология Docker Compose е предназначено за конфигуриране на многоконтейнерни приложения. В проект на Docker Compose могат да влизат толкова Docker контейнери, колкото са нужни на създателя на проекта.

При работа с Docker Compose, за настройване на услугите на приложението и организиране на тяхното взаимодействие помежду им, се използва YAML файл. Docker Compose, по този начин, е инструмент за описание и стартиране на многоконтейнерни приложения Docker.

Два контейнера, работещи на хост система

GNU Make

Програма направи, по същество, представлява инструмент за автоматизация на изграждането на програми и библиотеки от изходен код. Като цяло, можем да говорим за това, че направи е приложима за всеки процес, който включва изпълнението на произволни команди за преобразуване на определени исходни материали в определен резултат, в определена цел. В нашия случай командите docker-compose ще бъдат преобразувани в абстрактни цели (Phony targets).

За да уведомим програмата направи какво искаме от нея, ще ни трябва файл Makefile.

В нашия Makefile в който ще се съдържат обикновени команди docker и docker-compose, които са предназначени за решаване на множество задачи. По-специално, става дума за сглобяване на контейнер, за неговото стартиране, спиране, рестартиране, за организиране на входа на потребителя в контейнера, за работа с логовете на контейнера и за решаване на други подобни задачи.

Типични варианти за използване на Docker Compose

Представете си обикновено уеб приложение, което има следните компоненти:

• База данни TimescaleDB (Postgres).
• Приложение на Express.js.
• Ping (просто контейнер, който не извършва нищо специално).

На това приложение ще са му необходими 3 Docker контейнера и файл docker-compose, съдържащ инструкции за управление на тези контейнери. Всеки от контейнерите ще има различни точки на взаимодействие. Например, с контейнера timescale може да се работи по начина, по който работим с бази данни. По-конкретно, той позволява извършване на следните действия:

• Влизане в обвивката на Postgres.
• Импорт и експорт на таблици.
• само за четене изисква известни допълнителни усилия от разработчиците на вградени системи и тук на сцената излиза VFS. Linux изисква файловете в pg_dump таблици или бази данни.

Контейнерът на Express.js приложението, expressjs, може да разполага със следните възможности:

• Извеждане на актуални данни от системния журнал.
• Влизане в обвивка за изпълнение на команди.

Взаимодействие с контейнерите

След като настроим връзката между контейнерите, използвайки Docker Compose, е време да установим взаимодействие с тези контейнери. В рамките на системата Docker Compose има команда docker-compose, която поддържа опцията -f, позволяваща прехвърляне на файла docker-compose.yml.

Използвайки функционалността на тази опция, можем да ограничим взаимодействието с системата само до тези контейнери, които са споменати във файла docker-compose.yml.

Нека разгледаме как изглеждат взаимодействията с контейнерите при използване на командите docker-compose. Ако предположим, че трябва да влезем в обвивката psql, съответните команди могат да изглеждат така:

docker-compose -f docker-compose.yml exec timescale psql -Upostgres

Същата команда, за която се използва не docker-compose, а docker, може да изглежда така:

docker exec -it edp_timescale_1 psql -Upostgres

Обърнете внимание, че в подобни случаи винаги е за предпочитане да се използва не командата docker, а командата docker-compose, тъй като това позволява да се избегне необходимостта от запомняне на имената на контейнерите.

И двете команди, приведени по-горе, не са толкова сложни. Но ако използвахме „обвивка“ в рамките на Makefile, която би ни дала интерфейс под формата на прости команди и сама би извиквала подобни дълги команди, то същите резултати биха могли да се постигнат така:

make db-shell

Съвсем очевидно е, че използването на Makefile значително улеснява работата с контейнери!

Работен пример

На базата на разгледаната схема на проекта ще създадем следния файл docker-compose.yml:

version: '3.3'
services:
    api:
        build: .
        image: mywebimage:0.0.1
        ports:
            - 8080:8080
        volumes:
            - /app/node_modules/
        depends_on:
            - timescale
        command: npm run dev
        networks:
            - webappnetwork
    timescale:
        image: timescale/timescaledb-postgis:latest-pg11
        environment:
          - POSTGRES_USER=postgres
          - POSTGRES_PASSWORD=postgres
        command: ["postgres", "-c", "log_statement=all", "-c", "log_destination=stderr"]
        volumes:
          - ./create_schema.sql:/docker-entrypoint-initdb.d/create_schema.sql
        networks:
           - webappnetwork
    ping:
       image: willfarrell/ping
       environment:
           HOSTNAME: "localhost"
           TIMEOUT: 300
networks:
   webappnetwork:
       driver: bridge

За управление на конфигурацията на Docker Compose и за взаимодействие с контейнерите, които тя описва, ще създадем следния файл Makefile:

THIS_FILE := $(lastword $(MAKEFILE_LIST))
.PHONY: help build up start down destroy stop restart logs logs-api ps login-timescale login-api db-shell
help:
        make -pRrq  -f $(THIS_FILE) : 2>/dev/null | awk -v RS= -F: '/^# File/,/^# Finished Make data base/ {if ($$1 !~ "^[#.]") {print $$1}}' | sort | egrep -v -e '^[^[:alnum:]]' -e '^$@$$'
build:
        docker-compose -f docker-compose.yml build $(c)
up:
        docker-compose -f docker-compose.yml up -d $(c)
start:
        docker-compose -f docker-compose.yml start $(c)
down:
        docker-compose -f docker-compose.yml down $(c)
destroy:
        docker-compose -f docker-compose.yml down -v $(c)
stop:
        docker-compose -f docker-compose.yml stop $(c)
restart:
        docker-compose -f docker-compose.yml stop $(c)
        docker-compose -f docker-compose.yml up -d $(c)
logs:
        docker-compose -f docker-compose.yml logs --tail=100 -f $(c)
logs-api:
        docker-compose -f docker-compose.yml logs --tail=100 -f api
ps:
        docker-compose -f docker-compose.yml ps
login-timescale:
        docker-compose -f docker-compose.yml exec timescale /bin/bash
login-api:
        docker-compose -f docker-compose.yml exec api /bin/bash
db-shell:
        docker-compose -f docker-compose.yml exec timescale psql -Upostgres

Повечето от описаните тук команди се прилагат към всички контейнери, но използването на опцията c= позволява да се ограничи обхватът на командата до един контейнер.

След като Makefile готов, може да се използва така:

• make help — показва списък на всички команди, налични за направи.

Помощ по наличните команди

• make build — изграждане на образ от Dockerfile. В наш пример използвахме съществуващи образи timescale и ping. Но образът api което искаме да съберем локално. Именно това ще бъде направено след изпълнението на тази команда.

Сглобяване на Docker контейнер

• make start — стартира всички контейнери. За стартиране само на един контейнер можете да използвате команда от вида make start c=timescale.

Стартиране на контейнера timescale

Стартиране на контейнера ping

• make login-timescale — вход в bash сессията на контейнера timescale.

Стартиране на bash в контейнера timescale

• make db-shell — вход в psql в контейнер timescale за извършване на SQL заявки към базата данни.

Стартиране на psql в контейнера timescaledb

• make stop — спиране на контейнерите.

Спиране на контейнера timescale

• make down — спиране и изтриване на контейнерите. За да се изтрие конкретен контейнер, можете да използвате тази команда с указване на нужния контейнер. Например — make down c=timescale или make down c=api.

Спиране и изтриване на всички контейнери

Резюме

Въпреки, че системата Docker Compose разполага с обширен набор от команди за управление на контейнери, понякога тези команди стават дълги и е трудно да бъдат запомнени.

Методиката на използване Makefile ни помогна да установим бърза и лесна взаимодействие с контейнерите от файла docker-compose.yml. А именно, става дума за следното:

• Разработчикът взаимодействия само с контейнерите на проекта, описани в docker-compose.yml, работата не пречи на други стартирани контейнери.
• В случай, че е забравена някаква команда, можете да изпълните команда make help и да получите помощ относно наличните команди.
• Не е необходимо да запомняте дълги списъци от аргументи, за да извършвате такива действия като получаване на нови записи на журнала или вход в системата. Например, команда от вида docker-compose -f docker-compose.yml exec timescale psql -Upostgres се превръща в make db-shell.
• Файл Makefile може, с увеличаването на проекта, да бъде гъвкаво адаптирано. Например, в него не е трудно да се добави команда за създаване на резервно копие на базата данни или за извършване на всяко друго действие.
• Ако голям екип разработчици използва една и съща Makefile, това подрежда съвместната работа и намалява броя на грешките.

P.S. В нашия маркетплейс има образ Docker, който се инсталира с едно кликване. Можете да проверите работата на контейнерите на VPS. На всички нови клиенти се предоставят безплатно 3 дни за тестване.

Уважаеми читатели! Как автоматизирате работата с Docker Compose?

Източник: habr.com