-
Notifications
You must be signed in to change notification settings - Fork 6.5k
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
fix a typo in the "matallb_auto_assign" variable name #8949
fix a typo in the "matallb_auto_assign" variable name #8949
Conversation
Hi @orange-llajeanne. 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 Once the patch is verified, the new status will be reflected by the 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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for fixing the wrong name.
The wrong name is used in long-term.
So it is better to have something to support it for the existing inventory, I feel.
/cc @oomichi
@@ -19,4 +19,4 @@ metallb_speaker_tolerations: | |||
operator: Exists | |||
metallb_controller_tolerations: [] | |||
metallb_pool_name: "loadbalanced" | |||
matallb_auto_assign: true | |||
metallb_auto_assign: true |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
To support old name in the existing inventory
metallb_auto_assign: true | |
metallb_auto_assign: >- | |
{%- if matallb_auto_assign is defined -%} | |
{{ matallb_auto_assign }} | |
{%- else -%} | |
true | |
{%- endif -%} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I wonder if anyone is actually using the typo'ed variable name. Carrying some compatibility code due to a typo in the past seems like a lot of effort.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah, this kind of thing is always maintenance burden for developers.
At least, it would be necessary to take 1-2 versions for warning the option is renamed from the original one for users as the deprecation period.
Then we can remove the original one after that.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Well this can be discussed, but a warning in the release note might be enough, or we can add an ansible check and message indeed
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I updated this PR with the solution proposed by @oomichi , but I can still modify it if this discussion ends up identifying another solution.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
we can add an ansible check and message indeed
@floryut Thanks, that is a good idea for users I think.
@orange-llajeanne Could you update this pull request again based on
kubespray/roles/network_plugin/calico/tasks/check.yml
Lines 2 to 8 in 4726a11
- name: Stop if legacy encapsulation variables are detected (ipip) | |
assert: | |
that: | |
- ipip is not defined | |
msg: "'ipip' configuration variable is deprecated, please configure your inventory with 'calico_ipip_mode' set to 'Always' or 'CrossSubnet' according to your specific needs" | |
run_once: True | |
delegate_to: "{{ groups['kube_control_plane'][0] }}" |
as a reference?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I removed the workaround in defaults/main.yml
and added a check in metallb tasks, inspired from other checks from the same file
I think this should be ok now
4e3204a
to
b120ddb
Compare
Looks good, thanks @orange-llajeanne /approve |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
/ok-to-test
@orange-llajeanne Fine by me now, thank you 👍
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: cristicalin, floryut, orange-llajeanne 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 |
Thanks for updating again! /lgtm |
…s#8949) * fix a typo in the "matallb_auto_assign" variable name * add metallb check to fail when deprecated "matallb_auto_assign" variable is defined
…s#8949) * fix a typo in the "matallb_auto_assign" variable name * add metallb check to fail when deprecated "matallb_auto_assign" variable is defined
…s#8949) * fix a typo in the "matallb_auto_assign" variable name * add metallb check to fail when deprecated "matallb_auto_assign" variable is defined
What type of PR is this?
/kind api-change
What this PR does / why we need it:
Fixes a typo in the variable setting the auto-assign param of metallb:
matallb_auto_assign
=>metallb_auto_assign
Special notes for your reviewer:
This is a breaking change for existing inventories using the
matallb_auto_assign
variable name. Should kubespray support both names and deprecate the previous one?Does this PR introduce a user-facing change?: