diff --git a/docs/site/guides/inventory.md b/docs/site/guides/inventory.md index 7e9bd93dc..1bb2f96c5 100644 --- a/docs/site/guides/inventory.md +++ b/docs/site/guides/inventory.md @@ -25,7 +25,9 @@ buildClan { ## How to add machines -Machines can be added via `inventory.machines` OR via `buildClan` directly. +Every machine of the form `machines/{machineName}/configuration.nix` will be registered automatically. + +Machines can also be manually added under `inventory.machines` OR via `buildClan` directly. !!! Note It doesn't matter where the machine gets introduced to buildClan - All delarations are valid, duplications are merged. @@ -47,13 +49,8 @@ buildClan { inventory = { machines = { "backup_server" = { - # Don't include any nixos config here - # The following fields are avilable - # description: null | string - # icon: null | string - # name: string - # system: null | string - # tags: [...string] + # Don't include any nixos config here. + # See the Inventory API Docs for the available attributes. }; "jon" = { # Same as above @@ -75,6 +72,10 @@ Currently the inventory interface is implemented by the following clanModules See the respective module documentation for available roles. +!!! Note + It is possible to use any [clanModule](../reference/clanModules/index.md) in the inventory and add machines via + `roles.default.*` + ### Adding services to machines A module can be added to one or multiple machines via `Roles`. clan's `Role` interface provide sane defaults for a module this allows the module author to reduce the configuration overhead to a minimum. @@ -117,9 +118,7 @@ Each service can still be customized and configured according to the modules opt } ``` -### Scalabling the Backup - -The inventory allows machines to set **Tags** +### Scaling the Backup It is possible to add services to multiple machines via tags. The service instance gets added in the specified role. In this case `role = "client"`