Influxdb2
services.influxdb2.enable
Whether to enable the influxdb2 server.
Type: boolean
Default
false
Example
true
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/databases/influxdb2.nix
services.influxdb2.package
The influxdb2 package to use.
Type: package
Default
pkgs.influxdb2
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/databases/influxdb2.nix
services.influxdb2.provision.enable
Whether to enable initial database setup and provisioning.
Type: boolean
Default
false
Example
true
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/databases/influxdb2.nix
services.influxdb2.provision.initialSetup.bucket
Primary bucket name
Type: string
Example
"example"
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/databases/influxdb2.nix
services.influxdb2.provision.initialSetup.organization
Primary organization name
Type: string
Example
"main"
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/databases/influxdb2.nix
services.influxdb2.provision.initialSetup.passwordFile
Password for primary user. Don't use a file from the nix store!
Type: path
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/databases/influxdb2.nix
services.influxdb2.provision.initialSetup.retention
The duration in seconds for which the bucket will retain data (0 is infinite).
Type: unsigned integer, meaning >=0
Default
0
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/databases/influxdb2.nix
services.influxdb2.provision.initialSetup.tokenFile
API Token to set for the admin user. Don't use a file from the nix store!
Type: path
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/databases/influxdb2.nix
services.influxdb2.provision.initialSetup.username
Primary username
Type: string
Default
"admin"
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/databases/influxdb2.nix
services.influxdb2.provision.organizations
Organizations to provision.
Type: attribute set of (submodule)
Default
{ }
Example
{myorg = {description = "My organization";buckets.mybucket = {description = "My bucket";retention = 31536000; # 1 year};auths.mytoken = {readBuckets = ["mybucket"];tokenFile = "/run/secrets/mytoken";};};}
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/databases/influxdb2.nix
services.influxdb2.provision.organizations.<name>.auths
API tokens to provision for the user in this organization.
Type: attribute set of (submodule)
Default
{ }
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/databases/influxdb2.nix
services.influxdb2.provision.organizations.<name>.auths.<name>.allAccess
Grants all permissions in the associated organization.
Type: boolean
Default
false
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/databases/influxdb2.nix
services.influxdb2.provision.organizations.<name>.auths.<name>.description
Optional description for the API token. Note that the actual token will always be created with a descriptionregardless of whether this is given or not. The name is always added plus a unique suffix to later identify the token to track whether it has already been created.
Type: null or string
Default
null
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/databases/influxdb2.nix
services.influxdb2.provision.organizations.<name>.auths.<name>.id
A unique identifier for this authentication token. Since influx doesn't store names for tokens, this will be hashed and appended to the description to identify the token.
Type: string
Default
"<a hash derived from org and name>"
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/databases/influxdb2.nix
services.influxdb2.provision.organizations.<name>.auths.<name>.operator
Grants all permissions in all organizations.
Type: boolean
Default
false
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/databases/influxdb2.nix
services.influxdb2.provision.organizations.<name>.auths.<name>.present
Whether to ensure that this user is present or absent.
Type: boolean
Default
true
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/databases/influxdb2.nix
services.influxdb2.provision.organizations.<name>.auths.<name>.readBuckets
The organization's buckets which should be allowed to be read
Type: list of string
Default
[ ]
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/databases/influxdb2.nix
services.influxdb2.provision.organizations.<name>.auths.<name>.readPermissions
The read permissions to include for this token. Access is usually granted only for resources in the associated organization.
Available permissions are authorizations, buckets, dashboards,
orgs, tasks, telegrafs, users, variables, secrets, labels, views,
documents, notificationRules, notificationEndpoints, checks, dbrp,
annotations, sources, scrapers, notebooks, remotes, replications.
Refer to influx auth create --help for a full list with descriptions.
buckets grants read access to all associated buckets. Use readBuckets to define
more granular access permissions.
Type: list of (one of "authorizations", "buckets", "dashboards", "orgs", "tasks", "telegrafs", "users", "variables", "secrets", "labels", "views", "documents", "notificationRules", "notificationEndpoints", "checks", "dbrp", "annotations", "sources", "scrapers", "notebooks", "remotes", "replications")
Default
[ ]
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/databases/influxdb2.nix
services.influxdb2.provision.organizations.<name>.auths.<name>.tokenFile
The token value. If not given, influx will automatically generate one.
Type: null or path
Default
null
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/databases/influxdb2.nix
services.influxdb2.provision.organizations.<name>.auths.<name>.writeBuckets
The organization's buckets which should be allowed to be written
Type: list of string
Default
[ ]
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/databases/influxdb2.nix
services.influxdb2.provision.organizations.<name>.auths.<name>.writePermissions
The read permissions to include for this token. Access is usually granted only for resources in the associated organization.
Available permissions are authorizations, buckets, dashboards,
orgs, tasks, telegrafs, users, variables, secrets, labels, views,
documents, notificationRules, notificationEndpoints, checks, dbrp,
annotations, sources, scrapers, notebooks, remotes, replications.
Refer to influx auth create --help for a full list with descriptions.
buckets grants write access to all associated buckets. Use writeBuckets to define
more granular access permissions.
Type: list of (one of "authorizations", "buckets", "dashboards", "orgs", "tasks", "telegrafs", "users", "variables", "secrets", "labels", "views", "documents", "notificationRules", "notificationEndpoints", "checks", "dbrp", "annotations", "sources", "scrapers", "notebooks", "remotes", "replications")
Default
[ ]
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/databases/influxdb2.nix
services.influxdb2.provision.organizations.<name>.buckets
Buckets to provision in this organization.
Type: attribute set of (submodule)
Default
{ }
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/databases/influxdb2.nix
services.influxdb2.provision.organizations.<name>.buckets.<name>.description
Optional description for the bucket.
Type: null or string
Default
null
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/databases/influxdb2.nix
services.influxdb2.provision.organizations.<name>.buckets.<name>.present
Whether to ensure that this bucket is present or absent.
Type: boolean
Default
true
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/databases/influxdb2.nix
services.influxdb2.provision.organizations.<name>.buckets.<name>.retention
The duration in seconds for which the bucket will retain data (0 is infinite).
Type: unsigned integer, meaning >=0
Default
0
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/databases/influxdb2.nix
services.influxdb2.provision.organizations.<name>.description
Optional description for the organization.
Type: null or string
Default
null
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/databases/influxdb2.nix
services.influxdb2.provision.organizations.<name>.present
Whether to ensure that this organization is present or absent.
Type: boolean
Default
true
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/databases/influxdb2.nix
services.influxdb2.provision.users
Users to provision.
Type: attribute set of (submodule)
Default
{ }
Example
{# admin = {}; /* The initialSetup.username will automatically be added. */myuser.passwordFile = "/run/secrets/myuser_password";}
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/databases/influxdb2.nix
services.influxdb2.provision.users.<name>.passwordFile
Password for the user. If unset, the user will not be able to log in until a password is set by an operator! Don't use a file from the nix store!
Type: null or path
Default
null
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/databases/influxdb2.nix
services.influxdb2.provision.users.<name>.present
Whether to ensure that this user is present or absent.
Type: boolean
Default
true
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/databases/influxdb2.nix
services.influxdb2.settings
configuration options for influxdb2, see https://docs.influxdata.com/influxdb/v2.0/reference/config-options for details.
Type: JSON value
Default
{ }
Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/databases/influxdb2.nix