Skip to content

Conversation

@viragvoros
Copy link

What this PR does / why we need it:
This PR adds a kube_persistentvolume_access_mode metric that exposes the access modes of PersistentVolume objects, in a way that mirrors the existing PVC access mode metric.

At the moment, if we want to filter or aggregate PersistentVolumes by access mode (e.g. ReadWriteOnce, ReadWriteMany, ReadOnlyMany), we have to rely on kube_persistentvolumeclaim_access_mode and join through
PVC metrics. That forces us to scrape the PVC access mode metrics even when we only care about PVs, and increases metric cardinality.

By exposing a dedicated PV access mode metric with a small label set, we can:

  • filter and aggregate PVs directly by access mode
  • avoid scraping PVC access mode metrics in setups where they are not
    otherwise needed,
    while still keeping metric cardinality low.

Details of the change

  • Add kube_persistentvolume_access_mode metric in the PV store:
    • creates one sample for each access mode a PersistentVolume lists
    • access_mode label uses the standard Kubernetes access
      modes (ReadWriteOnce, ReadOnlyMany, ReadWriteMany, etc.)
    • metric follows a similar style as the existing PVC access mode metric
  • Update internal/store/persistentvolume_test.go
    • add test coverage for the new PV access mode metric
  • Update PV metrics documentation

How does this change affect the cardinality of KSM:
Previously, dashboards and alerts that needed PV access mode information had to join against PVC access mode metrics and therefore scrape kube_persistentvolumeclaim_access_mode, which may have higher cardinality in large clusters.
With kube_persistentvolume_access_mode, users can query PV access modes directly from the PV metrics.

@linux-foundation-easycla
Copy link

linux-foundation-easycla bot commented Dec 2, 2025

CLA Not Signed

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: viragvoros
Once this PR has been reviewed and has the lgtm label, please assign rexagod for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. label Dec 2, 2025
@k8s-ci-robot k8s-ci-robot requested a review from mrueg December 2, 2025 17:06
@k8s-ci-robot
Copy link
Contributor

This issue is currently awaiting triage.

If kube-state-metrics contributors determine this is a relevant issue, they will accept it by applying the triage/accepted label and provide further guidance.

The triage/accepted label can be added by org members by writing /triage accepted in a comment.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@k8s-ci-robot
Copy link
Contributor

Welcome @viragvoros!

It looks like this is your first PR to kubernetes/kube-state-metrics 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes/kube-state-metrics has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

@k8s-ci-robot k8s-ci-robot added the cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. label Dec 2, 2025
@github-project-automation github-project-automation bot moved this to Needs Triage in SIG Instrumentation Dec 2, 2025
@k8s-ci-robot k8s-ci-robot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Dec 2, 2025
Expose a kube_persistentvolume_access_mode metric that mirrors the
existing PVC access mode metric. This allows consumers to filter and
aggregate PersistentVolumes by access mode directly, without having to
scrape kube_persistentvolumeclaim_access_mode.

Using a small set of access-mode labels keeps cardinality low while
still allowing PV metrics to be sliced by access mode.

Signed-off-by: vvoeroes <[email protected]>
@viragvoros viragvoros force-pushed the feature/pv-access-mode-metric branch from 2b6ab10 to 17c531d Compare December 4, 2025 10:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.

Projects

Status: Needs Triage

Development

Successfully merging this pull request may close these issues.

2 participants