使用 TLS 加密保护 Prometheus API 和 UI 端点

Prometheus 支持通过 传输层安全 (TLS) 加密连接到 Prometheus 实例（即表达式浏览器或 HTTP API）。如果您想强制对这些连接使用 TLS，则需要创建一个特定的 Web 配置文件。

注意： 本指南是关于连接 到 Prometheus 实例的 TLS。Prometheus 实例连接 到 抓取目标 也支持 TLS。

先决条件

假设您已经有一个正在运行的 Prometheus 实例，并且想要进行修改。本指南不涵盖 Prometheus 的初始设置。

假设您想运行一个使用 TLS 提供服务的 Prometheus 实例，该实例可通过 example.com 域名（您拥有该域名）访问。

再假设您已经使用 OpenSSL 或类似工具生成了以下文件：

  • SSL 证书文件，位于 /home/prometheus/certs/example.com/example.com.crt
  • SSL 密钥文件，位于 /home/prometheus/certs/example.com/example.com.key

您可以使用以下命令生成自签名证书和私钥：

mkdir -p /home/prometheus/certs/example.com && cd /home/prometheus/certs/certs/example.com
openssl req \
  -x509 \
  -newkey rsa:4096 \
  -nodes \
  -keyout example.com.key \
  -out example.com.crt

在提示符下填写相应信息，并在 Common Name 提示符处务必输入 example.com。

Prometheus 配置

下面是一个 web-config.yml 示例配置文件。使用此配置，Prometheus 将通过 TLS 提供其所有端点。

tls_server_config:
  cert_file: /home/prometheus/certs/example.com/example.com.crt
  key_file: /home/prometheus/certs/example.com/example.com.key

要让 Prometheus 使用此配置，您需要使用 --web.config.file 标志启动它。

prometheus \
  --config.file=/path/to/prometheus.yml \
  --web.config.file=/path/to/web-config.yml \
  --web.external-url=https://example.com/

这里的 --web.external-url= 标志是可选的。

测试

如果您想使用 example.com 域名在本地测试 TLS，可以向 /etc/hosts 文件添加一个条目，将 example.com 重定向到 localhost

127.0.0.1     example.com

然后可以使用 cURL 与您的本地 Prometheus 设置进行交互

curl --cacert /home/prometheus/certs/example.com/example.com.crt \
  https://example.com/api/v1/label/job/values

您可以使用 --insecure 或 -k 标志连接到 Prometheus 服务器，无需指定证书

curl -k https://example.com/api/v1/label/job/values

此文档是开源的。请通过提交问题或拉取请求帮助改进它。