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

Change Leader Election Config Map for Chains Controller #1025

Merged
merged 1 commit into from
Jan 25, 2024

Conversation

khrm
Copy link
Contributor

@khrm khrm commented Jan 3, 2024

Currently, the chains controller assumes config-leader-election configmap as the name for the leader election configmap. This is the default name for the Knative controllers' leader election configmap. If some other controllers also exist, it's a good practice to have a separate configmap for every controller.
Fixes #1024

Changes

Submitter Checklist

As the author of this PR, please check off the items in this checklist:

  • Has Docs included if any changes are user facing
  • Has Tests included if any functionality added or changed
  • Follows the commit message standard
  • Meets the Tekton contributor standards (including
    functionality, content, code)
  • Release notes block below has been updated with any user facing changes (API changes, bug fixes, changes requiring upgrade notices or deprecation warnings)
  • Release notes contains the string "action required" if the change requires additional action from users switching to the new release

Release Notes

BREAKING CHANGE:
The name of the configmap for leader election of chains controller has been changed to
`tekton-chains-config-leader-election` from default `config-leader-election`.
Any existing users of this configmap are requested to override the name to back to `config-leader-election`,
or migrate their existing config to `tekton-chains-config-leader-election`.

@tekton-robot tekton-robot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Jan 3, 2024
Copy link
Contributor Author

@khrm khrm left a comment

Choose a reason for hiding this comment

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

/kind bug

@tekton-robot tekton-robot added the kind/bug Categorizes issue or PR as related to a bug. label Jan 3, 2024
wlynch
wlynch previously requested changes Jan 3, 2024
Copy link
Member

@wlynch wlynch left a comment

Choose a reason for hiding this comment

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

Lgtm, but this should be called out as a potentially breaking change in the release notes, since this will affect anyone relying on the previous behavior.

@vdemeester
Copy link
Member

@wlynch given we did not ship the configmap at all in the chains release, do we think a lot of people relied on it ?
Anyway, I agree, we need to highlight that in the release changelog yes.

@wlynch
Copy link
Member

wlynch commented Jan 9, 2024

@wlynch given we did not ship the configmap at all in the chains release, do we think a lot of people relied on it ? Anyway, I agree, we need to highlight that in the release changelog yes.

Technically the feature has always existed because of our usage of the knative controller framework, but we never really advertised it. This is changing the default configmap that chains looks for, which would technically break anyone currently setting the existing default knative leader election configmap (which I assume is how @khrm discovered this).

I agree its unlikely that many people were aware that this feature existed, which is why I'm fine with making the change even though it's potentially breaking. But we should update the PR description release notes with the change + instructions for how to revert back to the old behavior if needed.

@khrm
Copy link
Contributor Author

khrm commented Jan 15, 2024

/kind feature
/remove kind bug

@tekton-robot tekton-robot added the kind/feature Categorizes issue or PR as related to a new feature. label Jan 15, 2024
Currently, the chains controller assumes config-leader-election configmap
as the name for the leader election configmap. This is the default name
for the Knative controllers' leader election configmap. If some other
controllers also exist, it's a good practice to have a separate configmap
for every controller.
@khrm
Copy link
Contributor Author

khrm commented Jan 15, 2024

@wlynch I have added the Breaking change note. And also updated the PR description.

@khrm
Copy link
Contributor Author

khrm commented Jan 15, 2024

/kind remove bug

@tekton-robot
Copy link

@khrm: The label(s) kind/remove cannot be applied, because the repository doesn't have them.

In response to this:

/kind remove bug

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/test-infra repository.

Copy link
Contributor Author

@khrm khrm left a comment

Choose a reason for hiding this comment

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

/remove-kind bug

@tekton-robot tekton-robot removed the kind/bug Categorizes issue or PR as related to a bug. label Jan 15, 2024
@vdemeester
Copy link
Member

/approve
/cc @wlynch @lcarva

@tekton-robot
Copy link

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: lcarva, vdemeester

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

@tekton-robot tekton-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jan 25, 2024
@lcarva
Copy link
Contributor

lcarva commented Jan 25, 2024

@wlynch, I think your comment was addressed, but before I add the lgtm label, I want to make sure you have a chance to take another look.

@wlynch
Copy link
Member

wlynch commented Jan 25, 2024

Made some tweaks to the release note, but otherwise lgtm!

/lgtm

@tekton-robot tekton-robot added the lgtm Indicates that a PR is ready to be merged. label Jan 25, 2024
@lcarva lcarva dismissed wlynch’s stale review January 25, 2024 22:28

Dismissing because Billy has already mentioned LGTM above.

@tekton-robot tekton-robot merged commit b2f32fb into tektoncd:main Jan 25, 2024
17 checks passed
@khrm khrm deleted the b-leaderElection branch February 26, 2024 09:39
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. kind/feature Categorizes issue or PR as related to a new feature. lgtm Indicates that a PR is ready to be merged. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Change Leader Election Configmap for Controllers
5 participants