Docker/Compose/03 compose.yaml

Aus Foxwiki
Wechseln zu:Navigation, Suche

Datei compose.yaml

In diesem Abschnitt fassen wir die wichtigsten Schlüsselwörter zusammen, die in der Datei compose.yaml vorkommen.

Dokumentation

Vollständige Referenz

Compose Version 2 Spezifikation

compose.yaml beginnt in der Regel mit dem Bezeichner services

  • auf den eingerückt frei wählbare Namen mehrerer Dienste folgen.

Die Eigenschaften jedes Dienstes werden, nochmals eingerückt, durch diverse Schlüsselwörter festgelegt

# Grundsätzlicher Aufbau von compose.yaml
services :
  dienstname1:
    schlüsselwort1: einstellung1
    schlüsselwort2: einstellung2
    ...

  dienstname2:
    schlüsselwort1: einstellung1
    schlüsselwort2: einstellung2
    ...

In manchen Fällen folgen dem Top-Level-Abschnitt services weitere Top-Level-Abschnitte, z. B.  volumes, networks oder secrets.

  • Diese sind in der Regel mit gleichnamigen Schlüsselwörtern innerhalb eines Service verbunden.
  • Entsprechende Beispiele folgen in den weiteren Abschnitten.

Image oder Dockerfile

Das Schlüsselwort image gibt an, welches Basis-Image verwendet werden soll.

  • Dabei sind Image-Namen in allen Varianten (registryname/reponame/imagename:tag) sowie Image-IDs erlaubt.
image: ubuntu:22.04

Sofern Sie nicht docker stack deploy verwenden, können Sie anstelle eines Images auch den Pfad zu einem Verzeichnis angeben, in dem sich die Datei Dockerfile befindet

build: verzeichnis
docker compose

berücksichtigt die Angaben in dieser Datei, erzeugt ein entsprechendes Image und verwendet dieses als Basis

  • Wenn Sie das Dockerfile im gleichen Verzeichnis wie compose.yaml gespeichert haben, geben Sie anstelle des Pfads einfach einen Punkt an

Netzwerke

docker compose und docker stack deploy richtet für die auszuführenden Container bzw. Services automatisch ein eigenes Netzwerk ein

Zusätzliche Netzwerk

Wenn Sie darüber hinaus zusätzliche Netzwerke einrichten und in Ihren Diensten nutzen möchten

  • müssen Sie mit dem Top-Level-Schlüsselwort networks eigene Netzwerke definieren und
  • im services-Abschnitt mit einem weiteren networks -Schlüsselwort darauf verweisen
Beispiel

Ein Dienst web kann mit dem Netzwerk myownnet kommunizieren

  • Dabei handelt es sich um das in Docker immer verfügbare Host-Netzwerk

Siehe auch

docker network ls
services:
  web:
  ...
  networks:
    - myownnet

# Top-Level-Abschnitt zur Definitionzusätzlicher Netzwerke
networks:
  myownnet:
  external:
  name: host

Netzwerkports

Dem Schlüsselwort ports folgt eine Liste von Port-Zuordnungen in der Syntax portnummer (den Port einfach weiterleiten) oder lokal:dienst (einen Port des Dienstes auf einen anderen Port des lokalen Computers umleiten).

  • Die folgende Einstellung macht die Ports 80 und 443 des Docker-Containers bzw. -Service auf den Ports 8080 und 8443 des Docker-Hosts zugänglich:
ports:
  - "8080:80"
  - "8443:443"

Wenn Sie einen Port nur innerhalb desjenigen Netzwerks freigeben möchten, das docker compose bzw. docker stack deploy für die Container bzw. Services des Projekts einrichtet, geben Sie diese Ports mit expose an:

expose:
 - "7500"
 - "7501"

Volumes

Dem Schlüsselwort volumes folgt ebenfalls eine Liste, in der Sie angeben, an welchen lokalen Orten im Docker-Host die Volume-Verzeichnisse des Images abgelegt werden sollen.

  • Der folgende Eintrag bewirkt, dass das Volume/var/lib/mysql des Images auf dem Docker-Host im Verzeichnis/data/db gespeichert werden soll.
  • Dieses Verzeichnis muss bereits existieren, wenn docker compose ausgeführt wird.
volumes:
  - /data/db:/var/lib/mysql

Der Pfad für das lokale Volume-Verzeichnis darf in der Form ./<name> auch relativ zum Ort der Datei compose.yaml angegeben werden.

  • Unter Fedora und RHEL müssen Sie für Volumes, die nicht innerhalb des Standardverzeichnisses für Docker bzw. Podman gespeichert werden (also z. B.  nicht in /var/lib/docker), das zusätzliche Flag :z angeben.
Volumes im Heimatverzeichnis
Der lokale Volume-Pfad (also der Teil vor dem Doppelpunkt) wird relativ zur Datei compose.yaml ausgewertet
  • Wenn Sie einen Pfad relativ zum Heimatverzeichnis des aktiven Benutzers wünschen, leiten Sie den Pfad mit ~ ein
docker compose

interpretiert die bloße Angabe von <name> nicht als relativen Pfad, sondern als Namen für ein benanntes Volume! docker compose erwartet in diesem Fall einen zusätzlichen Top-Level-Abschnitt volumes, in dem die Details des Volumes <name> definiert sind.

  • Ein entsprechendes Beispiel folgt im nächsten Abschnitt.

Beachten Sie, dass auch einzelne Dateien als Volumes betrachtet werden.

  • In diesem Fall muss die betreffende lokale Datei bereits existieren.
  • Achten Sie aber darauf, dass Sie nicht Verzeichnisse und Dateien vermischen.
  • Sie können also nicht eine lokale Datei einem Image-Verzeichnis zuordnen oder ein lokales Verzeichnis einer Image-Datei.
volumes:
 - ./default.conf:/etc/nginx/conf.d/default.conf

UID und GID in lokalen Volumes

Docker Engine unter Linux

Wenn Sie ein lokales Verzeichnis in Ihrem Heimatverzeichnis zur Speicherung von Volumes verwenden, werden neue, vom Container erzeugte Dateien nicht Ihrem eigenen Benutzer bzw. Ihrer Gruppe zugeordnet.

  • Außerhalb des Docker-Containers können Sie diese Dateien nicht verändern und möglicherweise nicht einmal lesen (z. B.  bei einem Backup).

Das hier beschriebene Problem tritt nur auf, wenn Sie unter Linux mit einer Standardinstallation der Docker Engine arbeiten.

  • Es tritt nicht auf, wenn Sie mit Rootless Docker oder mit Podman arbeiten.

Am einfachsten ist das Problem anhand eines konkreten Beispiels zu verstehen: Die folgende Datei compose.yaml beschreibt einen Alpine-Container, der das gerade aktuelle Verzeichnis mit dem/home-Verzeichnis des Containers verbindet.

  • In diesem Verzeichnis wird die neue Datei newfile erzeugt.
 # Datei compose.yaml
 services :
 secrette s t :
 image: alpine
 volumes :
-./:/home: z
 command: [" touch ", "/home/newfile "]

Wenn Sie das Setup unter Linux ausführen, gehört die neue Datei nicht Ihnen, sondern dem Benutzer root.

  • Das liegt daran, dass der Docker-Dämon mit root-Rechten läuft.
docker compose up

</syntaxhighlight>

ls -l newfile
-rw-r--r-- 1 root      root          0 17. Jun 09:46 newfile

</syntaxhighlight>

Wenn Sie dagegen mit Rootless Docker oder mit Podman arbeiten, gehört die Datei Ihnen:

podman-compose up </syntaxhighlight>

ls -l newfile -rw-r--r--. 1 user user 0 17. Jun 09:50 newfile </syntaxhighlight>

Wenn Sie im Zusammenspiel mit Docker und Linux vermeiden möchten, dass neue Dateien root gehören, können Sie compose.yaml um das Schlüsselwort user erweitern und dort eine UID (User Identification Number) oder GID (Group Identification Number) angeben.

  • user legt fest, in welchem Account der Container-Prozess ausgeführt wird.
  • Der Account kann auch durch das Schlüsselwort USER im zugrundeliegenden Dockerfile festgelegt werden.
# Datei compose.yaml
services :
secrette s t :
image: alpine
volumes :

-./:/home: z

command: [" touch ", "/home/newfile "]
user: "1000:10 00 "

</syntaxhighlight>

Das obige Listing setzt voraus, dass Ihre UID und GID jeweils 1000 ist.

  • Das trifft für den ersten angelegten Benutzer zu.
  • Allgemeingültiger ist die folgende Variante, die aber voraussetzt, dass Sie die Variable UID_GID vor dem Aufruf von docker compose initialisieren:
# in compose.yaml
...
user: $ { UID_GID }

</syntaxhighlight>

Sie müssen nun docker compose wie folgt aufrufen:

UID_GID =" $ ( id -u ): $( id -g) " docker compose up

</syntaxhighlight>

Leider ist die Vorgehensweise mit user inkompatibel mit podman-compose.

  • Das Script verarbeitet das Schlüsselwort user zwar prinzipiell korrekt, allerdings tritt nun bei der Ausführung des Containers der Fehler permission denied auf.

Benannte Volumes

Zur Definition benannter Volumes stellen Sie dem Volume-Verzeichnis einfach den gewünschten Namen (im folgenden Beispiel webdata) voran.

  • Allerdings müssen Sie das Volume ein zweites Mail in der Top-Level-Ebene volumes angeben.
  • Dort können Sie gegebenenfalls besondere Eigenschaften des Volumes festlegen:
# Datei compose.yaml im Verzeichnis test2
services :
nginx :
volumes :

-webdata :/var/www/html/

...

volumes :
webdata :

</syntaxhighlight>

Docker kümmert sich darum, das Volume einzurichten.

  • Der Volume-Name setzt sich aus dem aktuellen Verzeichnisnamen, dem in der Datei compose.yaml angegebenen Namen sowie data_ zusammen.
  • Sofern Sie Docker mit root-Rechten ausführen und das aktuelle Verzeichnis test2 lautet, ergibt sich der folgende Pfad:
/var/lib/docker/volumes/test2_web d a t a/_data

</syntaxhighlight>

Volumes für Services In einem Docker-Schwarm entscheidet der Schwarm-Manager, auf welchem Knoten ein Service ausgeführt wird.

  • Der Ort kann sich also jederzeit ändern.
  • Bei der Verwendung von Volumes führt das zu Problemen: Ein beim ersten Ablauf auf Knoten A eingerichtetes Volume existiert ja nicht auf Knoten B, wo der Service vielleicht beim nächsten Mal läuft.

Um dieses Problem zu umgehen, können Sie in den Deploy-Einstellungen mit deploy. placement.constraints Regeln festlegen, auf welchem Knoten der Service laufen soll.

Umgebungsvariablen

Dem Schlüsselwort environment folgen wahlweise Key-Value-Paare oder Listenelemente in der Form var=wert.

  • Die so definierten Umgebungsvariablen gelten bei der Ausführung des Kommandos im Container.
  • Die beiden folgenden Listings sind gleichwertig:
environme n t :
WORDPRES S _ D B_ H O S T: mariadb
WORDPRES S _ D B_ N A M E: dockerbu c h
environme n t :

-WORDPRES S _D B _ H OS T = mariadb -WORDPRES S _D B _ N AM E = dockerbu ch </syntaxhighlight>

Wenn Sie viele Umgebungsvariablen setzen müssen, können Sie die Einstellungen mit env_file: dateiname auch aus einer Datei lesen.

Kommandoausführung

Normalerweise wird in Containern bzw. Services das Kommando ausgeführt, das im Image durch ENTRYPOINT und/oder CMD vorgegeben ist

Siehe auch

  • den Abschnitt »Container-Startkommando« in Abschnitt 4.2, »Dockerfile-Syntax«)

Bei einem Apache-Image wird das ein Startkommando für den Webserver sein, bei einem MySQL-Image der Dienst des MySQL-Servers etc.

Wenn davon abweichend ein anderes Kommando ausgeführt werden soll, geben Sie dieses mit den Schlüsselwörtern entrypoint und/oder command an.

  • Beachten Sie, dass Sie Kommandos, die aus mehreren Teilen zusammengesetzt sind, entweder als Liste oder in der Form ["teil1", "teil2", "teil3"] übergeben müssen.

entrypoin t: ["some-script.sh "] command: ["/bin/bash "]

  1. mehrteil i g e s Kommando command: [" php ", " -a "]
  1. gleichwe r t i g command :

- " php " - " -a " </syntaxhighlight>

Restart-Verhalten

Bei Containern, die mit docker compose erzeugt werden, können Sie mit dem Schlüsselwort restart einstellen, ob sie bei einem Rechnerneustart oder nach einem Fehler automatisch neu gestartet werden sollen.

  • Das Defaultverhalten lautet no.
  • Die anderen zulässigen Einstellungen lauten always, on-failure und unless-stopped.

Siehe auch

restart: always </syntaxhighlight>

Das restart -Schlüsselwort wird von docker stack deploy ignoriert.

  • Für Stack-Services gilt standardmäßig, dass sie bei Bedarf automatisch neu gestartet werden.
  • Davon abweichende Einstellungen können Sie mit deploy.restart_policy festlegen (siehe »Deploy-Einstellungen«).

Deploy-Einstellungen

Das Schlüsselwort deploy steuert, wie Services durch docker stack deploy eingerichtet werden.

  • Diese Einstellungen gelten nur für den Schwarmmodus.
  • docker compose ignoriert das deploy-Schlüsselwort und alle von ihm abgeleiteten Einstellungen!

Die folgende Liste fasst die wichtigsten Schlüsselwörter zusammen:

deploy.mode gibt an, wie der Service ausgeführt wird.

  • Die Defaulteinstellung lautet replicated .
  • Damit kann angegeben werden, wie viele Instanzen ausgeführt werden.

Der Schwarm-Manager entscheidet dann, auf welchen Docker-Rechnern die Instanzen gestartet werden.

Die alternative Einstellung global bestimmt, dass auf jedem Knoten im Schwarm exakt eine Instanz des Service ausgeführt werden soll. deploy.placement.constraint legt eine Liste von Regeln fest, die bestimmt, auf welchem Knoten der Service laufen soll.

Die folgenden Zeilen geben Beispiele für mögliche Regeln:

-node .

  • id == <xxxx >

-node .

  • hostname == <name >

-node .

  • role == manager | worker

</syntaxhighlight>

deploy.replicas gibt an, wie viele Instanzen des Service gleichzeitig laufen sollen (normalerweise nur eine Instanz). deploy.resources.limits.cpus limitiert die CPU-Nutzung des Service.

  • Die Einstellung 0.25 bedeutet, dass der Service ein CPU-Core durchschnittlich zu 25 % auslasten darf.

deploy.resources.limits.memory legt eine Obergrenze für den Speicherbedarf des Service fest. deploy.restart_policy.condition: any|on-failure|none gibt an, unter welchen Umständen ein Service automatisch neu gestartet werden soll.

  • Standardmäßig gilt any.

deploy.restart_policy.delay bestimmt, wie viele Sekunden Docker warten soll, bevor es einen Service neu startet (standardmäßig 0). deploy.restart_policy.max_attempts limitiert die Anzahl der Neustarts. (Standardmäßig gibt es kein Limit.)

In compose.yaml müssen die Einstellungen wie üblich durch Einrückungen formuliert werden:

services :
nginx :
image: nginx: alpine
deploy :
placement :
constrai n t s :
-node . 
  • hostname == " dockerhos t 7 "
replicas: 5
resources :
limits :
cpus: '0.25 '
memory: 50 M
restart_p o l i cy :
conditio n: on-failure
delay: 2 s

</syntaxhighlight>