Backport fixes for k8s module 2.6

[fabianvf]

SUMMARY

Backport:

• update k8s module arguments to allow resource_definition to be a string #40730
• [k8s] Special case project creation so that it is possible #42132
• [k8s] Properly format API key when set in an enviroment variable #42202
• [k8s] Use top level values as defaults if metadata is not provided #42277
• [k8s] allow user to pass list of resources in to definition parameter #42377

ISSUE TYPE

• Bugfix Pull Request

COMPONENT NAME

k8s

[ansibot]

cc @chouseknecht @flaper87 @maxamillion
click here for bot help

[ansibot]

The test ansible-test sanity --test pep8 [explain] failed with 1 error:

lib/ansible/module_utils/k8s/raw.py:115:5: E303 too many blank lines (2)

click here for bot help

[fabianvf]

rebuild_merge

[fabianvf]

@maxamillion don't think the build failure is related, or if it is not sure what would cause it. Looks like it failed to find the openshift python client.

[maxamillion]

rekicking CI, network timeouts seem to be failing unrelated tests

[mattclay]

bot_status

[ansibot]

cc @willthames
click here for bot help

[ansibot]

Components

lib/ansible/module_utils/k8s/common.py
support: core
maintainers: chouseknecht fabianvf flaper87 maxamillion willthames

lib/ansible/module_utils/k8s/raw.py
support: core
maintainers: chouseknecht fabianvf flaper87 maxamillion willthames

lib/ansible/modules/clustering/k8s/k8s.py
support: community
maintainers: chouseknecht fabianvf flaper87 maxamillion willthames

lib/ansible/utils/module_docs_fragments/k8s_resource_options.py
support: core
maintainers:

test/integration/targets/k8s/tasks/main.yml
support: community
maintainers: chouseknecht fabianvf flaper87 maxamillion willthames

Metadata

waiting_on: ansible
changes_requested_by: null
needs_info: False
needs_revision: False
needs_rebase: False
merge_commits: []
too many files or commits: False
mergeable_state: blocked
shippable_status: success
maintainer_shipits (module maintainers): 1
community_shipits (namespace maintainers): 0
ansible_shipits (core team members): 0
shipit_actors (maintainers or core team members): fabianvf
shipit_actors_other: []
automerge: automerge shipit test failed

click here for bot help

[mattclay]

Two of the PRs being backported appear to be new features rather than bug fixes:

#40730
#42377

Normally only bug fixes are backported to stable releases.

[fabianvf]

I suppose they are features. I was really hoping #40730 could make it back, because many existing kubernetes files are multidocument yaml, which can't be read by the from_yaml. This means a large portion of existing kubernetes projects can't be easily automated in Ansible 2.6.

#42377 is a follow-up that enabled lists as well, as a stop-gap for proper support of *List kinds in the Python client.

These two PRs together fix a lot of behavior that makes the modules look broken from a user perspective, without them they may have to make significant changes to their templates to make their existing kubernetes definitions work in Ansible.

[willthames]

For #40730 we could just document the workaround for multi-document yaml

k8s:
  definition="{{ item }}"
loop: "{{ lookup('template', 'resource.yaml').split('\n---\n')|map('from_yaml')|select('ne', None)|list) }}"

[fabianvf]

@mattclay should I take those two out and bring them up at the next community meeting to discuss backporting them?

[fabianvf]

@mattclay removed the offending commits.

[fabianvf]

Failures seem unrelated, can we rekick?

[fabianvf]

ping @mattclay