From 80cfd36fdf7442385eaa0e8548774063291f23db Mon Sep 17 00:00:00 2001 From: Chris Kruining Date: Wed, 5 Nov 2025 10:45:43 +0100 Subject: [PATCH 1/2] chore: add descriptions to roles --- clanServices/customer-portal/README.md | 1 + clanServices/customer-portal/default.nix | 2 ++ clanServices/k3s/README.md | 1 + clanServices/k3s/default.nix | 4 ++++ clanServices/zitadel/default.nix | 4 ++++ 5 files changed, 12 insertions(+) diff --git a/clanServices/customer-portal/README.md b/clanServices/customer-portal/README.md index e69de29..cec9c07 100644 --- a/clanServices/customer-portal/README.md +++ b/clanServices/customer-portal/README.md @@ -0,0 +1 @@ +# Customer portal Clan-service diff --git a/clanServices/customer-portal/default.nix b/clanServices/customer-portal/default.nix index a2767f2..058d5c3 100644 --- a/clanServices/customer-portal/default.nix +++ b/clanServices/customer-portal/default.nix @@ -16,6 +16,8 @@ in # Server configuration #============================================================================================================== roles.server = { + description = "A server hosts the portal"; + interface = { lib, ... }: let inherit (lib) mkOption types toString; diff --git a/clanServices/k3s/README.md b/clanServices/k3s/README.md index e69de29..2f4c0fa 100644 --- a/clanServices/k3s/README.md +++ b/clanServices/k3s/README.md @@ -0,0 +1 @@ +# K3s Clan-service diff --git a/clanServices/k3s/default.nix b/clanServices/k3s/default.nix index e93d1e6..a98a4a2 100644 --- a/clanServices/k3s/default.nix +++ b/clanServices/k3s/default.nix @@ -16,6 +16,8 @@ in # Server configuration #============================================================================================================== roles.server = { + description = "A server manages the cluster"; + interface = { lib, ... }: let inherit (lib) mkOption mkEnableOption mkIf types toString; @@ -184,6 +186,8 @@ in # Agent configuration #============================================================================================================== roles.agent = { + description = "An agent connects to the server"; + interface = { lib, ... }: { options = {}; }; diff --git a/clanServices/zitadel/default.nix b/clanServices/zitadel/default.nix index 003ac7c..027110e 100644 --- a/clanServices/zitadel/default.nix +++ b/clanServices/zitadel/default.nix @@ -17,6 +17,8 @@ in # Controller configuration #============================================================================================================== roles.controller = { + description = "A controller that manages the instance"; + interface = { options = { hostName = mkOption { @@ -225,6 +227,8 @@ in # Peer configuration #============================================================================================================== roles.peer = { + description = "A peer"; + interface = { options = {}; }; From f2bb2757b8452bde481293c53391ddaab5a02390 Mon Sep 17 00:00:00 2001 From: Chris Kruining Date: Wed, 5 Nov 2025 10:46:20 +0100 Subject: [PATCH 2/2] feat: add test code to assert if k3s is running --- clanServices/zitadel/default.nix | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/clanServices/zitadel/default.nix b/clanServices/zitadel/default.nix index 027110e..328a912 100644 --- a/clanServices/zitadel/default.nix +++ b/clanServices/zitadel/default.nix @@ -77,6 +77,21 @@ in }; in { + assertions = + let + inherit (lib) attrValues any; + in + [ + { + assertion = + config.services.k3s.enable == true; + # config.clan.inventory.instances + # |> attrValues + # |> any ({ module, ... }: module.name == "k3s"); + message = "This module requires k3s in order to run"; + } + ]; + clan.core.vars.generators.zitadel = { share = false;