Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add kube_secret_owner metric #2298

Merged
merged 1 commit into from
Feb 25, 2024

Conversation

jrcichra
Copy link
Contributor

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

Copy link

linux-foundation-easycla bot commented Jan 10, 2024

CLA Signed

The committers listed above are authorized under a signed CLA.

  • ✅ login: jrcichra / name: Justin Cichra (01507af)

@k8s-ci-robot k8s-ci-robot added 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. labels Jan 10, 2024
@k8s-ci-robot
Copy link
Contributor

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. 😃

@k8s-ci-robot k8s-ci-robot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Jan 10, 2024
@dashpole
Copy link

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

@k8s-ci-robot k8s-ci-robot added triage/accepted Indicates an issue or PR is ready to be actively worked on. and removed needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels Jan 11, 2024
@rexagod
Copy link
Member

rexagod commented Jan 17, 2024

Needs CLA.

@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. and removed cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels Jan 18, 2024
@jrcichra
Copy link
Contributor Author

CLA signed. Thanks!

@jrcichra
Copy link
Contributor Author

Are there any other prerequisites I need to complete?

@jrcichra
Copy link
Contributor Author

jrcichra commented Feb 5, 2024

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

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.
@jrcichra
Copy link
Contributor Author

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

@mrueg
Copy link
Member

mrueg commented Feb 23, 2024

/approve

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Feb 23, 2024
@rexagod
Copy link
Member

rexagod commented Feb 25, 2024

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Feb 25, 2024
@k8s-ci-robot
Copy link
Contributor

[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:

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 merged commit c92541d into kubernetes:main Feb 25, 2024
12 checks passed
@mrueg mrueg mentioned this pull request Mar 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. triage/accepted Indicates an issue or PR is ready to be actively worked on.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants