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

kubespray-defaults: Check for boostrap-os FQDN #10590

Conversation

VannTen
Copy link
Contributor

@VannTen VannTen commented Nov 3, 2023

What type of PR is this?
/kind bug

What this PR does / why we need it:

When installed as an ansible collection, roles in
ansible_play_role_names will be designated by their FQDN (i.e
'kubernetes-sigs.kubespray.).

It means we need to check for both when checking for roles in the play.

Which issue(s) this PR fixes:

Fixes #10432

Special notes for your reviewer:

Does this PR introduce a user-facing change?:

kubespray-defaults: Check for boostrap-os FQDN

@RikuXan can you test that fix ?

@k8s-ci-robot k8s-ci-robot added kind/bug Categorizes issue or PR as related to a bug. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Nov 3, 2023
@k8s-ci-robot k8s-ci-robot added the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Nov 3, 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/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Nov 3, 2023
When installed as an ansible collection, roles in
ansible_play_role_names will be designated by their FQDN (i.e
'kubernetes-sigs.kubespray.<role-name>).

It means we need to check for both when checking for roles in the play.
@VannTen VannTen force-pushed the fix/boostrap_os_check_collection_mode branch from 8a62b5e to 5973495 Compare November 3, 2023 16:15
@RikuXan
Copy link

RikuXan commented Nov 3, 2023

I'll probably not get around to actually testing it in my environment until next week, but if I'm not mistaken, the proposed change would always add the two tasks in question since one of the checks around the or would always fail, either when kubespray is used as a collection (first condition) or when it's not (second condition).

I think what could work would be prepending the role name with ansible_collection_name and a dot if the variable is set/non-empty. This would also have the benefit of working still, even if the namespace or collection were to be changed in the future (Edit: just saw that you already added the variable, 👍). I'm just not sure what would be an elegant way of expressing this in Ansible. Maybe something like (ansible_collection_name + '.' if ansible_collection_name else '') + 'bootstrap-os' not in ansible_play_role_names, there might be a more concise way to write it, but I think this should generate the correct role name in both cases.

I am kinda confused that I cannot find any code using these two variables in conjunction anywhere. I would have assumed that someone somewhere would have stood before a similar issue, but either my proposed solution has a massive drawback or the requirement of working as both a collection module as well as a standalone playbook is much rarer than I would've thought.

@VannTen
Copy link
Contributor Author

VannTen commented Nov 3, 2023 via email

@yankay
Copy link
Member

yankay commented Nov 15, 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 Nov 15, 2023
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 Thank you 👍

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: floryut, 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 added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Nov 17, 2023
@yankay
Copy link
Member

yankay commented Nov 28, 2023

Thanks @VannTen
/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 28, 2023
@k8s-ci-robot k8s-ci-robot merged commit c2e3071 into kubernetes-sigs:master Nov 28, 2023
63 checks passed
@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
When installed as an ansible collection, roles in
ansible_play_role_names will be designated by their FQDN (i.e
'kubernetes-sigs.kubespray.<role-name>).

It means we need to check for both when checking for roles in the play.
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/bug Categorizes issue or PR as related to a bug. 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/XS Denotes a PR that changes 0-9 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

ansible_play_role_names check fails when using Kubespray collection
5 participants