菜单
开源

发现:Kuma

discovery.kumaKuma 控制平面发现抓取目标。

使用方法

alloy
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_headermap(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_urlno_proxy

proxy_connect_header 应仅在配置了 proxy_urlproxy_from_environment 时配置。

discovery.kuma 的定义中支持以下块

层次结构描述必需
basic_authbasic_auth配置对端点进行基本身份验证。
authorizationauthorization配置对端点的通用身份验证。
oauth2oauth2配置对端点的 OAuth2 身份验证。
oauth2 > tls_configtls_config配置连接到端点的 TLS 设置。
tls_configtls_config配置连接到端点的 TLS 设置。

《>》符号表示更深的嵌套级别。例如,oauth2 > tls_config 指的是一个定义在 oauth2 块内部的 tls_config 块。

基本认证块

名称类型描述默认必需
password_file字符串包含基本认证密码的文件。
password机密基本认证密码。
username字符串基本认证用户名。

passwordpassword_file 是互相排斥的,在 basic_auth 块内部只能提供其中一个。

授权块

名称类型描述默认必需
credentials_file字符串包含密值的文件。
credentials机密密值。
type字符串授权类型,例如,“Bearer”。

credentialscredentials_file 是互相排斥的,在 authorization 块内部只能提供其中一个。

oauth2 块

名称类型描述默认必需
client_id字符串OAuth2 客户端 ID。
client_secret_file字符串包含 OAuth2 客户端密钥的文件。
client_secret机密OAuth2 客户端密钥。
endpoint_paramsmap(string)可选参数,用于添加到令牌 URL 中。
proxy_url字符串通过其发送请求的 HTTP 代理。
no_proxy字符串逗号分隔的 IP 地址、CIDR 表示法和域名列表,要从代理中排除。
proxy_from_environment布尔值使用环境变量指示的代理 URL。
proxy_connect_headermap(list(secret))指定在连接请求期间发送到代理的头。
scopeslist(string)用于认证的作用域列表。
token_url字符串获取令牌的 URL。

client_secretclient_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_urlno_proxy

proxy_connect_header 应仅在配置了 proxy_urlproxy_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_pemca_file
  • cert_pemcert_file
  • key_pemkey_file

在配置客户端认证时,必须同时提供客户端证书(使用 cert_pemcert_file)和客户端密钥(使用 key_pemkey_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)

导出字段

以下字段是导出的,可以作为其他组件的引用

名称类型描述
targetslist(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不公开任何特定组件的调试度量。

示例

alloy
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有导出字段,可以被以下组件消费

注意

连接某些组件可能不合理,或者可能需要进一步配置才能正确连接。有关更多详细信息,请参阅相关文档。