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

Refactor "multi" handlers to use listen #10542

Merged

Conversation

VannTen
Copy link
Contributor

@VannTen VannTen commented Oct 19, 2023

What type of PR is this?
/kind cleanup

What this PR does / why we need it:

We have some handlers which do nothing but notify other handlers (using command: /bin/true + notify)
This replaces all of them to use listen, which allow handlers to be triggered by one or more "listen topics"
(see https://docs.ansible.com/ansible/latest/playbook_guide/playbooks_handlers.html#naming-handlers)

The benefits are mostly for developing or debugging, when looking which handlers are triggered by a particular notify:
instead of grepping twice, we only need to do it once.

I did some quick testing to see if their was any performance difference (from less /bin/true commands executed across ssh),
but it does not seems to make any noticeable differences, at least on a small cluster.

Special notes for your reviewer:
I made one commit per role to make it more digestable, but I can squash that if you prefer.

Regarding the pre-install role: I'm not sure the when are completely coherent here regarding the Flatcar stuff:
While the first "multi handler" was not run for Flatcar, most of the actual handlers were still triggered, since "Preinstall | reload kubelet" is run for Flatcar as well.
The change have made should not alter the execution flow, but maybe a follow-up PR (and someone more knowledgeable about Flatcar) should examine that.

Does this PR introduce a user-facing change?:

Refactor "multi" handlers to use listen

@k8s-ci-robot k8s-ci-robot added kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Oct 19, 2023
@k8s-ci-robot
Copy link
Contributor

Hi @VannTen. Thanks for your PR.

I'm waiting for a kubernetes-sigs 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/test-infra repository.

@k8s-ci-robot k8s-ci-robot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Oct 19, 2023
@yankay
Copy link
Member

yankay commented Oct 20, 2023

/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 Oct 20, 2023
@VannTen
Copy link
Contributor Author

VannTen commented Oct 30, 2023

Rebased to fix conflicts

@VannTen
Copy link
Contributor Author

VannTen commented Oct 31, 2023

Looks like the CI runner had a a system failure
/retest

@floryut
Copy link
Member

floryut commented Oct 31, 2023

Looks like the CI runner had a a system failure /retest

Indeed, retrying

@VannTen
Copy link
Contributor Author

VannTen commented Oct 31, 2023

/retest

Copy link
Member

@floryut floryut left a comment

Choose a reason for hiding this comment

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

@VannTen Nice and cleaner 👍

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Nov 3, 2023
Copy link
Member

@MrFreezeex MrFreezeex left a comment

Choose a reason for hiding this comment

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

Thanks! looks much cleaner! :D
/lgtm

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

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: floryut, MrFreezeex, VannTen

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 8ebeb88 into kubernetes-sigs:master Nov 8, 2023
63 checks passed
@Saigut
Copy link

Saigut commented Dec 8, 2023

Hello, does this change of code can ensure the handler be executed in an expected order?
For example in this file cri-dockerd/handlers/main.yml, will the handlers be executed in the order: Cri-dockerd | reload systemd -> Cri-dockerd | restart docker.service -> ... -> Cri-dockerd | enable cri-dockerd service?

@VannTen
Copy link
Contributor Author

VannTen commented Dec 8, 2023 via email

@yankay yankay mentioned this pull request Dec 15, 2023
pedro-peter pushed a commit to pedro-peter/kubespray that referenced this pull request May 8, 2024
* containerd: refactor handlers to use 'listen'

* cri-dockerd: refactor handlers to use 'listen'

* cri-o: refactor handlers to use 'listen'

* docker: refactor handlers to use 'listen'

* etcd: refactor handlers to use 'listen'

* control-plane: refactor handlers to use 'listen'

* kubeadm: refactor handlers to use 'listen'

* node: refactor handlers to use 'listen'

* preinstall: refactor handlers to use 'listen'

* calico: refactor handlers to use 'listen'

* kube-router: refactor handlers to use 'listen'

* macvlan: refactor handlers to use 'listen'
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. kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. lgtm "Looks good to me", indicates that a PR is ready to be merged. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants