Skip to content

Vault agent

services.vault-agent.instances

Attribute set of vault-agent instances. Creates independent vault-agent-${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.vault-agent.instances.<name>.enable

Whether to enable this vault-agent instance. Type: boolean

Default

true

Example

true

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

services.vault-agent.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.vault-agent.instances.<name>.package

The vault package to use. Type: package

Default

pkgs.vault

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

services.vault-agent.instances.<name>.settings

Free-form settings written directly to the config.json file. Refer to https://developer.hashicorp.com/vault/docs/agent#configuration-file-options 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.vault-agent.instances.<name>.settings.pid_file

Path to use for the pid file.

Type: string

Default

"/run/vault-agent/‹name›.pid"

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

services.vault-agent.instances.<name>.settings.template

Template section of vault-agent. Refer to https://developer.hashicorp.com/vault/docs/agent/template 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.vault-agent.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