diff options
| author | pennae <github@quasiparticle.net> | 2022-07-28 23:19:15 +0200 |
|---|---|---|
| committer | pennae <github@quasiparticle.net> | 2022-07-30 15:16:34 +0200 |
| commit | 2e751c0772b9d48ff6923569adfa661b030ab6a2 (patch) | |
| tree | 0accd740380b7b7fe3ea5965a3a4517674e79260 /nixos/modules/services/monitoring | |
| parent | 52b0ad17e3727fe0c3ca028787128ede5fb86352 (diff) | |
treewide: automatically md-convert option descriptions
the conversion procedure is simple: - find all things that look like options, ie calls to either `mkOption` or `lib.mkOption` that take an attrset. remember the attrset as the option - for all options, find a `description` attribute who's value is not a call to `mdDoc` or `lib.mdDoc` - textually convert the entire value of the attribute to MD with a few simple regexes (the set from mdize-module.sh) - if the change produced a change in the manual output, discard - if the change kept the manual unchanged, add some text to the description to make sure we've actually found an option. if the manual changes this time, keep the converted description this procedure converts 80% of nixos options to markdown. around 2000 options remain to be inspected, but most of those fail the "does not change the manual output check": currently the MD conversion process does not faithfully convert docbook tags like <code> and <package>, so any option using such tags will not be converted at all.
Diffstat (limited to 'nixos/modules/services/monitoring')
46 files changed, 573 insertions, 573 deletions
diff --git a/nixos/modules/services/monitoring/alerta.nix b/nixos/modules/services/monitoring/alerta.nix index a73d94001f710..c0caa0dc3beb1 100644 --- a/nixos/modules/services/monitoring/alerta.nix +++ b/nixos/modules/services/monitoring/alerta.nix @@ -26,53 +26,53 @@ in port = mkOption { type = types.int; default = 5000; - description = "Port of Alerta"; + description = lib.mdDoc "Port of Alerta"; }; bind = mkOption { type = types.str; default = "0.0.0.0"; - description = "Address to bind to. The default is to bind to all addresses"; + description = lib.mdDoc "Address to bind to. The default is to bind to all addresses"; }; logDir = mkOption { type = types.path; - description = "Location where the logfiles are stored"; + description = lib.mdDoc "Location where the logfiles are stored"; default = "/var/log/alerta"; }; databaseUrl = mkOption { type = types.str; - description = "URL of the MongoDB or PostgreSQL database to connect to"; + description = lib.mdDoc "URL of the MongoDB or PostgreSQL database to connect to"; default = "mongodb://localhost"; }; databaseName = mkOption { type = types.str; - description = "Name of the database instance to connect to"; + description = lib.mdDoc "Name of the database instance to connect to"; default = "monitoring"; }; corsOrigins = mkOption { type = types.listOf types.str; - description = "List of URLs that can access the API for Cross-Origin Resource Sharing (CORS)"; + description = lib.mdDoc "List of URLs that can access the API for Cross-Origin Resource Sharing (CORS)"; default = [ "http://localhost" "http://localhost:5000" ]; }; authenticationRequired = mkOption { type = types.bool; - description = "Whether users must authenticate when using the web UI or command-line tool"; + description = lib.mdDoc "Whether users must authenticate when using the web UI or command-line tool"; default = false; }; signupEnabled = mkOption { type = types.bool; - description = "Whether to prevent sign-up of new users via the web UI"; + description = lib.mdDoc "Whether to prevent sign-up of new users via the web UI"; default = true; }; extraConfig = mkOption { - description = "These lines go into alertad.conf verbatim."; + description = lib.mdDoc "These lines go into alertad.conf verbatim."; default = ""; type = types.lines; }; diff --git a/nixos/modules/services/monitoring/apcupsd.nix b/nixos/modules/services/monitoring/apcupsd.nix index 1dccbc93edf84..d4216b44cdc8c 100644 --- a/nixos/modules/services/monitoring/apcupsd.nix +++ b/nixos/modules/services/monitoring/apcupsd.nix @@ -75,7 +75,7 @@ in enable = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' Whether to enable the APC UPS daemon. apcupsd monitors your UPS and permits orderly shutdown of your computer in the event of a power failure. User manual: http://www.apcupsd.com/manual/manual.html. @@ -92,7 +92,7 @@ in MINUTES 5 ''; type = types.lines; - description = '' + description = lib.mdDoc '' Contents of the runtime configuration file, apcupsd.conf. The default settings makes apcupsd autodetect USB UPSes, limit network access to localhost and shutdown the system when the battery level is below 50 @@ -107,7 +107,7 @@ in doshutdown = "# shell commands to notify that the computer is shutting down"; }; type = types.attrsOf types.lines; - description = '' + description = lib.mdDoc '' Each attribute in this option names an apcupsd event and the string value it contains will be executed in a shell, in response to that event (prior to the default action). See "man apccontrol" for the diff --git a/nixos/modules/services/monitoring/arbtt.nix b/nixos/modules/services/monitoring/arbtt.nix index 94eead220aed6..8bf4f78cc7279 100644 --- a/nixos/modules/services/monitoring/arbtt.nix +++ b/nixos/modules/services/monitoring/arbtt.nix @@ -10,7 +10,7 @@ in { enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Enable the arbtt statistics capture service. ''; }; @@ -19,7 +19,7 @@ in { type = types.package; default = pkgs.haskellPackages.arbtt; defaultText = literalExpression "pkgs.haskellPackages.arbtt"; - description = '' + description = lib.mdDoc '' The package to use for the arbtt binaries. ''; }; @@ -28,7 +28,7 @@ in { type = types.str; default = "%h/.arbtt/capture.log"; example = "/home/username/.arbtt-capture.log"; - description = '' + description = lib.mdDoc '' The log file for captured samples. ''; }; @@ -37,7 +37,7 @@ in { type = types.int; default = 60; example = 120; - description = '' + description = lib.mdDoc '' The sampling interval in seconds. ''; }; diff --git a/nixos/modules/services/monitoring/bosun.nix b/nixos/modules/services/monitoring/bosun.nix index 4b278b9c200b9..27966e089eb9e 100644 --- a/nixos/modules/services/monitoring/bosun.nix +++ b/nixos/modules/services/monitoring/bosun.nix @@ -25,7 +25,7 @@ in { enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to run bosun. ''; }; @@ -34,7 +34,7 @@ in { type = types.package; default = pkgs.bosun; defaultText = literalExpression "pkgs.bosun"; - description = '' + description = lib.mdDoc '' bosun binary to use. ''; }; @@ -42,7 +42,7 @@ in { user = mkOption { type = types.str; default = "bosun"; - description = '' + description = lib.mdDoc '' User account under which bosun runs. ''; }; @@ -50,7 +50,7 @@ in { group = mkOption { type = types.str; default = "bosun"; - description = '' + description = lib.mdDoc '' Group account under which bosun runs. ''; }; @@ -58,7 +58,7 @@ in { opentsdbHost = mkOption { type = types.nullOr types.str; default = "localhost:4242"; - description = '' + description = lib.mdDoc '' Host and port of the OpenTSDB database that stores bosun data. To disable opentsdb you can pass null as parameter. ''; @@ -68,7 +68,7 @@ in { type = types.nullOr types.str; default = null; example = "localhost:8086"; - description = '' + description = lib.mdDoc '' Host and port of the influxdb database. ''; }; @@ -76,7 +76,7 @@ in { listenAddress = mkOption { type = types.str; default = ":8070"; - description = '' + description = lib.mdDoc '' The host address and port that bosun's web interface will listen on. ''; }; @@ -84,7 +84,7 @@ in { stateFile = mkOption { type = types.path; default = "/var/lib/bosun/bosun.state"; - description = '' + description = lib.mdDoc '' Path to bosun's state file. ''; }; @@ -92,7 +92,7 @@ in { ledisDir = mkOption { type = types.path; default = "/var/lib/bosun/ledis_data"; - description = '' + description = lib.mdDoc '' Path to bosun's ledis data dir ''; }; @@ -100,7 +100,7 @@ in { checkFrequency = mkOption { type = types.str; default = "5m"; - description = '' + description = lib.mdDoc '' Bosun's check frequency ''; }; @@ -108,7 +108,7 @@ in { extraConfig = mkOption { type = types.lines; default = ""; - description = '' + description = lib.mdDoc '' Extra configuration options for Bosun. You should describe your desired templates, alerts, macros, etc through this configuration option. diff --git a/nixos/modules/services/monitoring/cadvisor.nix b/nixos/modules/services/monitoring/cadvisor.nix index dfbf07efcaea9..c844b1599dd46 100644 --- a/nixos/modules/services/monitoring/cadvisor.nix +++ b/nixos/modules/services/monitoring/cadvisor.nix @@ -11,56 +11,56 @@ in { enable = mkOption { default = false; type = types.bool; - description = "Whether to enable cadvisor service."; + description = lib.mdDoc "Whether to enable cadvisor service."; }; listenAddress = mkOption { default = "127.0.0.1"; type = types.str; - description = "Cadvisor listening host"; + description = lib.mdDoc "Cadvisor listening host"; }; port = mkOption { default = 8080; type = types.int; - description = "Cadvisor listening port"; + description = lib.mdDoc "Cadvisor listening port"; }; storageDriver = mkOption { default = null; type = types.nullOr types.str; example = "influxdb"; - description = "Cadvisor storage driver."; + description = lib.mdDoc "Cadvisor storage driver."; }; storageDriverHost = mkOption { default = "localhost:8086"; type = types.str; - description = "Cadvisor storage driver host."; + description = lib.mdDoc "Cadvisor storage driver host."; }; storageDriverDb = mkOption { default = "root"; type = types.str; - description = "Cadvisord storage driver database name."; + description = lib.mdDoc "Cadvisord storage driver database name."; }; storageDriverUser = mkOption { default = "root"; type = types.str; - description = "Cadvisor storage driver username."; + description = lib.mdDoc "Cadvisor storage driver username."; }; storageDriverPassword = mkOption { default = "root"; type = types.str; - description = '' + description = lib.mdDoc '' Cadvisor storage driver password. Warning: this password is stored in the world-readable Nix store. It's - recommended to use the <option>storageDriverPasswordFile</option> option + recommended to use the {option}`storageDriverPasswordFile` option since that gives you control over the security of the password. - <option>storageDriverPasswordFile</option> also takes precedence over <option>storageDriverPassword</option>. + {option}`storageDriverPasswordFile` also takes precedence over {option}`storageDriverPassword`. ''; }; @@ -82,7 +82,7 @@ in { storageDriverSecure = mkOption { default = false; type = types.bool; - description = "Cadvisor storage driver, enable secure communication."; + description = lib.mdDoc "Cadvisor storage driver, enable secure communication."; }; extraOptions = mkOption { diff --git a/nixos/modules/services/monitoring/collectd.nix b/nixos/modules/services/monitoring/collectd.nix index 1b9af58575604..5c62d509511d9 100644 --- a/nixos/modules/services/monitoring/collectd.nix +++ b/nixos/modules/services/monitoring/collectd.nix @@ -33,7 +33,7 @@ in { validateConfig = mkOption { default = true; - description = '' + description = lib.mdDoc '' Validate the syntax of collectd configuration file at build time. Disable this if you use the Include directive on files unavailable in the build sandbox, or when cross-compiling. @@ -44,7 +44,7 @@ in { package = mkOption { default = pkgs.collectd; defaultText = literalExpression "pkgs.collectd"; - description = '' + description = lib.mdDoc '' Which collectd package to use. ''; type = types.package; @@ -60,7 +60,7 @@ in { user = mkOption { default = "collectd"; - description = '' + description = lib.mdDoc '' User under which to run collectd. ''; type = nullOr str; @@ -68,7 +68,7 @@ in { dataDir = mkOption { default = "/var/lib/collectd"; - description = '' + description = lib.mdDoc '' Data directory for collectd agent. ''; type = path; @@ -76,7 +76,7 @@ in { autoLoadPlugin = mkOption { default = false; - description = '' + description = lib.mdDoc '' Enable plugin autoloading. ''; type = bool; @@ -84,7 +84,7 @@ in { include = mkOption { default = []; - description = '' + description = lib.mdDoc '' Additional paths to load config from. ''; type = listOf str; @@ -93,7 +93,7 @@ in { plugins = mkOption { default = {}; example = { cpu = ""; memory = ""; network = "Server 192.168.1.1 25826"; }; - description = '' + description = lib.mdDoc '' Attribute set of plugin names to plugin config segments ''; type = attrsOf lines; @@ -101,7 +101,7 @@ in { extraConfig = mkOption { default = ""; - description = '' + description = lib.mdDoc '' Extra configuration for collectd. Use mkBefore to add lines before the default config, and mkAfter to add them below. ''; diff --git a/nixos/modules/services/monitoring/datadog-agent.nix b/nixos/modules/services/monitoring/datadog-agent.nix index 6d9d1ef973a44..9b984fafc12b5 100644 --- a/nixos/modules/services/monitoring/datadog-agent.nix +++ b/nixos/modules/services/monitoring/datadog-agent.nix @@ -50,7 +50,7 @@ let in { options.services.datadog-agent = { enable = mkOption { - description = '' + description = lib.mdDoc '' Whether to enable the datadog-agent v7 monitoring service ''; default = false; @@ -70,7 +70,7 @@ in { }; apiKeyFile = mkOption { - description = '' + description = lib.mdDoc '' Path to a file containing the Datadog API key to associate the agent with your account. ''; @@ -79,7 +79,7 @@ in { }; ddUrl = mkOption { - description = '' + description = lib.mdDoc '' Custom dd_url to configure the agent with. Useful if traffic to datadog needs to go through a proxy. Don't use this to point to another datadog site (EU) - use site instead. @@ -90,7 +90,7 @@ in { }; site = mkOption { - description = '' + description = lib.mdDoc '' The datadog site to point the agent towards. Set to datadoghq.eu to point it to their EU site. ''; @@ -100,21 +100,21 @@ in { }; tags = mkOption { - description = "The tags to mark this Datadog agent"; + description = lib.mdDoc "The tags to mark this Datadog agent"; example = [ "test" "service" ]; default = null; type = types.nullOr (types.listOf types.str); }; hostname = mkOption { - description = "The hostname to show in the Datadog dashboard (optional)"; + description = lib.mdDoc "The hostname to show in the Datadog dashboard (optional)"; default = null; example = "mymachine.mydomain"; type = types.nullOr types.str; }; logLevel = mkOption { - description = "Logging verbosity."; + description = lib.mdDoc "Logging verbosity."; default = null; type = types.nullOr (types.enum ["DEBUG" "INFO" "WARN" "ERROR"]); }; @@ -123,7 +123,7 @@ in { default = {}; type = types.attrs; - description = '' + description = lib.mdDoc '' Extra integrations from the Datadog core-integrations repository that should be built and included. @@ -145,14 +145,14 @@ in { extraConfig = mkOption { default = {}; type = types.attrs; - description = '' + description = lib.mdDoc '' Extra configuration options that will be merged into the - main config file <filename>datadog.yaml</filename>. + main config file {file}`datadog.yaml`. ''; }; enableLiveProcessCollection = mkOption { - description = '' + description = lib.mdDoc '' Whether to enable the live process collection agent. ''; default = false; @@ -160,7 +160,7 @@ in { }; enableTraceAgent = mkOption { - description = '' + description = lib.mdDoc '' Whether to enable the trace agent. ''; default = false; @@ -207,7 +207,7 @@ in { }; diskCheck = mkOption { - description = "Disk check config"; + description = lib.mdDoc "Disk check config"; type = types.attrs; default = { init_config = {}; @@ -216,7 +216,7 @@ in { }; networkCheck = mkOption { - description = "Network check config"; + description = lib.mdDoc "Network check config"; type = types.attrs; default = { init_config = {}; diff --git a/nixos/modules/services/monitoring/dd-agent/dd-agent.nix b/nixos/modules/services/monitoring/dd-agent/dd-agent.nix index a290dae8d4b99..8c0070c4853a6 100644 --- a/nixos/modules/services/monitoring/dd-agent/dd-agent.nix +++ b/nixos/modules/services/monitoring/dd-agent/dd-agent.nix @@ -112,68 +112,68 @@ let in { options.services.dd-agent = { enable = mkOption { - description = '' + description = lib.mdDoc '' Whether to enable the dd-agent v5 monitoring service. - For datadog-agent v6, see <option>services.datadog-agent.enable</option>. + For datadog-agent v6, see {option}`services.datadog-agent.enable`. ''; default = false; type = types.bool; }; api_key = mkOption { - description = '' + description = lib.mdDoc '' The Datadog API key to associate the agent with your account. Warning: this key is stored in cleartext within the world-readable Nix store! Consider using the new v6 - <option>services.datadog-agent</option> module instead. + {option}`services.datadog-agent` module instead. ''; example = "ae0aa6a8f08efa988ba0a17578f009ab"; type = types.str; }; tags = mkOption { - description = "The tags to mark this Datadog agent"; + description = lib.mdDoc "The tags to mark this Datadog agent"; example = [ "test" "service" ]; default = null; type = types.nullOr (types.listOf types.str); }; hostname = mkOption { - description = "The hostname to show in the Datadog dashboard (optional)"; + description = lib.mdDoc "The hostname to show in the Datadog dashboard (optional)"; default = null; example = "mymachine.mydomain"; type = types.nullOr types.str; }; postgresqlConfig = mkOption { - description = "Datadog PostgreSQL integration configuration"; + description = lib.mdDoc "Datadog PostgreSQL integration configuration"; default = null; type = types.nullOr types.lines; }; nginxConfig = mkOption { - description = "Datadog nginx integration configuration"; + description = lib.mdDoc "Datadog nginx integration configuration"; default = null; type = types.nullOr types.lines; }; mongoConfig = mkOption { - description = "MongoDB integration configuration"; + description = lib.mdDoc "MongoDB integration configuration"; default = null; type = types.nullOr types.lines; }; jmxConfig = mkOption { - description = "JMX integration configuration"; + description = lib.mdDoc "JMX integration configuration"; default = null; type = types.nullOr types.lines; }; processConfig = mkOption { - description = '' + description = lib.mdDoc '' Process integration configuration - See <link xlink:href="https://docs.datadoghq.com/integrations/process/"/> + See <https://docs.datadoghq.com/integrations/process/> ''; default = null; type = types.nullOr types.lines; diff --git a/nixos/modules/services/monitoring/fusion-inventory.nix b/nixos/modules/services/monitoring/fusion-inventory.nix index 9b65c76ce02e5..6b440e9fa45b3 100644 --- a/nixos/modules/services/monitoring/fusion-inventory.nix +++ b/nixos/modules/services/monitoring/fusion-inventory.nix @@ -26,7 +26,7 @@ in { servers = mkOption { type = types.listOf types.str; - description = '' + description = lib.mdDoc '' The urls of the OCS/GLPI servers to connect to. ''; }; @@ -34,7 +34,7 @@ in { extraConfig = mkOption { default = ""; type = types.lines; - description = '' + description = lib.mdDoc '' Configuration that is injected verbatim into the configuration file. ''; }; diff --git a/nixos/modules/services/monitoring/grafana-agent.nix b/nixos/modules/services/monitoring/grafana-agent.nix index bbeda18464707..7ac0bffe8de27 100644 --- a/nixos/modules/services/monitoring/grafana-agent.nix +++ b/nixos/modules/services/monitoring/grafana-agent.nix @@ -17,11 +17,11 @@ in type = types.package; default = pkgs.grafana-agent; defaultText = "pkgs.grafana-agent"; - description = "The grafana-agent package to use."; + description = lib.mdDoc "The grafana-agent package to use."; }; credentials = mkOption { - description = '' + description = lib.mdDoc '' Credentials to load at service startup. Keys that are UPPER_SNAKE will be loaded as env vars. Values are absolute paths to the credentials. ''; type = types.attrsOf types.str; diff --git a/nixos/modules/services/monitoring/grafana-image-renderer.nix b/nixos/modules/services/monitoring/grafana-image-renderer.nix index b8b95d846c6af..97488f2653a5b 100644 --- a/nixos/modules/services/monitoring/grafana-image-renderer.nix +++ b/nixos/modules/services/monitoring/grafana-image-renderer.nix @@ -14,7 +14,7 @@ in { chromium = mkOption { type = types.package; - description = '' + description = lib.mdDoc '' The chromium to use for image rendering. ''; }; @@ -32,15 +32,15 @@ in { port = mkOption { type = types.port; default = 8081; - description = '' + description = lib.mdDoc '' The TCP port to use for the rendering server. ''; }; logging.level = mkOption { type = types.enum [ "error" "warning" "info" "debug" ]; default = "info"; - description = '' - The log-level of the <filename>grafana-image-renderer.service</filename>-unit. + description = lib.mdDoc '' + The log-level of the {file}`grafana-image-renderer.service`-unit. ''; }; }; @@ -48,14 +48,14 @@ in { width = mkOption { default = 1000; type = types.ints.positive; - description = '' + description = lib.mdDoc '' Width of the PNG used to display the alerting graph. ''; }; height = mkOption { default = 500; type = types.ints.positive; - description = '' + description = lib.mdDoc '' Height of the PNG used to display the alerting graph. ''; }; diff --git a/nixos/modules/services/monitoring/grafana-reporter.nix b/nixos/modules/services/monitoring/grafana-reporter.nix index e40d78f538faf..7a27b5cbce31b 100644 --- a/nixos/modules/services/monitoring/grafana-reporter.nix +++ b/nixos/modules/services/monitoring/grafana-reporter.nix @@ -11,36 +11,36 @@ in { grafana = { protocol = mkOption { - description = "Grafana protocol."; + description = lib.mdDoc "Grafana protocol."; default = "http"; type = types.enum ["http" "https"]; }; addr = mkOption { - description = "Grafana address."; + description = lib.mdDoc "Grafana address."; default = "127.0.0.1"; type = types.str; }; port = mkOption { - description = "Grafana port."; + description = lib.mdDoc "Grafana port."; default = 3000; type = types.int; }; }; addr = mkOption { - description = "Listening address."; + description = lib.mdDoc "Listening address."; default = "127.0.0.1"; type = types.str; }; port = mkOption { - description = "Listening port."; + description = lib.mdDoc "Listening port."; default = 8686; type = types.int; }; templateDir = mkOption { - description = "Optional template directory to use custom tex templates"; + description = lib.mdDoc "Optional template directory to use custom tex templates"; default = pkgs.grafana_reporter; defaultText = literalExpression "pkgs.grafana_reporter"; type = types.either types.str types.path; diff --git a/nixos/modules/services/monitoring/grafana.nix b/nixos/modules/services/monitoring/grafana.nix index 68b4796f4f4ec..456fe92eea386 100644 --- a/nixos/modules/services/monitoring/grafana.nix +++ b/nixos/modules/services/monitoring/grafana.nix @@ -108,90 +108,90 @@ let options = { name = mkOption { type = types.str; - description = "Name of the datasource. Required."; + description = lib.mdDoc "Name of the datasource. Required."; }; type = mkOption { type = types.str; - description = "Datasource type. Required."; + description = lib.mdDoc "Datasource type. Required."; }; access = mkOption { type = types.enum ["proxy" "direct"]; default = "proxy"; - description = "Access mode. proxy or direct (Server or Browser in the UI). Required."; + description = lib.mdDoc "Access mode. proxy or direct (Server or Browser in the UI). Required."; }; orgId = mkOption { type = types.int; default = 1; - description = "Org id. will default to orgId 1 if not specified."; + description = lib.mdDoc "Org id. will default to orgId 1 if not specified."; }; uid = mkOption { type = types.nullOr types.str; default = null; - description = "Custom UID which can be used to reference this datasource in other parts of the configuration, if not specified will be generated automatically."; + description = lib.mdDoc "Custom UID which can be used to reference this datasource in other parts of the configuration, if not specified will be generated automatically."; }; url = mkOption { type = types.str; - description = "Url of the datasource."; + description = lib.mdDoc "Url of the datasource."; }; password = mkOption { type = types.nullOr types.str; default = null; - description = "Database password, if used."; + description = lib.mdDoc "Database password, if used."; }; user = mkOption { type = types.nullOr types.str; default = null; - description = "Database user, if used."; + description = lib.mdDoc "Database user, if used."; }; database = mkOption { type = types.nullOr types.str; default = null; - description = "Database name, if used."; + description = lib.mdDoc "Database name, if used."; }; basicAuth = mkOption { type = types.nullOr types.bool; default = null; - description = "Enable/disable basic auth."; + description = lib.mdDoc "Enable/disable basic auth."; }; basicAuthUser = mkOption { type = types.nullOr types.str; default = null; - description = "Basic auth username."; + description = lib.mdDoc "Basic auth username."; }; basicAuthPassword = mkOption { type = types.nullOr types.str; default = null; - description = "Basic auth password."; + description = lib.mdDoc "Basic auth password."; }; withCredentials = mkOption { type = types.bool; default = false; - description = "Enable/disable with credentials headers."; + description = lib.mdDoc "Enable/disable with credentials headers."; }; isDefault = mkOption { type = types.bool; default = false; - description = "Mark as default datasource. Max one per org."; + description = lib.mdDoc "Mark as default datasource. Max one per org."; }; jsonData = mkOption { type = types.nullOr types.attrs; default = null; - description = "Datasource specific configuration."; + description = lib.mdDoc "Datasource specific configuration."; }; secureJsonData = mkOption { type = types.nullOr types.attrs; default = null; - description = "Datasource specific secure configuration."; + description = lib.mdDoc "Datasource specific secure configuration."; }; version = mkOption { type = types.int; default = 1; - description = "Version."; + description = lib.mdDoc "Version."; }; editable = mkOption { type = types.bool; default = false; - description = "Allow users to edit datasources from the UI."; + description = lib.mdDoc "Allow users to edit datasources from the UI."; }; }; }; @@ -202,42 +202,42 @@ let name = mkOption { type = types.str; default = "default"; - description = "Provider name."; + description = lib.mdDoc "Provider name."; }; orgId = mkOption { type = types.int; default = 1; - description = "Organization ID."; + description = lib.mdDoc "Organization ID."; }; folder = mkOption { type = types.str; default = ""; - description = "Add dashboards to the specified folder."; + description = lib.mdDoc "Add dashboards to the specified folder."; }; type = mkOption { type = types.str; default = "file"; - description = "Dashboard provider type."; + description = lib.mdDoc "Dashboard provider type."; }; disableDeletion = mkOption { type = types.bool; default = false; - description = "Disable deletion when JSON file is removed."; + description = lib.mdDoc "Disable deletion when JSON file is removed."; }; updateIntervalSeconds = mkOption { type = types.int; default = 10; - description = "How often Grafana will scan for changed dashboards."; + description = lib.mdDoc "How often Grafana will scan for changed dashboards."; }; options = { path = mkOption { type = types.path; - description = "Path grafana will watch for dashboards."; + description = lib.mdDoc "Path grafana will watch for dashboards."; }; foldersFromFilesStructure = mkOption { type = types.bool; default = false; - description = "Use folder names from filesystem to create folders in Grafana."; + description = lib.mdDoc "Use folder names from filesystem to create folders in Grafana."; }; }; }; @@ -248,55 +248,55 @@ let name = mkOption { type = types.str; default = "default"; - description = "Notifier name."; + description = lib.mdDoc "Notifier name."; }; type = mkOption { type = types.enum ["dingding" "discord" "email" "googlechat" "hipchat" "kafka" "line" "teams" "opsgenie" "pagerduty" "prometheus-alertmanager" "pushover" "sensu" "sensugo" "slack" "telegram" "threema" "victorops" "webhook"]; - description = "Notifier type."; + description = lib.mdDoc "Notifier type."; }; uid = mkOption { type = types.str; - description = "Unique notifier identifier."; + description = lib.mdDoc "Unique notifier identifier."; }; org_id = mkOption { type = types.int; default = 1; - description = "Organization ID."; + description = lib.mdDoc "Organization ID."; }; org_name = mkOption { type = types.str; default = "Main Org."; - description = "Organization name."; + description = lib.mdDoc "Organization name."; }; is_default = mkOption { type = types.bool; - description = "Is the default notifier."; + description = lib.mdDoc "Is the default notifier."; default = false; }; send_reminder = mkOption { type = types.bool; default = true; - description = "Should the notifier be sent reminder notifications while alerts continue to fire."; + description = lib.mdDoc "Should the notifier be sent reminder notifications while alerts continue to fire."; }; frequency = mkOption { type = types.str; default = "5m"; - description = "How frequently should the notifier be sent reminders."; + description = lib.mdDoc "How frequently should the notifier be sent reminders."; }; disable_resolve_message = mkOption { type = types.bool; default = false; - description = "Turn off the message that sends when an alert returns to OK."; + description = lib.mdDoc "Turn off the message that sends when an alert returns to OK."; }; settings = mkOption { type = types.nullOr types.attrs; default = null; - description = "Settings for the notifier type."; + description = lib.mdDoc "Settings for the notifier type."; }; secure_settings = mkOption { type = types.nullOr types.attrs; default = null; - description = "Secure settings for the notifier type."; + description = lib.mdDoc "Secure settings for the notifier type."; }; }; }; @@ -305,62 +305,62 @@ in { enable = mkEnableOption "grafana"; protocol = mkOption { - description = "Which protocol to listen."; + description = lib.mdDoc "Which protocol to listen."; default = "http"; type = types.enum ["http" "https" "socket"]; }; addr = mkOption { - description = "Listening address."; + description = lib.mdDoc "Listening address."; default = "127.0.0.1"; type = types.str; }; port = mkOption { - description = "Listening port."; + description = lib.mdDoc "Listening port."; default = 3000; type = types.port; }; socket = mkOption { - description = "Listening socket."; + description = lib.mdDoc "Listening socket."; default = "/run/grafana/grafana.sock"; type = types.str; }; domain = mkOption { - description = "The public facing domain name used to access grafana from a browser."; + description = lib.mdDoc "The public facing domain name used to access grafana from a browser."; default = "localhost"; type = types.str; }; rootUrl = mkOption { - description = "Full public facing url."; + description = lib.mdDoc "Full public facing url."; default = "%(protocol)s://%(domain)s:%(http_port)s/"; type = types.str; }; certFile = mkOption { - description = "Cert file for ssl."; + description = lib.mdDoc "Cert file for ssl."; default = ""; type = types.str; }; certKey = mkOption { - description = "Cert key for ssl."; + description = lib.mdDoc "Cert key for ssl."; default = ""; type = types.str; }; staticRootPath = mkOption { - description = "Root path for static assets."; + description = lib.mdDoc "Root path for static assets."; default = "${cfg.package}/share/grafana/public"; defaultText = literalExpression ''"''${package}/share/grafana/public"''; type = types.str; }; package = mkOption { - description = "Package to use."; + description = lib.mdDoc "Package to use."; default = pkgs.grafana; defaultText = literalExpression "pkgs.grafana"; type = types.package; @@ -369,7 +369,7 @@ in { declarativePlugins = mkOption { type = with types; nullOr (listOf path); default = null; - description = "If non-null, then a list of packages containing Grafana plugins to install. If set, plugins cannot be manually installed."; + description = lib.mdDoc "If non-null, then a list of packages containing Grafana plugins to install. If set, plugins cannot be manually installed."; example = literalExpression "with pkgs.grafanaPlugins; [ grafana-piechart-panel ]"; # Make sure each plugin is added only once; otherwise building # the link farm fails, since the same path is added multiple @@ -378,38 +378,38 @@ in { }; dataDir = mkOption { - description = "Data directory."; + description = lib.mdDoc "Data directory."; default = "/var/lib/grafana"; type = types.path; }; database = { type = mkOption { - description = "Database type."; + description = lib.mdDoc "Database type."; default = "sqlite3"; type = types.enum ["mysql" "sqlite3" "postgres"]; }; host = mkOption { - description = "Database host."; + description = lib.mdDoc "Database host."; default = "127.0.0.1:3306"; type = types.str; }; name = mkOption { - description = "Database name."; + description = lib.mdDoc "Database name."; default = "grafana"; type = types.str; }; user = mkOption { - description = "Database user."; + description = lib.mdDoc "Database user."; default = "root"; type = types.str; }; password = mkOption { - description = '' + description = lib.mdDoc '' Database password. This option is mutual exclusive with the passwordFile option. ''; @@ -418,7 +418,7 @@ in { }; passwordFile = mkOption { - description = '' + description = lib.mdDoc '' File that containts the database password. This option is mutual exclusive with the password option. ''; @@ -427,14 +427,14 @@ in { }; path = mkOption { - description = "Database path."; + description = lib.mdDoc "Database path."; default = "${cfg.dataDir}/data/grafana.db"; defaultText = literalExpression ''"''${config.${opt.dataDir}}/data/grafana.db"''; type = types.path; }; connMaxLifetime = mkOption { - description = '' + description = lib.mdDoc '' Sets the maximum amount of time (in seconds) a connection may be reused. For MySQL this setting should be shorter than the `wait_timeout' variable. ''; @@ -447,19 +447,19 @@ in { provision = { enable = mkEnableOption "provision"; datasources = mkOption { - description = "Grafana datasources configuration."; + description = lib.mdDoc "Grafana datasources configuration."; default = []; type = types.listOf grafanaTypes.datasourceConfig; apply = x: map _filter x; }; dashboards = mkOption { - description = "Grafana dashboard configuration."; + description = lib.mdDoc "Grafana dashboard configuration."; default = []; type = types.listOf grafanaTypes.dashboardConfig; apply = x: map _filter x; }; notifiers = mkOption { - description = "Grafana notifier configuration."; + description = lib.mdDoc "Grafana notifier configuration."; default = []; type = types.listOf grafanaTypes.notifierConfig; apply = x: map _filter x; @@ -468,13 +468,13 @@ in { security = { adminUser = mkOption { - description = "Default admin username."; + description = lib.mdDoc "Default admin username."; default = "admin"; type = types.str; }; adminPassword = mkOption { - description = '' + description = lib.mdDoc '' Default admin password. This option is mutual exclusive with the adminPasswordFile option. ''; @@ -483,22 +483,22 @@ in { }; adminPasswordFile = mkOption { - description = '' + description = lib.mdDoc '' Default admin password. - This option is mutual exclusive with the <literal>adminPassword</literal> option. + This option is mutual exclusive with the `adminPassword` option. ''; default = null; type = types.nullOr types.path; }; secretKey = mkOption { - description = "Secret key used for signing."; + description = lib.mdDoc "Secret key used for signing."; default = "SW2YcwTIb9zpOOhoPsMm"; type = types.str; }; secretKeyFile = mkOption { - description = "Secret key used for signing."; + description = lib.mdDoc "Secret key used for signing."; default = null; type = types.nullOr types.path; }; @@ -506,7 +506,7 @@ in { server = { serveFromSubPath = mkOption { - description = "Serve Grafana from subpath specified in rootUrl setting"; + description = lib.mdDoc "Serve Grafana from subpath specified in rootUrl setting"; default = false; type = types.bool; }; @@ -515,17 +515,17 @@ in { smtp = { enable = mkEnableOption "smtp"; host = mkOption { - description = "Host to connect to."; + description = lib.mdDoc "Host to connect to."; default = "localhost:25"; type = types.str; }; user = mkOption { - description = "User used for authentication."; + description = lib.mdDoc "User used for authentication."; default = ""; type = types.str; }; password = mkOption { - description = '' + description = lib.mdDoc '' Password used for authentication. This option is mutual exclusive with the passwordFile option. ''; @@ -533,7 +533,7 @@ in { type = types.str; }; passwordFile = mkOption { - description = '' + description = lib.mdDoc '' Password used for authentication. This option is mutual exclusive with the password option. ''; @@ -541,7 +541,7 @@ in { type = types.nullOr types.path; }; fromAddress = mkOption { - description = "Email address used for sending."; + description = lib.mdDoc "Email address used for sending."; default = "admin@grafana.localhost"; type = types.str; }; @@ -549,25 +549,25 @@ in { users = { allowSignUp = mkOption { - description = "Disable user signup / registration."; + description = lib.mdDoc "Disable user signup / registration."; default = false; type = types.bool; }; allowOrgCreate = mkOption { - description = "Whether user is allowed to create organizations."; + description = lib.mdDoc "Whether user is allowed to create organizations."; default = false; type = types.bool; }; autoAssignOrg = mkOption { - description = "Whether to automatically assign new users to default org."; + description = lib.mdDoc "Whether to automatically assign new users to default org."; default = true; type = types.bool; }; autoAssignOrgRole = mkOption { - description = "Default role new users will be auto assigned."; + description = lib.mdDoc "Default role new users will be auto assigned."; default = "Viewer"; type = types.enum ["Viewer" "Editor"]; }; @@ -575,51 +575,51 @@ in { auth = { disableLoginForm = mkOption { - description = "Set to true to disable (hide) the login form, useful if you use OAuth"; + description = lib.mdDoc "Set to true to disable (hide) the login form, useful if you use OAuth"; default = false; type = types.bool; }; anonymous = { enable = mkOption { - description = "Whether to allow anonymous access."; + description = lib.mdDoc "Whether to allow anonymous access."; default = false; type = types.bool; }; org_name = mkOption { - description = "Which organization to allow anonymous access to."; + description = lib.mdDoc "Which organization to allow anonymous access to."; default = "Main Org."; type = types.str; }; org_role = mkOption { - description = "Which role anonymous users have in the organization."; + description = lib.mdDoc "Which role anonymous users have in the organization."; default = "Viewer"; type = types.str; }; }; azuread = { enable = mkOption { - description = "Whether to allow Azure AD OAuth."; + description = lib.mdDoc "Whether to allow Azure AD OAuth."; default = false; type = types.bool; }; allowSignUp = mkOption { - description = "Whether to allow sign up with Azure AD OAuth."; + description = lib.mdDoc "Whether to allow sign up with Azure AD OAuth."; default = false; type = types.bool; }; clientId = mkOption { - description = "Azure AD OAuth client ID."; + description = lib.mdDoc "Azure AD OAuth client ID."; default = ""; type = types.str; }; clientSecretFile = mkOption { - description = "Azure AD OAuth client secret."; + description = lib.mdDoc "Azure AD OAuth client secret."; default = null; type = types.nullOr types.path; }; tenantId = mkOption { - description = '' + description = lib.mdDoc '' Tenant id used to create auth and token url. Default to "common" , let user sign in with any tenant. ''; @@ -627,7 +627,7 @@ in { type = types.str; }; allowedDomains = mkOption { - description = '' + description = lib.mdDoc '' To limit access to authenticated users who are members of one or more groups, set allowedGroups to a comma- or space-separated list of group object IDs. You can find object IDs for a specific group on the Azure portal. @@ -636,7 +636,7 @@ in { type = types.str; }; allowedGroups = mkOption { - description = '' + description = lib.mdDoc '' Limits access to users who belong to specific domains. Separate domains with space or comma. ''; @@ -646,22 +646,22 @@ in { }; google = { enable = mkOption { - description = "Whether to allow Google OAuth2."; + description = lib.mdDoc "Whether to allow Google OAuth2."; default = false; type = types.bool; }; allowSignUp = mkOption { - description = "Whether to allow sign up with Google OAuth2."; + description = lib.mdDoc "Whether to allow sign up with Google OAuth2."; default = false; type = types.bool; }; clientId = mkOption { - description = "Google OAuth2 client ID."; + description = lib.mdDoc "Google OAuth2 client ID."; default = ""; type = types.str; }; clientSecretFile = mkOption { - description = "Google OAuth2 client secret."; + description = lib.mdDoc "Google OAuth2 client secret."; default = null; type = types.nullOr types.path; }; @@ -670,16 +670,16 @@ in { analytics.reporting = { enable = mkOption { - description = "Whether to allow anonymous usage reporting to stats.grafana.net."; + description = lib.mdDoc "Whether to allow anonymous usage reporting to stats.grafana.net."; default = true; type = types.bool; }; }; extraOptions = mkOption { - description = '' + description = lib.mdDoc '' Extra configuration options passed as env variables as specified in - <link xlink:href="http://docs.grafana.org/installation/configuration/">documentation</link>, + [documentation](http://docs.grafana.org/installation/configuration/), but without GF_ prefix ''; default = {}; diff --git a/nixos/modules/services/monitoring/graphite.nix b/nixos/modules/services/monitoring/graphite.nix index 1dc2cee479ac3..73b509202df66 100644 --- a/nixos/modules/services/monitoring/graphite.nix +++ b/nixos/modules/services/monitoring/graphite.nix @@ -73,26 +73,26 @@ in { dataDir = mkOption { type = types.path; default = "/var/db/graphite"; - description = '' + description = lib.mdDoc '' Data directory for graphite. ''; }; web = { enable = mkOption { - description = "Whether to enable graphite web frontend."; + description = lib.mdDoc "Whether to enable graphite web frontend."; default = false; type = types.bool; }; listenAddress = mkOption { - description = "Graphite web frontend listen address."; + description = lib.mdDoc "Graphite web frontend listen address."; default = "127.0.0.1"; type = types.str; }; port = mkOption { - description = "Graphite web frontend port."; + description = lib.mdDoc "Graphite web frontend port."; default = 8080; type = types.int; }; @@ -100,16 +100,16 @@ in { extraConfig = mkOption { type = types.str; default = ""; - description = '' + description = lib.mdDoc '' Graphite webapp settings. See: - <link xlink:href="http://graphite.readthedocs.io/en/latest/config-local-settings.html"/> + <http://graphite.readthedocs.io/en/latest/config-local-settings.html> ''; }; }; carbon = { config = mkOption { - description = "Content of carbon configuration file."; + description = lib.mdDoc "Content of carbon configuration file."; default = '' [cache] # Listen on localhost by default for security reasons @@ -125,13 +125,13 @@ in { }; enableCache = mkOption { - description = "Whether to enable carbon cache, the graphite storage daemon."; + description = lib.mdDoc "Whether to enable carbon cache, the graphite storage daemon."; default = false; type = types.bool; }; storageAggregation = mkOption { - description = "Defines how to aggregate data to lower-precision retentions."; + description = lib.mdDoc "Defines how to aggregate data to lower-precision retentions."; default = null; type = types.nullOr types.str; example = '' @@ -143,7 +143,7 @@ in { }; storageSchemas = mkOption { - description = "Defines retention rates for storing metrics."; + description = lib.mdDoc "Defines retention rates for storing metrics."; default = ""; type = types.nullOr types.str; example = '' @@ -154,21 +154,21 @@ in { }; blacklist = mkOption { - description = "Any metrics received which match one of the experssions will be dropped."; + description = lib.mdDoc "Any metrics received which match one of the experssions will be dropped."; default = null; type = types.nullOr types.str; example = "^some\\.noisy\\.metric\\.prefix\\..*"; }; whitelist = mkOption { - description = "Only metrics received which match one of the experssions will be persisted."; + description = lib.mdDoc "Only metrics received which match one of the experssions will be persisted."; default = null; type = types.nullOr types.str; example = ".*"; }; rewriteRules = mkOption { - description = '' + description = lib.mdDoc '' Regular expression patterns that can be used to rewrite metric names in a search and replace fashion. ''; @@ -182,13 +182,13 @@ in { }; enableRelay = mkOption { - description = "Whether to enable carbon relay, the carbon replication and sharding service."; + description = lib.mdDoc "Whether to enable carbon relay, the carbon replication and sharding service."; default = false; type = types.bool; }; relayRules = mkOption { - description = "Relay rules are used to send certain metrics to a certain backend."; + description = lib.mdDoc "Relay rules are used to send certain metrics to a certain backend."; default = null; type = types.nullOr types.str; example = '' @@ -199,13 +199,13 @@ in { }; enableAggregator = mkOption { - description = "Whether to enable carbon aggregator, the carbon buffering service."; + description = lib.mdDoc "Whether to enable carbon aggregator, the carbon buffering service."; default = false; type = types.bool; }; aggregationRules = mkOption { - description = "Defines if and how received metrics will be aggregated."; + description = lib.mdDoc "Defines if and how received metrics will be aggregated."; default = null; type = types.nullOr types.str; example = '' @@ -217,13 +217,13 @@ in { seyren = { enable = mkOption { - description = "Whether to enable seyren service."; + description = lib.mdDoc "Whether to enable seyren service."; default = false; type = types.bool; }; port = mkOption { - description = "Seyren listening port."; + description = lib.mdDoc "Seyren listening port."; default = 8081; type = types.int; }; @@ -231,21 +231,21 @@ in { seyrenUrl = mkOption { default = "http://localhost:${toString cfg.seyren.port}/"; defaultText = literalExpression ''"http://localhost:''${toString config.${opt.seyren.port}}/"''; - description = "Host where seyren is accessible."; + description = lib.mdDoc "Host where seyren is accessible."; type = types.str; }; graphiteUrl = mkOption { default = "http://${cfg.web.listenAddress}:${toString cfg.web.port}"; defaultText = literalExpression ''"http://''${config.${opt.web.listenAddress}}:''${toString config.${opt.web.port}}"''; - description = "Host where graphite service runs."; + description = lib.mdDoc "Host where graphite service runs."; type = types.str; }; mongoUrl = mkOption { default = "mongodb://${config.services.mongodb.bind_ip}:27017/seyren"; defaultText = literalExpression ''"mongodb://''${config.services.mongodb.bind_ip}:27017/seyren"''; - description = "Mongodb connection string."; + description = lib.mdDoc "Mongodb connection string."; type = types.str; }; diff --git a/nixos/modules/services/monitoring/heapster.nix b/nixos/modules/services/monitoring/heapster.nix index 44f53e1890ac5..2f2467477ae2f 100644 --- a/nixos/modules/services/monitoring/heapster.nix +++ b/nixos/modules/services/monitoring/heapster.nix @@ -7,31 +7,31 @@ let in { options.services.heapster = { enable = mkOption { - description = "Whether to enable heapster monitoring"; + description = lib.mdDoc "Whether to enable heapster monitoring"; default = false; type = types.bool; }; source = mkOption { - description = "Heapster metric source"; + description = lib.mdDoc "Heapster metric source"; example = "kubernetes:https://kubernetes.default"; type = types.str; }; sink = mkOption { - description = "Heapster metic sink"; + description = lib.mdDoc "Heapster metic sink"; example = "influxdb:http://localhost:8086"; type = types.str; }; extraOpts = mkOption { - description = "Heapster extra options"; + description = lib.mdDoc "Heapster extra options"; default = ""; type = types.separatedString " "; }; package = mkOption { - description = "Package to use by heapster"; + description = lib.mdDoc "Package to use by heapster"; default = pkgs.heapster; defaultText = literalExpression "pkgs.heapster"; type = types.package; diff --git a/nixos/modules/services/monitoring/incron.nix b/nixos/modules/services/monitoring/incron.nix index 2681c35d6a015..53cbe1a9e26a1 100644 --- a/nixos/modules/services/monitoring/incron.nix +++ b/nixos/modules/services/monitoring/incron.nix @@ -27,12 +27,12 @@ in allow = mkOption { type = types.nullOr (types.listOf types.str); default = null; - description = '' + description = lib.mdDoc '' Users allowed to use incrontab. If empty then no user will be allowed to have their own incrontab. - If <literal>null</literal> then will defer to <option>deny</option>. - If both <option>allow</option> and <option>deny</option> are null + If `null` then will defer to {option}`deny`. + If both {option}`allow` and {option}`deny` are null then all users will be allowed to have their own incrontab. ''; }; @@ -40,13 +40,13 @@ in deny = mkOption { type = types.nullOr (types.listOf types.str); default = null; - description = "Users forbidden from using incrontab."; + description = lib.mdDoc "Users forbidden from using incrontab."; }; systab = mkOption { type = types.lines; default = ""; - description = "The system incrontab contents."; + description = lib.mdDoc "The system incrontab contents."; example = '' /var/mail IN_CLOSE_WRITE abc $@/$# /tmp IN_ALL_EVENTS efg $@/$# $& @@ -57,7 +57,7 @@ in type = types.listOf types.package; default = []; example = literalExpression "[ pkgs.rsync ]"; - description = "Extra packages available to the system incrontab."; + description = lib.mdDoc "Extra packages available to the system incrontab."; }; }; diff --git a/nixos/modules/services/monitoring/kapacitor.nix b/nixos/modules/services/monitoring/kapacitor.nix index a79c647becfc4..9cdb0e4495a4b 100644 --- a/nixos/modules/services/monitoring/kapacitor.nix +++ b/nixos/modules/services/monitoring/kapacitor.nix @@ -62,24 +62,24 @@ in dataDir = mkOption { type = types.path; default = "/var/lib/kapacitor"; - description = "Location where Kapacitor stores its state"; + description = lib.mdDoc "Location where Kapacitor stores its state"; }; port = mkOption { type = types.int; default = 9092; - description = "Port of Kapacitor"; + description = lib.mdDoc "Port of Kapacitor"; }; bind = mkOption { type = types.str; default = ""; example = "0.0.0.0"; - description = "Address to bind to. The default is to bind to all addresses"; + description = lib.mdDoc "Address to bind to. The default is to bind to all addresses"; }; extraConfig = mkOption { - description = "These lines go into kapacitord.conf verbatim."; + description = lib.mdDoc "These lines go into kapacitord.conf verbatim."; default = ""; type = types.lines; }; @@ -87,24 +87,24 @@ in user = mkOption { type = types.str; default = "kapacitor"; - description = "User account under which Kapacitor runs"; + description = lib.mdDoc "User account under which Kapacitor runs"; }; group = mkOption { type = types.str; default = "kapacitor"; - description = "Group under which Kapacitor runs"; + description = lib.mdDoc "Group under which Kapacitor runs"; }; taskSnapshotInterval = mkOption { type = types.str; - description = "Specifies how often to snapshot the task state (in InfluxDB time units)"; + description = lib.mdDoc "Specifies how often to snapshot the task state (in InfluxDB time units)"; default = "1m0s"; }; loadDirectory = mkOption { type = types.nullOr types.path; - description = "Directory where to load services from, such as tasks, templates and handlers (or null to disable service loading on startup)"; + description = lib.mdDoc "Directory where to load services from, such as tasks, templates and handlers (or null to disable service loading on startup)"; default = null; }; @@ -112,18 +112,18 @@ in enable = mkEnableOption "kapacitor.defaultDatabase"; url = mkOption { - description = "The URL to an InfluxDB server that serves as the default database"; + description = lib.mdDoc "The URL to an InfluxDB server that serves as the default database"; example = "http://localhost:8086"; type = types.str; }; username = mkOption { - description = "The username to connect to the remote InfluxDB server"; + description = lib.mdDoc "The username to connect to the remote InfluxDB server"; type = types.str; }; password = mkOption { - description = "The password to connect to the remote InfluxDB server"; + description = lib.mdDoc "The password to connect to the remote InfluxDB server"; type = types.str; }; }; @@ -132,25 +132,25 @@ in enable = mkEnableOption "kapacitor alerta integration"; url = mkOption { - description = "The URL to the Alerta REST API"; + description = lib.mdDoc "The URL to the Alerta REST API"; default = "http://localhost:5000"; type = types.str; }; token = mkOption { - description = "Default Alerta authentication token"; + description = lib.mdDoc "Default Alerta authentication token"; type = types.str; default = ""; }; environment = mkOption { - description = "Default Alerta environment"; + description = lib.mdDoc "Default Alerta environment"; type = types.str; default = "Production"; }; origin = mkOption { - description = "Default origin of alert"; + description = lib.mdDoc "Default origin of alert"; type = types.str; default = "kapacitor"; }; diff --git a/nixos/modules/services/monitoring/loki.nix b/nixos/modules/services/monitoring/loki.nix index ebac70c30c22e..d73e2abb71d21 100644 --- a/nixos/modules/services/monitoring/loki.nix +++ b/nixos/modules/services/monitoring/loki.nix @@ -17,7 +17,7 @@ in { user = mkOption { type = types.str; default = "loki"; - description = '' + description = lib.mdDoc '' User under which the Loki service runs. ''; }; @@ -25,7 +25,7 @@ in { group = mkOption { type = types.str; default = "loki"; - description = '' + description = lib.mdDoc '' Group under which the Loki service runs. ''; }; @@ -33,7 +33,7 @@ in { dataDir = mkOption { type = types.path; default = "/var/lib/loki"; - description = '' + description = lib.mdDoc '' Specify the directory for Loki. ''; }; @@ -41,7 +41,7 @@ in { configuration = mkOption { type = (pkgs.formats.json {}).type; default = {}; - description = '' + description = lib.mdDoc '' Specify the configuration for Loki in Nix. ''; }; @@ -49,7 +49,7 @@ in { configFile = mkOption { type = types.nullOr types.path; default = null; - description = '' + description = lib.mdDoc '' Specify a configuration file that Loki should use. ''; }; @@ -58,7 +58,7 @@ in { type = types.listOf types.str; default = []; example = [ "--server.http-listen-port=3101" ]; - description = '' + description = lib.mdDoc '' Specify a list of additional command line flags, which get escaped and are then passed to Loki. ''; diff --git a/nixos/modules/services/monitoring/longview.nix b/nixos/modules/services/monitoring/longview.nix index 9c38956f9ba85..5825cab0134c2 100644 --- a/nixos/modules/services/monitoring/longview.nix +++ b/nixos/modules/services/monitoring/longview.nix @@ -16,7 +16,7 @@ in { enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' If enabled, system metrics will be sent to Linode LongView. ''; }; @@ -25,12 +25,12 @@ in { type = types.str; default = ""; example = "01234567-89AB-CDEF-0123456789ABCDEF"; - description = '' + description = lib.mdDoc '' Longview API key. To get this, look in Longview settings which are found at https://manager.linode.com/longview/. Warning: this secret is stored in the world-readable Nix store! - Use <option>apiKeyFile</option> instead. + Use {option}`apiKeyFile` instead. ''; }; @@ -38,12 +38,12 @@ in { type = types.nullOr types.path; default = null; example = "/run/keys/longview-api-key"; - description = '' + description = lib.mdDoc '' A file containing the Longview API key. To get this, look in Longview settings which are found at https://manager.linode.com/longview/. - <option>apiKeyFile</option> takes precedence over <option>apiKey</option>. + {option}`apiKeyFile` takes precedence over {option}`apiKey`. ''; }; @@ -51,7 +51,7 @@ in { type = types.str; default = ""; example = "http://127.0.0.1/server-status"; - description = '' + description = lib.mdDoc '' The Apache status page URL. If provided, Longview will gather statistics from this location. This requires Apache mod_status to be loaded and enabled. @@ -62,7 +62,7 @@ in { type = types.str; default = ""; example = "http://127.0.0.1/nginx_status"; - description = '' + description = lib.mdDoc '' The Nginx status page URL. Longview will gather statistics from this URL. This requires the Nginx stub_status module to be enabled and configured at the given location. @@ -72,7 +72,7 @@ in { mysqlUser = mkOption { type = types.str; default = ""; - description = '' + description = lib.mdDoc '' The user for connecting to the MySQL database. If provided, Longview will connect to MySQL and collect statistics about queries, etc. This user does not need to have been granted @@ -83,10 +83,10 @@ in { mysqlPassword = mkOption { type = types.str; default = ""; - description = '' - The password corresponding to <option>mysqlUser</option>. + description = lib.mdDoc '' + The password corresponding to {option}`mysqlUser`. Warning: this is stored in cleartext in the Nix store! - Use <option>mysqlPasswordFile</option> instead. + Use {option}`mysqlPasswordFile` instead. ''; }; @@ -94,8 +94,8 @@ in { type = types.nullOr types.path; default = null; example = "/run/keys/dbpassword"; - description = '' - A file containing the password corresponding to <option>mysqlUser</option>. + description = lib.mdDoc '' + A file containing the password corresponding to {option}`mysqlUser`. ''; }; diff --git a/nixos/modules/services/monitoring/mackerel-agent.nix b/nixos/modules/services/monitoring/mackerel-agent.nix index aeb6247abd8b1..89c6d4d6c65bd 100644 --- a/nixos/modules/services/monitoring/mackerel-agent.nix +++ b/nixos/modules/services/monitoring/mackerel-agent.nix @@ -29,11 +29,11 @@ in { }; settings = mkOption { - description = '' + description = lib.mdDoc '' Options for mackerel-agent.conf. Documentation: - <link xlink:href="https://mackerel.io/docs/entry/spec/agent"/> + <https://mackerel.io/docs/entry/spec/agent> ''; default = {}; @@ -48,12 +48,12 @@ in { options.host_status = { on_start = mkOption { type = types.enum [ "working" "standby" "maintenance" "poweroff" ]; - description = "Host status after agent startup."; + description = lib.mdDoc "Host status after agent startup."; default = "working"; }; on_stop = mkOption { type = types.enum [ "working" "standby" "maintenance" "poweroff" ]; - description = "Host status after agent shutdown."; + description = lib.mdDoc "Host status after agent shutdown."; default = "poweroff"; }; }; diff --git a/nixos/modules/services/monitoring/metricbeat.nix b/nixos/modules/services/monitoring/metricbeat.nix index e75039daa1079..0968d25c2ad2d 100644 --- a/nixos/modules/services/monitoring/metricbeat.nix +++ b/nixos/modules/services/monitoring/metricbeat.nix @@ -26,7 +26,7 @@ in default = pkgs.metricbeat; defaultText = literalExpression "pkgs.metricbeat"; example = literalExpression "pkgs.metricbeat7"; - description = '' + description = lib.mdDoc '' The metricbeat package to use ''; }; @@ -51,11 +51,11 @@ in module = mkOption { type = types.str; default = name; - description = '' + description = lib.mdDoc '' The name of the module. - Look for the value after <literal>module:</literal> on the individual - module pages linked from <link xlink:href="https://www.elastic.co/guide/en/beats/metricbeat/current/metricbeat-modules.html"/>. + Look for the value after `module:` on the individual + module pages linked from <https://www.elastic.co/guide/en/beats/metricbeat/current/metricbeat-modules.html>. ''; }; }; @@ -80,18 +80,18 @@ in name = mkOption { type = types.str; default = ""; - description = '' + description = lib.mdDoc '' Name of the beat. Defaults to the hostname. - See <link xlink:href="https://www.elastic.co/guide/en/beats/metricbeat/current/configuration-general-options.html#_name"/>. + See <https://www.elastic.co/guide/en/beats/metricbeat/current/configuration-general-options.html#_name>. ''; }; tags = mkOption { type = types.listOf types.str; default = []; - description = '' + description = lib.mdDoc '' Tags to place on the shipped metrics. - See <link xlink:href="https://www.elastic.co/guide/en/beats/metricbeat/current/configuration-general-options.html#_tags_2"/>. + See <https://www.elastic.co/guide/en/beats/metricbeat/current/configuration-general-options.html#_tags_2>. ''; }; @@ -108,8 +108,8 @@ in }; }; default = {}; - description = '' - Configuration for metricbeat. See <link xlink:href="https://www.elastic.co/guide/en/beats/metricbeat/current/configuring-howto-metricbeat.html"/> for supported values. + description = lib.mdDoc '' + Configuration for metricbeat. See <https://www.elastic.co/guide/en/beats/metricbeat/current/configuring-howto-metricbeat.html> for supported values. ''; }; diff --git a/nixos/modules/services/monitoring/mimir.nix b/nixos/modules/services/monitoring/mimir.nix index 83c0b23c59dd8..87f7af7855e15 100644 --- a/nixos/modules/services/monitoring/mimir.nix +++ b/nixos/modules/services/monitoring/mimir.nix @@ -13,7 +13,7 @@ in { configuration = mkOption { type = (pkgs.formats.json {}).type; default = {}; - description = '' + description = lib.mdDoc '' Specify the configuration for Mimir in Nix. ''; }; @@ -21,7 +21,7 @@ in { configFile = mkOption { type = types.nullOr types.path; default = null; - description = '' + description = lib.mdDoc '' Specify a configuration file that Mimir should use. ''; }; diff --git a/nixos/modules/services/monitoring/monit.nix b/nixos/modules/services/monitoring/monit.nix index 379ee967620e0..6ce5b44eb279b 100644 --- a/nixos/modules/services/monitoring/monit.nix +++ b/nixos/modules/services/monitoring/monit.nix @@ -14,7 +14,7 @@ in config = mkOption { type = types.lines; default = ""; - description = "monitrc content"; + description = lib.mdDoc "monitrc content"; }; }; diff --git a/nixos/modules/services/monitoring/munin.nix b/nixos/modules/services/monitoring/munin.nix index 4fddb1e37e2e3..c77ae7b3b6eb2 100644 --- a/nixos/modules/services/monitoring/munin.nix +++ b/nixos/modules/services/monitoring/munin.nix @@ -171,7 +171,7 @@ in extraPlugins = mkOption { default = {}; type = with types; attrsOf path; - description = '' + description = lib.mdDoc '' Additional Munin plugins to activate. Keys are the name of the plugin symlink, values are the path to the underlying plugin script. You can use the same plugin script multiple times (e.g. for wildcard @@ -179,15 +179,15 @@ in Note that these plugins do not participate in autoconfiguration. If you want to autoconfigure additional plugins, use - <option>services.munin-node.extraAutoPlugins</option>. + {option}`services.munin-node.extraAutoPlugins`. Plugins enabled in this manner take precedence over autoconfigured plugins. Plugins will be copied into the Nix store, and it will attempt to modify them to run properly by fixing hardcoded references to - <literal>/bin</literal>, <literal>/usr/bin</literal>, - <literal>/sbin</literal>, and <literal>/usr/sbin</literal>. + `/bin`, `/usr/bin`, + `/sbin`, and `/usr/sbin`. ''; example = literalExpression '' { @@ -201,24 +201,24 @@ in extraAutoPlugins = mkOption { default = []; type = with types; listOf path; - description = '' + description = lib.mdDoc '' Additional Munin plugins to autoconfigure, using - <literal>munin-node-configure --suggest</literal>. These should be + `munin-node-configure --suggest`. These should be the actual paths to the plugin files (or directories containing them), not just their names. If you want to manually enable individual plugins instead, use - <option>services.munin-node.extraPlugins</option>. + {option}`services.munin-node.extraPlugins`. Note that only plugins that have the 'autoconfig' capability will do anything if listed here, since plugins that cannot autoconfigure won't be automatically enabled by - <literal>munin-node-configure</literal>. + `munin-node-configure`. Plugins will be copied into the Nix store, and it will attempt to modify them to run properly by fixing hardcoded references to - <literal>/bin</literal>, <literal>/usr/bin</literal>, - <literal>/sbin</literal>, and <literal>/usr/sbin</literal>. + `/bin`, `/usr/bin`, + `/sbin`, and `/usr/sbin`. ''; example = literalExpression '' [ @@ -234,14 +234,14 @@ in # NaNs in the output. default = [ "munin_stats" ]; type = with types; listOf str; - description = '' + description = lib.mdDoc '' Munin plugins to disable, even if - <literal>munin-node-configure --suggest</literal> tries to enable + `munin-node-configure --suggest` tries to enable them. To disable a wildcard plugin, use an actual wildcard, as in the example. munin_stats is disabled by default as it tries to read - <literal>/var/log/munin/munin-update.log</literal> for timing + `/var/log/munin/munin-update.log` for timing information, and the NixOS build of Munin does not write this file. ''; example = [ "diskstats" "zfs_usage_*" ]; @@ -253,12 +253,12 @@ in enable = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' Enable munin-cron. Takes care of all heavy lifting to collect data from nodes and draws graphs to html. Runs munin-update, munin-limits, munin-graphs and munin-html in that order. - HTML output is in <filename>/var/www/munin/</filename>, configure your + HTML output is in {file}`/var/www/munin/`, configure your favourite webserver to serve static files. ''; }; @@ -296,7 +296,7 @@ in extraCSS = mkOption { default = ""; type = types.lines; - description = '' + description = lib.mdDoc '' Custom styling for the HTML that munin-cron generates. This will be appended to the CSS files used by munin-cron and will thus take precedence over the builtin styles. diff --git a/nixos/modules/services/monitoring/netdata.nix b/nixos/modules/services/monitoring/netdata.nix index baf869af1c428..4fd07a4ba1432 100644 --- a/nixos/modules/services/monitoring/netdata.nix +++ b/nixos/modules/services/monitoring/netdata.nix @@ -55,24 +55,24 @@ in { type = types.package; default = pkgs.netdata; defaultText = literalExpression "pkgs.netdata"; - description = "Netdata package to use."; + description = lib.mdDoc "Netdata package to use."; }; user = mkOption { type = types.str; default = "netdata"; - description = "User account under which netdata runs."; + description = lib.mdDoc "User account under which netdata runs."; }; group = mkOption { type = types.str; default = "netdata"; - description = "Group under which netdata runs."; + description = lib.mdDoc "Group under which netdata runs."; }; configText = mkOption { type = types.nullOr types.lines; - description = "Verbatim netdata.conf, cannot be combined with config."; + description = lib.mdDoc "Verbatim netdata.conf, cannot be combined with config."; default = null; example = '' [global] @@ -86,7 +86,7 @@ in { enable = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Whether to enable python-based plugins ''; }; @@ -101,7 +101,7 @@ in { ps.dnspython ] ''; - description = '' + description = lib.mdDoc '' Extra python packages available at runtime to enable additional python plugins. ''; @@ -129,7 +129,7 @@ in { config = mkOption { type = types.attrsOf types.attrs; default = {}; - description = "netdata.conf configuration as nix attributes. cannot be combined with configText."; + description = lib.mdDoc "netdata.conf configuration as nix attributes. cannot be combined with configText."; example = literalExpression '' global = { "debug log" = "syslog"; @@ -142,7 +142,7 @@ in { configDir = mkOption { type = types.attrsOf types.path; default = {}; - description = '' + description = lib.mdDoc '' Complete netdata config directory except netdata.conf. The default configuration is merged with changes defined in this option. @@ -162,11 +162,11 @@ in { enableAnalyticsReporting = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Enable reporting of anonymous usage statistics to Netdata Inc. via either Google Analytics (in versions prior to 1.29.4), or Netdata Inc.'s self-hosted PostHog (in versions 1.29.4 and later). - See: <link xlink:href="https://learn.netdata.cloud/docs/agent/anonymous-statistics"/> + See: <https://learn.netdata.cloud/docs/agent/anonymous-statistics> ''; }; }; diff --git a/nixos/modules/services/monitoring/parsedmarc.nix b/nixos/modules/services/monitoring/parsedmarc.nix index efc7f69be7d64..736718c25359c 100644 --- a/nixos/modules/services/monitoring/parsedmarc.nix +++ b/nixos/modules/services/monitoring/parsedmarc.nix @@ -40,7 +40,7 @@ in recipientName = lib.mkOption { type = lib.types.str; default = "dmarc"; - description = '' + description = lib.mdDoc '' The DMARC mail recipient name, i.e. the name part of the email address which receives DMARC reports. @@ -54,7 +54,7 @@ in default = config.networking.fqdn; defaultText = lib.literalExpression "config.networking.fqdn"; example = "monitoring.example.com"; - description = '' + description = lib.mdDoc '' The hostname to use when configuring Postfix. Should correspond to the host's fully qualified domain @@ -84,7 +84,7 @@ in elasticsearch = lib.mkOption { type = lib.types.bool; default = true; - description = '' + description = lib.mdDoc '' Whether to set up and use a local instance of Elasticsearch. ''; }; @@ -110,7 +110,7 @@ in type = lib.types.bool; default = config.services.grafana.enable; defaultText = lib.literalExpression "config.services.grafana.enable"; - description = '' + description = lib.mdDoc '' Whether the official parsedmarc grafana dashboard should be provisioned to the local grafana instance. ''; @@ -134,20 +134,20 @@ in }; } ''; - description = '' + description = lib.mdDoc '' Configuration parameters to set in - <filename>parsedmarc.ini</filename>. For a full list of + {file}`parsedmarc.ini`. For a full list of available parameters, see - <link xlink:href="https://domainaware.github.io/parsedmarc/#configuration-file" />. + <https://domainaware.github.io/parsedmarc/#configuration-file>. Settings containing secret data should be set to an attribute - set containing the attribute <literal>_secret</literal> - a + set containing the attribute `_secret` - a string pointing to a file containing the value the option should be set to. See the example to get a better picture of - this: in the resulting <filename>parsedmarc.ini</filename> - file, the <literal>splunk_hec.token</literal> key will be set + this: in the resulting {file}`parsedmarc.ini` + file, the `splunk_hec.token` key will be set to the contents of the - <filename>/run/keys/splunk_token</filename> file. + {file}`/run/keys/splunk_token` file. ''; type = lib.types.submodule { @@ -158,7 +158,7 @@ in save_aggregate = lib.mkOption { type = lib.types.bool; default = true; - description = '' + description = lib.mdDoc '' Save aggregate report data to Elasticsearch and/or Splunk. ''; }; @@ -166,7 +166,7 @@ in save_forensic = lib.mkOption { type = lib.types.bool; default = true; - description = '' + description = lib.mdDoc '' Save forensic report data to Elasticsearch and/or Splunk. ''; }; @@ -176,7 +176,7 @@ in host = lib.mkOption { type = lib.types.str; default = "localhost"; - description = '' + description = lib.mdDoc '' The IMAP server hostname or IP address. ''; }; @@ -184,7 +184,7 @@ in port = lib.mkOption { type = lib.types.port; default = 993; - description = '' + description = lib.mdDoc '' The IMAP server port. ''; }; @@ -192,7 +192,7 @@ in ssl = lib.mkOption { type = lib.types.bool; default = true; - description = '' + description = lib.mdDoc '' Use an encrypted SSL/TLS connection. ''; }; @@ -200,7 +200,7 @@ in user = lib.mkOption { type = with lib.types; nullOr str; default = null; - description = '' + description = lib.mdDoc '' The IMAP server username. ''; }; @@ -223,7 +223,7 @@ in watch = lib.mkOption { type = lib.types.bool; default = true; - description = '' + description = lib.mdDoc '' Use the IMAP IDLE command to process messages as they arrive. ''; }; @@ -231,7 +231,7 @@ in delete = lib.mkOption { type = lib.types.bool; default = false; - description = '' + description = lib.mdDoc '' Delete messages after processing them, instead of archiving them. ''; }; @@ -241,7 +241,7 @@ in host = lib.mkOption { type = with lib.types; nullOr str; default = null; - description = '' + description = lib.mdDoc '' The SMTP server hostname or IP address. ''; }; @@ -249,7 +249,7 @@ in port = lib.mkOption { type = with lib.types; nullOr port; default = null; - description = '' + description = lib.mdDoc '' The SMTP server port. ''; }; @@ -257,7 +257,7 @@ in ssl = lib.mkOption { type = with lib.types; nullOr bool; default = null; - description = '' + description = lib.mdDoc '' Use an encrypted SSL/TLS connection. ''; }; @@ -265,7 +265,7 @@ in user = lib.mkOption { type = with lib.types; nullOr str; default = null; - description = '' + description = lib.mdDoc '' The SMTP server username. ''; }; @@ -288,8 +288,8 @@ in from = lib.mkOption { type = with lib.types; nullOr str; default = null; - description = '' - The <literal>From</literal> address to use for the + description = lib.mdDoc '' + The `From` address to use for the outgoing mail. ''; }; @@ -297,7 +297,7 @@ in to = lib.mkOption { type = with lib.types; nullOr (listOf str); default = null; - description = '' + description = lib.mdDoc '' The addresses to send outgoing mail to. ''; }; @@ -308,7 +308,7 @@ in default = []; type = with lib.types; listOf str; apply = x: if x == [] then null else lib.concatStringsSep "," x; - description = '' + description = lib.mdDoc '' A list of Elasticsearch hosts to push parsed reports to. ''; @@ -317,7 +317,7 @@ in user = lib.mkOption { type = with lib.types; nullOr str; default = null; - description = '' + description = lib.mdDoc '' Username to use when connecting to Elasticsearch, if required. ''; @@ -342,7 +342,7 @@ in ssl = lib.mkOption { type = lib.types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to use an encrypted SSL/TLS connection. ''; }; @@ -350,7 +350,7 @@ in cert_path = lib.mkOption { type = lib.types.path; default = "/etc/ssl/certs/ca-certificates.crt"; - description = '' + description = lib.mdDoc '' The path to a TLS certificate bundle used to verify the server's certificate. ''; diff --git a/nixos/modules/services/monitoring/prometheus/alertmanager.nix b/nixos/modules/services/monitoring/prometheus/alertmanager.nix index 1f396634ae015..60e0523cc3535 100644 --- a/nixos/modules/services/monitoring/prometheus/alertmanager.nix +++ b/nixos/modules/services/monitoring/prometheus/alertmanager.nix @@ -46,7 +46,7 @@ in { type = types.package; default = pkgs.prometheus-alertmanager; defaultText = literalExpression "pkgs.alertmanager"; - description = '' + description = lib.mdDoc '' Package that should be used for alertmanager. ''; }; @@ -54,7 +54,7 @@ in { configuration = mkOption { type = types.nullOr types.attrs; default = null; - description = '' + description = lib.mdDoc '' Alertmanager configuration as nix attribute set. ''; }; @@ -62,7 +62,7 @@ in { configText = mkOption { type = types.nullOr types.lines; default = null; - description = '' + description = lib.mdDoc '' Alertmanager configuration as YAML text. If non-null, this option defines the text that is written to alertmanager.yml. If null, the contents of alertmanager.yml is generated from the structured config @@ -73,7 +73,7 @@ in { logFormat = mkOption { type = types.nullOr types.str; default = null; - description = '' + description = lib.mdDoc '' If set use a syslog logger or JSON logging. ''; }; @@ -81,7 +81,7 @@ in { logLevel = mkOption { type = types.enum ["debug" "info" "warn" "error" "fatal"]; default = "warn"; - description = '' + description = lib.mdDoc '' Only log messages with the given severity or above. ''; }; @@ -89,7 +89,7 @@ in { webExternalUrl = mkOption { type = types.nullOr types.str; default = null; - description = '' + description = lib.mdDoc '' The URL under which Alertmanager is externally reachable (for example, if Alertmanager is served via a reverse proxy). Used for generating relative and absolute links back to Alertmanager itself. If the URL has a path portion, it will be used to prefix all HTTP endoints served by Alertmanager. @@ -100,7 +100,7 @@ in { listenAddress = mkOption { type = types.str; default = ""; - description = '' + description = lib.mdDoc '' Address to listen on for the web interface and API. Empty string will listen on all interfaces. "localhost" will listen on 127.0.0.1 (but not ::1). ''; @@ -109,7 +109,7 @@ in { port = mkOption { type = types.int; default = 9093; - description = '' + description = lib.mdDoc '' Port to listen on for the web interface and API. ''; }; @@ -117,7 +117,7 @@ in { openFirewall = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Open port in firewall for incoming connections. ''; }; @@ -125,7 +125,7 @@ in { clusterPeers = mkOption { type = types.listOf types.str; default = []; - description = '' + description = lib.mdDoc '' Initial peers for HA cluster. ''; }; @@ -133,7 +133,7 @@ in { extraFlags = mkOption { type = types.listOf types.str; default = []; - description = '' + description = lib.mdDoc '' Extra commandline options when launching the Alertmanager. ''; }; @@ -142,11 +142,11 @@ in { type = types.nullOr types.path; default = null; example = "/root/alertmanager.env"; - description = '' + description = lib.mdDoc '' File to load as environment file. Environment variables from this file will be interpolated into the config file using envsubst with this syntax: - <literal>$ENVIRONMENT ''${VARIABLE}</literal> + `$ENVIRONMENT ''${VARIABLE}` ''; }; }; diff --git a/nixos/modules/services/monitoring/prometheus/default.nix b/nixos/modules/services/monitoring/prometheus/default.nix index 41848c1c6d3a7..db4286b66a5d3 100644 --- a/nixos/modules/services/monitoring/prometheus/default.nix +++ b/nixos/modules/services/monitoring/prometheus/default.nix @@ -184,7 +184,7 @@ let options = { username = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' HTTP username ''; }; @@ -257,7 +257,7 @@ let }; job_name = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' The job name assigned to scraped metrics by default. ''; }; @@ -513,7 +513,7 @@ let subscription_id = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' The subscription ID. ''; }; @@ -618,7 +618,7 @@ let mkDockerSdConfigModule = extraOptions: mkSdConfigModule ({ host = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' Address of the Docker daemon. ''; }; @@ -675,7 +675,7 @@ let options = { names = mkOption { type = types.listOf types.str; - description = '' + description = lib.mdDoc '' A list of DNS SRV record names to be queried. ''; }; @@ -698,7 +698,7 @@ let options = { region = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' The AWS Region. If blank, the region from the instance metadata is used. ''; }; @@ -762,7 +762,7 @@ let promTypes.eureka_sd_config = mkSdConfigModule { server = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' The URL to connect to the Eureka server. ''; }; @@ -772,7 +772,7 @@ let options = { files = mkOption { type = types.listOf types.str; - description = '' + description = lib.mdDoc '' Patterns for files from which target groups are extracted. Refer to the Prometheus documentation for permitted filename patterns and formats. @@ -791,14 +791,14 @@ let # required configuration values for `gce_sd_config`. project = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' The GCP Project. ''; }; zone = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' The zone of the scrape targets. If you need multiple zones use multiple gce_sd_configs. ''; @@ -833,9 +833,9 @@ let promTypes.hetzner_sd_config = mkSdConfigModule { role = mkOption { type = types.enum [ "robot" "hcloud" ]; - description = '' + description = lib.mdDoc '' The Hetzner role of entities that should be discovered. - One of <literal>robot</literal> or <literal>hcloud</literal>. + One of `robot` or `hcloud`. ''; }; @@ -852,7 +852,7 @@ let options = { url = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' URL from which the targets are fetched. ''; }; @@ -889,7 +889,7 @@ let role = mkOption { type = types.enum [ "endpoints" "service" "pod" "node" "ingress" ]; - description = '' + description = lib.mdDoc '' The Kubernetes role of entities that should be discovered. One of endpoints, service, pod, node, or ingress. ''; @@ -954,7 +954,7 @@ let promTypes.kuma_sd_config = mkSdConfigModule { server = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' Address of the Kuma Control Plane's MADS xDS server. ''; }; @@ -1022,7 +1022,7 @@ let promTypes.marathon_sd_config = mkSdConfigModule { servers = mkOption { type = types.listOf types.str; - description = '' + description = lib.mdDoc '' List of URLs to be used to contact Marathon servers. You need to provide at least one server URL. ''; }; @@ -1048,14 +1048,14 @@ let options = { servers = mkOption { type = types.listOf types.str; - description = '' + description = lib.mdDoc '' The Zookeeper servers. ''; }; paths = mkOption { type = types.listOf types.str; - description = '' + description = lib.mdDoc '' Paths can point to a single service, or the root of a tree of services. ''; }; @@ -1097,14 +1097,14 @@ let { role = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' The OpenStack role of entities that should be discovered. ''; }; region = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' The OpenStack Region. ''; }; @@ -1165,14 +1165,14 @@ let promTypes.puppetdb_sd_config = mkSdConfigModule { url = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' The URL of the PuppetDB root query endpoint. ''; }; query = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' Puppet Query Language (PQL) query. Only resources are supported. https://puppet.com/docs/puppetdb/latest/api/query/v4/pql.html ''; @@ -1201,7 +1201,7 @@ let options = { access_key = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' Access key to use. https://console.scaleway.com/project/credentials ''; }; @@ -1218,7 +1218,7 @@ let project_id = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' Project ID of the targets. ''; }; @@ -1275,7 +1275,7 @@ let options = { account = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' The account to use for discovering new targets. ''; }; @@ -1288,15 +1288,15 @@ let dns_suffix = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' The DNS suffix which should be applied to target. ''; }; endpoint = mkOption { type = types.str; - description = '' - The Triton discovery endpoint (e.g. <literal>cmon.us-east-3b.triton.zone</literal>). This is + description = lib.mdDoc '' + The Triton discovery endpoint (e.g. `cmon.us-east-3b.triton.zone`). This is often the same value as dns_suffix. ''; }; @@ -1327,21 +1327,21 @@ let promTypes.uyuni_sd_config = mkSdConfigModule { server = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' The URL to connect to the Uyuni server. ''; }; username = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' Credentials are used to authenticate the requests to Uyuni API. ''; }; password = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' Credentials are used to authenticate the requests to Uyuni API. ''; }; @@ -1363,14 +1363,14 @@ let options = { targets = mkOption { type = types.listOf types.str; - description = '' + description = lib.mdDoc '' The targets specified by the target group. ''; }; labels = mkOption { type = types.attrsOf types.str; default = { }; - description = '' + description = lib.mdDoc '' Labels assigned to all metrics scraped from the targets. ''; }; @@ -1426,7 +1426,7 @@ let options = { url = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' ServerName extension to indicate the name of the server. http://tools.ietf.org/html/rfc4366#section-3.1 ''; @@ -1512,7 +1512,7 @@ let options = { url = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' ServerName extension to indicate the name of the server. http://tools.ietf.org/html/rfc4366#section-3.1 ''; @@ -1569,7 +1569,7 @@ in enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Enable the Prometheus monitoring daemon. ''; }; @@ -1578,7 +1578,7 @@ in type = types.package; default = pkgs.prometheus; defaultText = literalExpression "pkgs.prometheus"; - description = '' + description = lib.mdDoc '' The prometheus package that should be used. ''; }; @@ -1586,7 +1586,7 @@ in port = mkOption { type = types.port; default = 9090; - description = '' + description = lib.mdDoc '' Port to listen on. ''; }; @@ -1594,7 +1594,7 @@ in listenAddress = mkOption { type = types.str; default = "0.0.0.0"; - description = '' + description = lib.mdDoc '' Address to listen on for the web interface, API, and telemetry. ''; }; @@ -1602,8 +1602,8 @@ in stateDir = mkOption { type = types.str; default = "prometheus2"; - description = '' - Directory below <literal>/var/lib</literal> to store Prometheus metrics data. + description = lib.mdDoc '' + Directory below `/var/lib` to store Prometheus metrics data. This directory will be created automatically using systemd's StateDirectory mechanism. ''; }; @@ -1611,7 +1611,7 @@ in extraFlags = mkOption { type = types.listOf types.str; default = [ ]; - description = '' + description = lib.mdDoc '' Extra commandline options when launching Prometheus. ''; }; @@ -1619,11 +1619,11 @@ in enableReload = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' Reload prometheus when configuration file changes (instead of restart). The following property holds: switching to a configuration - (<literal>switch-to-configuration</literal>) that changes the prometheus + (`switch-to-configuration`) that changes the prometheus configuration only finishes successully when prometheus has finished loading the new configuration. ''; @@ -1632,7 +1632,7 @@ in configText = mkOption { type = types.nullOr types.lines; default = null; - description = '' + description = lib.mdDoc '' If non-null, this option defines the text that is written to prometheus.yml. If null, the contents of prometheus.yml is generated from the structured config options. @@ -1642,7 +1642,7 @@ in globalConfig = mkOption { type = promTypes.globalConfig; default = { }; - description = '' + description = lib.mdDoc '' Parameters that are valid in all configuration contexts. They also serve as defaults for other configuration sections ''; @@ -1651,25 +1651,25 @@ in remoteRead = mkOption { type = types.listOf promTypes.remote_read; default = [ ]; - description = '' + description = lib.mdDoc '' Parameters of the endpoints to query from. - See <link xlink:href="https://prometheus.io/docs/prometheus/latest/configuration/configuration/#remote_read">the official documentation</link> for more information. + See [the official documentation](https://prometheus.io/docs/prometheus/latest/configuration/configuration/#remote_read) for more information. ''; }; remoteWrite = mkOption { type = types.listOf promTypes.remote_write; default = [ ]; - description = '' + description = lib.mdDoc '' Parameters of the endpoints to send samples to. - See <link xlink:href="https://prometheus.io/docs/prometheus/latest/configuration/configuration/#remote_write">the official documentation</link> for more information. + See [the official documentation](https://prometheus.io/docs/prometheus/latest/configuration/configuration/#remote_write) for more information. ''; }; rules = mkOption { type = types.listOf types.str; default = [ ]; - description = '' + description = lib.mdDoc '' Alerting and/or Recording rules to evaluate at runtime. ''; }; @@ -1677,7 +1677,7 @@ in ruleFiles = mkOption { type = types.listOf types.path; default = [ ]; - description = '' + description = lib.mdDoc '' Any additional rules files to include in this configuration. ''; }; @@ -1685,7 +1685,7 @@ in scrapeConfigs = mkOption { type = types.listOf promTypes.scrape_config; default = [ ]; - description = '' + description = lib.mdDoc '' A list of scrape configurations. ''; }; @@ -1704,16 +1704,16 @@ in } ] ''; default = [ ]; - description = '' + description = lib.mdDoc '' A list of alertmanagers to send alerts to. - See <link xlink:href="https://prometheus.io/docs/prometheus/latest/configuration/configuration/#alertmanager_config">the official documentation</link> for more information. + See [the official documentation](https://prometheus.io/docs/prometheus/latest/configuration/configuration/#alertmanager_config) for more information. ''; }; alertmanagerNotificationQueueCapacity = mkOption { type = types.int; default = 10000; - description = '' + description = lib.mdDoc '' The capacity of the queue for pending alert manager notifications. ''; }; @@ -1722,7 +1722,7 @@ in type = types.nullOr types.str; default = null; example = "https://example.com/"; - description = '' + description = lib.mdDoc '' The URL under which Prometheus is externally reachable (for example, if Prometheus is served via a reverse proxy). ''; @@ -1750,7 +1750,7 @@ in type = types.nullOr types.str; default = null; example = "15d"; - description = '' + description = lib.mdDoc '' How long to retain samples in storage. ''; }; diff --git a/nixos/modules/services/monitoring/prometheus/pushgateway.nix b/nixos/modules/services/monitoring/prometheus/pushgateway.nix index 01b9937624367..ac7a2300f67cb 100644 --- a/nixos/modules/services/monitoring/prometheus/pushgateway.nix +++ b/nixos/modules/services/monitoring/prometheus/pushgateway.nix @@ -27,7 +27,7 @@ in { type = types.package; default = pkgs.prometheus-pushgateway; defaultText = literalExpression "pkgs.prometheus-pushgateway"; - description = '' + description = lib.mdDoc '' Package that should be used for the prometheus pushgateway. ''; }; @@ -35,27 +35,27 @@ in { web.listen-address = mkOption { type = types.nullOr types.str; default = null; - description = '' + description = lib.mdDoc '' Address to listen on for the web interface, API and telemetry. - <literal>null</literal> will default to <literal>:9091</literal>. + `null` will default to `:9091`. ''; }; web.telemetry-path = mkOption { type = types.nullOr types.str; default = null; - description = '' + description = lib.mdDoc '' Path under which to expose metrics. - <literal>null</literal> will default to <literal>/metrics</literal>. + `null` will default to `/metrics`. ''; }; web.external-url = mkOption { type = types.nullOr types.str; default = null; - description = '' + description = lib.mdDoc '' The URL under which Pushgateway is externally reachable. ''; }; @@ -63,11 +63,11 @@ in { web.route-prefix = mkOption { type = types.nullOr types.str; default = null; - description = '' + description = lib.mdDoc '' Prefix for the internal routes of web endpoints. Defaults to the path of - <option>services.prometheus.pushgateway.web.external-url</option>. + {option}`services.prometheus.pushgateway.web.external-url`. ''; }; @@ -75,20 +75,20 @@ in { type = types.nullOr types.str; default = null; example = "10m"; - description = '' + description = lib.mdDoc '' The minimum interval at which to write out the persistence file. - <literal>null</literal> will default to <literal>5m</literal>. + `null` will default to `5m`. ''; }; log.level = mkOption { type = types.nullOr (types.enum ["debug" "info" "warn" "error" "fatal"]); default = null; - description = '' + description = lib.mdDoc '' Only log messages with the given severity or above. - <literal>null</literal> will default to <literal>info</literal>. + `null` will default to `info`. ''; }; @@ -96,17 +96,17 @@ in { type = types.nullOr types.str; default = null; example = "logger:syslog?appname=bob&local=7"; - description = '' + description = lib.mdDoc '' Set the log target and format. - <literal>null</literal> will default to <literal>logger:stderr</literal>. + `null` will default to `logger:stderr`. ''; }; extraFlags = mkOption { type = types.listOf types.str; default = []; - description = '' + description = lib.mdDoc '' Extra commandline options when launching the Pushgateway. ''; }; @@ -114,26 +114,26 @@ in { persistMetrics = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to persist metrics to a file. When enabled metrics will be saved to a file called - <literal>metrics</literal> in the directory - <literal>/var/lib/pushgateway</literal>. The directory below - <literal>/var/lib</literal> can be set using - <option>services.prometheus.pushgateway.stateDir</option>. + `metrics` in the directory + `/var/lib/pushgateway`. The directory below + `/var/lib` can be set using + {option}`services.prometheus.pushgateway.stateDir`. ''; }; stateDir = mkOption { type = types.str; default = "pushgateway"; - description = '' - Directory below <literal>/var/lib</literal> to store metrics. + description = lib.mdDoc '' + Directory below `/var/lib` to store metrics. This directory will be created automatically using systemd's StateDirectory mechanism when - <option>services.prometheus.pushgateway.persistMetrics</option> + {option}`services.prometheus.pushgateway.persistMetrics` is enabled. ''; }; diff --git a/nixos/modules/services/monitoring/prometheus/xmpp-alerts.nix b/nixos/modules/services/monitoring/prometheus/xmpp-alerts.nix index 980c93c9c4788..1d7da7ced3fef 100644 --- a/nixos/modules/services/monitoring/prometheus/xmpp-alerts.nix +++ b/nixos/modules/services/monitoring/prometheus/xmpp-alerts.nix @@ -21,9 +21,9 @@ in type = settingsFormat.type; default = {}; - description = '' + description = lib.mdDoc '' Configuration for prometheus xmpp-alerts, see - <link xlink:href="https://github.com/jelmer/prometheus-xmpp-alerts/blob/master/xmpp-alerts.yml.example"/> + <https://github.com/jelmer/prometheus-xmpp-alerts/blob/master/xmpp-alerts.yml.example> for supported values. ''; }; diff --git a/nixos/modules/services/monitoring/riemann-dash.nix b/nixos/modules/services/monitoring/riemann-dash.nix index 16eb83008509a..1ca8af14e7772 100644 --- a/nixos/modules/services/monitoring/riemann-dash.nix +++ b/nixos/modules/services/monitoring/riemann-dash.nix @@ -26,20 +26,20 @@ in { enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Enable the riemann-dash dashboard daemon. ''; }; config = mkOption { type = types.lines; - description = '' + description = lib.mdDoc '' Contents added to the end of the riemann-dash configuration file. ''; }; dataDir = mkOption { type = types.str; default = "/var/riemann-dash"; - description = '' + description = lib.mdDoc '' Location of the riemann-base dir. The dashboard configuration file is is stored to this directory. The directory is created automatically on service start, and owner is set to the riemanndash user. diff --git a/nixos/modules/services/monitoring/riemann-tools.nix b/nixos/modules/services/monitoring/riemann-tools.nix index 86a11694e7b49..b5cd79c743013 100644 --- a/nixos/modules/services/monitoring/riemann-tools.nix +++ b/nixos/modules/services/monitoring/riemann-tools.nix @@ -23,14 +23,14 @@ in { enableHealth = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Enable the riemann-health daemon. ''; }; riemannHost = mkOption { type = types.str; default = "127.0.0.1"; - description = '' + description = lib.mdDoc '' Address of the host riemann node. Defaults to localhost. ''; }; diff --git a/nixos/modules/services/monitoring/riemann.nix b/nixos/modules/services/monitoring/riemann.nix index 13d2b1cc06027..8d61ec2a308ff 100644 --- a/nixos/modules/services/monitoring/riemann.nix +++ b/nixos/modules/services/monitoring/riemann.nix @@ -30,13 +30,13 @@ in { enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Enable the Riemann network monitoring daemon. ''; }; config = mkOption { type = types.lines; - description = '' + description = lib.mdDoc '' Contents of the Riemann configuration file. For more complicated config you should use configFile. ''; @@ -44,17 +44,17 @@ in { configFiles = mkOption { type = with types; listOf path; default = []; - description = '' + description = lib.mdDoc '' Extra files containing Riemann configuration. These files will be loaded at runtime by Riemann (with Clojure's - <literal>load-file</literal> function) at the end of the + `load-file` function) at the end of the configuration if you use the config option, this is ignored if you use configFile. ''; }; configFile = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' A Riemann config file. Any files in the same directory as this file will be added to the classpath by Riemann. ''; @@ -62,14 +62,14 @@ in { extraClasspathEntries = mkOption { type = with types; listOf str; default = []; - description = '' + description = lib.mdDoc '' Extra entries added to the Java classpath when running Riemann. ''; }; extraJavaOpts = mkOption { type = with types; listOf str; default = []; - description = '' + description = lib.mdDoc '' Extra Java options used when launching Riemann. ''; }; diff --git a/nixos/modules/services/monitoring/scollector.nix b/nixos/modules/services/monitoring/scollector.nix index 6a6fe110f9407..48be309c95996 100644 --- a/nixos/modules/services/monitoring/scollector.nix +++ b/nixos/modules/services/monitoring/scollector.nix @@ -35,7 +35,7 @@ in { enable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to run scollector. ''; }; @@ -44,7 +44,7 @@ in { type = types.package; default = pkgs.scollector; defaultText = literalExpression "pkgs.scollector"; - description = '' + description = lib.mdDoc '' scollector binary to use. ''; }; @@ -52,7 +52,7 @@ in { user = mkOption { type = types.str; default = "scollector"; - description = '' + description = lib.mdDoc '' User account under which scollector runs. ''; }; @@ -60,7 +60,7 @@ in { group = mkOption { type = types.str; default = "scollector"; - description = '' + description = lib.mdDoc '' Group account under which scollector runs. ''; }; @@ -68,7 +68,7 @@ in { bosunHost = mkOption { type = types.str; default = "localhost:8070"; - description = '' + description = lib.mdDoc '' Host and port of the bosun server that will store the collected data. ''; @@ -78,7 +78,7 @@ in { type = with types; attrsOf (listOf path); default = {}; example = literalExpression ''{ "0" = [ "''${postgresStats}/bin/collect-stats" ]; }''; - description = '' + description = lib.mdDoc '' An attribute set mapping the frequency of collection to a list of binaries that should be executed at that frequency. You can use "0" to run a binary forever. @@ -89,7 +89,7 @@ in { type = with types; listOf str; default = []; example = [ "-d" ]; - description = '' + description = lib.mdDoc '' Extra scollector command line options ''; }; @@ -97,7 +97,7 @@ in { extraConfig = mkOption { type = types.lines; default = ""; - description = '' + description = lib.mdDoc '' Extra scollector configuration added to the end of scollector.toml ''; }; diff --git a/nixos/modules/services/monitoring/smartd.nix b/nixos/modules/services/monitoring/smartd.nix index 6d39cc3e4e6bb..83791631d2cac 100644 --- a/nixos/modules/services/monitoring/smartd.nix +++ b/nixos/modules/services/monitoring/smartd.nix @@ -72,14 +72,14 @@ let device = mkOption { example = "/dev/sda"; type = types.str; - description = "Location of the device."; + description = lib.mdDoc "Location of the device."; }; options = mkOption { default = ""; example = "-d sat"; type = types.separatedString " "; - description = "Options that determine how smartd monitors the device."; + description = lib.mdDoc "Options that determine how smartd monitors the device."; }; }; @@ -100,12 +100,12 @@ in autodetect = mkOption { default = true; type = types.bool; - description = '' + description = lib.mdDoc '' Whenever smartd should monitor all devices connected to the machine at the time it's being started (the default). Set to false to monitor the devices listed in - <option>services.smartd.devices</option> only. + {option}`services.smartd.devices` only. ''; }; @@ -113,11 +113,11 @@ in default = []; type = types.listOf types.str; example = ["-A /var/log/smartd/" "--interval=3600"]; - description = '' - Extra command-line options passed to the <literal>smartd</literal> + description = lib.mdDoc '' + Extra command-line options passed to the `smartd` daemon on startup. - (See <literal>man 8 smartd</literal>.) + (See `man 8 smartd`.) ''; }; @@ -128,7 +128,7 @@ in default = config.services.mail.sendmailSetuidWrapper != null; defaultText = literalExpression "config.services.mail.sendmailSetuidWrapper != null"; type = types.bool; - description = "Whenever to send e-mail notifications."; + description = lib.mdDoc "Whenever to send e-mail notifications."; }; sender = mkOption { @@ -144,17 +144,17 @@ in recipient = mkOption { default = "root"; type = types.str; - description = "Recipient of the notification messages."; + description = lib.mdDoc "Recipient of the notification messages."; }; mailer = mkOption { default = "/run/wrappers/bin/sendmail"; type = types.path; - description = '' + description = lib.mdDoc '' Sendmail-compatible binary to be used to send the messages. You should probably enable - <option>services.postfix</option> or some other MTA for + {option}`services.postfix` or some other MTA for this to work. ''; }; @@ -164,7 +164,7 @@ in enable = mkOption { default = true; type = types.bool; - description = "Whenever to send wall notifications to all users."; + description = lib.mdDoc "Whenever to send wall notifications to all users."; }; }; @@ -173,21 +173,21 @@ in default = config.services.xserver.enable; defaultText = literalExpression "config.services.xserver.enable"; type = types.bool; - description = "Whenever to send X11 xmessage notifications."; + description = lib.mdDoc "Whenever to send X11 xmessage notifications."; }; display = mkOption { default = ":${toString config.services.xserver.display}"; defaultText = literalExpression ''":''${toString config.services.xserver.display}"''; type = types.str; - description = "DISPLAY to send X11 notifications to."; + description = lib.mdDoc "DISPLAY to send X11 notifications to."; }; }; test = mkOption { default = false; type = types.bool; - description = "Whenever to send a test notification on startup."; + description = lib.mdDoc "Whenever to send a test notification on startup."; }; }; @@ -197,12 +197,12 @@ in default = "-a"; type = types.separatedString " "; example = "-a -o on -s (S/../.././02|L/../../7/04)"; - description = '' + description = lib.mdDoc '' Common default options for explicitly monitored (listed in - <option>services.smartd.devices</option>) devices. + {option}`services.smartd.devices`) devices. The default value turns on monitoring of all the things (see - <literal>man 5 smartd.conf</literal>). + `man 5 smartd.conf`). The example also turns on SMART Automatic Offline Testing on startup, and schedules short self-tests daily, and long @@ -214,8 +214,8 @@ in default = cfg.defaults.monitored; defaultText = literalExpression "config.${opt.defaults.monitored}"; type = types.separatedString " "; - description = '' - Like <option>services.smartd.defaults.monitored</option>, but for the + description = lib.mdDoc '' + Like {option}`services.smartd.defaults.monitored`, but for the autodetected devices. ''; }; @@ -225,7 +225,7 @@ in default = []; example = [ { device = "/dev/sda"; } { device = "/dev/sdb"; options = "-d sat"; } ]; type = with types; listOf (submodule smartdDeviceOpts); - description = "List of devices to monitor."; + description = lib.mdDoc "List of devices to monitor."; }; }; diff --git a/nixos/modules/services/monitoring/statsd.nix b/nixos/modules/services/monitoring/statsd.nix index 30b2916a99285..d109e0826204d 100644 --- a/nixos/modules/services/monitoring/statsd.nix +++ b/nixos/modules/services/monitoring/statsd.nix @@ -59,31 +59,31 @@ in enable = mkEnableOption "statsd"; listenAddress = mkOption { - description = "Address that statsd listens on over UDP"; + description = lib.mdDoc "Address that statsd listens on over UDP"; default = "127.0.0.1"; type = types.str; }; port = mkOption { - description = "Port that stats listens for messages on over UDP"; + description = lib.mdDoc "Port that stats listens for messages on over UDP"; default = 8125; type = types.int; }; mgmt_address = mkOption { - description = "Address to run management TCP interface on"; + description = lib.mdDoc "Address to run management TCP interface on"; default = "127.0.0.1"; type = types.str; }; mgmt_port = mkOption { - description = "Port to run the management TCP interface on"; + description = lib.mdDoc "Port to run the management TCP interface on"; default = 8126; type = types.int; }; backends = mkOption { - description = "List of backends statsd will use for data persistence"; + description = lib.mdDoc "List of backends statsd will use for data persistence"; default = []; example = [ "graphite" @@ -97,19 +97,19 @@ in }; graphiteHost = mkOption { - description = "Hostname or IP of Graphite server"; + description = lib.mdDoc "Hostname or IP of Graphite server"; default = null; type = types.nullOr types.str; }; graphitePort = mkOption { - description = "Port of Graphite server (i.e. carbon-cache)."; + description = lib.mdDoc "Port of Graphite server (i.e. carbon-cache)."; default = null; type = types.nullOr types.int; }; extraConfig = mkOption { - description = "Extra configuration options for statsd"; + description = lib.mdDoc "Extra configuration options for statsd"; default = ""; type = types.nullOr types.str; }; diff --git a/nixos/modules/services/monitoring/sysstat.nix b/nixos/modules/services/monitoring/sysstat.nix index ca2cff8272320..f8621f08bb8cf 100644 --- a/nixos/modules/services/monitoring/sysstat.nix +++ b/nixos/modules/services/monitoring/sysstat.nix @@ -10,7 +10,7 @@ in { collect-frequency = mkOption { type = types.str; default = "*:00/10"; - description = '' + description = lib.mdDoc '' OnCalendar specification for sysstat-collect ''; }; @@ -18,7 +18,7 @@ in { collect-args = mkOption { type = types.str; default = "1 1"; - description = '' + description = lib.mdDoc '' Arguments to pass sa1 when collecting statistics ''; }; diff --git a/nixos/modules/services/monitoring/telegraf.nix b/nixos/modules/services/monitoring/telegraf.nix index 13aae58d0f37d..d228b5cc2d0a2 100644 --- a/nixos/modules/services/monitoring/telegraf.nix +++ b/nixos/modules/services/monitoring/telegraf.nix @@ -16,7 +16,7 @@ in { package = mkOption { default = pkgs.telegraf; defaultText = literalExpression "pkgs.telegraf"; - description = "Which telegraf derivation to use"; + description = lib.mdDoc "Which telegraf derivation to use"; type = types.package; }; @@ -24,17 +24,17 @@ in { type = types.listOf types.path; default = []; example = [ "/run/keys/telegraf.env" ]; - description = '' + description = lib.mdDoc '' File to load as environment file. Environment variables from this file will be interpolated into the config file using envsubst with this - syntax: <literal>$ENVIRONMENT</literal> or <literal>''${VARIABLE}</literal>. + syntax: `$ENVIRONMENT` or `''${VARIABLE}`. This is useful to avoid putting secrets into the nix store. ''; }; extraConfig = mkOption { default = {}; - description = "Extra configuration options for telegraf"; + description = lib.mdDoc "Extra configuration options for telegraf"; type = settingsFormat.type; example = { outputs.influxdb = { diff --git a/nixos/modules/services/monitoring/thanos.nix b/nixos/modules/services/monitoring/thanos.nix index 9e93d8dbb0efd..c7404241fbf5a 100644 --- a/nixos/modules/services/monitoring/thanos.nix +++ b/nixos/modules/services/monitoring/thanos.nix @@ -86,11 +86,11 @@ let defaultText = literalDocBook '' calculated from <literal>config.services.thanos.${cmd}</literal> ''; - description = '' - Arguments to the <literal>thanos ${cmd}</literal> command. + description = lib.mdDoc '' + Arguments to the `thanos ${cmd}` command. Defaults to a list of arguments formed by converting the structured - options of <option>services.thanos.${cmd}</option> to a list of arguments. + options of {option}`services.thanos.${cmd}` to a list of arguments. Overriding this option will cause none of the structured options to have any effect. So only set this if you know what you're doing! @@ -127,10 +127,10 @@ let if config.services.thanos.<cmd>.tracing.config == null then null else toString (toYAML "tracing.yaml" config.services.thanos.<cmd>.tracing.config); ''; - description = '' + description = lib.mdDoc '' Path to YAML file that contains tracing configuration. - See format details: <link xlink:href="https://thanos.io/tracing.md/#configuration"/> + See format details: <https://thanos.io/tracing.md/#configuration> ''; }; }; @@ -192,10 +192,10 @@ let if config.services.thanos.<cmd>.objstore.config == null then null else toString (toYAML "objstore.yaml" config.services.thanos.<cmd>.objstore.config); ''; - description = '' + description = lib.mdDoc '' Path to YAML file that contains object store configuration. - See format details: <link xlink:href="https://thanos.io/storage.md/#configuration"/> + See format details: <https://thanos.io/storage.md/#configuration> ''; }; }; @@ -231,7 +231,7 @@ let type = types.str; default = "/var/lib/${config.services.prometheus.stateDir}/data"; defaultText = literalExpression ''"/var/lib/''${config.services.prometheus.stateDir}/data"''; - description = '' + description = lib.mdDoc '' Data directory of TSDB. ''; }; @@ -660,7 +660,7 @@ in { type = types.package; default = pkgs.thanos; defaultText = literalExpression "pkgs.thanos"; - description = '' + description = lib.mdDoc '' The thanos package that should be used. ''; }; diff --git a/nixos/modules/services/monitoring/tuptime.nix b/nixos/modules/services/monitoring/tuptime.nix index de80282559aeb..ffe24c0ef0be8 100644 --- a/nixos/modules/services/monitoring/tuptime.nix +++ b/nixos/modules/services/monitoring/tuptime.nix @@ -16,13 +16,13 @@ in { enable = mkOption { type = types.bool; default = true; - description = "Whether to regularly log uptime to detect bad shutdowns."; + description = lib.mdDoc "Whether to regularly log uptime to detect bad shutdowns."; }; period = mkOption { type = types.str; default = "*:0/5"; - description = "systemd calendar event"; + description = lib.mdDoc "systemd calendar event"; }; }; }; diff --git a/nixos/modules/services/monitoring/unifi-poller.nix b/nixos/modules/services/monitoring/unifi-poller.nix index cca4a0e720714..a955bf4907fc4 100644 --- a/nixos/modules/services/monitoring/unifi-poller.nix +++ b/nixos/modules/services/monitoring/unifi-poller.nix @@ -17,7 +17,7 @@ in { debug = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Turns on line numbers, microsecond logging, and a per-device log. This may be noisy if you have a lot of devices. It adds one line per device. ''; @@ -25,14 +25,14 @@ in { quiet = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Turns off per-interval logs. Only startup and error logs will be emitted. ''; }; plugins = mkOption { type = with types; listOf str; default = []; - description = '' + description = lib.mdDoc '' Load additional plugins. ''; }; @@ -42,21 +42,21 @@ in { disable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to disable the prometheus ouput plugin. ''; }; http_listen = mkOption { type = types.str; default = "[::]:9130"; - description = '' + description = lib.mdDoc '' Bind the prometheus exporter to this IP or hostname. ''; }; report_errors = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to report errors. ''; }; @@ -66,21 +66,21 @@ in { disable = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Whether to disable the influxdb ouput plugin. ''; }; url = mkOption { type = types.str; default = "http://127.0.0.1:8086"; - description = '' + description = lib.mdDoc '' URL of the influxdb host. ''; }; user = mkOption { type = types.str; default = "unifipoller"; - description = '' + description = lib.mdDoc '' Username for the influxdb. ''; }; @@ -88,7 +88,7 @@ in { type = types.path; default = pkgs.writeText "unifi-poller-influxdb-default.password" "unifipoller"; defaultText = literalExpression "unifi-poller-influxdb-default.password"; - description = '' + description = lib.mdDoc '' Path of a file containing the password for influxdb. This file needs to be readable by the unifi-poller user. ''; @@ -97,21 +97,21 @@ in { db = mkOption { type = types.str; default = "unifi"; - description = '' + description = lib.mdDoc '' Database name. Database should exist. ''; }; verify_ssl = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Verify the influxdb's certificate. ''; }; interval = mkOption { type = types.str; default = "30s"; - description = '' + description = lib.mdDoc '' Setting this lower than the Unifi controller's refresh interval may lead to zeroes in your database. ''; @@ -122,14 +122,14 @@ in { url = mkOption { type = types.str; default = ""; - description = '' + description = lib.mdDoc '' URL of the Loki host. ''; }; user = mkOption { type = types.str; default = ""; - description = '' + description = lib.mdDoc '' Username for Loki. ''; }; @@ -137,7 +137,7 @@ in { type = types.path; default = pkgs.writeText "unifi-poller-loki-default.password" ""; defaultText = "unifi-poller-influxdb-default.password"; - description = '' + description = lib.mdDoc '' Path of a file containing the password for Loki. This file needs to be readable by the unifi-poller user. ''; @@ -146,28 +146,28 @@ in { verify_ssl = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Verify Loki's certificate. ''; }; tenant_id = mkOption { type = types.str; default = ""; - description = '' + description = lib.mdDoc '' Tenant ID to use in Loki. ''; }; interval = mkOption { type = types.str; default = "2m"; - description = '' + description = lib.mdDoc '' How often the events are polled and pushed to Loki. ''; }; timeout = mkOption { type = types.str; default = "10s"; - description = '' + description = lib.mdDoc '' Should be increased in case of timeout errors. ''; }; @@ -178,7 +178,7 @@ in { user = mkOption { type = types.str; default = "unifi"; - description = '' + description = lib.mdDoc '' Unifi service user name. ''; }; @@ -186,7 +186,7 @@ in { type = types.path; default = pkgs.writeText "unifi-poller-unifi-default.password" "unifi"; defaultText = literalExpression "unifi-poller-unifi-default.password"; - description = '' + description = lib.mdDoc '' Path of a file containing the password for the unifi service user. This file needs to be readable by the unifi-poller user. ''; @@ -195,14 +195,14 @@ in { url = mkOption { type = types.str; default = "https://unifi:8443"; - description = '' + description = lib.mdDoc '' URL of the Unifi controller. ''; }; sites = mkOption { type = with types; either (enum [ "default" "all" ]) (listOf str); default = "all"; - description = '' + description = lib.mdDoc '' List of site names for which statistics should be exported. Or the string "default" for the default site or the string "all" for all sites. ''; @@ -211,35 +211,35 @@ in { save_ids = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Collect and save data from the intrusion detection system to influxdb and Loki. ''; }; save_events = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Collect and save data from UniFi events to influxdb and Loki. ''; }; save_alarms = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Collect and save data from UniFi alarms to influxdb and Loki. ''; }; save_anomalies = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Collect and save data from UniFi anomalies to influxdb and Loki. ''; }; save_dpi = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Collect and save data from deep packet inspection. Adds around 150 data points and impacts performance. ''; @@ -247,14 +247,14 @@ in { save_sites = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Collect and save site data. ''; }; hash_pii = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Hash, with md5, client names and MAC addresses. This attempts to protect personally identifiable information. ''; @@ -262,7 +262,7 @@ in { verify_ssl = mkOption { type = types.bool; default = true; - description = '' + description = lib.mdDoc '' Verify the Unifi controller's certificate. ''; }; @@ -272,7 +272,7 @@ in { dynamic = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Let prometheus select which controller to poll when scraping. Use with default credentials. See unifi-poller wiki for more. ''; @@ -283,7 +283,7 @@ in { controllers = mkOption { type = with types; listOf (submodule { options = controllerOptions; }); default = []; - description = '' + description = lib.mdDoc '' List of Unifi controllers to poll. Use defaults if empty. ''; apply = map (flip removeAttrs [ "_module" ]); diff --git a/nixos/modules/services/monitoring/ups.nix b/nixos/modules/services/monitoring/ups.nix index ae5097c54424c..8af2c2a1f253b 100644 --- a/nixos/modules/services/monitoring/ups.nix +++ b/nixos/modules/services/monitoring/ups.nix @@ -16,7 +16,7 @@ let # /nix/store/nut/share/driver.list driver = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' Specify the program to run to talk to this UPS. apcsmart, bestups, and sec are some examples. ''; @@ -24,7 +24,7 @@ let port = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' The serial port to which your UPS is connected. /dev/ttyS0 is usually the first port on Linux boxes, for example. ''; @@ -33,7 +33,7 @@ let shutdownOrder = mkOption { default = 0; type = types.int; - description = '' + description = lib.mdDoc '' When you have multiple UPSes on your system, you usually need to turn them off in a certain order. upsdrvctl shuts down all the 0s, then the 1s, 2s, and so on. To exclude a UPS from the @@ -44,7 +44,7 @@ let maxStartDelay = mkOption { default = null; type = types.uniq (types.nullOr types.int); - description = '' + description = lib.mdDoc '' This can be set as a global variable above your first UPS definition and it can also be set in a UPS section. This value controls how long upsdrvctl will wait for the driver to finish @@ -56,7 +56,7 @@ let description = mkOption { default = ""; type = types.str; - description = '' + description = lib.mdDoc '' Description of the UPS. ''; }; @@ -64,7 +64,7 @@ let directives = mkOption { default = []; type = types.listOf types.str; - description = '' + description = lib.mdDoc '' List of configuration directives for this UPS. ''; }; @@ -72,7 +72,7 @@ let summary = mkOption { default = ""; type = types.lines; - description = '' + description = lib.mdDoc '' Lines which would be added inside ups.conf for handling this UPS. ''; }; @@ -106,7 +106,7 @@ in enable = mkOption { default = false; type = with types; bool; - description = '' + description = lib.mdDoc '' Enables support for Power Devices, such as Uninterruptible Power Supplies, Power Distribution Units and Solar Controllers. ''; @@ -143,7 +143,7 @@ in schedulerRules = mkOption { example = "/etc/nixos/upssched.conf"; type = types.str; - description = '' + description = lib.mdDoc '' File which contains the rules to handle UPS events. ''; }; @@ -152,7 +152,7 @@ in maxStartDelay = mkOption { default = 45; type = types.int; - description = '' + description = lib.mdDoc '' This can be set as a global variable above your first UPS definition and it can also be set in a UPS section. This value controls how long upsdrvctl will wait for the driver to finish @@ -164,7 +164,7 @@ in ups = mkOption { default = {}; # see nut/etc/ups.conf.sample - description = '' + description = lib.mdDoc '' This is where you configure all the UPSes that this system will be monitoring directly. These are usually attached to serial ports, but USB devices are also supported. diff --git a/nixos/modules/services/monitoring/uptime.nix b/nixos/modules/services/monitoring/uptime.nix index 79b86be6cc715..24ca7c3763f41 100644 --- a/nixos/modules/services/monitoring/uptime.nix +++ b/nixos/modules/services/monitoring/uptime.nix @@ -26,7 +26,7 @@ let in { options.services.uptime = { configFile = mkOption { - description = '' + description = lib.mdDoc '' The uptime configuration file If mongodb: server != localhost, please set usesRemoteMongo = true @@ -44,7 +44,7 @@ in { }; usesRemoteMongo = mkOption { - description = "Whether the configuration file specifies a remote mongo instance"; + description = lib.mdDoc "Whether the configuration file specifies a remote mongo instance"; default = false; @@ -59,7 +59,7 @@ in { }; nodeEnv = mkOption { - description = "The node environment to run in (development, production, etc.)"; + description = lib.mdDoc "The node environment to run in (development, production, etc.)"; type = types.str; diff --git a/nixos/modules/services/monitoring/zabbix-agent.nix b/nixos/modules/services/monitoring/zabbix-agent.nix index c48b973f1ef7e..f2a8adace69e9 100644 --- a/nixos/modules/services/monitoring/zabbix-agent.nix +++ b/nixos/modules/services/monitoring/zabbix-agent.nix @@ -35,7 +35,7 @@ in type = types.package; default = pkgs.zabbix.agent; defaultText = literalExpression "pkgs.zabbix.agent"; - description = "The Zabbix package to use."; + description = lib.mdDoc "The Zabbix package to use."; }; extraPackages = mkOption { @@ -51,7 +51,7 @@ in modules = mkOption { type = types.attrsOf types.package; - description = "A set of modules to load."; + description = lib.mdDoc "A set of modules to load."; default = {}; example = literalExpression '' { @@ -71,7 +71,7 @@ in server = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' The IP address or hostname of the Zabbix server to connect to. ''; }; @@ -80,7 +80,7 @@ in ip = mkOption { type = types.str; default = "0.0.0.0"; - description = '' + description = lib.mdDoc '' List of comma delimited IP addresses that the agent should listen on. ''; }; @@ -88,7 +88,7 @@ in port = mkOption { type = types.port; default = 10050; - description = '' + description = lib.mdDoc '' Agent will listen on this port for connections from the server. ''; }; @@ -97,7 +97,7 @@ in openFirewall = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Open ports in the firewall for the Zabbix Agent. ''; }; @@ -105,9 +105,9 @@ in settings = mkOption { type = with types; attrsOf (oneOf [ int str (listOf str) ]); default = {}; - description = '' + description = lib.mdDoc '' Zabbix Agent configuration. Refer to - <link xlink:href="https://www.zabbix.com/documentation/current/manual/appendix/config/zabbix_agentd"/> + <https://www.zabbix.com/documentation/current/manual/appendix/config/zabbix_agentd> for details on supported values. ''; example = { diff --git a/nixos/modules/services/monitoring/zabbix-proxy.nix b/nixos/modules/services/monitoring/zabbix-proxy.nix index 0ebd7bcff8343..9cfe1bdaa2054 100644 --- a/nixos/modules/services/monitoring/zabbix-proxy.nix +++ b/nixos/modules/services/monitoring/zabbix-proxy.nix @@ -42,7 +42,7 @@ in server = mkOption { type = types.str; - description = '' + description = lib.mdDoc '' The IP address or hostname of the Zabbix server to connect to. ''; }; @@ -54,7 +54,7 @@ in else if cfg.database.type == "pgsql" then pkgs.zabbix.proxy-pgsql else pkgs.zabbix.proxy-sqlite; defaultText = literalExpression "pkgs.zabbix.proxy-pgsql"; - description = "The Zabbix package to use."; + description = lib.mdDoc "The Zabbix package to use."; }; extraPackages = mkOption { @@ -69,7 +69,7 @@ in modules = mkOption { type = types.attrsOf types.package; - description = "A set of modules to load."; + description = lib.mdDoc "A set of modules to load."; default = {}; example = literalExpression '' { @@ -92,13 +92,13 @@ in type = types.enum [ "mysql" "pgsql" "sqlite" ]; example = "mysql"; default = "pgsql"; - description = "Database engine to use."; + description = lib.mdDoc "Database engine to use."; }; host = mkOption { type = types.str; default = "localhost"; - description = "Database host address."; + description = lib.mdDoc "Database host address."; }; port = mkOption { @@ -109,29 +109,29 @@ in then config.${options.services.mysql.port} else config.${options.services.postgresql.port} ''; - description = "Database host port."; + description = lib.mdDoc "Database host port."; }; name = mkOption { type = types.str; default = if cfg.database.type == "sqlite" then "${stateDir}/zabbix.db" else "zabbix"; defaultText = literalExpression "zabbix"; - description = "Database name."; + description = lib.mdDoc "Database name."; }; user = mkOption { type = types.str; default = "zabbix"; - description = "Database user."; + description = lib.mdDoc "Database user."; }; passwordFile = mkOption { type = types.nullOr types.path; default = null; example = "/run/keys/zabbix-dbpassword"; - description = '' + description = lib.mdDoc '' A file containing the password corresponding to - <option>database.user</option>. + {option}`database.user`. ''; }; @@ -139,13 +139,13 @@ in type = types.nullOr types.path; default = null; example = "/run/postgresql"; - description = "Path to the unix socket file to use for authentication."; + description = lib.mdDoc "Path to the unix socket file to use for authentication."; }; createLocally = mkOption { type = types.bool; default = true; - description = "Whether to create a local database automatically."; + description = lib.mdDoc "Whether to create a local database automatically."; }; }; @@ -153,7 +153,7 @@ in ip = mkOption { type = types.str; default = "0.0.0.0"; - description = '' + description = lib.mdDoc '' List of comma delimited IP addresses that the trapper should listen on. Trapper will listen on all network interfaces if this parameter is missing. ''; @@ -162,7 +162,7 @@ in port = mkOption { type = types.port; default = 10051; - description = '' + description = lib.mdDoc '' Listen port for trapper. ''; }; @@ -171,7 +171,7 @@ in openFirewall = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Open ports in the firewall for the Zabbix Proxy. ''; }; @@ -179,9 +179,9 @@ in settings = mkOption { type = with types; attrsOf (oneOf [ int str (listOf str) ]); default = {}; - description = '' + description = lib.mdDoc '' Zabbix Proxy configuration. Refer to - <link xlink:href="https://www.zabbix.com/documentation/current/manual/appendix/config/zabbix_proxy"/> + <https://www.zabbix.com/documentation/current/manual/appendix/config/zabbix_proxy> for details on supported values. ''; example = { diff --git a/nixos/modules/services/monitoring/zabbix-server.nix b/nixos/modules/services/monitoring/zabbix-server.nix index 9f960517a81b0..566ec4ab2f6d0 100644 --- a/nixos/modules/services/monitoring/zabbix-server.nix +++ b/nixos/modules/services/monitoring/zabbix-server.nix @@ -46,7 +46,7 @@ in type = types.package; default = if cfg.database.type == "mysql" then pkgs.zabbix.server-mysql else pkgs.zabbix.server-pgsql; defaultText = literalExpression "pkgs.zabbix.server-pgsql"; - description = "The Zabbix package to use."; + description = lib.mdDoc "The Zabbix package to use."; }; extraPackages = mkOption { @@ -61,7 +61,7 @@ in modules = mkOption { type = types.attrsOf types.package; - description = "A set of modules to load."; + description = lib.mdDoc "A set of modules to load."; default = {}; example = literalExpression '' { @@ -84,13 +84,13 @@ in type = types.enum [ "mysql" "pgsql" ]; example = "mysql"; default = "pgsql"; - description = "Database engine to use."; + description = lib.mdDoc "Database engine to use."; }; host = mkOption { type = types.str; default = "localhost"; - description = "Database host address."; + description = lib.mdDoc "Database host address."; }; port = mkOption { @@ -101,28 +101,28 @@ in then config.${options.services.mysql.port} else config.${options.services.postgresql.port} ''; - description = "Database host port."; + description = lib.mdDoc "Database host port."; }; name = mkOption { type = types.str; default = "zabbix"; - description = "Database name."; + description = lib.mdDoc "Database name."; }; user = mkOption { type = types.str; default = "zabbix"; - description = "Database user."; + description = lib.mdDoc "Database user."; }; passwordFile = mkOption { type = types.nullOr types.path; default = null; example = "/run/keys/zabbix-dbpassword"; - description = '' + description = lib.mdDoc '' A file containing the password corresponding to - <option>database.user</option>. + {option}`database.user`. ''; }; @@ -130,13 +130,13 @@ in type = types.nullOr types.path; default = null; example = "/run/postgresql"; - description = "Path to the unix socket file to use for authentication."; + description = lib.mdDoc "Path to the unix socket file to use for authentication."; }; createLocally = mkOption { type = types.bool; default = true; - description = "Whether to create a local database automatically."; + description = lib.mdDoc "Whether to create a local database automatically."; }; }; @@ -144,7 +144,7 @@ in ip = mkOption { type = types.str; default = "0.0.0.0"; - description = '' + description = lib.mdDoc '' List of comma delimited IP addresses that the trapper should listen on. Trapper will listen on all network interfaces if this parameter is missing. ''; @@ -153,7 +153,7 @@ in port = mkOption { type = types.port; default = 10051; - description = '' + description = lib.mdDoc '' Listen port for trapper. ''; }; @@ -162,7 +162,7 @@ in openFirewall = mkOption { type = types.bool; default = false; - description = '' + description = lib.mdDoc '' Open ports in the firewall for the Zabbix Server. ''; }; @@ -170,9 +170,9 @@ in settings = mkOption { type = with types; attrsOf (oneOf [ int str (listOf str) ]); default = {}; - description = '' + description = lib.mdDoc '' Zabbix Server configuration. Refer to - <link xlink:href="https://www.zabbix.com/documentation/current/manual/appendix/config/zabbix_server"/> + <https://www.zabbix.com/documentation/current/manual/appendix/config/zabbix_server> for details on supported values. ''; example = { |