Docker/Compose/01 YAML: Unterschied zwischen den Versionen

Aus Foxwiki
Wechseln zu:Navigation, Suche
K Dirkwagner verschob die Seite Docker/Compose/YAML nach Docker/Compose/01 YAML
Keine Bearbeitungszusammenfassung
Zeile 3: Zeile 3:
* Die Kennung *.yml bezeichnet das YAML-Format (YAML Ain’t Markup Language)
* Die Kennung *.yml bezeichnet das YAML-Format (YAML Ain’t Markup Language)


Die Syntaxregeln von YAML haben wir Ihnen hier kurz zusammengefasst:
; Syntaxregeln
 
{|
--- leitet einen neuen Abschnitt ein.
| --- || 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 dann, wenn die Zeichenkette Sonderzeichen enthält oder als ein anderer YAML-Ausdruck interpretiert werden kann.
| # || startet einen Kommentar, der bis zum Ende der Zeile reicht
Mehrere mit - eingeleitete Ausdrücke bilden eine Liste:
|-
| 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
  - rot
  - grün
  - grün
  - blau
  - 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}
|-
| <nowiki>|</nowiki> || leitet einen Textblock ein, in dem die Zeilenumbrüche erhalten bleiben
codeblock : |
  Zeile 1
  Zeile 2
|-
| <nowiki> > </nowiki> || leitet einen Textblock ein, in dem Zeilenumbrüche ignoriert werden
Leere Zeilen bleiben erhalten:
textblock : >
  Zusammenghörender
  Text.
 
  Hier beginnt der
  zweite Absatz.
|}


Alternativ können Listen auch in eckige Klammern gestellt werden:
Alle vorgestellten Elemente können ineinander verschachtelt werden
[rot, grün, blau]
* Die Struktur wird durch Einrückungen hergestellt
 
* Dabei müssen Leerzeichen verwendet werden (keine Tabulatoren!)
Assoziative Listen (Key-Value-Paare) werden in der Form key: value gebildet:
* Beim Zugriff auf die Elemente werden die Bezeichner (Keys) aneinandergereiht
 
<syntaxhighlight lang="bash" highlight="1" line copy>
name : Hermann Huber age : 37
# Datei sample.yaml data:
 
Auch hier gibt es eine platzsparende Variante, diesmal 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 aber erhalten:
 
textblock : >
Zusammeng e h örender Text .
 
Hier beginnt der zweite Absatz .
 
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.
 
# Datei sample . yaml data :
list :
list :
  - item1
  - item1
Zeile 51: Zeile 55:
  code line 1
  code line 1
  code line 2
  code line 2
</syntaxhighlight>


; 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 Zum Auslesen von YAML-Dateien können Sie das Python-Script shyaml verwenden.
Unter Ubuntu installieren Sie das Kommando wie folgt:


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


Beim Experimentieren mit YAML-Dateien sind auch die YAML-Validatoren bzw.&nbsp;-Parser auf den folgenden Websites hilfreich:
Beim Experimentieren mit YAML-Dateien sind auch die YAML-Validatoren bzw.&nbsp;-Parser auf den folgenden Websites hilfreich:
Zeile 64: Zeile 70:
* https://yaml-online-parser.appspot.com
* https://yaml-online-parser.appspot.com
* https://codebeautify.org/yaml-validator
* https://codebeautify.org/yaml-validator
[[Kategorie:Docker/Compose]]
[[Kategorie:Docker/Compose]]

Version vom 18. November 2026, 06:10 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
--- 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.

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
# 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 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: