Docker Compose: Опростете работата си с Makefile

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

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

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

докер

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

Докер Композиране

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

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

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

GNU Make

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

Да кажа програмата make за това какво искаме от нея, имаме нужда от файл Makefile.

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

Типични случаи на използване на Docker Compose

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

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

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

• Влезте в обвивката на Postgres.
• Импорт и експорт на таблици.
• създаване pg_dump таблици или бази данни.

Express.js контейнер за приложения, expressjs, може да има следните характеристики:

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

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

Сега, след като настроихме комуникация между контейнери с помощта на 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.

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

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

Изграждане на Docker контейнер

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

Изпълнение на контейнера за времева скала

Изпълнение на ping контейнер

• make login-timescale - влезте в bash сесията на контейнера timescale.

Изпълнение на bash в контейнер за времева скала

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

Изпълнение на psql в контейнер timescaledb

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

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

• 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, това рационализира сътрудничеството и намалява грешките.

PS В нашата пазар има изображение докер, който се инсталира с едно кликване. Можете да проверите работата на контейнерите VPS. Всички нови клиенти получават 3 дни безплатно тестване.

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

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