Docker/Compose/01 YAML: Unterschied zwischen den Versionen
Keine Bearbeitungszusammenfassung |
Keine Bearbeitungszusammenfassung |
||
| Zeile 4: | Zeile 4: | ||
; Syntaxregeln | ; Syntaxregeln | ||
{| | {| class="table table-striped table-hover col1bold col1nowrap" | ||
|- | |||
! Syntax !! Beschreibung | |||
|- | |||
| --- || leitet einen neuen Abschnitt ein | | --- || leitet einen neuen Abschnitt ein | ||
|- | |- | ||
| Zeile 21: | Zeile 24: | ||
|- | |- | ||
| Assoziative Listen || (Key-Value-Paare) werden in der Form ''key: value'' gebildet | | Assoziative Listen || (Key-Value-Paare) werden in der Form ''key: value'' gebildet | ||
name : Hermann Huber age : 37 | name: Hermann Huber age: 37 | ||
Auch hier gibt es eine platzsparende Variantem in geschwungenen Klammern: | Auch hier gibt es eine platzsparende Variantem in geschwungenen Klammern: | ||
{ name : Hermann Huber , age : 37} | { name: Hermann Huber , age: 37} | ||
|- | |- | ||
| <nowiki>|</nowiki> || leitet einen Textblock ein, in dem die Zeilenumbrüche erhalten bleiben | | <nowiki>|</nowiki> || leitet einen Textblock ein, in dem die Zeilenumbrüche erhalten bleiben | ||
codeblock : | | codeblock: | | ||
Zeile 1 | Zeile 1 | ||
Zeile 2 | Zeile 2 | ||
| Zeile 32: | Zeile 35: | ||
| <nowiki> > </nowiki> || leitet einen Textblock ein, in dem Zeilenumbrüche ignoriert werden | | <nowiki> > </nowiki> || leitet einen Textblock ein, in dem Zeilenumbrüche ignoriert werden | ||
Leere Zeilen bleiben erhalten: | Leere Zeilen bleiben erhalten: | ||
textblock : > | textblock: > | ||
Zusammenghörender | Zusammenghörender | ||
Text. | Text. | ||
| Zeile 40: | Zeile 43: | ||
|} | |} | ||
; Verschachtelung | |||
Alle vorgestellten Elemente können ineinander verschachtelt werden | Alle vorgestellten Elemente können ineinander verschachtelt werden | ||
* Die Struktur wird durch Einrückungen hergestellt | * Die Struktur wird durch Einrückungen hergestellt | ||
* Dabei müssen Leerzeichen verwendet werden (keine Tabulatoren!) | * Dabei müssen Leerzeichen verwendet werden (keine Tabulatoren!) | ||
* Beim Zugriff auf die Elemente werden die Bezeichner (Keys) aneinandergereiht | * Beim Zugriff auf die Elemente werden die Bezeichner (Keys) aneinandergereiht | ||
<syntaxhighlight lang=" | |||
; Beispiel | |||
<syntaxhighlight lang="yaml" highlight="" line> | |||
# Datei sample.yaml data: | # Datei sample.yaml data: | ||
list : | list: | ||
- item1 | - item1 | ||
- item2 | - item2 | ||
key1 : > | key1: > | ||
Dieser Text ist dem | Dieser Text ist dem | ||
Schlüssel 'data.key1' zugeordnet . | Schlüssel 'data.key1' zugeordnet . | ||
key2 : | | key2: | | ||
code line 1 | code line 1 | ||
code line 2 | code line 2 | ||
| Zeile 59: | Zeile 65: | ||
; Fortgeschrittene Syntaxelemente | ; Fortgeschrittene Syntaxelemente | ||
Einige fortgeschrittene Syntaxelemente von YAML, die jedoch in compose.yaml-Dateien normalerweise keine Rolle spielen, sind in der Wikipedia dokumentiert: | Einige fortgeschrittene Syntaxelemente von YAML, die jedoch in compose.yaml-Dateien normalerweise keine Rolle spielen, sind in der Wikipedia dokumentiert: | ||
https://en.wikipedia.org/wiki/YAML Zum Auslesen von YAML-Dateien können Sie das Python-Script shyaml verwenden | https://en.wikipedia.org/wiki/YAML | ||
; Auslesen von YAML-Dateien | |||
Zum Auslesen von YAML-Dateien können Sie das Python-Script shyaml verwenden | |||
Installation (Debian) | Installation (Debian) | ||
<syntaxhighlight lang="bash" highlight="1" copy> | |||
sudo apt install python-pip | |||
</syntaxhighlight> | |||
<syntaxhighlight lang="bash" highlight="1" copy> | |||
sudo pip install shyaml | |||
</syntaxhighlight> | |||
<syntaxhighlight lang="bash" highlight="1" copy> | |||
shyaml get-value data.list < sample.yaml | |||
</syntaxhighlight> | |||
<syntaxhighlight lang="bash" highlight="" line> | |||
- item1 | |||
- item2 | |||
</syntaxhighlight> | |||
Beim Experimentieren mit YAML-Dateien sind auch die YAML-Validatoren bzw. -Parser auf den folgenden Websites hilfreich: | Beim Experimentieren mit YAML-Dateien sind auch die YAML-Validatoren bzw. -Parser auf den folgenden Websites hilfreich: | ||
Version vom 18. November 2026, 06:15 Uhr
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
- 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.
|
| 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
Einige fortgeschrittene Syntaxelemente von YAML, die jedoch in compose.yaml-Dateien normalerweise keine Rolle spielen, sind in der Wikipedia dokumentiert: https://en.wikipedia.org/wiki/YAML
- 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: