发现:Kuma
discovery.kuma
从 Kuma 控制平面发现抓取目标。
使用方法
discovery.kuma "LABEL" {
server = SERVER
}
参数
以下参数被支持
名称 | 类型 | 描述 | 默认 | 必需 |
---|---|---|---|---|
server | 字符串 | Kuma 控制平面 MADS xDS 服务器地址。 | 是 | |
refresh_interval | 时间持续时间 | 轮询更新请求之间的等待时间。 | "30s" | 否 |
fetch_timeout | 时间持续时间 | 在监控分配更新后多长时间。 | "2m" | 否 |
bearer_token_file | 字符串 | 包含用于身份验证的承载令牌的文件。 | 否 | |
bearer_token | 机密 | 用于身份验证的承载令牌。 | 否 | |
enable_http2 | 布尔值 | 是否支持请求的 HTTP2。 | 是 | 否 |
follow_redirects | 布尔值 | 是否应该跟随服务器返回的重定向。 | 是 | 否 |
proxy_url | 字符串 | 通过其发送请求的 HTTP 代理。 | 否 | |
no_proxy | 字符串 | 逗号分隔的 IP 地址、CIDR 表示法和域名列表,要从代理中排除。 | 否 | |
proxy_from_environment | 布尔值 | 使用环境变量指示的代理 URL。 | 否 | 否 |
proxy_connect_header | map(list(secret)) | 指定在连接请求期间发送到代理的头。 | 否 |
以下之一最多可提供
no_proxy
可以包含 IP、CIDR 表示法和域名。IP 和域名可以包含端口号。如果配置了 no_proxy
,则必须配置 proxy_url
。
proxy_from_environment
使用环境变量 HTTP_PROXY、HTTPS_PROXY 和 NO_PROXY(或其小写版本)。除非被 NO_PROXY 排除,否则请求将使用与其方案匹配的环境变量中的代理。如果配置了 proxy_from_environment
,则不得配置 proxy_url
和 no_proxy
。
proxy_connect_header
应仅在配置了 proxy_url
或 proxy_from_environment
时配置。
在 discovery.kuma
的定义中支持以下块
层次结构 | 块 | 描述 | 必需 |
---|---|---|---|
basic_auth | basic_auth | 配置对端点进行基本身份验证。 | 否 |
authorization | authorization | 配置对端点的通用身份验证。 | 否 |
oauth2 | oauth2 | 配置对端点的 OAuth2 身份验证。 | 否 |
oauth2 > tls_config | tls_config | 配置连接到端点的 TLS 设置。 | 否 |
tls_config | tls_config | 配置连接到端点的 TLS 设置。 | 否 |
《>》符号表示更深的嵌套级别。例如,oauth2 > tls_config
指的是一个定义在 oauth2
块内部的 tls_config
块。
基本认证块
名称 | 类型 | 描述 | 默认 | 必需 |
---|---|---|---|---|
password_file | 字符串 | 包含基本认证密码的文件。 | 否 | |
password | 机密 | 基本认证密码。 | 否 | |
username | 字符串 | 基本认证用户名。 | 否 |
password
和 password_file
是互相排斥的,在 basic_auth
块内部只能提供其中一个。
授权块
名称 | 类型 | 描述 | 默认 | 必需 |
---|---|---|---|---|
credentials_file | 字符串 | 包含密值的文件。 | 否 | |
credentials | 机密 | 密值。 | 否 | |
type | 字符串 | 授权类型,例如,“Bearer”。 | 否 |
credentials
和 credentials_file
是互相排斥的,在 authorization
块内部只能提供其中一个。
oauth2 块
名称 | 类型 | 描述 | 默认 | 必需 |
---|---|---|---|---|
client_id | 字符串 | OAuth2 客户端 ID。 | 否 | |
client_secret_file | 字符串 | 包含 OAuth2 客户端密钥的文件。 | 否 | |
client_secret | 机密 | OAuth2 客户端密钥。 | 否 | |
endpoint_params | map(string) | 可选参数,用于添加到令牌 URL 中。 | 否 | |
proxy_url | 字符串 | 通过其发送请求的 HTTP 代理。 | 否 | |
no_proxy | 字符串 | 逗号分隔的 IP 地址、CIDR 表示法和域名列表,要从代理中排除。 | 否 | |
proxy_from_environment | 布尔值 | 使用环境变量指示的代理 URL。 | 否 | 否 |
proxy_connect_header | map(list(secret)) | 指定在连接请求期间发送到代理的头。 | 否 | |
scopes | list(string) | 用于认证的作用域列表。 | 否 | |
token_url | 字符串 | 获取令牌的 URL。 | 否 |
client_secret
和 client_secret_file
是互相排斥的,在 oauth2
块内部只能提供其中一个。
oauth2
块还可以包含一个独立的 tls_config
子块。
no_proxy
可以包含 IP、CIDR 表示法和域名。IP 和域名可以包含端口号。如果配置了 no_proxy
,则必须配置 proxy_url
。
proxy_from_environment
使用环境变量 HTTP_PROXY、HTTPS_PROXY 和 NO_PROXY(或其小写版本)。除非被 NO_PROXY 排除,否则请求将使用与其方案匹配的环境变量中的代理。如果配置了 proxy_from_environment
,则不得配置 proxy_url
和 no_proxy
。
proxy_connect_header
应仅在配置了 proxy_url
或 proxy_from_environment
时配置。
tls_config 块
名称 | 类型 | 描述 | 默认 | 必需 |
---|---|---|---|---|
ca_pem | 字符串 | 用于验证服务器的 CA PEM 编码文本。 | 否 | |
ca_file | 字符串 | 用于验证服务器的 CA 证书。 | 否 | |
cert_pem | 字符串 | 用于客户端认证的证书 PEM 编码文本。 | 否 | |
cert_file | 字符串 | 用于客户端认证的证书文件。 | 否 | |
insecure_skip_verify | 布尔值 | 禁用服务器证书的验证。 | 否 | |
key_file | 字符串 | 用于客户端认证的密钥文件。 | 否 | |
key_pem | 机密 | 用于客户端认证的密钥 PEM 编码文本。 | 否 | |
min_version | 字符串 | 可接受的最小 TLS 版本。 | 否 | |
server_name | 字符串 | ServerName 扩展,用于指示服务器名称。 | 否 |
以下参数对是互相排斥的,不能同时设置
ca_pem
和ca_file
cert_pem
和cert_file
key_pem
和key_file
在配置客户端认证时,必须同时提供客户端证书(使用 cert_pem
或 cert_file
)和客户端密钥(使用 key_pem
或 key_file
)。
如果没有提供 min_version
,则可接受的最小 TLS 版本将从 Go 的默认最小版本 TLS 1.2 继承。如果提供了 min_version
,则必须将其设置为以下字符串之一:
"TLS10"
(TLS 1.0)"TLS11"
(TLS 1.1)"TLS12"
(TLS 1.2)"TLS13"
(TLS 1.3)
导出字段
以下字段是导出的,可以作为其他组件的引用
名称 | 类型 | 描述 |
---|---|---|
targets | list(map(string)) | 从 Kuma API 中发现的集合。 |
以下元标签在目标上可用,并可用于 discovery.relabel 组件
__meta_kuma_mesh
:代理 Mesh 的名称__meta_kuma_dataplane
:代理的名称__meta_kuma_service
:与代理关联的服务名称__meta_kuma_label_<tagname>
:代理的每个标签
组件健康
discovery.kuma
只在给定无效配置时报告为不健康。在这些情况下,导出字段保留其最后健康的值。
调试信息
discovery.kuma
不公开任何特定组件的调试信息。
调试度量
discovery.kuma
不公开任何特定组件的调试度量。
示例
discovery.kuma "example" {
server = "http://kuma-control-plane.kuma-system.svc:5676"
}
prometheus.scrape "demo" {
targets = discovery.kuma.example.targets
forward_to = [prometheus.remote_write.demo.receiver]
}
prometheus.remote_write "demo" {
endpoint {
url = PROMETHEUS_REMOTE_WRITE_URL
basic_auth {
username = USERNAME
password = PASSWORD
}
}
}
替换以下内容
PROMETHEUS_REMOTE_WRITE_URL
:将度量发送到 Prometheus remote_write 兼容服务器的 URL。USERNAME
:用于远程_write API 认证的用户名。PASSWORD
:用于远程_write API 认证的密码。
兼容组件
discovery.kuma
有导出字段,可以被以下组件消费
- 消耗目标的组件
注意
连接某些组件可能不合理,或者可能需要进一步配置才能正确连接。有关更多详细信息,请参阅相关文档。