Docker Compose: pojednostavljenje rada s korištenjem Makefile-a

Svake nekoliko godina u industriji razvoja softvera događa se promjena paradigme. Jedan od takvih fenomena može se prepoznati u porastu interesa za koncept mikroservisa. Iako mikroservisi nisu najnovija tehnologija, tek je nedavno njihova popularnost drastično porasla.

Velike monolitne usluge u današnje vrijeme zamjenjuju neovisni autonomni mikroservisi. Mikroservis se može smatrati aplikacijom koja ima jedinstvenu i vrlo specifičnu svrhu. Na primjer, to može biti relacijska baza podataka, Express aplikacija, ili Solr usluga.

Docker Compose: pojednostavljenje rada s korištenjem Makefile-a

Teško je zamisliti razvoj novog softverskog sistema bez upotrebe mikroservisa. Ova situacija, zauzvrat, vodi nas do platforme Docker.

Docker

Platforma Docker, u razvoju i implementaciji mikroservisa, postala je gotovo industrijski standard. Na web stranici projekta možete saznati da je Docker jedina neovisna platforma za konteniranje koja omogućava organizacijama da lako kreiraju bilo koje aplikacije, kao i da ih distribuiraju i pokreću u raznim okruženjima — od hibridnih oblaka do ivicnih sistema.

Docker Compose

Tehnologija Docker Compose je namijenjena za konfiguriranje višekontejnerskih aplikacija. U Docker Compose-projekt može ući onoliko Docker kontejnera koliko stvaraoc tog projekta želi.

Kada radite s Docker Compose, za postavljanje usluga aplikacije i organizaciju njihove međusobne interakcije koristi se YAML datoteka. Docker Compose je, dakle, alat za opisivanje i pokretanje višekontejnerskih aplikacija Docker.

Docker Compose: pojednostavljenje rada s korištenjem Makefile-a
Dva kontejnera koja rade na hostskoj sistemu

GNU Make

Program make, zapravo, predstavlja alat za automatizaciju izgradnje programa i biblioteka iz izvorne datoteke. Sve u svemu, može se reći da make se primjenjuje na bilo koji proces koji uključuje izvršavanje proizvoljnih komandi za transformaciju nekih izvornih materijala u određeni rezultat, s nekim ciljem. U našem slučaju, komande docker-compose će se transformirati u apstraktne ciljeve (Phony targets).

Kako bismo poručili programu make šta od njega želimo, trebat će nam datoteka Makefile.

U našim Makefile bit će sadržane obične komande docker i docker-compose, koji su namijenjeni za rješavanje mnogih zadataka. Naime, riječ je o izradi kontejnera, njegovom pokretanju, zaustavljanju, ponovnom pokretanju, organizaciji prijave korisnika u kontejner, radu s logovima kontejnera i rješavanju drugih sličnih zadataka.

Tipični načini uporabe Docker Compose

Zamislimo običnu web aplikaciju koja ima sljedeće komponente:

  • Baza podataka TimescaleDB (Postgres).
  • Express.js aplikacija.
  • Ping (samo kontejner, ništa posebno ne radi).

Ovoj aplikaciji će trebati 3 Docker kontejnera i datoteka docker-compose, koja sadrži upute za upravljanje tim kontejnerima. Svaki od kontejnera će imati različite točke interakcije. Na primjer, s kontejnerom timescale može se raditi otprilike kao s bazama podataka. Naime, omogućava sljedeće radnje:

  • Pristup Postgres školjki.
  • Uvoz i izvoz tablica.
  • Izrada pg_dump tablica ili bazama podataka.

Kontejner Express.js aplikacije, expressjs, može imati sljedeće mogućnosti:

  • Izdavanje svježih podataka iz sustavnog dnevnika.
  • Pristup školjci za izvršavanje određenih naredbi.

Interakcija s kontejnerima

Nakon što smo postavili povezanost između kontejnera koristeći Docker Compose, došlo je vrijeme za uspostavljanje interakcije s tim kontejnerima. U okviru sustava Docker Compose postoji naredba docker-compose, koja podržava opciju -f, koja omogućava prijenos datoteke sustavu docker-compose.yml.

Korištenjem mogućnosti ove opcije, možemo ograničiti interakciju s sustavom samo na one kontejnere koji su navedeni u datoteci docker-compose.yml.

Pogledajmo kako izgledaju interakcije s kontejnerima prilikom korištenja naredbi docker-compose. Ako pretpostavimo da trebamo ući u školjku psql, odgovarajuće naredbe mogu izgledati ovako:

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

Ista naredba, za čije se izvršenje ne koristi docker-compose, već docker, može izgledati ovako:

docker exec -it edp_timescale_1 psql -Upostgres

Obratite pozornost na to da je u takvim slučajevima uvijek bolje koristiti ne naredbu docker, već naredbu docker-compose, jer to omogućava da se izbjegne potreba za pamćenjem imena kontejnera.

Obje navedene naredbe nisu tako teške. Ali da smo se poslužili ‘umotavanjem’ u obliku Makefile, koja bi nam dala sučelje u obliku jednostavnih naredbi i sama bi pozivala slične dugačke naredbe, tada bismo mogli postići iste rezultate ovako:

make db-shell

Potpuno je očigledno da korištenje Makefile znatno olakšava rad s kontejnerima!

Radni primjer

Na temelju gore razmatrane sheme projekta kreirat ćemo sljedeću datoteku 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

Za upravljanje konfiguracijom Docker Compose i za interakciju s kontejnerima koje ona opisuje, kreirat ćemo sljedeću datoteku 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

Većina ovdje opisanih naredbi odnosi se na sve kontejnere, ali korištenje opcije c= omogućuje ograničavanje područja primjene naredbe na jedan kontejner.

Nakon što Makefile spreman je, možete ga koristiti ovako:

  • make help — ispis popisa svih naredbi dostupnih za make.

Docker Compose: pojednostavljenje rada s korištenjem Makefile-a
Pomoć o dostupnim naredbama

  • make build — izrada slike iz Dockerfile. U našem primjeru koristili smo postojeće slike timescale i ping. No slika api koju želimo izgraditi lokalno. To će biti učinjeno nakon izvršavanja ove naredbe.

Docker Compose: pojednostavljenje rada s korištenjem Makefile-a
Izgradnja Docker kontejnera

  • make start — pokretanje svih kontejnera. Za pokretanje samo jednog kontejnera možete koristiti naredbu u obliku make start c=timescale.

Docker Compose: pojednostavljenje rada s korištenjem Makefile-a
Pokretanje kontejnera timescale

Docker Compose: pojednostavljenje rada s korištenjem Makefile-a
Pokretanje kontejnera ping

  • make login-timescale — ulazak u bash sesiju kontejnera timescale.

Docker Compose: pojednostavljenje rada s korištenjem Makefile-a
Pokretanje bash-a u kontejneru timescale

  • make db-shell — ulazak u psql u kontejneru timescale za izvršavanje SQL upita na bazi podataka.

Docker Compose: pojednostavljenje rada s korištenjem Makefile-a
Pokretanje psql-a u kontejneru timescaledb

  • make stop — zaustavljanje kontejnera.

Docker Compose: pojednostavljenje rada s korištenjem Makefile-a
Zaustavljanje kontejnera timescale

  • make down — zaustavljanje i uklanjanje kontejnera. Za uklanjanje određenog kontejnera možete koristiti ovu naredbu s naznakom potrebnog kontejnera. Na primjer — make down c=timescale ili make down c=api.

Docker Compose: pojednostavljenje rada s korištenjem Makefile-a
Zaustavljanje i uklanjanje svih kontejnera

Zaključci

Iako sustav Docker Compose daje na raspolaganje opsežan skup naredbi za upravljanje kontejnerima, ponekad te naredbe postaju duge, što ih čini teškim za zapamtiti.

Metodologija korištenja Makefile pomogla nam je uspostaviti brzo i jednostavno interakciju s kontejnerima iz datoteke docker-compose.yml. Točnije, radi se o sljedećem:

  • Razvijač komunicira samo s kontejnerima projekta opisanim u docker-compose.yml, a rad nisu ometali drugi pokrenuti kontejneri.
  • U slučaju da neka naredba zaboravi, možete izvršiti naredbu make help i dobiti pomoć o dostupnim naredbama.
  • Nema potrebe pamtiti dugačke popise argumenata za izvršavanje takvih radnji, kao što je dobivanje svježih zapisa iz dnevnika ili ulazak u sustav. Na primjer, naredba u obliku docker-compose -f docker-compose.yml exec timescale psql -Upostgres pretvara se u make db-shell.
  • Datoteka Makefile može se, kako projekt raste, fleksibilno prilagoditi njemu. Na primjer, nije teško dodati naredbu za izradu sigurnosne kopije baze podataka ili za izvršavanje bilo koje druge radnje.
  • Ako velika ekipa programera koristi isti Makefile, to strukturira suradnju i smanjuje broj grešaka.

P.S. U našim marketplaceu ima slika Docker, koja se instalira jednim klikom. Možete provjeriti rad kontejnera na VPS. Svim novim klijentima se besplatno nudi 3 dana za testiranje.

Dragi čitatelji! Kako automatizirate rad s Docker Compose?

Docker Compose: pojednostavljenje rada s korištenjem Makefile-a

Izvor: habr.com

Kupite pouzdan hosting za web stranice s DDoS zaštitom, VPS VDS servere 🔥 Kupite pouzdan hosting za web stranice s DDoS zaštitom, VPS VDS servere | ProHoster