Docker/Compose/01 YAML: Unterschied zwischen den Versionen

Aus Foxwiki
Wechseln zu:Navigation, Suche
Keine Bearbeitungszusammenfassung
 
(6 dazwischenliegende Versionen desselben Benutzers werden nicht angezeigt)
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)


Die Syntaxregeln von YAML haben wir Ihnen hier kurz zusammengefasst:
; Syntaxregeln
 
{| class="table table-striped table-hover col1bold col1nowrap"
--- leitet einen neuen Abschnitt ein.
|-
# startet einen Kommentar, der bis zum Ende der Zeile reicht.
! Syntax !! Beschreibung
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.
|-
Mehrere mit - eingeleitete Ausdrücke bilden eine Liste:
| --- || 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
  - 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:
; Verschachtelung
[rot, grün, blau]
Alle vorgestellten Elemente können ineinander verschachtelt werden
 
* Die Struktur wird durch Einrückungen hergestellt
Assoziative Listen (Key-Value-Paare) werden in der Form key: value gebildet:
* Dabei müssen Leerzeichen verwendet werden (keine Tabulatoren!)
 
* Beim Zugriff auf die Elemente werden die Bezeichner (Keys) aneinandergereiht
name : Hermann Huber age : 37
 
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
; Beispiel
(keine Tabulatoren!). Beim Zugriff auf die Elemente werden die Bezeichner (Keys)
<syntaxhighlight lang="yaml" highlight="" line>
aneinandergereiht.
# Datei sample.yaml data:
 
list:
# Datei sample . yaml data :
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
</syntaxhighlight>


Einige fortgeschrittene Syntaxelemente von YAML, die jedoch in compose.yaml-Dateien normalerweise keine Rolle spielen, sind in der Wikipedia dokumentiert:
== Fortgeschrittene Syntaxelemente ==
https://en.wikipedia.org/wiki/YAML Zum Auslesen von YAML-Dateien können Sie das Python-Script shyaml verwenden.
Spielen in compose.yaml-Dateien meist keine Rolle
Unter Ubuntu installieren Sie das Kommando wie folgt:


sudo apt install python - pip sudo pip install shyaml shyaml get - value data . list < sample . yaml
Siehe auch
* 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)
<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
- item1
- item2
- item2
</syntaxhighlight>


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 oder -Parser auf den folgenden Websites hilfreich:
* http://www.yamllint.com
* http://www.yamllint.com
* 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]]

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: