readme improvements

This commit is contained in:
Johannes Kirschbauer
2024-06-20 18:52:34 +02:00
committed by hsjobeki
parent 5f72778ade
commit 3a9c56deb2

View File

@@ -1,6 +1,13 @@
# Inventory # 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 ? - [x] Must roles be a list ?
-> Yes. In zerotier you can be "moon" and "controller" at the same time. -> Yes. In zerotier you can be "moon" and "controller" at the same time.
@@ -31,9 +38,9 @@ Questions:
Architecture 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 creates the config Maps from high level services to the borgbackup clan module
for ONE machine for ONE machine