diff options
author | Naïm Favier <n@monade.li> | 2021-10-03 18:06:03 +0200 |
---|---|---|
committer | Naïm Favier <n@monade.li> | 2021-10-04 12:47:20 +0200 |
commit | 2ddc335e6f32b875e14ad9610101325b306a0add (patch) | |
tree | 2a4591c137cb363a6ec09f529d587a10aa7a0bc7 /nixos/modules/services/network-filesystems | |
parent | 330b1e08b8df4e1f0100a0a7810ec3157749e5ee (diff) |
nixos/doc: clean up defaults and examples
Diffstat (limited to 'nixos/modules/services/network-filesystems')
11 files changed, 34 insertions, 54 deletions
diff --git a/nixos/modules/services/network-filesystems/ceph.nix b/nixos/modules/services/network-filesystems/ceph.nix index d833062c47370..e313589134f10 100644 --- a/nixos/modules/services/network-filesystems/ceph.nix +++ b/nixos/modules/services/network-filesystems/ceph.nix @@ -97,6 +97,7 @@ in mgrModulePath = mkOption { type = types.path; default = "${pkgs.ceph.lib}/lib/ceph/mgr"; + defaultText = literalExpression ''"''${pkgs.ceph.lib}/lib/ceph/mgr"''; description = '' Path at which to find ceph-mgr modules. ''; @@ -181,6 +182,7 @@ in rgwMimeTypesFile = mkOption { type = with types; nullOr path; default = "${pkgs.mime-types}/etc/mime.types"; + defaultText = literalExpression ''"''${pkgs.mime-types}/etc/mime.types"''; description = '' Path to mime types used by radosgw. ''; @@ -190,11 +192,9 @@ in extraConfig = mkOption { type = with types; attrsOf str; default = {}; - example = '' - { - "ms bind ipv6" = "true"; - }; - ''; + example = { + "ms bind ipv6" = "true"; + }; description = '' Extra configuration to add to the global section. Use for setting values that are common for all daemons in the cluster. ''; @@ -205,9 +205,7 @@ in daemons = mkOption { type = with types; listOf str; default = []; - example = '' - [ "name1" "name2" ]; - ''; + example = [ "name1" "name2" ]; description = '' A list of names for manager daemons that should have a service created. The names correspond to the id part in ceph i.e. [ "name1" ] would result in mgr.name1 @@ -227,9 +225,7 @@ in daemons = mkOption { type = with types; listOf str; default = []; - example = '' - [ "name1" "name2" ]; - ''; + example = [ "name1" "name2" ]; description = '' A list of monitor daemons that should have a service created. The names correspond to the id part in ceph i.e. [ "name1" ] would result in mon.name1 @@ -249,9 +245,7 @@ in daemons = mkOption { type = with types; listOf str; default = []; - example = '' - [ "name1" "name2" ]; - ''; + example = [ "name1" "name2" ]; description = '' A list of OSD daemons that should have a service created. The names correspond to the id part in ceph i.e. [ "name1" ] would result in osd.name1 @@ -279,9 +273,7 @@ in daemons = mkOption { type = with types; listOf str; default = []; - example = '' - [ "name1" "name2" ]; - ''; + example = [ "name1" "name2" ]; description = '' A list of metadata service daemons that should have a service created. The names correspond to the id part in ceph i.e. [ "name1" ] would result in mds.name1 @@ -301,9 +293,7 @@ in daemons = mkOption { type = with types; listOf str; default = []; - example = '' - [ "name1" "name2" ]; - ''; + example = [ "name1" "name2" ]; description = '' A list of rados gateway daemons that should have a service created. The names correspond to the id part in ceph i.e. [ "name1" ] would result in client.name1, radosgw daemons @@ -318,7 +308,7 @@ in extraConfig = mkOption { type = with types; attrsOf (attrsOf str); default = {}; - example = '' + example = literalExpression '' { # This would create a section for a radosgw daemon named node0 and related # configuration for it diff --git a/nixos/modules/services/network-filesystems/glusterfs.nix b/nixos/modules/services/network-filesystems/glusterfs.nix index d70092999f674..bc8be05ca8cb1 100644 --- a/nixos/modules/services/network-filesystems/glusterfs.nix +++ b/nixos/modules/services/network-filesystems/glusterfs.nix @@ -113,19 +113,16 @@ in type = types.nullOr (types.submodule { options = { tlsKeyPath = mkOption { - default = null; type = types.str; description = "Path to the private key used for TLS."; }; tlsPem = mkOption { - default = null; type = types.path; description = "Path to the certificate used for TLS."; }; caCert = mkOption { - default = null; type = types.path; description = "Path certificate authority used to sign the cluster certificates."; }; diff --git a/nixos/modules/services/network-filesystems/ipfs.nix b/nixos/modules/services/network-filesystems/ipfs.nix index faa515835b678..36b72ca48b2c3 100644 --- a/nixos/modules/services/network-filesystems/ipfs.nix +++ b/nixos/modules/services/network-filesystems/ipfs.nix @@ -57,7 +57,7 @@ in package = mkOption { type = types.package; default = pkgs.ipfs; - defaultText = "pkgs.ipfs"; + defaultText = literalExpression "pkgs.ipfs"; description = "Which IPFS package to use."; }; diff --git a/nixos/modules/services/network-filesystems/litestream/default.nix b/nixos/modules/services/network-filesystems/litestream/default.nix index f1806c5af0a94..51eb920d778dc 100644 --- a/nixos/modules/services/network-filesystems/litestream/default.nix +++ b/nixos/modules/services/network-filesystems/litestream/default.nix @@ -13,7 +13,7 @@ in package = mkOption { description = "Package to use."; default = pkgs.litestream; - defaultText = "pkgs.litestream"; + defaultText = literalExpression "pkgs.litestream"; type = types.package; }; diff --git a/nixos/modules/services/network-filesystems/openafs/client.nix b/nixos/modules/services/network-filesystems/openafs/client.nix index 03884cb729760..c8cc5052c2ace 100644 --- a/nixos/modules/services/network-filesystems/openafs/client.nix +++ b/nixos/modules/services/network-filesystems/openafs/client.nix @@ -4,7 +4,7 @@ with import ./lib.nix { inherit config lib pkgs; }; let - inherit (lib) getBin mkOption mkIf optionalString singleton types; + inherit (lib) getBin literalExpression mkOption mkIf optionalString singleton types; cfg = config.services.openafsClient; @@ -57,11 +57,10 @@ in CellServDB. See CellServDB(5) man page for syntax. Ignored when <literal>afsdb</literal> is set to <literal>true</literal>. ''; - example = '' - [ { ip = "1.2.3.4"; dnsname = "first.afsdb.server.dns.fqdn.org"; } - { ip = "2.3.4.5"; dnsname = "second.afsdb.server.dns.fqdn.org"; } - ] - ''; + example = [ + { ip = "1.2.3.4"; dnsname = "first.afsdb.server.dns.fqdn.org"; } + { ip = "2.3.4.5"; dnsname = "second.afsdb.server.dns.fqdn.org"; } + ]; }; cache = { @@ -149,13 +148,13 @@ in packages = { module = mkOption { default = config.boot.kernelPackages.openafs; - defaultText = "config.boot.kernelPackages.openafs"; + defaultText = literalExpression "config.boot.kernelPackages.openafs"; type = types.package; description = "OpenAFS kernel module package. MUST match the userland package!"; }; programs = mkOption { default = getBin pkgs.openafs; - defaultText = "getBin pkgs.openafs"; + defaultText = literalExpression "getBin pkgs.openafs"; type = types.package; description = "OpenAFS programs package. MUST match the kernel module package!"; }; diff --git a/nixos/modules/services/network-filesystems/openafs/server.nix b/nixos/modules/services/network-filesystems/openafs/server.nix index 4fce650b01336..c1bf83be77b91 100644 --- a/nixos/modules/services/network-filesystems/openafs/server.nix +++ b/nixos/modules/services/network-filesystems/openafs/server.nix @@ -4,7 +4,7 @@ with import ./lib.nix { inherit config lib pkgs; }; let - inherit (lib) concatStringsSep mkIf mkOption optionalString types; + inherit (lib) concatStringsSep literalExpression mkIf mkOption optionalString types; bosConfig = pkgs.writeText "BosConfig" ('' restrictmode 1 @@ -81,7 +81,7 @@ in { package = mkOption { default = pkgs.openafs.server or pkgs.openafs; - defaultText = "pkgs.openafs.server or pkgs.openafs"; + defaultText = literalExpression "pkgs.openafs.server or pkgs.openafs"; type = types.package; description = "OpenAFS package for the server binaries"; }; diff --git a/nixos/modules/services/network-filesystems/orangefs/client.nix b/nixos/modules/services/network-filesystems/orangefs/client.nix index b69d9e713c3dc..36ea5af2168d0 100644 --- a/nixos/modules/services/network-filesystems/orangefs/client.nix +++ b/nixos/modules/services/network-filesystems/orangefs/client.nix @@ -47,7 +47,6 @@ in { target = mkOption { type = types.str; - default = null; example = "tcp://server:3334/orangefs"; description = "Target URL"; }; diff --git a/nixos/modules/services/network-filesystems/orangefs/server.nix b/nixos/modules/services/network-filesystems/orangefs/server.nix index 8c55ccf5ffb0d..621c2fe8f78df 100644 --- a/nixos/modules/services/network-filesystems/orangefs/server.nix +++ b/nixos/modules/services/network-filesystems/orangefs/server.nix @@ -118,12 +118,10 @@ in { servers = mkOption { type = with types; attrsOf types.str; default = {}; - example = '' - { - node1="tcp://node1:3334"; - node2="tcp://node2:3334"; - } - ''; + example = { + node1 = "tcp://node1:3334"; + node2 = "tcp://node2:3334"; + }; description = "URLs for storage server including port. The attribute names define the server alias."; }; @@ -132,8 +130,7 @@ in { These options will create the <literal><FileSystem></literal> sections of config file. ''; default = { orangefs = {}; }; - defaultText = literalExample "{ orangefs = {}; }"; - example = literalExample '' + example = literalExpression '' { fs1 = { id = 101; diff --git a/nixos/modules/services/network-filesystems/samba.nix b/nixos/modules/services/network-filesystems/samba.nix index 78ea245cb3519..3fedaeb49529b 100644 --- a/nixos/modules/services/network-filesystems/samba.nix +++ b/nixos/modules/services/network-filesystems/samba.nix @@ -117,8 +117,8 @@ in package = mkOption { type = types.package; default = pkgs.samba; - defaultText = "pkgs.samba"; - example = literalExample "pkgs.samba4Full"; + defaultText = literalExpression "pkgs.samba"; + example = literalExpression "pkgs.samba4Full"; description = '' Defines which package should be used for the samba server. ''; @@ -176,7 +176,7 @@ in See <command>man smb.conf</command> for options. ''; type = types.attrsOf (types.attrsOf types.unspecified); - example = literalExample '' + example = literalExpression '' { public = { path = "/srv/public"; "read only" = true; diff --git a/nixos/modules/services/network-filesystems/tahoe.nix b/nixos/modules/services/network-filesystems/tahoe.nix index 7d75eb286106b..5426463dffaca 100644 --- a/nixos/modules/services/network-filesystems/tahoe.nix +++ b/nixos/modules/services/network-filesystems/tahoe.nix @@ -34,9 +34,8 @@ in }; package = mkOption { default = pkgs.tahoelafs; - defaultText = "pkgs.tahoelafs"; + defaultText = literalExpression "pkgs.tahoelafs"; type = types.package; - example = literalExample "pkgs.tahoelafs"; description = '' The package to use for the Tahoe LAFS daemon. ''; @@ -179,9 +178,8 @@ in }; package = mkOption { default = pkgs.tahoelafs; - defaultText = "pkgs.tahoelafs"; + defaultText = literalExpression "pkgs.tahoelafs"; type = types.package; - example = literalExample "pkgs.tahoelafs"; description = '' The package to use for the Tahoe LAFS daemon. ''; diff --git a/nixos/modules/services/network-filesystems/xtreemfs.nix b/nixos/modules/services/network-filesystems/xtreemfs.nix index 6cc8a05ee00b0..fc07231157877 100644 --- a/nixos/modules/services/network-filesystems/xtreemfs.nix +++ b/nixos/modules/services/network-filesystems/xtreemfs.nix @@ -142,7 +142,7 @@ in ''; }; syncMode = mkOption { - type = types.enum [ "ASYNC" "SYNC_WRITE_METADATA" "SYNC_WRITE" "FDATASYNC" "ASYNC" ]; + type = types.enum [ "ASYNC" "SYNC_WRITE_METADATA" "SYNC_WRITE" "FDATASYNC" "FSYNC" ]; default = "FSYNC"; example = "FDATASYNC"; description = '' @@ -268,7 +268,7 @@ in }; syncMode = mkOption { default = "FSYNC"; - type = types.enum [ "ASYNC" "SYNC_WRITE_METADATA" "SYNC_WRITE" "FDATASYNC" "ASYNC" ]; + type = types.enum [ "ASYNC" "SYNC_WRITE_METADATA" "SYNC_WRITE" "FDATASYNC" "FSYNC" ]; example = "FDATASYNC"; description = '' The sync mode influences how operations are committed to the disk |