Docker/Compose/01 YAML: Unterschied zwischen den Versionen

Aus Foxwiki
Wechseln zu:Navigation, Suche
Keine Bearbeitungszusammenfassung
Zeile 1: Zeile 1:
== YAML-Syntax ==
== YAML-Syntax ==
Bevor Sie docker compose oder docker stack deploy ausführen können, müssen Sie eine Datei mit dem Namen compose.yml erstellen
Bevor ''docker compose'' oder ''docker stack deploy'' ausführen können, muss eine Datei mit dem Namen ''compose.yml'' erstellen
* Die Kennung *.yml bezeichnet das YAML-Format (YAML Ain’t Markup Language)
* Die Kennung *.yml bezeichnet das YAML-Format (YAML Ain’t Markup Language)



Version vom 18. November 2026, 06:17 Uhr

YAML-Syntax

Bevor docker compose oder docker stack deploy ausführen können, muss eine Datei mit dem Namen compose.yml erstellen

  • Die Kennung *.yml bezeichnet das YAML-Format (YAML Ain’t Markup Language)
Syntaxregeln
Syntax Beschreibung
--- leitet einen neuen Abschnitt ein
# startet einen Kommentar, der bis zum Ende der Zeile reicht
Zeichenketten können in der Form "abc" oder 'abc' ausgedrückt werden.
  • Dies ist aber nur in Ausnahmefällen zwingend erforderlich
  • beispielsweise, wenn die Zeichenkette Sonderzeichen enthält oder als ein anderer YAML-Ausdruck interpretiert werden kann
Mehrere mit - eingeleitete Ausdrücke bilden eine Liste
- rot
- grün
- blau

Alternativ können Listen auch in eckige Klammern gestellt werden

[rot, grün, blau]
Assoziative Listen (Key-Value-Paare) werden in der Form key: value gebildet
name: Hermann Huber age: 37

Auch hier gibt es eine platzsparende Variantem in geschwungenen Klammern:

{ name: Hermann Huber , age: 37}
| leitet einen Textblock ein, in dem die Zeilenumbrüche erhalten bleiben
codeblock: |
  Zeile 1
  Zeile 2
> leitet einen Textblock ein, in dem Zeilenumbrüche ignoriert werden

Leere Zeilen bleiben erhalten:

textblock: >
  Zusammenghörender
  Text.
  
  Hier beginnt der
  zweite Absatz.
Verschachtelung

Alle vorgestellten Elemente können ineinander verschachtelt werden

  • Die Struktur wird durch Einrückungen hergestellt
  • Dabei müssen Leerzeichen verwendet werden (keine Tabulatoren!)
  • Beim Zugriff auf die Elemente werden die Bezeichner (Keys) aneinandergereiht
Beispiel
# Datei sample.yaml data:
list:
 - item1
 - item2
key1: >
 Dieser Text ist dem
 Schlüssel 'data.key1' zugeordnet .
key2: |
 code line 1
 code line 2
Fortgeschrittene Syntaxelemente

Spielen in compose.yaml-Dateien normalerweise keine Rolle

Siehe auch

Auslesen von YAML-Dateien

Zum Auslesen von YAML-Dateien können Sie das Python-Script shyaml verwenden

Installation (Debian)

sudo apt install python-pip
sudo pip install shyaml
shyaml get-value data.list < sample.yaml
- item1
- item2

Beim Experimentieren mit YAML-Dateien sind auch die YAML-Validatoren bzw. -Parser auf den folgenden Websites hilfreich: