JakeHillion/nixpkgs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add trailing periods to all Grafana option descriptions

Browse Source
This commit is contained in:
Isaac van Bakel 2021-01-28 14:17:13 +00:00 committed by tomberek
parent f689b8a65f
commit 3e4499519d
1 changed files with 45 additions and 45 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

90
nixos/modules/services/monitoring/grafana.nix
View File

@ -87,80 +87,80 @@ let
options = { options = {
name = mkOption { name = mkOption {
type = types.str; type = types.str;
description = "Name of the datasource. Required"; description = "Name of the datasource. Required.";
}; };
type = mkOption { type = mkOption {
type = types.enum ["graphite" "prometheus" "cloudwatch" "elasticsearch" "influxdb" "opentsdb" "mysql" "mssql" "postgres" "loki"]; type = types.enum ["graphite" "prometheus" "cloudwatch" "elasticsearch" "influxdb" "opentsdb" "mysql" "mssql" "postgres" "loki"];
description = "Datasource type. Required"; description = "Datasource type. Required.";
}; };
access = mkOption { access = mkOption {
type = types.enum ["proxy" "direct"]; type = types.enum ["proxy" "direct"];
default = "proxy"; default = "proxy";
description = "Access mode. proxy or direct (Server or Browser in the UI). Required"; description = "Access mode. proxy or direct (Server or Browser in the UI). Required.";
}; };
orgId = mkOption { orgId = mkOption {
type = types.int; type = types.int;
default = 1; default = 1;
description = "Org id. will default to orgId 1 if not specified"; description = "Org id. will default to orgId 1 if not specified.";
}; };
url = mkOption { url = mkOption {
type = types.str; type = types.str;
description = "Url of the datasource"; description = "Url of the datasource.";
}; };
password = mkOption { password = mkOption {
type = types.nullOr types.str; type = types.nullOr types.str;
default = null; default = null;
description = "Database password, if used"; description = "Database password, if used.";
}; };
user = mkOption { user = mkOption {
type = types.nullOr types.str; type = types.nullOr types.str;
default = null; default = null;
description = "Database user, if used"; description = "Database user, if used.";
}; };
database = mkOption { database = mkOption {
type = types.nullOr types.str; type = types.nullOr types.str;
default = null; default = null;
description = "Database name, if used"; description = "Database name, if used.";
}; };
basicAuth = mkOption { basicAuth = mkOption {
type = types.nullOr types.bool; type = types.nullOr types.bool;
default = null; default = null;
description = "Enable/disable basic auth"; description = "Enable/disable basic auth.";
}; };
basicAuthUser = mkOption { basicAuthUser = mkOption {
type = types.nullOr types.str; type = types.nullOr types.str;
default = null; default = null;
description = "Basic auth username"; description = "Basic auth username.";
}; };
basicAuthPassword = mkOption { basicAuthPassword = mkOption {
type = types.nullOr types.str; type = types.nullOr types.str;
default = null; default = null;
description = "Basic auth password"; description = "Basic auth password.";
}; };
withCredentials = mkOption { withCredentials = mkOption {
type = types.bool; type = types.bool;
default = false; default = false;
description = "Enable/disable with credentials headers"; description = "Enable/disable with credentials headers.";
}; };
isDefault = mkOption { isDefault = mkOption {
type = types.bool; type = types.bool;
default = false; default = false;
description = "Mark as default datasource. Max one per org"; description = "Mark as default datasource. Max one per org.";
}; };
jsonData = mkOption { jsonData = mkOption {
type = types.nullOr types.attrs; type = types.nullOr types.attrs;
default = null; default = null;
description = "Datasource specific configuration"; description = "Datasource specific configuration.";
}; };
secureJsonData = mkOption { secureJsonData = mkOption {
type = types.nullOr types.attrs; type = types.nullOr types.attrs;
default = null; default = null;
description = "Datasource specific secure configuration"; description = "Datasource specific secure configuration.";
}; };
version = mkOption { version = mkOption {
type = types.int; type = types.int;
default = 1; default = 1;
description = "Version"; description = "Version.";
}; };
editable = mkOption { editable = mkOption {
type = types.bool; type = types.bool;
@ -176,37 +176,37 @@ let
name = mkOption { name = mkOption {
type = types.str; type = types.str;
default = "default"; default = "default";
description = "Provider name"; description = "Provider name.";
}; };
orgId = mkOption { orgId = mkOption {
type = types.int; type = types.int;
default = 1; default = 1;
description = "Organization ID"; description = "Organization ID.";
}; };
folder = mkOption { folder = mkOption {
type = types.str; type = types.str;
default = ""; default = "";
description = "Add dashboards to the specified folder"; description = "Add dashboards to the specified folder.";
}; };
type = mkOption { type = mkOption {
type = types.str; type = types.str;
default = "file"; default = "file";
description = "Dashboard provider type"; description = "Dashboard provider type.";
}; };
disableDeletion = mkOption { disableDeletion = mkOption {
type = types.bool; type = types.bool;
default = false; default = false;
description = "Disable deletion when JSON file is removed"; description = "Disable deletion when JSON file is removed.";
}; };
updateIntervalSeconds = mkOption { updateIntervalSeconds = mkOption {
type = types.int; type = types.int;
default = 10; default = 10;
description = "How often Grafana will scan for changed dashboards"; description = "How often Grafana will scan for changed dashboards.";
}; };
options = { options = {
path = mkOption { path = mkOption {
type = types.path; type = types.path;
description = "Path grafana will watch for dashboards"; description = "Path grafana will watch for dashboards.";
}; };
}; };
}; };
@ -217,55 +217,55 @@ let
name = mkOption { name = mkOption {
type = types.str; type = types.str;
default = "default"; default = "default";
description = "Notifier name"; description = "Notifier name.";
}; };
type = mkOption { 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"]; 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 = "Notifier type.";
}; };
uid = mkOption { uid = mkOption {
type = types.str; type = types.str;
description = "Unique notifier identifier"; description = "Unique notifier identifier.";
}; };
org_id = mkOption { org_id = mkOption {
type = types.int; type = types.int;
default = 1; default = 1;
description = "Organization ID"; description = "Organization ID.";
}; };
org_name = mkOption { org_name = mkOption {
type = types.str; type = types.str;
default = "Main Org."; default = "Main Org.";
description = "Organization name"; description = "Organization name.";
}; };
is_default = mkOption { is_default = mkOption {
type = types.bool; type = types.bool;
description = "Is the default notifier"; description = "Is the default notifier.";
default = false; default = false;
}; };
send_reminder = mkOption { send_reminder = mkOption {
type = types.bool; type = types.bool;
default = true; default = true;
description = "Should the notifier be sent reminder notifications while alerts continue to fire"; description = "Should the notifier be sent reminder notifications while alerts continue to fire.";
}; };
frequency = mkOption { frequency = mkOption {
type = types.str; type = types.str;
default = "5m"; default = "5m";
description = "How frequently should the notifier be sent reminders"; description = "How frequently should the notifier be sent reminders.";
}; };
disable_resolve_message = mkOption { disable_resolve_message = mkOption {
type = types.bool; type = types.bool;
default = false; default = false;
description = "Turn off the message that sends when an alert returns to OK"; description = "Turn off the message that sends when an alert returns to OK.";
}; };
settings = mkOption { settings = mkOption {
type = types.nullOr types.attrs; type = types.nullOr types.attrs;
default = null; default = null;
description = "Settings for the notifier type"; description = "Settings for the notifier type.";
}; };
secure_settings = mkOption { secure_settings = mkOption {
type = types.nullOr types.attrs; type = types.nullOr types.attrs;
default = null; default = null;
description = "Secure settings for the notifier type"; description = "Secure settings for the notifier type.";
}; };
}; };
}; };
@ -403,19 +403,19 @@ in {
provision = { provision = {
enable = mkEnableOption "provision"; enable = mkEnableOption "provision";
datasources = mkOption { datasources = mkOption {
description = "Grafana datasources configuration"; description = "Grafana datasources configuration.";
default = []; default = [];
type = types.listOf grafanaTypes.datasourceConfig; type = types.listOf grafanaTypes.datasourceConfig;
apply = x: map _filter x; apply = x: map _filter x;
}; };
dashboards = mkOption { dashboards = mkOption {
description = "Grafana dashboard configuration"; description = "Grafana dashboard configuration.";
default = []; default = [];
type = types.listOf grafanaTypes.dashboardConfig; type = types.listOf grafanaTypes.dashboardConfig;
apply = x: map _filter x; apply = x: map _filter x;
}; };
notifiers = mkOption { notifiers = mkOption {
description = "Grafana notifier configuration"; description = "Grafana notifier configuration.";
default = []; default = [];
type = types.listOf grafanaTypes.notifierConfig; type = types.listOf grafanaTypes.notifierConfig;
apply = x: map _filter x; apply = x: map _filter x;
@ -463,12 +463,12 @@ in {
smtp = { smtp = {
enable = mkEnableOption "smtp"; enable = mkEnableOption "smtp";
host = mkOption { host = mkOption {
description = "Host to connect to"; description = "Host to connect to.";
default = "localhost:25"; default = "localhost:25";
type = types.str; type = types.str;
}; };
user = mkOption { user = mkOption {
description = "User used for authentication"; description = "User used for authentication.";
default = ""; default = "";
type = types.str; type = types.str;
}; };
@ -489,7 +489,7 @@ in {
type = types.nullOr types.path; type = types.nullOr types.path;
}; };
fromAddress = mkOption { fromAddress = mkOption {
description = "Email address used for sending"; description = "Email address used for sending.";
default = "admin@grafana.localhost"; default = "admin@grafana.localhost";
type = types.str; type = types.str;
}; };
@ -497,7 +497,7 @@ in {
users = { users = {
allowSignUp = mkOption { allowSignUp = mkOption {
description = "Disable user signup / registration"; description = "Disable user signup / registration.";
default = false; default = false;
type = types.bool; type = types.bool;
}; };
@ -523,17 +523,17 @@ in {
auth.anonymous = { auth.anonymous = {
enable = mkOption { enable = mkOption {
description = "Whether to allow anonymous access"; description = "Whether to allow anonymous access.";
default = false; default = false;
type = types.bool; type = types.bool;
}; };
org_name = mkOption { org_name = mkOption {
description = "Which organization to allow anonymous access to"; description = "Which organization to allow anonymous access to.";
default = "Main Org."; default = "Main Org.";
type = types.str; type = types.str;
}; };
org_role = mkOption { org_role = mkOption {
description = "Which role anonymous users have in the organization"; description = "Which role anonymous users have in the organization.";
default = "Viewer"; default = "Viewer";
type = types.str; type = types.str;
}; };
@ -542,7 +542,7 @@ in {
analytics.reporting = { analytics.reporting = {
enable = mkOption { enable = mkOption {
description = "Whether to allow anonymous usage reporting to stats.grafana.net"; description = "Whether to allow anonymous usage reporting to stats.grafana.net.";
default = true; default = true;
type = types.bool; type = types.bool;
}; };