Skip to content

Consul template

services.consul-template.instances

Attribute set of consul-template instances. Creates independent consul-template-${name}.service systemd units for each instance defined here.

Type: attribute set of (submodule)

Default

{ }

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/security/vault-agent.nix

services.consul-template.instances.<name>.enable

Whether to enable this consul-template instance. Type: boolean

Default

true

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/security/vault-agent.nix

services.consul-template.instances.<name>.group

Group under which this instance runs.

Type: string

Default

"root"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/security/vault-agent.nix

services.consul-template.instances.<name>.package

The consul-template package to use. Type: package

Default

pkgs.consul-template

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/security/vault-agent.nix

services.consul-template.instances.<name>.settings

Free-form settings written directly to the config.json file. Refer to https://github.com/hashicorp/consul-template/blob/main/docs/configuration.md#configuration-file for supported values.

::: {.note} Resulting format is JSON not HCL. Refer to https://www.hcl2json.com/ if you are unsure how to convert HCL options to JSON. :::

Type: JSON value

Default

{ }

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/security/vault-agent.nix

services.consul-template.instances.<name>.settings.pid_file

Path to use for the pid file.

Type: string

Default

"/run/consul-template/‹name›.pid"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/security/vault-agent.nix

services.consul-template.instances.<name>.settings.template

Template section of consul-template. Refer to https://github.com/hashicorp/consul-template/blob/main/docs/configuration.md#templates for supported values.

Type: list of attribute set of anything

Default

[ ]

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/security/vault-agent.nix

services.consul-template.instances.<name>.user

User under which this instance runs.

Type: string

Default

"root"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/security/vault-agent.nix