diff options
Diffstat (limited to 'nixos/modules/services/monitoring/cadvisor.nix')
-rw-r--r-- | nixos/modules/services/monitoring/cadvisor.nix | 22 |
1 files changed, 11 insertions, 11 deletions
diff --git a/nixos/modules/services/monitoring/cadvisor.nix b/nixos/modules/services/monitoring/cadvisor.nix index dfbf07efcae..c844b1599dd 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 { |