]> Frank Brehm's Git Trees - pixelpark/create-terraform.git/commitdiff
Weiter mit Überarbeitung README.md
authorFrank Brehm <frank.brehm@pixelpark.com>
Fri, 3 Jan 2020 15:38:01 +0000 (16:38 +0100)
committerFrank Brehm <frank.brehm@pixelpark.com>
Fri, 3 Jan 2020 15:38:01 +0000 (16:38 +0100)
README.md

index 0965e63d07a5ee73dfcf830d87a454eabea06c31..35f5b19dc21756a1def87dd0fe6b292e7199243b 100644 (file)
--- a/README.md
+++ b/README.md
@@ -296,8 +296,33 @@ Mit dem Schüssel **'defaults'** werden entweder auf oberster Ebene oder innerha
 definiert. Es können alle Werte bis auf den Hostnamen und die IP-Adressen vorbelegt werden. Für alle diese Werte
 gibt es aber auch vordefinierte (hoffentlich sinnvolle) Werte, falls man diese komplett vergißt.
 
-
-```
+*Hinweis:* Sebstverständlich müssen die Projekt-Dateien UTF-8 codiert sein (Standard bei YAML - wenn ich etwas anderes
+finde, hacke ich dem Verursacher die Hände ab). Weiterhin möchte ich bitten, dass der POSIX-Standard
+für Text-Dateien eingehalten wird, das heißt, die letzte Zeile der Datei schließt immer mit einem Newline ab.
+
+#### 2.1.1. Schlüssel auf oberster Ebene
+
+* **simulate**: Boolscher Wert. Wenn wahr, ist das identisch damit, als ob *'create-terraform'* immer mit dem
+  Schalter *'--simulate'* aufgerufen wird. Es wird also nur so getan, als ob, und die Terraform-Projekt-Verzeichnisse
+  und -Dateien werden nicht angelegt.
+* **defaults**: Wie bereits erwähnt, werden hier die globalen Vorgabewerte für alle VMs definiert.
+* **vms**: Liste der nicht gruppierten VMs. Das heißt, sie beziehen ihre Vorgaben ausschließlich aus den
+  Vorgabewerten der obersten Ebene.
+  In dieser Liste werden alle VMs, die provisioniert werden sollen, als Hashes aufgelistet, wobei minimal
+  der Name und eine IPv4-Adresse pro VM definiert werden müssen.
+* **groups**: Liste von Gruppen von VMs, die wiederum gemeinsame, von den globalen abweichende Vorgabewerte
+  haben. Jede Gruppe ist ein Hash mit drei notwendigen Schlüsseln: *'name'*, *'defaults'* und *'vms'*, sowie
+  dem optionalen Schlüssel *'groups'*.
+  Mit **name** wird jeder Gruppe ein eindeutiger Gruppenname zugewiesen. Dieser wird zwar in Terraform
+  nicht verwendet, aber dient zum einfacheren Auffinden von Fehlern in der Konfiguration.
+  Die Schlüssel **defaults**, **vms** und **groups** haben exakt die selbe Bedeutung wie auf der obersten
+  Ebene. In den *defaults* in einer Gruppe können Vorgabewerte der nächsthöheren Ebene überschrieben werde.
+
+#### 2.1.2. Konfigurations-Parameter für eine VM
+
+Die nachfolgenden Parameter können pro defaults-Abschnitt und pro VM vergeben werden.
 
 ## 3. FeatureRequests
+
 ### 3.1 change vSphere Host per need in terraform yaml (live <--> test)
+