Docker/Compose/01 YAML: Unterschied zwischen den Versionen

Aus Foxwiki
Wechseln zu:Navigation, Suche
Die Seite wurde neu angelegt: „5.1 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). Die Syntaxregeln von YAML haben wir Ihnen hier kurz zusammengefasst: --- 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 we…“
 
 
(9 dazwischenliegende Versionen desselben Benutzers werden nicht angezeigt)
Zeile 1: Zeile 1:
5.1 YAML-Syntax
== YAML-Syntax ==
Bevor Sie docker compose oder docker stack deploy ausführen können, müssen Sie
Bevor ''docker compose'' oder ''docker stack deploy'' ausführen können, muss eine Datei mit dem Namen ''compose.yml'' erstellen
eine Datei mit dem Namen compose.yml erstellen. Die Kennung *.yml bezeichnet das
* Die Kennung *.yml bezeichnet das YAML-Format (YAML Ain’t Markup Language)
YAML-Format (YAML Ain’t Markup Language). Die Syntaxregeln von YAML haben wir
Ihnen hier kurz zusammengefasst:


--- leitet einen neuen Abschnitt ein.
; Syntaxregeln
# startet einen Kommentar, der bis zum Ende der Zeile reicht.
{| class="table table-striped table-hover col1bold col1nowrap"
Zeichenketten können in der Form "abc" oder 'abc' ausgedrückt werden. Dies ist
|-
aber nur in Ausnahmefällen zwingend erforderlich – beispielsweise dann, wenn
! Syntax !! Beschreibung
die Zeichenkette Sonderzeichen enthält oder als ein anderer YAML-Ausdruck inter-
|-
pretiert werden kann.
| --- || leitet einen neuen Abschnitt ein
Mehrere mit - eingeleitete Ausdrücke bilden eine Liste:
|-
| # || 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}
|-
| <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.
|}


- rot
; Verschachtelung
- gr ü n
Alle vorgestellten Elemente können ineinander verschachtelt werden
- blau
* 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


Alternativ können Listen auch in eckige Klammern gestellt werden:
; Beispiel
 
<syntaxhighlight lang="yaml" highlight="" line>
[ rot , gr ü n , blau ]
# Datei sample.yaml data:
 
list:
Assoziative Listen (Key-Value-Paare) werden in der Form key: value gebildet:
 
name : Hermann Huber
age : 37
 
Auch hier gibt es eine platzsparende Variante, diesmal in geschwungenen Klam-
mern:
 
{ 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 .
 
115
 
5 Container-Setups mit »compose«
 
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
  - item1
  - item2
  - item2
key1 : >
key1: >
  Dieser Text ist dem
  Dieser Text ist dem
  Schl ü ssel 'data . key1 ' zugeordn e t .
  Schlüssel 'data.key1' zugeordnet .
key2 : |
key2: |
  code line 1
  code line 1
  code line 2
  code line 2
</syntaxhighlight>
== Fortgeschrittene Syntaxelemente ==
Spielen in compose.yaml-Dateien meist keine Rolle
Siehe auch
* https://en.wikipedia.org/wiki/YAML


Einige fortgeschrittene Syntaxelemente von YAML, die jedoch in compose.yaml-
== Auslesen von YAML-Dateien ==
Dateien normalerweise keine Rolle spielen, sind in der Wikipedia dokumentiert:
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
Installation (Debian)
<syntaxhighlight lang="bash" highlight="1" copy>
sudo apt install python-pip  
</syntaxhighlight>
<syntaxhighlight lang="bash" highlight="1" copy>
sudo pip install shyaml
sudo pip install shyaml
shyaml get - value data . list < sample . yaml
</syntaxhighlight>
<syntaxhighlight lang="bash" highlight="1" copy>
shyaml get-value data.list < sample.yaml
</syntaxhighlight>
<syntaxhighlight lang="bash" highlight="" line>
- item1
- item1
- item2
- item2
</syntaxhighlight>
Beim Experimentieren mit YAML-Dateien sind auch die YAML-Validatoren oder -Parser auf den folgenden Websites hilfreich:
* http://www.yamllint.com
* https://yaml-online-parser.appspot.com
* https://codebeautify.org/yaml-validator


Beim Experimentieren mit YAML-Dateien sind auch die YAML-Validatoren bzw.
[[Kategorie:Docker/Compose]]
-Parser auf den folgenden Websites hilfreich:
http://www.yamllint.com
https://yaml-online-parser.appspot.com
https://codebeautify.org/yaml-validator

Aktuelle Version vom 19. November 2026, 03:05 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 meist 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 oder -Parser auf den folgenden Websites hilfreich: