diff --git a/docs/site/guides/authoring/clanModules/index.md b/docs/site/guides/authoring/clanModules/index.md index 2ee9d0951..6bbb559dc 100644 --- a/docs/site/guides/authoring/clanModules/index.md +++ b/docs/site/guides/authoring/clanModules/index.md @@ -52,6 +52,7 @@ clanModules/borgbackup ```nix title="flake.nix" # ... + # Sometimes this attribute set is defined in clan.nix clan-core.lib.clan { # 1. Add the module to the available clanModules with inventory support inventory.modules = { @@ -175,6 +176,7 @@ The following shows how to add options to your module. Configuration can be set as follows. ```nix title="flake.nix" + # Sometimes this attribute set is defined in clan.nix clan-core.lib.clan { inventory.services = { custom-module.instance_1 = { diff --git a/docs/site/guides/authoring/clanServices/index.md b/docs/site/guides/authoring/clanServices/index.md index 319e29e44..f3e86bb70 100644 --- a/docs/site/guides/authoring/clanServices/index.md +++ b/docs/site/guides/authoring/clanServices/index.md @@ -27,6 +27,7 @@ i.e. `@hsjobeki/customNetworking` outputs = inputs: inputs.flake-parts.lib.mkFlake { inherit inputs; } ({ imports = [ inputs.clan-core.flakeModules.default ]; # ... + # Sometimes this attribute set is defined in clan.nix clan = { # If needed: Exporting the module for other people modules."@hsjobeki/customNetworking" = import ./service-modules/networking.nix; @@ -218,6 +219,7 @@ To import the module use `importApply` outputs = inputs: flake-parts.lib.mkFlake { inherit inputs; } ({self, lib, ...}: { imports = [ inputs.clan-core.flakeModules.default ]; # ... + # Sometimes this attribute set is defined in clan.nix clan = { # Register the module modules."@hsjobeki/messaging" = lib.importApply ./service-modules/messaging.nix { inherit self; }; @@ -244,6 +246,7 @@ Then wrap the module and forward the variable `self` from the outer context into outputs = inputs: flake-parts.lib.mkFlake { inherit inputs; } ({self, lib, ...}: { imports = [ inputs.clan-core.flakeModules.default ]; # ... + # Sometimes this attribute set is defined in clan.nix clan = { # Register the module modules."@hsjobeki/messaging" = { diff --git a/docs/site/guides/getting-started/add-machines.md b/docs/site/guides/getting-started/add-machines.md index 1f0726fb8..8c10dc499 100644 --- a/docs/site/guides/getting-started/add-machines.md +++ b/docs/site/guides/getting-started/add-machines.md @@ -90,6 +90,7 @@ See the complete [list](../../guides/more-machines.md#automatic-registration) of The option: `machines.` is used to add extra *nixosConfiguration* to a machine ```{.nix .annotate title="flake.nix" hl_lines="3-13 18-22"} +# Sometimes this attribute set is defined in clan.nix clan = { inventory.machines = { jon = { diff --git a/docs/site/guides/getting-started/add-services.md b/docs/site/guides/getting-started/add-services.md index 6a0b08cc6..a4355b112 100644 --- a/docs/site/guides/getting-started/add-services.md +++ b/docs/site/guides/getting-started/add-services.md @@ -28,6 +28,7 @@ To learn more: [Guide about clanService](../clanServices.md) inputs@{ flake-parts, ... }: flake-parts.lib.mkFlake { inherit inputs; } { imports = [ inputs.clan-core.flakeModules.default ]; + # Sometimes this attribute set is defined in clan.nix clan = { inventory.machines = { jon = { @@ -76,6 +77,7 @@ Adding the following services is recommended for most users: inputs@{ flake-parts, ... }: flake-parts.lib.mkFlake { inherit inputs; } { imports = [ inputs.clan-core.flakeModules.default ]; + # Sometimes this attribute set is defined in clan.nix clan = { inventory.machines = { jon = { diff --git a/docs/site/guides/getting-started/secrets.md b/docs/site/guides/getting-started/secrets.md index 2fb9df600..5475875d6 100644 --- a/docs/site/guides/getting-started/secrets.md +++ b/docs/site/guides/getting-started/secrets.md @@ -152,6 +152,7 @@ are loaded when using Clan: outputs = { self, clan-core, ... }: let + # Sometimes this attribute set is defined in clan.nix clan = clan-core.lib.clan { inherit self; diff --git a/docs/site/guides/mesh-vpn.md b/docs/site/guides/mesh-vpn.md index 038de1ce7..ef9878576 100644 --- a/docs/site/guides/mesh-vpn.md +++ b/docs/site/guides/mesh-vpn.md @@ -39,6 +39,7 @@ For the purpose of this guide we have two machines: outputs = { self, clan-core, ... }: let + # Sometimes this attribute set is defined in clan.nix clan = clan-core.lib.clan { inherit self; diff --git a/docs/site/guides/target-host.md b/docs/site/guides/target-host.md index aec79beba..d413ac6cb 100644 --- a/docs/site/guides/target-host.md +++ b/docs/site/guides/target-host.md @@ -14,6 +14,7 @@ If the hostname is **static**, like `server.example.com`, set it in the **invent outputs = { self, clan-core, ... }: let + # Sometimes this attribute set is defined in clan.nix clan = clan-core.lib.clan { inventory.machines.jon = { deploy.targetHost = "root@server.example.com"; @@ -41,6 +42,7 @@ If your target host depends on a **dynamic expression** (like using the machine outputs = { self, clan-core, ... }: let + # Sometimes this attribute set is defined in clan.nix clan = clan-core.lib.clan { machines.jon = {config, ...}: { clan.core.networking.targetHost = "jon@${config.networking.fqdn}";