nps.stacks.monitoring.enable

Enable the monitoring stack. This stack provides monitoring services including Grafana, Loki, Alloy, and Prometheus. Configuration files for each service will be provided automatically to work out of the box.

Type: boolean

Default: false

Example: true

Declared by:

nps.stacks.monitoring.alertmanager.enable

Whether to enable the Alertmanager.

When setting alertmanager.ntfy.enable, a route and receiver configuration will be setup for ntfy. If using without ntfy, you will have to provide your own route and receiver configurations via the settings option for Alertmanager to startup correctly.

Type: boolean

Default: false

Declared by:

nps.stacks.monitoring.alertmanager.ntfy.enable

Whether to setup and configure alertmanager-ntfy. This allows alerts to be forwarded to ntfy.

See https://github.com/alexbakker/alertmanager-ntfy

Type: boolean

Default: config.nps.stacks.ntfy.enable

Declared by:

nps.stacks.monitoring.alertmanager.ntfy.settings

alertmanager-ntfy configuration. Will be provided as the config.yml.

See https://github.com/alexbakker/alertmanager-ntfy/pkgs/container/alertmanager-ntfy#configuration

Type: YAML 1.1 value

Default: { }

Declared by:

nps.stacks.monitoring.alertmanager.ntfy.tokenFile

Path to the file containing the token that is used for authentication against the ntfy service. Only required if ntfy is configured to require authentication.

Type: null or absolute path

Default: null

Declared by:

nps.stacks.monitoring.alertmanager.settings

Alertmanager configuration. Will be provided as the alertmanager.yml.

See https://prometheus.io/docs/alerting/latest/configuration/

Type: YAML 1.1 value

Default: { }

Declared by:

nps.stacks.monitoring.alloy.enable

Whether to enable Alloy.

Type: boolean

Default: true

Example: true

Declared by:

nps.stacks.monitoring.alloy.config

Configuration for Alloy. A default configuration will be automatically provided by this monitoring module. The default configuration will ship logs of all containers that set the alloy.enable=true option to Loki. Multiple definitions of this option will be merged together into a single file.

See https://grafana.com/docs/alloy/latest/get-started/configuration-syntax/

Type: strings concatenated with “\n”

Declared by:

nps.stacks.monitoring.alloy.useSocketProxy

Whether to access the Podman socket through the read-only proxy for the monitoring stack. Will be enabled by default if the ‘docker-socket-proxy’ stack is enabled.

Type: boolean

Default: config.nps.stacks.docker-socket-proxy.enable

Declared by:

nps.stacks.monitoring.containers.alloy

Alias of services.podman.containers.alloy.

Type: submodule

Declared by:

nps.stacks.monitoring.containers.grafana

Alias of services.podman.containers.grafana.

Type: submodule

Declared by:

nps.stacks.monitoring.containers.loki

Alias of services.podman.containers.loki.

Type: submodule

Declared by:

nps.stacks.monitoring.containers.podman-exporter

Alias of services.podman.containers.podman-exporter.

Type: submodule

Declared by:

nps.stacks.monitoring.containers.prometheus

Alias of services.podman.containers.prometheus.

Type: submodule

Declared by:

nps.stacks.monitoring.grafana.enable

Whether to enable Grafana.

Type: boolean

Default: true

Example: true

Declared by:

nps.stacks.monitoring.grafana.dashboards

List of paths to Grafana dashboard JSON files.

Type: list of absolute path

Default: [ ]

Declared by:

nps.stacks.monitoring.grafana.datasources

Datasource configuration for Grafana. Loki and Prometheus datasources will be automatically configured.

Type: YAML 1.1 value

Declared by:

nps.stacks.monitoring.grafana.oidc.enable

Whether to enable OIDC login with Authelia. This will register an OIDC client in Authelia and setup the necessary configuration.

For details, see:

Type: boolean

Default: false

Declared by:

nps.stacks.monitoring.grafana.oidc.adminGroup

Users of this group will be assigned the Grafana ‘Admin’ role.

Type: string

Default: "grafana_admin"

Declared by:

nps.stacks.monitoring.grafana.oidc.clientSecretFile

The file containing the client secret for the OIDC client that will be registered in Authelia.

Type: string

Declared by:

nps.stacks.monitoring.grafana.oidc.clientSecretHash

The hashed client_secret. Will be set in the Authelia client config. For examples on how to generate a client secret, see

https://www.authelia.com/integration/openid-connect/frequently-asked-questions/#client-secret

Type: string

Declared by:

nps.stacks.monitoring.grafana.oidc.userGroup

Users of this group will be assigned the Grafana ‘Viewer’ role.

Type: string

Default: "grafana_user"

Declared by:

nps.stacks.monitoring.grafana.settings

Settings for Grafana. Will be written to the ‘grafana.ini’ file. See https://grafana.com/docs/grafana/latest/setup-grafana/configure-grafana/#configure-grafana

Type: attribute set of section of an INI file (attrs of INI atom (null, bool, int, float or string))

Default: { }

Declared by:

nps.stacks.monitoring.loki.enable

Whether to enable Loki.

Type: boolean

Default: true

Example: true

Declared by:

nps.stacks.monitoring.loki.config

Configuration for Loki. A default configuration will be automatically provided by this monitoring module.

See https://grafana.com/docs/loki/latest/configuration/

Type: YAML 1.1 value

Default: { }

Declared by:

nps.stacks.monitoring.podmanExporter.enable

Whether to enable Podman Metrics Exporter.

Type: boolean

Default: true

Example: true

Declared by:

nps.stacks.monitoring.prometheus.enable

Whether to enable Prometheus.

Type: boolean

Default: true

Example: true

Declared by:

nps.stacks.monitoring.prometheus.rules

Alerting rule configuration for Prometheus. If provided, the rules will added to the rule_file setting.

See https://prometheus.io/docs/prometheus/latest/configuration/alerting_rules/

Type: YAML 1.1 value

Default: { }

Declared by:

nps.stacks.monitoring.prometheus.settings

Configuration for Prometheus. A default configuration will be automatically provided by this monitoring module.

See https://prometheus.io/docs/prometheus/latest/configuration/configuration/

Type: YAML 1.1 value

Default: { }

Declared by: