NAME

IO::K8s::PrometheusOperator::V1alpha1::ConsulSDConfig - ConsulSDConfig defines a Consul service discovery configuration See https://prometheus.io/docs/prometheus/latest/configuration/configuration/#consul_sd_config

VERSION

version 1.108

allowStale

allowStale Consul results (see https://www.consul.io/api/features/consistency.html). Will reduce load on Consul. If unset, Prometheus uses its default value.

authorization

authorization defines the header configuration to authenticate against the Consul Server. Cannot be set at the same time as `basicAuth`, or `oauth2`.

basicAuth

basicAuth defines the information to authenticate against the Consul Server. More info: https://prometheus.io/docs/operating/configuration/#endpoints Cannot be set at the same time as `authorization`, or `oauth2`.

datacenter

datacenter defines the consul Datacenter name, if not provided it will use the local Consul Agent Datacenter.

enableHTTP2

enableHTTP2 defines whether to enable HTTP2.

filter

filter defines the filter expression used to filter the catalog results. See https://developer.hashicorp.com/consul/api-docs/catalog#filtering It requires Prometheus >= 3.0.0.

followRedirects

followRedirects defines whether HTTP requests follow HTTP 3xx redirects.

healthFilter

healthFilter defines the filter expression used to filter the health results. See https://developer.hashicorp.com/consul/api-docs/health#filtering It requires Prometheus >= 3.11.2.

namespace

namespace are only supported in Consul Enterprise.

It requires Prometheus >= 2.28.0.

noProxy

noProxy defines a comma-separated string that can contain IPs, CIDR notation, domain names that should be excluded from proxying. IP and domain names can contain port numbers.

It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.

nodeMeta

nodeMeta defines the node metadata key/value pairs to filter nodes for a given service. Starting with Consul 1.14, it is recommended to use `filter` with the `NodeMeta` selector instead.

oauth2

oauth2 defines the optional OAuth 2.0 configuration to authenticate against the target HTTP endpoint. Cannot be set at the same time as `authorization`, or `basicAuth`.

partition

partition defines the admin Partitions are only supported in Consul Enterprise.

pathPrefix

pathPrefix defines the prefix for URIs for when consul is behind an API gateway (reverse proxy).

It requires Prometheus >= 2.45.0.

proxyConnectHeader

proxyConnectHeader optionally specifies headers to send to proxies during CONNECT requests.

It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.

proxyFromEnvironment

proxyFromEnvironment defines whether to use the proxy configuration defined by environment variables (HTTP_PROXY, HTTPS_PROXY, and NO_PROXY).

It requires Prometheus >= v2.43.0, Alertmanager >= v0.25.0 or Thanos >= v0.32.0.

proxyUrl

proxyUrl defines the HTTP proxy server to use.

refreshInterval

refreshInterval defines the time after which the provided names are refreshed. If not set, Prometheus uses its default value.

scheme

scheme defines the HTTP Scheme.

server

server defines the consul server address. A valid string consisting of a hostname or IP followed by an optional port number.

services

services defines a list of services for which targets are retrieved. If omitted, all services are scraped.

tagSeparator

tagSeparator defines the string by which Consul tags are joined into the tag label. If unset, Prometheus uses its default value.

tags

tags defines an optional list of tags used to filter nodes for a given service. Services must contain all tags in the list. Starting with Consul 1.14, it is recommended to use `filter` with the `ServiceTags` selector instead.

tlsConfig

tlsConfig defines the TLS configuration to connect to the Consul API.

tokenRef

tokenRef defines the consul ACL TokenRef, if not provided it will use the ACL from the local Consul Agent.

SUPPORT

Issues

Please report bugs and feature requests on GitHub at https://github.com/pplu/io-k8s-p5/issues.

CONTRIBUTING

Contributions are welcome! Please fork the repository and submit a pull request.

AUTHORS

  • Torsten Raudssus <getty@cpan.org>

  • Jose Luis Martinez Torres <jlmartin@cpan.org>

COPYRIGHT AND LICENSE

This software is Copyright (c) 2018-2026 by Jose Luis Martinez Torres <jlmartin@cpan.org>.

This is free software, licensed under:

The Apache License, Version 2.0, January 2004