From 63adb41f1a060c21a68143eb9e86c2790ef66f36 Mon Sep 17 00:00:00 2001
From: Gregor Kleen <gkleen@yggdrasil.li>
Date: Thu, 8 Aug 2024 10:45:09 +0200
Subject: ...

---
 modules/pgbackrest.nix | 19 +++++++++++++++++--
 1 file changed, 17 insertions(+), 2 deletions(-)

(limited to 'modules/pgbackrest.nix')

diff --git a/modules/pgbackrest.nix b/modules/pgbackrest.nix
index e02849f5..886840b9 100644
--- a/modules/pgbackrest.nix
+++ b/modules/pgbackrest.nix
@@ -50,8 +50,8 @@ in {
       package = mkPackageOption pkgs "pgbackrest" {};
       dscpPackage = mkPackageOption pkgs "libdscp" { nullable = true; default = null; };
 
-      dscp.archive-push = mkDSCPOption { default = 24; };
-      dscp.backup = mkDSCPOption { default = 8; };
+      dscp.archive-push = mkDSCPOption { default = 24; description = "DSCP during archive push"; };
+      dscp.backup = mkDSCPOption { default = 8; description = "DSCP during backup"; };
 
       configurePostgresql = {
         enable = mkEnableOption "configuring PostgreSQL for sending WAL to pgBackRest" // {
@@ -63,6 +63,7 @@ in {
           type = types.str;
           default = config.networking.hostName;
           defaultText = literalExpression "config.networking.hostName";
+          description = "Stanza";
         };
       };
 
@@ -74,23 +75,28 @@ in {
             global.log-level-console = mkOption {
               type = loglevelType;
               default = "detail";
+              description = "Log level to console";
             };
             global.log-level-file = mkOption {
               type = loglevelType;
               default = "off";
+              description = "Log level to logfile";
             };
             global.log-level-stderr = mkOption {
               type = loglevelType;
               default = "warn";
+              description = "Log level to stderr";
             };
 
             global.log-subprocess = mkOption {
               type = types.bool;
               default = true;
+              description = "Log subprocesses?";
             };
             global.log-timestamp = mkOption {
               type = types.bool;
               default = false;
+              description = "Log timestamps?";
             };
           };
         };
@@ -106,10 +112,12 @@ in {
         user = mkOption {
           type = types.str;
           default = "postgres";
+          description = "User";
         };
         group = mkOption {
           type = types.str;
           default = "postgres";
+          description = "Group";
         };
       };
 
@@ -119,32 +127,39 @@ in {
             type = mkOption {
               type = types.enum ["full" "incr" "diff"];
               default = "full";
+              description = "Type";
             };
 
             stanza = mkOption {
               type = types.str;
               default = cfg.configurePostgresql.stanza;
               defaultText = literalExpression "config.services.pgbackrest.configurePostgresql.stanza";
+              description = "Stanza";
             };
             repo = mkOption {
               type = types.nullOr (types.strMatching "^[0-9]+$");
+              description = "Repository number";
             };
 
             user = mkOption {
               type = types.str;
               default = "postgres";
+              description = "User";
             };
             group = mkOption {
               type = types.str;
               default = "postgres";
+              description = "Group";
             };
 
             timerConfig = mkOption {
               type = types.attrsOf unitOption;
+              description = "Systemd timer options";
             };
           };
         }));
         default = {};
+        description = "Configure backups";
       };
     };
   };
-- 
cgit v1.2.3