1. 添加我们的 tap:

brew tap robusta-dev/homebrew-krr

2. 安装 KRR:

brew install krr

3. 检查安装是否成功:

krr --help

4. 运行 KRR (首次启动可能需要稍长时间):

krr simple

您可以在 WSL2 上使用 brew 安装(见上文),或从源代码安装(见下文)。

您可以从 Releases 下载预构建的二进制文件,或使用预构建的 Docker 容器。例如,版本 1.8.3 的容器是:

us-central1-docker.pkg.dev/genuine-flight-317411/devel/krr:v1.8.3

我们不建议在离线环境中从源代码安装 KRR,因为安装 Python 依赖项会很麻烦。请使用上述方法之一,如果需要帮助,请通过 Slack、GitHub issues 或电子邮件与我们联系。

1. 确保您已安装 Python 3.9 (或更高版本)
2. 克隆仓库:

git clone https://github.com/robusta-dev/krr

3. 进入项目根目录 (cd ./krr)
4. 安装依赖:

pip install -r requirements.txt

5. 运行工具:

python krr.py --help

请注意,使用源代码需要您以 Python 脚本方式运行,而使用 brew 安装允许直接运行 krr。 上面所有示例都显示运行命令为 krr ...,如果您使用手动安装,请将其替换为 python krr.py ...。

krr simple

最有用的标志:

• --cpu-min 设置推荐的最小 CPU 值(以毫核为单位)
• --mem-min 设置推荐的最小内存值(以 MB 为单位)
• --history_duration 使用的 Prometheus 历史数据的持续时间(以小时为单位)

可以使用以下命令查看有关策略设置的更多具体信息:

krr simple --help

如果您的 Prometheus 没有自动连接,您可以使用 kubectl port-forward 手动转发 Prometheus。

例如,如果您有一个名为 kube-prometheus-st-prometheus-0 的 Prometheus Pod,则运行此命令进行端口转发:

kubectl port-forward pod/kube-prometheus-st-prometheus-0 9090

然后,打开另一个终端并在其中运行 krr,提供明确的 Prometheus url:

krr simple -p http://127.0.0.1:9090

使用 -n 列出您想要的任意多个命名空间(在本例中为 default 和 ingress-nginx)

krr simple -n default -n ingress-nginx

参见 ServiceAccount 和 RBAC 权限示例

使用 标签选择器

python krr.py simple --selector 'app.kubernetes.io/instance in (robusta, ingress-nginx)'

默认情况下,krr 将在当前上下文中运行。如果您想在不同的上下文中运行它:

krr simple -c my-cluster-1 -c my-cluster-2

目前,KRR 提供了几种格式化程序来表示扫描数据:

• table - 默认使用的漂亮的 CLI 表格,由 Rich 库提供支持
• json
• yaml
• pprint - 来自 Python pprint 库的数据表示
• csv - 将数据导出到当前目录中的 csv 文件

要使用选定的格式化程序运行策略,请添加 -f 标志。通常应该与 --fileoutput <filename> 结合使用,以将干净的输出写入文件而不包含日志:

krr simple -f json --fileoutput krr-report.json

如果您愿意,也可以使用 --logtostderr 将格式化的输出放在一个文件中,将错误日志放在另一个文件中:

krr simple --logtostderr -f json > result.json 2> logs-and-errors.log

请参阅下面关于过滤中央化 Prometheus 输出以匹配单个集群的内容

KRR 支持 Prometheus、VictoriaMetrics、Coralogix 和其他兼容 Prometheus 的指标存储的所有已知认证方案。

请参考 krr simple --help,并查看标志 --prometheus-url、--prometheus-auth-header、--prometheus-headers --prometheus-ssl-enabled、--coralogix-token 以及各种 --eks-* 标志。

如果您需要帮助,请通过 Slack、电子邮件或打开 GitHub issue 与我们联系。

krr simple -v

默认情况下，KRR将尝试自动发现正在运行的Prometheus、Victoria Metrics和Thanos。 对于发现Prometheus，它会扫描具有以下标签的服务：

"app=kube-prometheus-stack-prometheus"
"app=prometheus,component=server"
"app=prometheus-server"
"app=prometheus-operator-prometheus"
"app=rancher-monitoring-prometheus"
"app=prometheus-prometheus"

对于Thanos，使用这些标签：

"app.kubernetes.io/component=query,app.kubernetes.io/name=thanos",
"app.kubernetes.io/name=thanos-query",
"app=thanos-query",
"app=thanos-querier",

对于Victoria Metrics，使用以下标签：

"app.kubernetes.io/name=vmsingle",
"app.kubernetes.io/name=victoria-metrics-single",
"app.kubernetes.io/name=vmselect",
"app=vmselect",

如果这些标签都无法找到Prometheus、Victoria Metrics或Thanos，您将收到一个错误，并且需要明确传递有效的URL（使用-p标志）。

(回到顶部)

如果您的Prometheus监控多个集群，我们需要您在Prometheus中为集群定义的标签。

例如，如果您的集群具有Prometheus标签cluster: "my-cluster-name"，则运行以下命令：

krr.py simple --prometheus-label cluster -l my-cluster-name

您可能还需要使用-p标志来明确提供Prometheus的URL。

对于Azure托管Prometheus，您需要生成一个访问令牌，可以通过运行以下命令来完成：

# 如果您尚未登录Azure，请取消注释以下行
# az login
AZURE_BEARER=$(az account get-access-token --resource=https://prometheus.monitor.azure.com  --query accessToken --output tsv); echo $AZURE_BEARER

然后运行以下命令，将PROMETHEUS_URL替换为您的Azure托管Prometheus URL：

python krr.py simple --namespace default -p PROMETHEUS_URL --prometheus-auth-header "Bearer $AZURE_BEARER"

点击此处了解如何为中央化Prometheus配置标签

(回到顶部)

请在这里查看详细的GMP使用说明

(回到顶部)

对于Amazon托管Prometheus，您需要添加Prometheus链接和标志--eks-managed-prom，krr将自动使用您的aws凭证

python krr.py simple -p "https://aps-workspaces.REGION.amazonaws.com/workspaces/..." --eks-managed-prom

其他可选参数包括：

--eks-profile-name PROFILE_NAME_HERE # 指定要使用的配置文件
--eks-access-key ACCESS_KEY # 指定您的访问密钥
--eks-secret-key SECRET_KEY # 指定您的秘密密钥
--eks-service-name SERVICE_NAME # 在签名中使用特定的服务名称
--eks-managed-prom-region REGION_NAME # 指定Prometheus所在的区域

点击此处了解如何为中央化Prometheus配置标签

(回到顶部)

对于Coralogix托管Prometheus，您需要指定Prometheus链接并添加标志coralogix_token，其中包含您的日志查询密钥

python krr.py simple -p "https://prom-api.coralogix..." --coralogix_token

点击此处了解如何为中央化Prometheus配置标签

(回到顶部)

对于Grafana Cloud托管Prometheus，您需要指定Prometheus链接、Prometheus用户和Grafana Cloud堆栈的访问令牌。可以在Grafana Cloud门户上找到堆栈的Prometheus链接和用户。还可以使用同一门户上的访问策略创建具有metrics:read范围的访问令牌。

接下来，运行以下命令，将PROM_URL、PROM_USER和PROM_TOKEN变量的值设置为您的Grafana Cloud堆栈的Prometheus链接、Prometheus用户和访问令牌。

python krr.py simple -p $PROM_URL --prometheus-auth-header "Bearer ${PROM_USER}:${PROM_TOKEN}" --prometheus-ssl-enabled

点击此处了解如何为中央化Prometheus配置标签

(回到顶部)

默认情况下，KRR将尝试自动发现正在运行的Grafana Mimir。

为了发现Prometheus，它会扫描具有以下标签的服务：

  "app.kubernetes.io/name=mimir,app.kubernetes.io/component=query-frontend"

(回到顶部)

我们强烈建议使用免费的Robusta SaaS平台。您可以：

• 通过应用使用历史了解单个应用的建议
• 按命名空间、优先级等对建议进行排序和过滤
• 为开发人员提供YAML片段以修复KRR发现的问题
• 使用KRR扫描历史分析影响

让成本节省自动化。获取关于超过 X% 的建议的 Slack 通知。发送每周全局报告，或每个团队一份报告。

![Slack 截图][slack-screenshot]

先决条件

• 一个 Slack 工作区

设置

1. 使用 Helm 在集群中安装 Robusta 并配置 Slack
2. 通过在 generated_values.yaml 中添加以下内容来创建您的 KRR Slack playbook：

customPlaybooks:
# 每周对 devs-namespace 命名空间运行一次 krr 扫描，并将结果发送到配置的 Slack 频道
customPlaybooks:
- triggers:
  - on_schedule:
      fixed_delay_repeat:
        repeat: -1 # 运行次数，-1 表示永久运行
        seconds_delay: 604800 # 1 周
  actions:
  - krr_scan:
      args: "--namespace devs-namespace" ## 在此处填写 KRR 参数
  sinks:
      - "main_slack_sink" # 在此处填写您想要发送报告的 Slack sink

3. 执行 Helm 升级以应用新的值：helm upgrade robusta robusta/robusta --values=generated_values.yaml --set clusterName=<YOUR_CLUSTER_NAME>

(返回顶部)

安装我们的 k9s 插件，直接在 deployments/daemonsets/statefulsets 视图中获取建议。

插件：resource recommender

安装说明：k9s 文档