Use the Kubernetes Ansible collection #2646
Conversation
openshift-ci-robot
added
the
size/L
There was a problem hiding this comment.
Great @fabianvf.
IHMO just fix the CI and then it is
/lgtm
/approve
| @@ -155,7 +155,7 @@ would become: | |||
|
|
|||
| ```yaml | |||
| - name: Create bind credential secret | |||
| k8s: | |||
| community.kubernetes.k8s: | |||
There was a problem hiding this comment.
Note that there's a different way (which I prefer) to upgrade to using collections, and that is to add a collections keyword on the play level, listing the collections you use, then leave the module invocations the same. Otherwise you end up writing things like community.kubernetes.k8s over and over and over, getting carpal tunnel.
Example:
- hosts: hosts_here
collections:
- community.kubernetes
- operator_sdk.util
tasks:
- k8s:
...There was a problem hiding this comment.
I put in the FQCN here and in other examples because they're outside of the context of a playbook and it didn't feel like an appropriate spot to explain collections and tell users to add those to their playbooks, though I did update the scaffolded code to use the collection play keyword when generating the playbook. Since it's possible to generate just a role, no playbook, and AFAIK there is no way to pass the collection keyword when running a role directly, I do think it makes sense to include the FQCN outside of playbook examples. Thoughts?
There was a problem hiding this comment.
AFAIK there is no way to pass the collection keyword when running a role directly
I haaaaaaaaate that. I'm hoping to campaign for that not to be the case because I absolutely hate the idea of having to type out a FQCN every time you type in a module in Ansible.
doc/ansible/dev/developer_guide.md
Outdated
| @@ -31,6 +31,11 @@ Python][openshift_restclient_python] package. This can be installed from pip: | |||
| $ pip3 install openshift | |||
| ``` | |||
|
|
|||
| Finally, a user must install the Ansible Kubernetes collection from ansible-galaxy: | |||
| ```bash | |||
| $ ansible-galaxy install community.kubernetes | |||
There was a problem hiding this comment.
This would need to be ansible-galaxy collection install community.kubernetes (at least for now). Otherwise we can use a requirements.yml file and just have it be ansible-galaxy install -r requirements.yml (and that could have any possible versioning requirements and other collections added as needed...
There was a problem hiding this comment.
(I think I would prefer a requirements.yml file, even if it didn't have a version constraint, so it would be like:
---
collections:
- name: community.kubernetes
There was a problem hiding this comment.
I always mess that up, good catch. As for the requirements.yml file, I'd also like to do it that way, but I think it's probably out of scope for this PR and should be done in a followup if we want to get it in
| @@ -61,7 +66,7 @@ we will create and delete a namespace with the switch of a variable: | |||
| ```yaml | |||
| --- | |||
| - name: set example-memcached namespace to {{ state }} | |||
| k8s: | |||
| community.kubernetes.k8s: | |||
There was a problem hiding this comment.
(Same notes as above on the collections keyword... I just hate seeing FQCNs everywhere, Ansible starts looking like Java...)
| @@ -79,7 +79,7 @@ RUN yum clean all && rm -rf /var/cache/yum/* \ | |||
| && yum remove -y gcc libffi-devel openssl-devel python36-devel \ | |||
| && yum clean all \ | |||
| && rm -rf /var/cache/yum \ | |||
| && ansible-galaxy collection install operator_sdk.util | |||
| && ansible-galaxy collection install operator_sdk.util community.kubernetes | |||
There was a problem hiding this comment.
See note about requirements.yml file from earlier.
|
Related upstream issue, to make maintaining version compatibility easier with upstream Ansible collections: ansible/ansible#68194 |
| RUN ansible-galaxy collection build /tmp/fixture_collection/ --output-path /tmp/fixture_collection/ \ | ||
| && ansible-galaxy collection install /tmp/fixture_collection/operator_sdk-test_fixtures-0.0.0.tar.gz |
There was a problem hiding this comment.
Good catch, prevents a new layer by combining.
Description of the change:
Updates scaffolded code and tests to use the Kubernetes modules from the Kubernetes Ansible collection instead of Ansible core. Existing code should work for the time being, so no immediate steps are required for existing users, though it is recommended they switch to using the collection to continue getting new fixes and features.
Motivation for the change:
Active module development has moved to the Kubernetes Ansible collection. At some point in the future, support for the Kubernetes modules in Ansible core may be removed.