clanModules: init single disk

2024-07-03 11:05:00 +02:00
parent fa524c9a14
commit e1fd63bca2
9 changed files with 118 additions and 10 deletions
--- a/clanModules/single-disk/README.md
+++ b/clanModules/single-disk/README.md
@@ -0,0 +1,43 @@
+---
+description = "Configures partitioning of the main disk"
+categories = ["disk-layout"]
+required = true
+---
+# Primary Disk Layout
+
+A module for the "disk-layout" category MUST be choosen.
+
+There is exactly one slot for this type of module in the UI, if you don't fill the slot, your machine cannot boot
+
+This module is a good choice for most machines. In the future clan will offer a broader choice of disk-layouts
+
+The UI will ask for the options of this module:
+
+`device: "/dev/null"`
+
+# Usage example
+
+`inventory.json`
+```json
+"services": {
+    "single-disk": {
+        "default": {
+            "meta": {
+                "name": "single-disk"
+            },
+            "roles": {
+                "default": {
+                    "machines": ["jon"]
+                }
+            },
+            "machines": {
+                "jon": {
+                    "config": {
+                        "device": "/dev/null"
+                    }
+                }
+            }
+        }
+    }
+}
+```