kubernetes / kube-state-metrics

Add-on agent to generate and expose cluster-level metrics.
https://kubernetes.io/docs/concepts/cluster-administration/kube-state-metrics/
Apache License 2.0
5.21k stars 1.93k forks source link

feat: add kube_secret_owner metric #2298

Closed jrcichra closed 4 months ago

jrcichra commented 5 months ago

What this PR does / why we need it: Add the kube_secret_owner metric for Secrets.

This metric already exists for several other Kubernetes primitives (Jobs, Pods, etc).

Cluster operators will often use external secret stores with a controller to reconcile those secrets into Kubernetes Secrets.

Cluster operators may wish to discourage manually managed secrets.

Having the secret owner data in kube-state-metrics allows graphing and alerting on unmanaged secrets.

How does this change affect the cardinality of KSM: (increases, decreases or does not change cardinality) Increases by adding an additional metric for each Secret in the cluster.

Which issue(s) this PR fixes (optional, in fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when PR gets merged): Fixes #

Relates To: #1993

linux-foundation-easycla[bot] commented 5 months ago

CLA Signed

The committers listed above are authorized under a signed CLA.

k8s-ci-robot commented 5 months ago

Welcome @jrcichra!

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:

dashpole commented 5 months ago

/triage accepted /assign @rexagod You will need to sign the CLA before we can accept this

rexagod commented 5 months ago

Needs CLA.

jrcichra commented 5 months ago

CLA signed. Thanks!

jrcichra commented 5 months ago

Are there any other prerequisites I need to complete?

jrcichra commented 4 months ago

@rexagod I've completed all the prerequisites and all the tests are passing. Please review at your earliest convenience. :)

jrcichra commented 4 months ago

@CatherineF-dev thanks for the review, would you mind taking another look?

mrueg commented 4 months ago

/approve

rexagod commented 4 months ago

/lgtm

k8s-ci-robot commented 4 months ago

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: jrcichra, mrueg, rexagod

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

The pull request process is described here

Needs approval from an approver in each of these files: - ~~[OWNERS](https://github.com/kubernetes/kube-state-metrics/blob/main/OWNERS)~~ [mrueg,rexagod] Approvers can indicate their approval by writing `/approve` in a comment Approvers can cancel approval by writing `/approve cancel` in a comment