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.

Sign up for GitHub

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

Jump to bottom

feat: hot reload kubeconfig #2144

Merged
merged 1 commit into from
Aug 29, 2023
Merged

feat: hot reload kubeconfig #2144

merged 1 commit into from
Aug 29, 2023

Conversation

opeco17
Copy link
Contributor

@opeco17 opeco17 commented Aug 13, 2023

What this PR does / why we need it:
This PR enables Kube State Metrics to hot reload kubeconfig automatically when it's changed. This feature is useful because kubeconfig should be short-lived and updated frequently.

How does this change affect the cardinality of KSM: (increases, decreases or does not change cardinality)
No change

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 #2120

@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels Aug 13, 2023
@k8s-ci-robot
Copy link
Contributor

Welcome @opeco17!

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 Aug 13, 2023
@opeco17 opeco17 mentioned this pull request Aug 14, 2023
Closed
dgrisonnet
dgrisonnet reviewed Aug 22, 2023
View reviewed changes
tests/e2e/hot-reload-kubeconfig_test.go Outdated Show resolved Hide resolved
tests/e2e/hot-reload-kubeconfig_test.go Outdated Show resolved Hide resolved
@opeco17 opeco17 force-pushed the feature/kubeconfig-hot-reload branch 2 times, most recently from b6dafdd to 4cd1901 Compare August 24, 2023 13:47
@opeco17 opeco17 requested a review from dgrisonnet August 24, 2023 13:52
mrueg
mrueg reviewed Aug 24, 2023
View reviewed changes
tests/e2e/hot-reload-kubeconfig_test.go Outdated
kubeconfig := os.Getenv("KUBECONFIG")
if kubeconfig == "" {
// Assume $HOME is always defined.
kubeconfig = os.Getenv("HOME") + "/.kube/config"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will this alter a user's config file?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, kubeconfig will be altered temporary by the following line

err = exec.Command("kubectl", "config", "set-cluster", "ksm-hot-reload-kubeconfig-test").Run()

When the test is finished, kubeconfig will be reverted

err := exec.Command("kubectl", "config", "delete-cluster", "ksm-hot-reload-kubeconfig-test").Run()

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe we could create a temporary copy of the kubeconfig that is passed just to be extra safe and still have access to the local cluster?

Copy link
Contributor Author

@opeco17 opeco17 Aug 28, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sounds good
I've implemented that feature (https://github.com/kubernetes/kube-state-metrics/pull/2144/files#diff-c529068bd1416eaf280644910132aa60a6736c14af241a6c9b118f19fe228c81R41-R62)
Could you please review it again?

@dgrisonnet
Copy link
Member

/triage accepted

@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 Aug 24, 2023
@dgrisonnet
Copy link
Member

Pending https://github.com/kubernetes/kube-state-metrics/pull/2144/files#r1307670306, the PR looks good to me.

Do you think you'll be able to address it by Wednesday?

@opeco17 opeco17 force-pushed the feature/kubeconfig-hot-reload branch from 4cd1901 to a0fd543 Compare August 28, 2023 23:02
@opeco17 opeco17 force-pushed the feature/kubeconfig-hot-reload branch from a0fd543 to 7bf825d Compare August 29, 2023 01:36
@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Aug 29, 2023
@mrueg
Copy link
Member

mrueg commented Aug 29, 2023

/lgtm

/hold
for @dgrisonnet to review.

@k8s-ci-robot k8s-ci-robot added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Aug 29, 2023
@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Aug 29, 2023
dgrisonnet
dgrisonnet approved these changes Aug 29, 2023
View reviewed changes
Copy link
Member

@dgrisonnet dgrisonnet left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/lgtm
/approve
/unhold

@k8s-ci-robot k8s-ci-robot removed the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Aug 29, 2023
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: dgrisonnet, mrueg, opeco17

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 db81be0 into kubernetes:main Aug 29, 2023
@opeco17 opeco17 deleted the feature/kubeconfig-hot-reload branch August 29, 2023 12:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dgrisonnet dgrisonnet dgrisonnet approved these changes

@mrueg mrueg mrueg approved these changes

@CatherineF-dev CatherineF-dev Awaiting requested review from CatherineF-dev

@logicalhan logicalhan Awaiting requested review from logicalhan

Assignees

@mrueg mrueg

@dgrisonnet dgrisonnet

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
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Reload kube-state-metrics when kubeconfig changes.
4 participants
@opeco17 @k8s-ci-robot @dgrisonnet @mrueg