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…“
 
Keine Bearbeitungszusammenfassung
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 Sie docker compose oder docker stack deploy ausführen können, müssen Sie 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:
Die Syntaxregeln von YAML haben wir Ihnen hier kurz zusammengefasst:


--- leitet einen neuen Abschnitt ein.
--- leitet einen neuen Abschnitt ein.
# startet einen Kommentar, der bis zum Ende der Zeile reicht.
# startet einen Kommentar, der bis zum Ende der Zeile reicht.
Zeichenketten können in der Form "abc" oder 'abc' ausgedrückt werden. Dies ist
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.
aber nur in Ausnahmefällen zwingend erforderlich – beispielsweise dann, wenn
die Zeichenkette Sonderzeichen enthält oder als ein anderer YAML-Ausdruck inter-
pretiert werden kann.
Mehrere mit - eingeleitete Ausdrücke bilden eine Liste:
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:
Alternativ können Listen auch in eckige Klammern gestellt werden:
 
[rot, grün, blau]
[ rot , gr ü n , blau ]


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
name : Hermann Huber age : 37
age : 37


Auch hier gibt es eine platzsparende Variante, diesmal in geschwungenen Klam-
Auch hier gibt es eine platzsparende Variante, diesmal in geschwungenen Klammern:
mern:


{ name : Hermann Huber , age : 37}
{ name : Hermann Huber , age : 37}
Zeile 37: Zeile 30:
Zeile 2
Zeile 2


> leitet einen Textblock ein, in dem Zeilenumbrüche ignoriert werden. Leere Zeilen
> leitet einen Textblock ein, in dem Zeilenumbrüche ignoriert werden. Leere Zeilen bleiben aber erhalten:
bleiben aber erhalten:


textblock : >
textblock : >
Zusammeng e h örender
Zusammeng e h örender Text .
Text .
 
Hier beginnt der
zweite Absatz .
 
115


5 Container-Setups mit »compose«
Hier beginnt der zweite Absatz .


Alle vorgestellten Elemente können ineinander verschachtelt werden. Die Struktur
Alle vorgestellten Elemente können ineinander verschachtelt werden. Die Struktur wird durch Einrückungen hergestellt. Dabei müssen Leerzeichen verwendet werden
wird durch Einrückungen hergestellt. Dabei müssen Leerzeichen verwendet werden
(keine Tabulatoren!). Beim Zugriff auf die Elemente werden die Bezeichner (Keys)
(keine Tabulatoren!). Beim Zugriff auf die Elemente werden die Bezeichner (Keys)
aneinandergereiht.
aneinandergereiht.


# Datei sample . yaml
# Datei sample . yaml data :
data :
list :
list :
  - item1
  - item1
Zeile 63: Zeile 47:
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


Einige fortgeschrittene Syntaxelemente von YAML, die jedoch in compose.yaml-
Einige fortgeschrittene Syntaxelemente von YAML, die jedoch in compose.yaml-Dateien normalerweise keine Rolle spielen, sind in der Wikipedia dokumentiert:
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:
Unter Ubuntu installieren Sie das Kommando wie folgt:


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


Beim Experimentieren mit YAML-Dateien sind auch die YAML-Validatoren bzw.
Beim Experimentieren mit YAML-Dateien sind auch die YAML-Validatoren bzw.&nbsp;-Parser auf den folgenden Websites hilfreich:
-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

Version vom 17. November 2026, 15:22 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)

Die Syntaxregeln von YAML haben wir Ihnen hier kurz zusammengefasst:

--- leitet einen neuen Abschnitt ein.

  1. 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. 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 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.

  1. Datei sample . yaml data :

list :

- item1
- item2

key1 : >

Dieser Text ist dem
Schlüssel 'data.key1' zugeordnet .

key2 : |

code line 1
code line 2

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. Unter Ubuntu installieren Sie das Kommando wie folgt:

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: