
镜像名称:k8s.gcr.io/kube-state-metrics/kube-state-metrics
官方维护:Kubernetes SIG Monitoring
功能定位:Kubernetes 集群状态指标收集工具,用于从 Kubernetes API 服务器抓取集群内资源对象(如 Pod、Deployment、Service 等)的状态指标,并通过 HTTP 接口暴露给监控系统(如 Prometheus)。
kube_pod_status_ready{condition="true"}),支持直接被 Prometheus 抓取。kube-state-metrics 需运行在 Kubernetes 集群内,主流部署方式包括 直接 YAML 部署 和 Helm 部署。
kube-state-metrics 主要通过命令行参数配置,支持自定义资源范围、指标过滤、网络端口等。
4.3.1 核心命令行参数
| 参数名 | 说明 | 默认值 |
|---|---|---|
--port | 指标暴露端口(Prometheus 抓取端口) | 8080 |
--telemetry-port | 自身监控端口(暴露组件内部指标,如 kube_state_metrics_build_info) | 8081 |
--namespace | 限制仅收集指定命名空间的资源(多命名空间用逗号分隔,默认全命名空间) | 空(全命名空间) |
--resources | 指定需收集的资源类型(多资源用逗号分隔,默认全资源) | 空(全资源) |
--metric-allowlist | 指标白名单(仅暴露符合正则的指标,如 kube_pod_.*) | 空(暴露所有指标) |
--metric-denylist | 指标黑名单(排除符合正则的指标,优先级高于白名单) | 空(不排除指标) |
--kubeconfig | 本地 kubeconfig 文件路径(集群外运行时使用,集群内无需指定) | 空(使用集群内 ServiceAccount) |
--leader-election | 启用 leader 选举(多副本部署时避免指标重复) | true |
4.3.2 RBAC 配置
kube-state-metrics 需通过 Kubernetes API 访问资源,需配置以下 RBAC 资源:
get/list/watch Pod、Node 等)。以下为完整部署示例,包含 Deployment、Service、RBAC 配置。
5.1.1 RBAC 配置(rbac.yaml)
yamlapiVersion: v1 kind: ServiceAccount metadata: name: kube-state-metrics namespace: kube-system --- apiVersion: rbac.authorization.k8s.io/v1 kind: ClusterRole metadata: name: kube-state-metrics rules: - apiGroups: [""] resources: ["pods", "nodes", "services", "endpoints", "namespaces", "configmaps", "secrets"] verbs: ["get", "list", "watch"] - apiGroups: ["apps"] resources: ["deployments", "daemonsets", "statefulsets", "replicasets"] verbs: ["get", "list", "watch"] - apiGroups: ["batch"] resources: ["jobs", "cronjobs"] verbs: ["get", "list", "watch"] --- apiVersion: rbac.authorization.k8s.io/v1 kind: ClusterRoleBinding metadata: name: kube-state-metrics subjects: - kind: ServiceAccount name: kube-state-metrics namespace: kube-system roleRef: kind: ClusterRole name: kube-state-metrics apiGroup: rbac.authorization.k8s.io
5.1.2 Deployment 配置(deployment.yaml)
yamlapiVersion: apps/v1 kind: Deployment metadata: name: kube-state-metrics namespace: kube-system labels: app: kube-state-metrics spec: replicas: 2 # 多副本提高可用性 selector: matchLabels: app: kube-state-metrics template: metadata: labels: app: kube-state-metrics spec: serviceAccountName: kube-state-metrics # 关联 RBAC 账号 containers: - name: kube-state-metrics image: k8s.gcr.io/kube-state-metrics/kube-state-metrics:v2.10.0 # 使用最新稳定版 ports: - containerPort: 8080 # 指标端口 name: metrics - containerPort: 8081 # 自身监控端口 name: telemetry args: - --resources=pods,deployments,nodes,services # 仅收集指定资源 - --metric-allowlist=kube_pod_.*,kube_deployment_.* # 仅暴露 Pod 和 Deployment 指标 resources: limits: cpu: 200m memory: 256Mi requests: cpu: 100m memory: 128Mi livenessProbe: httpGet: path: /healthz port: 8080 initialDelaySeconds: 5 periodSeconds: 10 readinessProbe: httpGet: path: / port: 8080 initialDelaySeconds: 5 periodSeconds: 10
5.1.3 Service 配置(service.yaml)
yamlapiVersion: v1 kind: Service metadata: name: kube-state-metrics namespace: kube-system labels: app: kube-state-metrics spec: ports: - name: metrics port: 8080 targetPort: metrics - name: telemetry port: 8081 targetPort: telemetry selector: app: kube-state-metrics
通过 Helm 部署可简化配置管理,支持自定义参数:
bash# 添加 Helm 仓库 helm repo add prometheus-community https://prometheus-community.github.io/helm-charts helm repo update # 安装 kube-state-metrics(自定义资源和指标过滤) helm install kube-state-metrics prometheus-community/kube-state-metrics \ --namespace kube-system \ --set resourcesToWatch="{pods,deployments,nodes}" \ --set metricAllowlist="{kube_pod_.*,kube_deployment_.*}" \ --set replicaCount=2
注意:kube-state-metrics 通常需运行在 Kubernetes 集群内,本地 Docker 运行需通过 kubeconfig 访问集群 API:
bashdocker run -d \ --name kube-state-metrics \ -p 8080:8080 \ -v ~/.kube/config:/kubeconfig \ # 挂载本地 kubeconfig k8s.gcr.io/kube-state-metrics/kube-state-metrics:v2.10.0 \ --kubeconfig=/kubeconfig \ --resources=pods,deployments
在 Prometheus 的 prometheus.yml 中添加抓取规则:
yamlscrape_configs: - job_name: 'kube-state-metrics' static_configs: - targets: ['kube-state-metrics.kube-system.svc:8080'] # 通过 Service 域名访问
现象:Pod 日志报 forbidden: User "system:serviceaccount:kube-system:kube-state-metrics" cannot list resource。
解决:检查 RBAC 配置,确保 ClusterRole 包含需访问的资源权限(参考 5.1.1 节)。
--leader-election,导致同一指标被多次暴露。需确保 --leader-election=true(默认启用)。--resources 或 --metric-allowlist 参数是否误过滤了目标资源/指标。kube-state-metrics 版本需与 Kubernetes 集群版本匹配,例如:
--resources),仅收集核心资源;--metric-allowlist 过滤非必要指标。以下是 dyrnq/kube-state-metrics 相关的常用 Docker 镜像,适用于 不同场景 等不同场景:
您可以使用以下命令拉取该镜像。请将 <标签> 替换为具体的标签版本。如需查看所有可用标签版本,请访问 标签列表页面。
探索更多轩辕镜像的使用方法,找到最适合您系统的配置方式
通过 Docker 登录认证访问私有仓库
无需登录使用专属域名
Kubernetes 集群配置 Containerd
K3s 轻量级 Kubernetes 镜像加速
VS Code Dev Containers 配置
Podman 容器引擎配置
HPC 科学计算容器配置
ghcr、Quay、nvcr 等镜像仓库
Harbor Proxy Repository 对接专属域名
Portainer Registries 加速拉取
Nexus3 Docker Proxy 内网缓存
需要其他帮助?请查看我们的 常见问题Docker 镜像访问常见问题解答 或 提交工单
docker search 限制
站内搜不到镜像
离线 save/load
插件要用 plugin install
WSL 拉取慢
安全与 digest
新手拉取配置
镜像合规机制
manifest unknown
no matching manifest(架构)
invalid tar header(解压)
TLS 证书失败
DNS 超时
域名连通性排查
410 Gone 排查
402 与流量用尽
401 认证失败
429 限流
D-Bus 凭证提示
413 与超大单层
来自真实用户的反馈,见证轩辕镜像的优质服务