chore: add descriptions to roles

clanServices/customer-portal/README.md

@@ -0,0 +1 @@
+# Customer portal Clan-service

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;

clanServices/k3s/README.md

@@ -0,0 +1 @@
+# K3s Clan-service

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 = {};
     };

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 = {};
     };