Docker Compose: פשט את העבודה שלך באמצעות Makefiles

מדי כמה שנים, תעשיית פיתוח התוכנה עוברת שינוי פרדיגמה. ניתן לזהות את אחת התופעות הללו כעניין הגובר במושג מיקרו-שירותים. למרות ששירותי מיקרו הם לא הטכנולוגיה החדשה ביותר, רק לאחרונה הפופולריות שלה ממש זינקה שחקים.

שירותים מונוליטיים גדולים מוחלפים כעת במיקרו-שירותים עצמאיים ואוטונומיים. ניתן להתייחס למיקרו-שירות כאפליקציה המשרתת מטרה אחת ומאוד ספציפית. לדוגמה, זה יכול להיות DBMS יחסי, יישום Express, שירות 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.
• פינג (סתם מיכל, לא עושה שום דבר מיוחד).

יישום זה יצטרך 3 מכולות Docker וקובץ docker-compose, המכיל הוראות לניהול מכולות אלו. לכל מיכל יהיו נקודות מגע שונות. למשל, עם מיכל timescale ניתן יהיה לעבוד בערך באותו אופן שבו הם עובדים עם מסדי נתונים. כלומר, זה מאפשר לך לבצע את הפעולות הבאות:

• התחברות למעטפת Postgres.
• ייבוא ​​וייצוא של טבלאות.
• יצירה 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.

עזרה לגבי פקודות זמינות

• make build - הרכבת תמונה מ Dockerfile. בדוגמה שלנו השתמשנו בתמונות קיימות timescale и ping. אבל התמונה api אנחנו רוצים לאסוף מקומית. זה בדיוק מה שיעשה לאחר ביצוע הפקודה הזו.

בניית קונטיינר Docker

• make start - השקת כל המכולות. כדי להפעיל רק מיכל אחד, אתה יכול להשתמש בפקודה כמו make start c=timescale.

הפעלת מיכל לוח הזמנים

הפעלת מיכל פינג

• 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, זה מייעל את שיתוף הפעולה ומפחית שגיאות.

נ.ב. שלנו זירת מסחר יש תמונה סַוָר, שניתן להתקין בקליק אחד. ניתן לבדוק את פעולת המכולות בכתובת VPS. כל הלקוחות החדשים מקבלים 3 ימי בדיקה ללא תשלום.

קוראים יקרים! כיצד להפוך את Docker Compose לאוטומטי?

מקור: www.habr.com