yadunut/clan-core
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

docs: update Adding Machines guide

Browse Source
This commit is contained in:
Michael Hoang
2024-12-11 13:54:18 +11:00
parent ad4a3b473f
commit 38d867a4e1
1 changed files with 9 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
docs/site/manual/adding-machines.md
View File

@@ -1,22 +1,22 @@
# Adding Machines
Clan has two general methods of adding machines
Clan has two general methods of adding machines:
- **Automatic**: Detects every folder in the `machines` folder.
- **Declarative**: Explicit declarations in nix.
- **Declarative**: Explicit declarations in Nix.
## Automatic register
## Automatic registration
Every machine of the form `machines/{machineName}` will be registered automatically.
Every folder `machines/{machineName}` will be registered automatically as a Clan machine.
!!! info "Automatically loaded files"
Some files are loaded by a clan machine automatically. This decision was made for convinience and allows easier automation.
The following files are loaded automatically for each Clan machine:
- [x] ``machines/{machineName}/configuration.nix`
- [x] ``machines/{machineName}/hardware-configuration.nix`
- [x] ``machines/{machineName}/facter.json` Automatically configured, for further information see [nixos-facter](https://clan.lol/blog/nixos-facter/)
- [x] ``machines/{machineName}/disko.nix` Automatically loaded, for further information see the [disko docs](https://github.com/nix-community/disko/blob/master/docs/quickstart.md).
- [x] `machines/{machineName}/configuration.nix`
- [x] `machines/{machineName}/hardware-configuration.nix`
- [x] `machines/{machineName}/facter.json` Automatically configured, for further information see [nixos-facter](https://clan.lol/blog/nixos-facter/)
- [x] `machines/{machineName}/disko.nix` Automatically loaded, for further information see the [disko docs](https://github.com/nix-community/disko/blob/master/docs/quickstart.md).
## Manual declaration