Adds support for Ansible collections

[luksi1]

What type of PR is this?

/kind feature

What this PR does / why we need it:

Collections are a modern way for Ansible to handle projects like this, allowing downstream users to patch into kubespray's code. This change allows for example a downstream user to simply install a Kubernetes cluster with something like this:

- name: Install Kubernetes
  ansible.builtin.import_playbook: kubernetes_sigs.kubespray.cluster

Which issue(s) this PR fixes:

Fixes #9048

Special notes for your reviewer:

Does this PR introduce a user-facing change?:

This would cause a change to the repository's structure, meaning downstream users would either need to change their code to point to the playbooks directory or use the ansible.builtin.import_playbook module

Add support for Ansible collections in Kubespray (⚠️ See notes !)

[k8s-ci-robot]

Hi @luksi1. 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.

[luksi1]

Sorry, for the late reply @floryut. Yes, there's some problems that popped up with syntax checking that I need to resolve.

[luksi1]

@floryut, I think this is good-to-go. Sorry, for the delay. I made a last minute change in tests/ansible.cfg as the syntax checks were not able to find the roles directory. I do not believe though this should cause any problems.

[floryut]

@luksi1 Thank you 👍
Can someone take a look at this one ?

[MrFreezeex]

I don't see this as removed elsewhere are we supposed to have two versions of this now?

[luksi1]

Unfortunately, the answer is yes. We would have to maintain a duplicate of this since an Ansible collection structure places libraries under plugins, see here, while an Ansible playbook structure
places libraries under library, see here.

The idea of this first iteration is to retain the structure as-is, so users could either use the repository as an Ansible collection, by simply pointing their requirements.txt directly at the Kubespray's repository, or download it and use it the same as before. And this seemed like the easiest way forward.

[MrFreezeex]

Random guess but did you try to see if a symlink works here?

[luksi1]

It would probably work, but before I start changing anything, do we want to go down this path? Symlinks will probably work fine on Linux distributions, and should work out-of-the-box when cloning (not tested), but I believe that symlinks in Windows require admin rights to access mklink functions plus enabling core.symlinks functionality when cloning, which might result in some confusion for users running Ansible from Windows. There might even be some additional edge cases that I'm not familiar with. Are we comfortable with this?

[zhan9san]

Windows without WSL is not natively supported as a control node.
https://docs.ansible.com/ansible/latest/installation_guide/intro_installation.html#control-node-requirements

[luksi1]

That settles it :) I'll see if I can't get the collection working with a symlink instead of duplicating the library. Thanks for the feedback.

[michel-zimmer]

Btw. how about using #!/usr/bin/env bash everywhere or at least in all new places introduced with this PR? This way operating systems like NixOS are supported, too. Using env is the best way when going for maximum portability. https://www.gnu.org/software/coreutils/manual/html_node/env-invocation.html

[MrFreezeex]

Since CI is failing I am guessing you might try the other way around (moving the file to the new location and symlink from old to new).

@michel-zimmer AFAICS there is only one file in this PR with this https://github.com/kubernetes-sigs/kubespray/blob/46dc09ca7647213230a0d869b13e150ae650c2b4/tests/scripts/check_galaxy_version.sh, feel free to send a PR for cleaning up those across the repo though!

[luksi1]

@MrFreezeex, good suggestion! Worked like a charm! Let me know if there's any other concerns regarding this PR.

[MrFreezeex]

Thanks for modernizing Kubespray with collection support :D @luksi1
/lgtm