docs: add glossary

This commit is contained in:
pinpox
2025-05-19 11:35:04 +02:00
parent cdd9b8a3e4
commit 6525b591e2
2 changed files with 39 additions and 0 deletions

View File

@@ -159,6 +159,7 @@ nav:
- Nix API:
- buildClan: reference/nix-api/buildclan.md
- Inventory: reference/nix-api/inventory.md
- Glossary: reference/glossary.md
- Decisions:
- Architecture Decisions: decisions/README.md
- 01-clanModules: decisions/01-ClanModules.md

View File

@@ -0,0 +1,38 @@
# :material-api: Glossary
## clan
Collection of machines interconnected in a network.
## clan-app
Graphical interface for managing clans. Simpler to use than the `clan-cli`.
## clan-cli
Command-line tool for managing clans.
## clanModule
Module that enables configuration via the inventory.
Legacy `clanModules` also support configuration outside the inventory.
## clanService
Service defined and managed through a clan configuration.
## clanURL
Flake URL-like syntax used to link to clans.
Required to connect the `url-open` application to the `clan-app`.
## facts *(deprecated)*
System for creating secrets and public files in a declarative way.
**Note:** Deprecated, use `vars` instead.
## inventory
JSON-like structure used to configure multiple machines.
## machine
A physical computer or virtual machine.
## role
Specific function assigned to a machine within a service.
Allows assignment of sane default configurations in multi-machine services.
## vars
System for creating secrets and public files in a declarative way.