Documentation

diff --git a/README.md b/README.md
index 35f5b19dc21756a1def87dd0fe6b292e7199243b..41f6c6a87404de34c02e61e806587cab4bb3d5ac 100644 (file)
--- a/README.md
+++ b/README.md
@@ -322,6 +322,26 @@ für Text-Dateien eingehalten wird, das heißt, die letzte Zeile der Datei schli
 
 Die nachfolgenden Parameter können pro defaults-Abschnitt und pro VM vergeben werden.
 
+* **vsphere**: Name der der VSPhere-Umgebung aus der Konfiguration dieser Anwendung, also im Falle von Pixelpark
+  entweder _test_ oder _live_. **Achtung**: Durch die Limitierung von Terraform darf es in einem Terraform-Projekt
+  nur ein VSphere geben, damit macht es Sinn, diesen Parameter nur ein einziges Mal anzugeben, nämlich im
+  obersten Template.
+
+* **vm_folder**: Der Name des Ordners innerhalb des Baums der 'VMs und Vorlagen'-Ansicht in VSPhere. Dabei achtet
+  VSPhere auf Groß- und Kleinschreibung, also sind _'Pixelpark'_ und _'pixelpark'_ zwei unterschiedliche Ordner.
+  Empfohlen wird auf oberster Ebene der Kunde als Ordnername, und darunter bei kleineren Kunden das Tier (z.Bsp.
+  'live', 'test' und 'dev') als zweite Ebene, bei größeren Kunden sollte noch das Projekt als zweite Ebene
+  dazwischen geschoben werden. Damit ergeben sich bei kleineren Kunden Ordnernamen wie _'Mubea/live'_, und bei
+  größeren Kunden zum Beispiel _'Pixelpark/DNS/test'_. Wenn der Ordner in VSphere nicht existieren sollte, wird
+  er vom Create-Script angelegt. Die Ordner werden nicht als Terraform-Resourcen behandelt, das heißt, wenn nach
+  dem Wegwerfen von VMs mittels Terraform der Ordner leer ist, wird er von Terraform nicht weggeräumt. Das
+  obliegt dann dem Admin, der die VMs weggeräumt hat, manuell.
+
+* **num_cpus**: Die Anzahl der CPUs der VM als Integer-Zahl. Der Einfachheit halber ist damit grundsätzlich die
+  Anzahl der CPUs mit jeweils einem Core gemeint. Wer Spielereien wie 'X CPUs mit Y Cores' unbedingt und dringend
+  benötigt, richtet die VM erst mal nach obigem Schema ein und konfiguriert diese anschließend manuell in VSPhere.
+  Bislang hat sich mir derlei Notwendigkeit aber noch nicht dargestellt.
+
 ## 3. FeatureRequests
 
 ### 3.1 change vSphere Host per need in terraform yaml (live <--> test)