summary refs log tree commit diff
path: root/nixos/modules/services/cluster/kubernetes
diff options
context:
space:
mode:
authorpennae <github@quasiparticle.net>2021-12-05 22:06:49 +0100
committerpennae <github@quasiparticle.net>2021-12-09 01:38:24 +0100
commit2d564521c094b17e88707ac95cb4b6331b1b709a (patch)
tree39be0a04a8835f7682dd70aae57d85ca46db7c3d /nixos/modules/services/cluster/kubernetes
parent6eaf4f90c2b25918109fb2689d56e33a4f59f37d (diff)
downloadnixpkgs-2d564521c094b17e88707ac95cb4b6331b1b709a.tar
nixpkgs-2d564521c094b17e88707ac95cb4b6331b1b709a.tar.gz
nixpkgs-2d564521c094b17e88707ac95cb4b6331b1b709a.tar.bz2
nixpkgs-2d564521c094b17e88707ac95cb4b6331b1b709a.tar.lz
nixpkgs-2d564521c094b17e88707ac95cb4b6331b1b709a.tar.xz
nixpkgs-2d564521c094b17e88707ac95cb4b6331b1b709a.tar.zst
nixpkgs-2d564521c094b17e88707ac95cb4b6331b1b709a.zip
treewide: add literalDocBook text to options with complex defaults
some options have default that are best described in prose, such as
defaults that depend on the system stateVersion, defaults that are
derivations specific to the surrounding context, or those where the
expression is much longer and harder to understand than a simple text
snippet.
Diffstat (limited to 'nixos/modules/services/cluster/kubernetes')
-rw-r--r--nixos/modules/services/cluster/kubernetes/addons/dns.nix6
-rw-r--r--nixos/modules/services/cluster/kubernetes/kubelet.nix1
2 files changed, 6 insertions, 1 deletions
diff --git a/nixos/modules/services/cluster/kubernetes/addons/dns.nix b/nixos/modules/services/cluster/kubernetes/addons/dns.nix
index 34943fddd3d..10f45db7883 100644
--- a/nixos/modules/services/cluster/kubernetes/addons/dns.nix
+++ b/nixos/modules/services/cluster/kubernetes/addons/dns.nix
@@ -1,4 +1,4 @@
-{ config, pkgs, lib, ... }:
+{ config, options, pkgs, lib, ... }:
 
 with lib;
 
@@ -23,6 +23,10 @@ in {
           take 3 (splitString "." config.services.kubernetes.apiserver.serviceClusterIpRange
         ))
       ) + ".254";
+      defaultText = literalDocBook ''
+        The <literal>x.y.z.254</literal> IP of
+        <literal>config.${options.services.kubernetes.apiserver.serviceClusterIpRange}</literal>.
+      '';
       type = types.str;
     };
 
diff --git a/nixos/modules/services/cluster/kubernetes/kubelet.nix b/nixos/modules/services/cluster/kubernetes/kubelet.nix
index 4c00e162efa..3a15984c230 100644
--- a/nixos/modules/services/cluster/kubernetes/kubelet.nix
+++ b/nixos/modules/services/cluster/kubernetes/kubelet.nix
@@ -36,6 +36,7 @@ let
       key = mkOption {
         description = "Key of taint.";
         default = name;
+        defaultText = literalDocBook "Name of this submodule.";
         type = str;
       };
       value = mkOption {