discovery.scaleway
discovery.scaleway
从 Scaleway 实例和 裸金属服务发现目标。
用法
discovery.scaleway "<LABEL>" {
project_id = "<SCALEWAY_PROJECT_ID>"
role = "<SCALEWAY_PROJECT_ROLE>"
access_key = "<SCALEWAY_ACCESS_KEY>"
secret_key = "<SCALEWAY_SECRET_KEY>"
}
参数
您可以对 discovery.scaleway
使用以下参数
名称 | 类型 | 描述 | 默认值 | 必填 |
---|---|---|---|---|
access_key | string | Scaleway API 的 Access Key。 | 是 | |
project_id | string | 目标的 Scaleway 项目 ID。 | 是 | |
role | string | 要检索的目标的角色。 | 是 | |
secret_key_file | string | 包含 Scaleway API Secret Key 的文件路径。 | 条件性 | |
secret_key | secret | Scaleway API 的 Secret Key。 | 条件性 | |
api_url | string | Scaleway API URL。 | "https://api.scaleway.com" | 否 |
enable_http2 | bool | 请求是否支持 HTTP2。 | true | 否 |
follow_redirects | bool | 是否应遵循服务器返回的重定向。 | true | 否 |
http_headers | map(list(secret)) | 随每个请求发送的自定义 HTTP 头。map 的键是头名称。 | 否 | |
name_filter | string | 应用于列表请求的名称过滤器。 | 否 | |
no_proxy | string | 用逗号分隔的 IP 地址、CIDR 表示法和域名列表,这些将被排除在代理之外。 | 否 | |
port | number | 与生成的目标关联的服务器默认端口。 | 80 | 否 |
proxy_connect_header | map(list(secret)) | 指定在 CONNECT 请求期间发送到代理的头。 | 否 | |
proxy_from_environment | bool | 使用环境变量指定的代理 URL。 | false | 否 |
proxy_url | string | 发送请求时使用的 HTTP 代理。 | 否 | |
refresh_interval | duration | 重新发现目标的频率。 | "60s" | 否 |
tags_filter | list(string) | 要搜索的标签列表。 | 否 | |
zone | string | 目标的可用区。 | "fr-par-1" | 否 |
role
参数决定要发现的 Scaleway 机器类型。它必须设置为以下之一:
name_filter
和 tags_filter
参数可用于过滤发现的服务器集。name_filter
返回与特定名称匹配的机器,而 tags_filter
返回包含 tags_filter
参数中列出的所有标签的机器。
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_url
或 proxy_from_environment
时才应配置 proxy_connect_header
。
块
您可以使用以下块与 discovery.scaleway
:
块 | 描述 | 必填 |
---|---|---|
tls_config | 配置连接到端点的 TLS 设置。 | 否 |
tls_config
tls_config
块配置连接到端点的 TLS 设置。
名称 | 类型 | 描述 | 默认值 | 必填 |
---|---|---|---|---|
ca_pem | string | 用于验证服务器的 CA PEM 编码文本。 | 否 | |
ca_file | string | 用于验证服务器的 CA 证书。 | 否 | |
cert_pem | string | 用于客户端身份验证的证书 PEM 编码文本。 | 否 | |
cert_file | string | 用于客户端身份验证的证书文件。 | 否 | |
insecure_skip_verify | bool | 禁用服务器证书验证。 | 否 | |
key_file | string | 用于客户端身份验证的密钥文件。 | 否 | |
key_pem | secret | 用于客户端身份验证的密钥 PEM 编码文本。 | 否 | |
min_version | string | 可接受的最低 TLS 版本。 | 否 | |
server_name | string | 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)) | 从 Consul catalog API 发现的目标集。 |
当 role
为 baremetal
时,发现的目标包含以下标签:
__meta_scaleway_baremetal_id
: 服务器 ID。__meta_scaleway_baremetal_name
: 服务器名称。__meta_scaleway_baremetal_os_name
: 服务器的操作系统名称。__meta_scaleway_baremetal_os_version
: 服务器的操作系统版本。__meta_scaleway_baremetal_project_id
: 服务器所属的项目 ID。__meta_scaleway_baremetal_public_ipv4
: 服务器的公有 IPv4 地址。__meta_scaleway_baremetal_public_ipv6
: 服务器的公有 IPv6 地址。__meta_scaleway_baremetal_status
: 服务器的当前状态。__meta_scaleway_baremetal_tags
: 与服务器关联的标签列表,用,
连接。__meta_scaleway_baremetal_type
: 服务器的商业类型。__meta_scaleway_baremetal_zone
: 服务器的可用区。
当 role
为 instance
时,发现的目标包含以下标签:
__meta_scaleway_instance_boot_type
: 服务器的启动类型。__meta_scaleway_instance_hostname
: 服务器的主机名。__meta_scaleway_instance_id
: 服务器 ID。__meta_scaleway_instance_image_arch
: 服务器运行镜像的架构。__meta_scaleway_instance_image_id
: 服务器运行镜像的 ID。__meta_scaleway_instance_image_name
: 服务器运行镜像的名称。__meta_scaleway_instance_location_cluster_id
: 服务器所在位置的集群 ID。__meta_scaleway_instance_location_hypervisor_id
: 服务器所在位置的 Hypervisor ID。__meta_scaleway_instance_location_node_id
: 服务器所在位置的节点 ID。__meta_scaleway_instance_name
: 服务器名称。__meta_scaleway_instance_organization_id
: 服务器所属的组织 ID。__meta_scaleway_instance_private_ipv4
: 服务器的私有 IPv4 地址。__meta_scaleway_instance_project_id
: 服务器所属的项目 ID。__meta_scaleway_instance_public_ipv4
: 服务器的公有 IPv4 地址。__meta_scaleway_instance_public_ipv6
: 服务器的公有 IPv6 地址。__meta_scaleway_instance_region
: 服务器所在的区域。__meta_scaleway_instance_security_group_id
: 服务器所属安全组的 ID。__meta_scaleway_instance_security_group_name
: 服务器所属安全组的名称。__meta_scaleway_instance_status
: 服务器的当前状态。__meta_scaleway_instance_tags
: 与服务器关联的标签列表,用,
连接。__meta_scaleway_instance_type
: 服务器的商业类型。__meta_scaleway_instance_zone
: 服务器的可用区。
组件健康状态
discovery.scaleway
仅在配置无效时报告不健康。在这种情况下,导出的字段会保留上次健康的数值。
调试信息
discovery.scaleway
不会暴露任何组件特定的调试信息。
调试指标
discovery.scaleway
不会暴露任何组件特定的调试指标。
示例
discovery.scaleway "example" {
project_id = "<SCALEWAY_PROJECT_ID>"
role = "<SCALEWAY_PROJECT_ROLE>"
access_key = "<SCALEWAY_ACCESS_KEY>"
secret_key = "<SCALEWAY_SECRET_KEY>"
}
prometheus.scrape "demo" {
targets = discovery.scaleway.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>"
}
}
}
替换以下内容:
<SCALEWAY_PROJECT_ID>
: 您的 Scaleway 机器的项目 ID。<SCALEWAY_PROJECT_ROLE>
: 设置为baremetal
发现 裸金属机器,或设置为instance
发现 虚拟实例。<SCALEWAY_ACCESS_KEY>
: 您的 Scaleway API access key。<SCALEWAY_SECRET_KEY>
: 您的 Scaleway API secret key。<PROMETHEUS_REMOTE_WRITE_URL>
: 用于发送指标的 Prometheus remote_write 兼容服务器 URL。<USERNAME>
: 用于对remote_write
API 进行身份验证的用户名。<PASSWORD>
: 用于对remote_write
API 进行身份验证的密码。
兼容组件
discovery.scaleway
具有可供以下组件使用的导出项:
- 消耗 Targets 的组件
注意
连接某些组件可能不合理,或者组件可能需要进一步配置才能正常工作。请参阅链接文档了解更多详细信息。