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

docs-site: fix md

Browse Source
This commit is contained in:
Glen Huang
2025-10-10 13:30:25 +08:00
parent 57c91c3da3
commit ae6eb1a822
1 changed files with 23 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
pkgs/docs-site/src/routes/docs/getting-started/add-machines.md
View File

@@ -12,8 +12,8 @@ See the complete [list](../guides/inventory/autoincludes.md) of auto-loaded file
=== "clan.nix (declarative)" === "clan.nix (declarative)"
```{.nix hl_lines="3-4"} ```nix {3-4}
{ {
inventory.machines = { inventory.machines = {
# Define a machine # Define a machine
jon = { }; jon = { };
@@ -25,30 +25,31 @@ See the complete [list](../guides/inventory/autoincludes.md) of auto-loaded file
# environment.systemPackages = [ pkgs.asciinema ]; # environment.systemPackages = [ pkgs.asciinema ];
# }; # };
}; };
} }
``` ```
=== "CLI (imperative)" === "CLI (imperative)"
```sh ```sh
clan machines create jon clan machines create jon
``` ```
The imperative command might create a machine folder in `machines/jon` The imperative command might create a machine folder in `machines/jon`
And might persist information in `inventory.json` And might persist information in `inventory.json`
### Configuring a machine ### Configuring a machine
!!! Note :::note
The option: `inventory.machines.<name>` is used to define metadata about the machine The option: `inventory.machines.<name>` is used to define metadata about the machine
That includes for example `deploy.targethost` `machineClass` or `tags` That includes for example `deploy.targethost` `machineClass` or `tags`
The option: `machines.<name>` is used to add extra *nixosConfiguration* to a machine The option: `machines.<name>` is used to add extra _nixosConfiguration_ to a machine
:::
Add the following to your `clan.nix` file for each machine. Add the following to your `clan.nix` file for each machine.
This example demonstrates what is needed based on a machine called `jon`: This example demonstrates what is needed based on a machine called `jon`:
```{.nix .annotate title="clan.nix" hl_lines="3-6 15-19"} ```nix {3-6,15-19}
{ {
inventory.machines = { inventory.machines = {
jon = { jon = {