Skip to content

Navigation Menu

Sign in

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Appearance settings

feat: Allow leases to have custom labels set when a new holder takes the lease #131632

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
Open
wants to merge 1 commit into
base: master
Choose a base branch
Loading
from
Open

feat: Allow leases to have custom labels set when a new holder takes the lease #131632

wants to merge 1 commit into from

Conversation

DerekFrank
Copy link

@DerekFrank DerekFrank commented May 6, 2025 •
edited
Loading

What type of PR is this?

/kind feature

What this PR does / why we need it:

This PR adds unit tests for the leaselock class, and slightly modifies the functionality to allow users to set custom labels that are updated when a lease gets a new leader.

The intended use of this feature is to allow graceful fail away from leaders. Right now understanding which replica holds a lease is complicated as the holder identity is merely the name of the pod. This would simplify the process to understand who holds the lease without having to backtrace that information through the pod's host names. It also prevents race conditions from other workarounds such as custom controllers that reconcile on leases and update labels.

Which issue(s) this PR fixes:

Fixes kubernetes/client-go#1413

Special notes for your reviewer:

Does this PR introduce a user-facing change?

This change is technically user facing, as users can now leverage the functionality, but there is no action necessary. If a release note is required, I would say a note such as

LeaseLocks can now have custom Labels that different holders will overwrite when they become the holder of the underlying lease.

Additional documentation e.g., KEPs (Kubernetes Enhancement Proposals), usage docs, etc.:

@k8s-ci-robot k8s-ci-robot added release-note Denotes a PR that will be considered when it comes time to generate release notes. kind/feature Categorizes issue or PR as related to a new feature. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. do-not-merge/needs-sig Indicates an issue or PR lacks a `sig/foo` label and requires one. needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels May 6, 2025
@k8s-ci-robot
Copy link
Contributor

Welcome @DerekFrank!

It looks like this is your first PR to kubernetes/kubernetes 🎉. 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/kubernetes 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
Copy link
Contributor

Hi @DerekFrank. Thanks for your PR.

I'm waiting for a kubernetes member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

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 k8s-ci-robot added needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. needs-priority Indicates a PR lacks a `priority/foo` label and requires one. sig/api-machinery Categorizes an issue or PR as relevant to SIG API Machinery. and removed do-not-merge/needs-sig Indicates an issue or PR lacks a `sig/foo` label and requires one. labels May 6, 2025
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: DerekFrank
Once this PR has been reviewed and has the lgtm label, please assign jefftree 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

@dims
Copy link
Member

dims commented May 6, 2025

/ok-to-test

@k8s-ci-robot k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels May 6, 2025
@DerekFrank DerekFrank force-pushed the custom-lease-metadata branch 2 times, most recently from 9e6551b to b63166c Compare May 6, 2025 18:26
@dims
Copy link
Member

dims commented May 6, 2025

/test pull-kubernetes-e2e-kind

@aaron-prindle
Copy link
Contributor

/cc @Jefftree

@k8s-ci-robot k8s-ci-robot requested a review from Jefftree May 6, 2025 20:14
@aaron-prindle
Copy link
Contributor

/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 May 6, 2025
@DerekFrank DerekFrank force-pushed the custom-lease-metadata branch from b63166c to 501d207 Compare May 6, 2025 22:09
@DerekFrank DerekFrank force-pushed the custom-lease-metadata branch from 501d207 to 8597aba Compare May 7, 2025 23:50
@DerekFrank
Copy link
Author

DerekFrank commented May 8, 2025 •
edited
Loading

e2e failing due to a 502 response from google.com. I'm going to guess thats a flake?

https://prow.k8s.io/view/gs/kubernetes-ci-logs/pr-logs/pull/131632/pull-kubernetes-e2e-gce/1920264922424414208

@DerekFrank
Copy link
Author

/retest

This was referenced May 12, 2025
Open
Open
@DerekFrank DerekFrank force-pushed the custom-lease-metadata branch 2 times, most recently from 84c947b to 9ca18a2 Compare May 13, 2025 17:59
@DerekFrank DerekFrank requested review from Jefftree and dims May 13, 2025 20:29
Jefftree
Jefftree reviewed May 14, 2025
View reviewed changes
Copy link
Member

@Jefftree Jefftree left a comment

Choose a reason for hiding this comment

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

Overall approach lgtm.

cc @jpbetz @sttts: Change is completely backwards compatible but this is adding new methods to client-go that we'll likely have to support forever and would like your thoughts

staging/src/k8s.io/client-go/tools/leaderelection/resourcelock/leaselock_test.go Outdated Show resolved Hide resolved
staging/src/k8s.io/client-go/tools/leaderelection/resourcelock/leaselock_test.go Show resolved Hide resolved
@DerekFrank DerekFrank force-pushed the custom-lease-metadata branch from 9ca18a2 to a89b7b7 Compare May 14, 2025 17:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Jefftree Jefftree Jefftree left review comments

@ingvagabund ingvagabund Awaiting requested review from ingvagabund

@mikedanese mikedanese Awaiting requested review from mikedanese

@dims dims Awaiting requested review from dims

Assignees
No one assigned
Labels
cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/feature Categorizes issue or PR as related to a new feature. needs-priority Indicates a PR lacks a `priority/foo` label and requires one. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. release-note Denotes a PR that will be considered when it comes time to generate release notes. sig/api-machinery Categorizes an issue or PR as relevant to SIG API Machinery. 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.

Feature: Allow users of LeaseLock to add custom object metadata that updates on leader election
5 participants
@DerekFrank @k8s-ci-robot @dims @aaron-prindle @Jefftree
Morty Proxy This is a proxified and sanitized view of the page, visit original site.