Merge pull request #2840 from rexagod/release-2.18

chore: Cut v2.18.0

Author: k8s-ci-robot

.github/workflows/ci.yml

@@ -20,8 +20,8 @@ env:
   E2E_SETUP_KIND: yes
   E2E_SETUP_KUBECTL: yes
   SUDO: sudo
-  GO_VERSION: "^1.24"
-  GOLANGCI_LINT_VERSION: "v2.4.0"
+  GO_VERSION: "1.25.6"
+  GOLANGCI_LINT_VERSION: "v2.8.0"
 
 jobs:
   ci-go-lint:

.github/workflows/pre-release.yml

@@ -14,7 +14,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout (full history)
-        uses: actions/checkout@v4
+        uses: actions/checkout@v6
         with:
           fetch-depth: 0
       - name: Extract versions
@@ -31,7 +31,7 @@ jobs:
           echo "📦 Go version: ${GO_VERSION}"
           echo "📦 k8s.io/client-go version: ${CLIENT_GO_VERSION}"  
       - name: Set up Go
-        uses: actions/setup-go@v5
+        uses: actions/setup-go@v6
         with:
           go-version: ${{ steps.versions.outputs.go-version }}
         id: go

.markdownlint-cli2.jsonc

@@ -2,6 +2,9 @@
   "globs": [
     "**/*.md"
   ],
+  "ignores": [
+    "vendor/**"
+  ],
   // ToDo: Following rules can't be fixed automatically. They should be enabled when fixed.
   "config": {
     "MD004": {
@@ -14,6 +17,7 @@
         "summary",
         "br"
       ]
-    }
+    },
+    "MD060": false // Allow table column misalignments
   }
 }

CHANGELOG.md

@@ -1,5 +1,31 @@
 # Changelog
 
+## v2.18.0 / 2026-01-11
+
+NOTE: This release addresses a regression that caused a panic when new versions were added to existing `CustomResourceDefinition`s. See the post-mortem analysis in <https://github.com/kubernetes/kube-state-metrics/pull/2838> for more details.
+NOTE: `endpointslices` are now part of the default resources exposed as metrics. `endpoints` is deprecated and needs to be manually activated through the `--resources` flag. See <https://github.com/kubernetes/kube-state-metrics/pull/2659> for more details.
+
+* This release builds with Go `v1.25.6`
+* This release builds with `k8s.io/client-go`: `v0.34.3`
+
+* [CHANGE] Replace endpoints with endpointslices as default resource by @mrueg in <https://github.com/kubernetes/kube-state-metrics/pull/2659>
+* [BUGFIX] Fix regression: React on WATCH updates for CRD informer by @rexagod in <https://github.com/kubernetes/kube-state-metrics/pull/2838>
+* [BUGFIX] Deduplicate tolerations when generating `kube_pod_tolerations` by @bhope in <https://github.com/kubernetes/kube-state-metrics/pull/2835>
+* [FEATURE] Allow filtering resources via URL parameters by @mrueg in <https://github.com/kubernetes/kube-state-metrics/pull/2844>
+* [FEATURE] Add `kube_job_status_ready` metric by @nmn3m in <https://github.com/kubernetes/kube-state-metrics/pull/2771>
+* [FEATURE] Add `kube_deployment_owner` metric by @nmn3m in <https://github.com/kubernetes/kube-state-metrics/pull/2782>
+* [FEATURE] Add `kube_deployment_status_replicas_terminating` and `kube_replicaset_status_terminating_replicas` metrics by @atiratree in <https://github.com/kubernetes/kube-state-metrics/pull/2708>
+* [FEATURE] Promote CronJob, HPA, and Pod metrics from BETA to STABLE by @nmn3m in <https://github.com/kubernetes/kube-state-metrics/pull/2798>
+* [FEATURE] Promote StatefulSet metrics to STABLE by @yasicar in <https://github.com/kubernetes/kube-state-metrics/pull/2783>
+* [FEATURE] Add info metric for client-go version by @fpetkovski in <https://github.com/kubernetes/kube-state-metrics/pull/2739>
+* [FEATURE] Warn on probe failing by @mickael-carl in <https://github.com/kubernetes/kube-state-metrics/pull/2808>
+* [ENHANCEMENT] Add `failed` condition to `kube_certificatesigningrequest_condition` by @ksmiley in <https://github.com/kubernetes/kube-state-metrics/pull/2841>
+* [ENHANCEMENT] Reduce allocations when creating metric families by @fpetkovski in <https://github.com/kubernetes/kube-state-metrics/pull/2807>
+* [ENHANCEMENT] Bump to kubernetes 1.34 by @mrueg in <https://github.com/kubernetes/kube-state-metrics/pull/2785>
+* [ENHANCEMENT] Bump exporter-toolkit by @mrueg in <https://github.com/kubernetes/kube-state-metrics/pull/2770>
+* [ENHANCEMENT] Replace gojsontoyaml with gojq by @mrueg in <https://github.com/kubernetes/kube-state-metrics/pull/2660>
+* [ENHANCEMENT] Split benchmarks by @mrueg in <https://github.com/kubernetes/kube-state-metrics/pull/2759>
+
 ## v2.17.0 / 2025-09-01
 
 * This release builds with Go `v1.24.6`

Makefile

@@ -13,13 +13,13 @@ GIT_COMMIT ?= $(shell git rev-parse --short HEAD)
 OS ?= $(shell uname -s | tr A-Z a-z)
 ALL_ARCH = amd64 arm arm64 ppc64le s390x
 PKG = github.com/prometheus/common
-PROMETHEUS_VERSION = 3.5.0
-GO_VERSION = 1.24.6
+PROMETHEUS_VERSION = 3.9.1
+GO_VERSION = 1.25.5
 IMAGE = $(REGISTRY)/kube-state-metrics
 MULTI_ARCH_IMG = $(IMAGE)-$(ARCH)
 USER ?= $(shell id -u -n)
 HOST ?= $(shell hostname)
-MARKDOWNLINT_CLI2_VERSION = 0.18.1
+MARKDOWNLINT_CLI2_VERSION = 0.20.0
 CLIENT_GO_VERSION = $(shell go list -m -f '{{.Version}}' k8s.io/client-go)
 KSM_MODULE = $(shell go list -m)
 

README.md

@@ -44,15 +44,15 @@ are deleted they are no longer visible on the `/metrics` endpoint.
   * [ECMAScript regular expression support for allow and deny lists](#ecmascript-regular-expression-support-for-allow-and-deny-lists)
   * [Conflict resolution in label names](#conflict-resolution-in-label-names)
 * [Kube-state-metrics self metrics](#kube-state-metrics-self-metrics)
-* [Resource recommendation](#resource-recommendation)
-* [Latency](#latency)
-* [A note on costing](#a-note-on-costing)
 * [kube-state-metrics vs. metrics-server](#kube-state-metrics-vs-metrics-server)
 * [Scaling kube-state-metrics](#scaling-kube-state-metrics)
   * [Resource recommendation](#resource-recommendation)
+  * [Latency](#latency)
+  * [A note on costing](#a-note-on-costing)
   * [Horizontal sharding](#horizontal-sharding)
     * [Automated sharding](#automated-sharding)
   * [Daemonset sharding for pod metrics](#daemonset-sharding-for-pod-metrics)
+  * [Resource filtering](#resource-filtering)
 * [Setup](#setup)
   * [Building the Docker container](#building-the-docker-container)
 * [Usage](#usage)
@@ -79,11 +79,11 @@ Generally, it is recommended to use the latest release of kube-state-metrics. If
 
 | kube-state-metrics | Kubernetes client-go Version |
 |--------------------|:----------------------------:|
-| **v2.13.0**        | v1.30                        |
 | **v2.14.0**        | v1.31                        |
 | **v2.15.0**        | v1.32                        |
 | **v2.16.0**        | v1.32                        |
 | **v2.17.0**        | v1.33                        |
+| **v2.18.0**        | v1.34                        |
 | **main**           | v1.34                        |
 
 #### Resource group version compatibility
@@ -96,8 +96,8 @@ release.
 
 The latest container image can be found at:
 
-* `registry.k8s.io/kube-state-metrics/kube-state-metrics:v2.17.0` (arch: `amd64`, `arm`, `arm64`, `ppc64le` and `s390x`)
-* [Multi-architecture images](https://explore.ggcr.dev/?image=registry.k8s.io%2Fkube-state-metrics%2Fkube-state-metrics:v2.17.0)
+* `registry.k8s.io/kube-state-metrics/kube-state-metrics:v2.18.0` (arch: `amd64`, `arm`, `arm64`, `ppc64le` and `s390x`)
+* [Multi-architecture images](https://explore.ggcr.dev/?image=registry.k8s.io%2Fkube-state-metrics%2Fkube-state-metrics:v2.18.0)
 
 ### Metrics Documentation
 
@@ -184,6 +184,29 @@ kube_state_metrics_last_config_reload_successful{filename="crs.yml",type="custom
 kube_state_metrics_last_config_reload_successful{filename="config.yml",type="config"} 1
 ```
 
+### kube-state-metrics vs. metrics-server
+
+The [metrics-server](https://github.com/kubernetes-incubator/metrics-server)
+is a project that has been inspired by
+[Heapster](https://github.com/kubernetes-retired/heapster) and is implemented
+to serve the goals of core metrics pipelines in [Kubernetes monitoring
+architecture](https://github.com/kubernetes/design-proposals-archive/blob/main/instrumentation/monitoring_architecture.md).
+It is a cluster level component which periodically scrapes metrics from all
+Kubernetes nodes served by Kubelet through Metrics API. The metrics are
+aggregated, stored in memory and served in [Metrics API
+format](https://git.k8s.io/metrics/pkg/apis/metrics/v1alpha1/types.go). The
+metrics-server stores the latest values only and is not responsible for
+forwarding metrics to third-party destinations.
+
+kube-state-metrics is focused on generating completely new metrics from
+Kubernetes' object state (e.g. metrics based on deployments, replica sets,
+etc.). It holds an entire snapshot of Kubernetes state in memory and
+continuously generates new metrics based off of it. And just like the
+metrics-server it too is not responsible for exporting its metrics anywhere.
+
+Having kube-state-metrics as a separate project also enables access to these
+metrics from monitoring systems such as Prometheus.
+
 ### Scaling kube-state-metrics
 
 #### Resource recommendation
@@ -198,7 +221,7 @@ As a general rule, you should allocate:
 
 Note that if CPU limits are set too low, kube-state-metrics' internal queues will not be able to be worked off quickly enough, resulting in increased memory consumption as the queue length grows. If you experience problems resulting from high memory allocation or CPU throttling, try increasing the CPU limits.
 
-### Latency
+#### Latency
 
 In a 100 node cluster scaling test the latency numbers were as follows:
 
@@ -208,34 +231,11 @@ In a 100 node cluster scaling test the latency numbers were as follows:
 "Perc99": 906666666 ns.
 ```
 
-### A note on costing
+#### A note on costing
 
 By default, kube-state-metrics exposes several metrics for events across your cluster. If you have a large number of frequently-updating resources on your cluster, you may find that a lot of data is ingested into these metrics. This can incur high costs on some cloud providers. Please take a moment to [configure what metrics you'd like to expose](docs/developer/cli-arguments.md), as well as consult the documentation for your Kubernetes environment in order to avoid unexpectedly high costs.
 
-### kube-state-metrics vs. metrics-server
-
-The [metrics-server](https://github.com/kubernetes-incubator/metrics-server)
-is a project that has been inspired by
-[Heapster](https://github.com/kubernetes-retired/heapster) and is implemented
-to serve the goals of core metrics pipelines in [Kubernetes monitoring
-architecture](https://github.com/kubernetes/design-proposals-archive/blob/main/instrumentation/monitoring_architecture.md).
-It is a cluster level component which periodically scrapes metrics from all
-Kubernetes nodes served by Kubelet through Metrics API. The metrics are
-aggregated, stored in memory and served in [Metrics API
-format](https://git.k8s.io/metrics/pkg/apis/metrics/v1alpha1/types.go). The
-metrics-server stores the latest values only and is not responsible for
-forwarding metrics to third-party destinations.
-
-kube-state-metrics is focused on generating completely new metrics from
-Kubernetes' object state (e.g. metrics based on deployments, replica sets,
-etc.). It holds an entire snapshot of Kubernetes state in memory and
-continuously generates new metrics based off of it. And just like the
-metrics-server it too is not responsible for exporting its metrics anywhere.
-
-Having kube-state-metrics as a separate project also enables access to these
-metrics from monitoring systems such as Prometheus.
-
-### Horizontal sharding
+#### Horizontal sharding
 
 In order to shard kube-state-metrics horizontally, some automated sharding capabilities have been implemented. It is configured with the following flags:
 
@@ -276,7 +276,7 @@ spec:
       - image: registry.k8s.io/kube-state-metrics/kube-state-metrics:IMAGE_TAG
         name: kube-state-metrics
         args:
-        - --resource=pods
+        - --resources=pods
         - --node=$(NODE_NAME)
         env:
         - name: NODE_NAME
@@ -304,6 +304,23 @@ spec:
 
 Other metrics can be sharded via [Horizontal sharding](#horizontal-sharding).
 
+#### Resource Filtering
+
+The `/metrics` endpoint supports filtering by resource type using the `resources` query parameter. This allows you to scrape only the metrics for specific Kubernetes resources, which can be useful for reducing the amount of data scraped or for creating separate scraping jobs for different resource types.
+
+Example:
+`curl 'http://localhost:8080/metrics?resources=pods,secrets'`
+
+Multiple resources can be specified as a comma-separated list, or by providing the `resources` parameter multiple times.
+
+You can also exclude specific resources using the `exclude_resources` query parameter. This is useful if you want to scrape all metrics except for a few specific ones.
+
+Example:
+`curl 'http://localhost:8080/metrics?exclude_resources=pods'`
+
+If both `resources` and `exclude_resources` are provided, the `resources` parameter acts as an allowlist, and `exclude_resources` acts as a denylist, filtering out any resources specified in the `exclude_resources` parameter from the allowed resources.
+The exclude_resources takes precedence here and you can only filter on resources that are enabled in kube-state-metrics.
+
 ### Setup
 
 Install this project to your `$GOPATH` using `go get`:

README.md.tpl

@@ -44,15 +44,15 @@ are deleted they are no longer visible on the `/metrics` endpoint.
   * [ECMAScript regular expression support for allow and deny lists](#ecmascript-regular-expression-support-for-allow-and-deny-lists)
   * [Conflict resolution in label names](#conflict-resolution-in-label-names)
 * [Kube-state-metrics self metrics](#kube-state-metrics-self-metrics)
-* [Resource recommendation](#resource-recommendation)
-* [Latency](#latency)
-* [A note on costing](#a-note-on-costing)
 * [kube-state-metrics vs. metrics-server](#kube-state-metrics-vs-metrics-server)
 * [Scaling kube-state-metrics](#scaling-kube-state-metrics)
   * [Resource recommendation](#resource-recommendation)
+  * [Latency](#latency)
+  * [A note on costing](#a-note-on-costing)
   * [Horizontal sharding](#horizontal-sharding)
     * [Automated sharding](#automated-sharding)
   * [Daemonset sharding for pod metrics](#daemonset-sharding-for-pod-metrics)
+  * [Resource filtering](#resource-filtering)
 * [Setup](#setup)
   * [Building the Docker container](#building-the-docker-container)
 * [Usage](#usage)
@@ -185,6 +185,29 @@ kube_state_metrics_last_config_reload_successful{filename="crs.yml",type="custom
 kube_state_metrics_last_config_reload_successful{filename="config.yml",type="config"} 1
 ```
 
+### kube-state-metrics vs. metrics-server
+
+The [metrics-server](https://github.com/kubernetes-incubator/metrics-server)
+is a project that has been inspired by
+[Heapster](https://github.com/kubernetes-retired/heapster) and is implemented
+to serve the goals of core metrics pipelines in [Kubernetes monitoring
+architecture](https://github.com/kubernetes/design-proposals-archive/blob/main/instrumentation/monitoring_architecture.md).
+It is a cluster level component which periodically scrapes metrics from all
+Kubernetes nodes served by Kubelet through Metrics API. The metrics are
+aggregated, stored in memory and served in [Metrics API
+format](https://git.k8s.io/metrics/pkg/apis/metrics/v1alpha1/types.go). The
+metrics-server stores the latest values only and is not responsible for
+forwarding metrics to third-party destinations.
+
+kube-state-metrics is focused on generating completely new metrics from
+Kubernetes' object state (e.g. metrics based on deployments, replica sets,
+etc.). It holds an entire snapshot of Kubernetes state in memory and
+continuously generates new metrics based off of it. And just like the
+metrics-server it too is not responsible for exporting its metrics anywhere.
+
+Having kube-state-metrics as a separate project also enables access to these
+metrics from monitoring systems such as Prometheus.
+
 ### Scaling kube-state-metrics
 
 #### Resource recommendation
@@ -199,7 +222,7 @@ As a general rule, you should allocate:
 
 Note that if CPU limits are set too low, kube-state-metrics' internal queues will not be able to be worked off quickly enough, resulting in increased memory consumption as the queue length grows. If you experience problems resulting from high memory allocation or CPU throttling, try increasing the CPU limits.
 
-### Latency
+#### Latency
 
 In a 100 node cluster scaling test the latency numbers were as follows:
 
@@ -209,34 +232,11 @@ In a 100 node cluster scaling test the latency numbers were as follows:
 "Perc99": 906666666 ns.
 ```
 
-### A note on costing
+#### A note on costing
 
 By default, kube-state-metrics exposes several metrics for events across your cluster. If you have a large number of frequently-updating resources on your cluster, you may find that a lot of data is ingested into these metrics. This can incur high costs on some cloud providers. Please take a moment to [configure what metrics you'd like to expose](docs/developer/cli-arguments.md), as well as consult the documentation for your Kubernetes environment in order to avoid unexpectedly high costs.
 
-### kube-state-metrics vs. metrics-server
-
-The [metrics-server](https://github.com/kubernetes-incubator/metrics-server)
-is a project that has been inspired by
-[Heapster](https://github.com/kubernetes-retired/heapster) and is implemented
-to serve the goals of core metrics pipelines in [Kubernetes monitoring
-architecture](https://github.com/kubernetes/design-proposals-archive/blob/main/instrumentation/monitoring_architecture.md).
-It is a cluster level component which periodically scrapes metrics from all
-Kubernetes nodes served by Kubelet through Metrics API. The metrics are
-aggregated, stored in memory and served in [Metrics API
-format](https://git.k8s.io/metrics/pkg/apis/metrics/v1alpha1/types.go). The
-metrics-server stores the latest values only and is not responsible for
-forwarding metrics to third-party destinations.
-
-kube-state-metrics is focused on generating completely new metrics from
-Kubernetes' object state (e.g. metrics based on deployments, replica sets,
-etc.). It holds an entire snapshot of Kubernetes state in memory and
-continuously generates new metrics based off of it. And just like the
-metrics-server it too is not responsible for exporting its metrics anywhere.
-
-Having kube-state-metrics as a separate project also enables access to these
-metrics from monitoring systems such as Prometheus.
-
-### Horizontal sharding
+#### Horizontal sharding
 
 In order to shard kube-state-metrics horizontally, some automated sharding capabilities have been implemented. It is configured with the following flags:
 
@@ -277,7 +277,7 @@ spec:
       - image: registry.k8s.io/kube-state-metrics/kube-state-metrics:IMAGE_TAG
         name: kube-state-metrics
         args:
-        - --resource=pods
+        - --resources=pods
         - --node=$(NODE_NAME)
         env:
         - name: NODE_NAME
@@ -305,6 +305,23 @@ spec:
 
 Other metrics can be sharded via [Horizontal sharding](#horizontal-sharding).
 
+#### Resource Filtering
+
+The `/metrics` endpoint supports filtering by resource type using the `resources` query parameter. This allows you to scrape only the metrics for specific Kubernetes resources, which can be useful for reducing the amount of data scraped or for creating separate scraping jobs for different resource types.
+
+Example:
+`curl 'http://localhost:8080/metrics?resources=pods,secrets'`
+
+Multiple resources can be specified as a comma-separated list, or by providing the `resources` parameter multiple times.
+
+You can also exclude specific resources using the `exclude_resources` query parameter. This is useful if you want to scrape all metrics except for a few specific ones.
+
+Example:
+`curl 'http://localhost:8080/metrics?exclude_resources=pods'`
+
+If both `resources` and `exclude_resources` are provided, the `resources` parameter acts as an allowlist, and `exclude_resources` acts as a denylist, filtering out any resources specified in the `exclude_resources` parameter from the allowed resources.
+The exclude_resources takes precedence here and you can only filter on resources that are enabled in kube-state-metrics.
+
 ### Setup
 
 Install this project to your `$GOPATH` using `go get`: