From 99a5b1f489f7f95b7ac47b396f4524c5f1583146 Mon Sep 17 00:00:00 2001
From: Frank Brehm <frank.brehm@pixelpark.com>
Date: Thu, 16 Sep 2021 16:36:55 +0200
Subject: [PATCH] Update README.md

---
 README.md | 70 +++++++++++++++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 68 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 6337608..a938208 100644
--- a/README.md
+++ b/README.md
@@ -91,7 +91,7 @@ bzw. zu aktualisieren. Das sind folgende Dinge:
 
 Das sieht beim ersten Mal so aus:
 ```
-frank.brehm@ns1-local ~/Work/terraform (test) > ./update-env.sh
+frank.brehm@terraform ~/Work/terraform (test) > ./update-env.sh
  * Searching for valid Python …
 
  * Found 'python3.6'.
@@ -197,7 +197,7 @@ Der nächste Schritt ist grundsätzlich vor jeder Arbeitssitzung zu machen, um d
 Umgebung zu aktivieren:
 
 ```
-frank.brehm@ns1-local ~/Work/terraform (test) > . venv/bin/activate
+frank.brehm@terraform ~/Work/terraform (test) > . venv/bin/activate
 frank.brehm@ns1-local ~/Work/terraform (test) >
 ```
 
@@ -342,6 +342,8 @@ gibt es aber auch vordefinierte (hoffentlich sinnvolle) Werte, falls man diese k
 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.
 
+Direkt im obersten Verzeichnis befindet sich die Datei **`example-dont-use.yaml`**, in der exemplarisch alle Möglichkeiten der Konfioguration dargestellt werden.
+
 #### 2.1.1. Schlüssel auf oberster Ebene
 
 ##### simulate
@@ -465,6 +467,70 @@ Vorgesehen ist, vorher eine ähnliche Suche über alle Datenstore-Cluster zu mac
 wurde, und erst danach, wenn kein entsprechender Datenstore-Cluster gefunden wurde, die Suche auf
 Datastores auszudehnen.
 
+##### root\_disk
+
+In der aktuellen Version des Tools ist der Wert ein Hash mit nur einem Schlüssel, nämlich **size**.
+
+    root_disk:
+      size: 20
+
+Darin wird die Größe der Root-Disk (sda) in GiByte angegeben. Diese darf nicht kleiner sein als
+die Größe der Root-Disk der Vorlage. Da momentan bei allen Vorlagen die Root-Disk 20 GB beträgt,
+ist also der Minimalgröße der Root-Disk 20 (GiBytes). Das ist auch die Größe der Root-Disk,
+wenn man diese nicht angibt.
+
+Wenn man einen Wert größer als die Root-Disk der Vorlage einträgt, erhält man auf sda einen
+ungenutzten Raum. Da in den Vorlagen die Root-Disks eine MS-DOS-Parititionstabelle mit drei primären
+Partitionen haben, kann man anschließend nach der Provisionierung in dem ungenutzten Platz
+eine weitere Partition anlegen, die man zum Beispiel zum Vergrößern von Volume-Gruppen
+nutzen könnte.
+
+##### dada\_disk
+
+In der aktuellen Version des Tools ist der Wert ein Hash mit nur einem Schlüssel, nämlich **size**,
+oder '**~**' - was bedeutet, dass keine Daten-Disk angelegt werden soll.
+
+    data_disk:
+      size: 100
+
+Darin wird die Größe der Daten-Disk (sdb) in GiByte angegeben. Die aktuelle Mindesgröße ist 4,
+die Maximalgröße ist 1024 (beide Grenzwerte kann man über eine hangestrickte Konfigurationsdatei
+verändern).
+
+Wenn man keine Daten-Disk haben möchte, kan man den Wert '**~**' angeben, was die Vorgabe ist:
+
+    data_disk: ~
+
+Das macht insbesondere dann Sinn, wenn man mehere VMs provisionieren möchte, die alle eine Daten-Disk
+haben, bis auf einzelne VMs, die keine haben sollen.
+
+Momentan bietet der Terraform-VSphere-Provider keine Möglichkeit, mehrere virtuelle SCSI-Controller
+anzugeben, und dann die Daten-Disk daran anzuhängen. Wenn man so etwas haben möchte, muss man das
+nach der Provisionierung in der VSPhere-WebGUI einrichten.
+
+Der Terraform-VSphere-Provider hängt die Disk als nicht verwendete Disk an die VM dran, um die
+Einbindung muss man sich in Puppet oder manuell selbst kümmern. Das ist insbesondere dann ein
+Problem, wenn die Daten-Disk für ein Dateisystem vorgesehen ist, das bereits in der Vorlage
+existiert und in Verwendung ist. Da kommnt man dann meistens nicht darum herum, die Daten-Disk
+als LVM PV zu deklarieren und damit die root-VolumeGroup zu vergrößern.
+
+##### data\_disks
+
+Wie der Name schon vermuten läßt, kann man hier mehrere Daten-Disks mit einem Mal bereits bei der
+Provisionierung an die VM anhängen.
+
+Der Wert dieses Schlüssels ist ein Array von Hashes, die alle den Schlüssel **size** haben
+(man kann es sicherlich erraten - es ist natürlich die Größe in GiBytes).
+
+Das sieht dann ungefähr so aus:
+
+    data_disks:
+      - size: 50
+      - size: 200
+
+Die Bemerkungen zur Größe, zum SCSI-Controller und zur Einbindung, die ich bereits bei _data_disk_
+gemacht habe, treffen natürlich auch hier zu.
+
 ## 3. FeatureRequests
 
 ### 3.1 change vSphere Host per need in terraform yaml (live <--> test)
-- 
2.39.5