diff options
Diffstat (limited to 'nixpkgs/nixos/modules/services/network-filesystems/ceph.nix')
| -rw-r--r-- | nixpkgs/nixos/modules/services/network-filesystems/ceph.nix | 60 |
1 files changed, 30 insertions, 30 deletions
diff --git a/nixpkgs/nixos/modules/services/network-filesystems/ceph.nix b/nixpkgs/nixos/modules/services/network-filesystems/ceph.nix index df9a2f802bb9..d375434a1bd4 100644 --- a/nixpkgs/nixos/modules/services/network-filesystems/ceph.nix +++ b/nixpkgs/nixos/modules/services/network-filesystems/ceph.nix @@ -71,7 +71,7 @@ in options.services.ceph = { # Ceph has a monolithic configuration file but different sections for # each daemon, a separate client section and a global section - enable = mkEnableOption (lib.mdDoc "Ceph global configuration"); + enable = mkEnableOption "Ceph global configuration"; global = { fsid = mkOption { @@ -79,7 +79,7 @@ in example = '' 433a2193-4f8a-47a0-95d2-209d7ca2cca5 ''; - description = lib.mdDoc '' + description = '' Filesystem ID, a generated uuid, its must be generated and set before attempting to start a cluster ''; @@ -88,7 +88,7 @@ in clusterName = mkOption { type = types.str; default = "ceph"; - description = lib.mdDoc '' + description = '' Name of cluster ''; }; @@ -97,7 +97,7 @@ in type = types.path; default = "${pkgs.ceph.lib}/lib/ceph/mgr"; defaultText = literalExpression ''"''${pkgs.ceph.lib}/lib/ceph/mgr"''; - description = lib.mdDoc '' + description = '' Path at which to find ceph-mgr modules. ''; }; @@ -108,7 +108,7 @@ in example = '' node0, node1, node2 ''; - description = lib.mdDoc '' + description = '' List of hosts that will be used as monitors at startup. ''; }; @@ -119,7 +119,7 @@ in example = '' 10.10.0.1, 10.10.0.2, 10.10.0.3 ''; - description = lib.mdDoc '' + description = '' List of hostname shortnames/IP addresses of the initial monitors. ''; }; @@ -127,7 +127,7 @@ in maxOpenFiles = mkOption { type = types.int; default = 131072; - description = lib.mdDoc '' + description = '' Max open files for each OSD daemon. ''; }; @@ -135,7 +135,7 @@ in authClusterRequired = mkOption { type = types.enum [ "cephx" "none" ]; default = "cephx"; - description = lib.mdDoc '' + description = '' Enables requiring daemons to authenticate with eachother in the cluster. ''; }; @@ -143,7 +143,7 @@ in authServiceRequired = mkOption { type = types.enum [ "cephx" "none" ]; default = "cephx"; - description = lib.mdDoc '' + description = '' Enables requiring clients to authenticate with the cluster to access services in the cluster (e.g. radosgw, mds or osd). ''; }; @@ -151,7 +151,7 @@ in authClientRequired = mkOption { type = types.enum [ "cephx" "none" ]; default = "cephx"; - description = lib.mdDoc '' + description = '' Enables requiring the cluster to authenticate itself to the client. ''; }; @@ -162,7 +162,7 @@ in example = '' 10.20.0.0/24, 192.168.1.0/24 ''; - description = lib.mdDoc '' + description = '' A comma-separated list of subnets that will be used as public networks in the cluster. ''; }; @@ -173,7 +173,7 @@ in example = '' 10.10.0.0/24, 192.168.0.0/24 ''; - description = lib.mdDoc '' + description = '' A comma-separated list of subnets that will be used as cluster networks in the cluster. ''; }; @@ -182,7 +182,7 @@ in type = with types; nullOr path; default = "${pkgs.mailcap}/etc/mime.types"; defaultText = literalExpression ''"''${pkgs.mailcap}/etc/mime.types"''; - description = lib.mdDoc '' + description = '' Path to mime types used by radosgw. ''; }; @@ -194,18 +194,18 @@ in example = { "ms bind ipv6" = "true"; }; - description = lib.mdDoc '' + description = '' Extra configuration to add to the global section. Use for setting values that are common for all daemons in the cluster. ''; }; mgr = { - enable = mkEnableOption (lib.mdDoc "Ceph MGR daemon"); + enable = mkEnableOption "Ceph MGR daemon"; daemons = mkOption { type = with types; listOf str; default = []; example = [ "name1" "name2" ]; - description = lib.mdDoc '' + 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 ''; @@ -214,19 +214,19 @@ in extraConfig = mkOption { type = with types; attrsOf str; default = {}; - description = lib.mdDoc '' + description = '' Extra configuration to add to the global section for manager daemons. ''; }; }; mon = { - enable = mkEnableOption (lib.mdDoc "Ceph MON daemon"); + enable = mkEnableOption "Ceph MON daemon"; daemons = mkOption { type = with types; listOf str; default = []; example = [ "name1" "name2" ]; - description = lib.mdDoc '' + 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 ''; @@ -235,19 +235,19 @@ in extraConfig = mkOption { type = with types; attrsOf str; default = {}; - description = lib.mdDoc '' + description = '' Extra configuration to add to the monitor section. ''; }; }; osd = { - enable = mkEnableOption (lib.mdDoc "Ceph OSD daemon"); + enable = mkEnableOption "Ceph OSD daemon"; daemons = mkOption { type = with types; listOf str; default = []; example = [ "name1" "name2" ]; - description = lib.mdDoc '' + 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 ''; @@ -263,19 +263,19 @@ in "osd pool default pgp num" = "200"; "osd crush chooseleaf type" = "1"; }; - description = lib.mdDoc '' + description = '' Extra configuration to add to the OSD section. ''; }; }; mds = { - enable = mkEnableOption (lib.mdDoc "Ceph MDS daemon"); + enable = mkEnableOption "Ceph MDS daemon"; daemons = mkOption { type = with types; listOf str; default = []; example = [ "name1" "name2" ]; - description = lib.mdDoc '' + 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 ''; @@ -284,20 +284,20 @@ in extraConfig = mkOption { type = with types; attrsOf str; default = {}; - description = lib.mdDoc '' + description = '' Extra configuration to add to the MDS section. ''; }; }; rgw = { - enable = mkEnableOption (lib.mdDoc "Ceph RadosGW daemon"); + enable = mkEnableOption "Ceph RadosGW daemon"; package = mkPackageOption pkgs "ceph" { }; daemons = mkOption { type = with types; listOf str; default = []; example = [ "name1" "name2" ]; - description = lib.mdDoc '' + 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 aren't daemons to cluster in the sense that OSD, MGR or MON daemons are. They are simply @@ -307,7 +307,7 @@ in }; client = { - enable = mkEnableOption (lib.mdDoc "Ceph client configuration"); + enable = mkEnableOption "Ceph client configuration"; extraConfig = mkOption { type = with types; attrsOf (attrsOf str); default = {}; @@ -318,7 +318,7 @@ in "client.radosgw.node0" = { "some config option" = "true"; }; }; ''; - description = lib.mdDoc '' + description = '' Extra configuration to add to the client section. Configuration for rados gateways would be added here, with their own sections, see example. ''; |