diff options
Diffstat (limited to 'nixpkgs/nixos/modules/services/misc/etcd.nix')
-rw-r--r-- | nixpkgs/nixos/modules/services/misc/etcd.nix | 42 |
1 files changed, 21 insertions, 21 deletions
diff --git a/nixpkgs/nixos/modules/services/misc/etcd.nix b/nixpkgs/nixos/modules/services/misc/etcd.nix index 3925b7dd1636..3343e94778a2 100644 --- a/nixpkgs/nixos/modules/services/misc/etcd.nix +++ b/nixpkgs/nixos/modules/services/misc/etcd.nix @@ -10,124 +10,124 @@ in { options.services.etcd = { enable = mkOption { - description = "Whether to enable etcd."; + description = lib.mdDoc "Whether to enable etcd."; default = false; type = types.bool; }; name = mkOption { - description = "Etcd unique node name."; + description = lib.mdDoc "Etcd unique node name."; default = config.networking.hostName; defaultText = literalExpression "config.networking.hostName"; type = types.str; }; advertiseClientUrls = mkOption { - description = "Etcd list of this member's client URLs to advertise to the rest of the cluster."; + description = lib.mdDoc "Etcd list of this member's client URLs to advertise to the rest of the cluster."; default = cfg.listenClientUrls; defaultText = literalExpression "config.${opt.listenClientUrls}"; type = types.listOf types.str; }; listenClientUrls = mkOption { - description = "Etcd list of URLs to listen on for client traffic."; + description = lib.mdDoc "Etcd list of URLs to listen on for client traffic."; default = ["http://127.0.0.1:2379"]; type = types.listOf types.str; }; listenPeerUrls = mkOption { - description = "Etcd list of URLs to listen on for peer traffic."; + description = lib.mdDoc "Etcd list of URLs to listen on for peer traffic."; default = ["http://127.0.0.1:2380"]; type = types.listOf types.str; }; initialAdvertisePeerUrls = mkOption { - description = "Etcd list of this member's peer URLs to advertise to rest of the cluster."; + description = lib.mdDoc "Etcd list of this member's peer URLs to advertise to rest of the cluster."; default = cfg.listenPeerUrls; defaultText = literalExpression "config.${opt.listenPeerUrls}"; type = types.listOf types.str; }; initialCluster = mkOption { - description = "Etcd initial cluster configuration for bootstrapping."; + description = lib.mdDoc "Etcd initial cluster configuration for bootstrapping."; default = ["${cfg.name}=http://127.0.0.1:2380"]; defaultText = literalExpression ''["''${config.${opt.name}}=http://127.0.0.1:2380"]''; type = types.listOf types.str; }; initialClusterState = mkOption { - description = "Etcd initial cluster configuration for bootstrapping."; + description = lib.mdDoc "Etcd initial cluster configuration for bootstrapping."; default = "new"; type = types.enum ["new" "existing"]; }; initialClusterToken = mkOption { - description = "Etcd initial cluster token for etcd cluster during bootstrap."; + description = lib.mdDoc "Etcd initial cluster token for etcd cluster during bootstrap."; default = "etcd-cluster"; type = types.str; }; discovery = mkOption { - description = "Etcd discovery url"; + description = lib.mdDoc "Etcd discovery url"; default = ""; type = types.str; }; clientCertAuth = mkOption { - description = "Whether to use certs for client authentication"; + description = lib.mdDoc "Whether to use certs for client authentication"; default = false; type = types.bool; }; trustedCaFile = mkOption { - description = "Certificate authority file to use for clients"; + description = lib.mdDoc "Certificate authority file to use for clients"; default = null; type = types.nullOr types.path; }; certFile = mkOption { - description = "Cert file to use for clients"; + description = lib.mdDoc "Cert file to use for clients"; default = null; type = types.nullOr types.path; }; keyFile = mkOption { - description = "Key file to use for clients"; + description = lib.mdDoc "Key file to use for clients"; default = null; type = types.nullOr types.path; }; peerCertFile = mkOption { - description = "Cert file to use for peer to peer communication"; + description = lib.mdDoc "Cert file to use for peer to peer communication"; default = cfg.certFile; defaultText = literalExpression "config.${opt.certFile}"; type = types.nullOr types.path; }; peerKeyFile = mkOption { - description = "Key file to use for peer to peer communication"; + description = lib.mdDoc "Key file to use for peer to peer communication"; default = cfg.keyFile; defaultText = literalExpression "config.${opt.keyFile}"; type = types.nullOr types.path; }; peerTrustedCaFile = mkOption { - description = "Certificate authority file to use for peer to peer communication"; + description = lib.mdDoc "Certificate authority file to use for peer to peer communication"; default = cfg.trustedCaFile; defaultText = literalExpression "config.${opt.trustedCaFile}"; type = types.nullOr types.path; }; peerClientCertAuth = mkOption { - description = "Whether to check all incoming peer requests from the cluster for valid client certificates signed by the supplied CA"; + description = lib.mdDoc "Whether to check all incoming peer requests from the cluster for valid client certificates signed by the supplied CA"; default = false; type = types.bool; }; extraConf = mkOption { - description = '' + description = lib.mdDoc '' Etcd extra configuration. See - <link xlink:href='https://github.com/coreos/etcd/blob/master/Documentation/op-guide/configuration.md#configuration-flags' /> + <https://github.com/coreos/etcd/blob/master/Documentation/op-guide/configuration.md#configuration-flags> ''; type = types.attrsOf types.str; default = {}; @@ -145,7 +145,7 @@ in { dataDir = mkOption { type = types.path; default = "/var/lib/etcd"; - description = "Etcd data directory."; + description = lib.mdDoc "Etcd data directory."; }; }; |