From 17d76ddfed9c7493e364f0c44667f7a1461f3a71 Mon Sep 17 00:00:00 2001 From: Johannes Kirschbauer Date: Thu, 20 Jun 2024 18:52:34 +0200 Subject: [PATCH] readme improvements --- inventory/README.md | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) diff --git a/inventory/README.md b/inventory/README.md index 2bdbf77b..64efedd3 100644 --- a/inventory/README.md +++ b/inventory/README.md @@ -1,6 +1,13 @@ # Inventory -Questions: +The inventory is our concept for distributed services. Users can configure multiple machines with minimal effort. + +- The inventory acts as a declarative source of truth for all machine configurations. +- Users can easily add or remove machines and services. +- Ensures that all machines and services are configured consistently, across multiple nixosConfigs. +- Defaults and predefined roles in our modules minimizes the need for manual configuration. + +Design questions: - [x] Must roles be a list ? -> Yes. In zerotier you can be "moon" and "controller" at the same time. @@ -31,9 +38,9 @@ Questions: Architecture ``` -machine < machine_module < inventory +nixosConfig < machine_module < inventory --------------------------------------------- -nixos < borgbackup < borgbackup-static > UI +nixos < borgbackup + borgbackup-static > UI creates the config Maps from high level services to the borgbackup clan module for ONE machine