feat: Add access mode metric for PersistentVolumes

[viragvoros]

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[bot]]

The committers listed above are authorized under a signed CLA.

• :white_check_mark: login: viragvoros / name: Virag Vörös (d01f7e896a7cc9170f64d44cd2272ff822475004)

[k8s-ci-robot]

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. :smiley:

[dgrisonnet]

/assign /triage accepted

[k8s-ci-robot]

[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 ask for approval from dgrisonnet. 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:

• OWNERS

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

[mrueg]

I wonder if it's worth adding a new metric here or enhancing kube_persistentvolume_volume_mode instead?