Compare commits

..
69 Commits
Author SHA1 Message Date
0f472b53e2 Prepare release 6.5.0 (#1188)
* Prepare k8s collection release 6.5.0

* update release date for the version 6.5.0

* Update changelog.yaml and changelog.rst mismatch

---------

Co-authored-by: Yuriy Novostavskiy <yuriy@novostavskiy.kyiv.ua>
2026-07-08 11:06:30 -04:00
a1cd39a71f Update RST documentation files (#1189) (#1190)
(cherry picked from commit 470c042690)

Co-authored-by: Bianca Henderson <bianca@redhat.com>
2026-07-07 17:17:19 -04:00
6742eaa725 Add meta/execution-environment.yml to fix EE builds on UBI images (#1142) (#1183)
ansible-builder builds fail with "No package matches 'openshift-clients'"
on UBI images because the openshift-clients RPM in bindep.txt requires
repos not available in standard UBI. This adds collection-level EE
metadata pointing to a minimal bindep file without openshift-clients,
while preserving the original bindep.txt for direct bindep usage.

Fixes #1141


(cherry picked from commit a80e2d067c)

Co-authored-by: Christopher Brown <snecklifter@users.noreply.github.com>
Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
2026-07-07 09:53:59 -04:00
5c98d5696e Add lint ignore entry (#1184) (#1186)
(cherry picked from commit 75a5560aec)

Co-authored-by: Bianca Henderson <bianca@redhat.com>
2026-07-07 09:43:06 -04:00
78b82c74f7 feat(ci): add security check to block .claude/ and .vscode/ directories (#1173) (#1181)
* feat(ci): add security check to block .claude/ and .vscode/ directories

Add workflow that calls the security_check_directories action from
cloud-content-ci-automation to fail PRs containing files under .claude/
or .vscode/ directories.

Integrates with all_green_check.yaml as a required job for PRs.

Ref: ACA-6411



* fix(ci): suppress SonarCloud S7637 for reusable actions using @main

Internal reusable actions from ansible-network/github_actions and
ansible-collections/cloud-content-ci-automation use @main refs for
simpler maintenance. Suppress the 'use full commit SHA' rule for
workflow files.



* fix(ci): use correct org and pin action to commit SHA

Address review feedback:
- Change org from ansible-collections to ansible
- Pin to commit SHA 74b5fe87 instead of @main



* docs: add changelog fragment for security check workflow



* Update changelogs/fragments/1173-security-check-workflow.yml

---------



(cherry picked from commit 6bb9cce51b)

Co-authored-by: GomathiselviS <gomathiselvi@gmail.com>
Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
Co-authored-by: Bianca Henderson <beeankha@gmail.com>
2026-07-03 08:39:50 -04:00
42963f0536 feat: add plugin --keyring option (#1150) (#1179)
* feat: add plugin --keyring option

* docs: add changelog fragment

* Update changelogs/fragments/20260620-add-plugin-keyring-option.yaml



* feat: restrict helm_plugin keyring to install subcommand (#1)

Restrict the keyring option to state=present (helm plugin install),
the only implemented subcommand that supports --keyring, and fail
explicitly when it is used with other states.



* refactor(helm_plugin): warn instead of fail

* Resolve linter error

* Update plugins/modules/helm_plugin.py

---------




(cherry picked from commit 4b3e24bf02)

Co-authored-by: Kenji Gaillac <48765390+Nhqml@users.noreply.github.com>
Co-authored-by: Yuriy Novostavskiy <yuriy@novostavskiy.kyiv.ua>
Co-authored-by: Bianca Henderson <bianca@redhat.com>
Co-authored-by: Bianca Henderson <beeankha@gmail.com>
2026-07-02 13:24:50 -04:00
9c3988689f helm: use --rollback-on-failure for atomic on Helm v4 (#1144) (#1178)
* helm: use --rollback-on-failure for atomic on Helm v4

Helm v4 renamed the `--atomic` flag to `--rollback-on-failure`. The old
flag is deprecated on `helm upgrade` and removed entirely from `helm
install`, so `atomic: true` failed against Helm v4 (issue #1143).

Emit the version-appropriate flag from deploy() using the existing
is_helm_v4() helper, covering both the upgrade and the replace/install
code paths. The public `atomic` option is unchanged.

Fixes: https://github.com/ansible-collections/kubernetes.core/issues/1143

Co-Authored-By: Claude Opus 4.8

* fix wrong link in the changelog fragment



---------


(cherry picked from commit bc17b33d44)

Signed-off-by: Yuriy Novostavskiy <yuriy@novostavskiy.kyiv.ua>
Co-authored-by: Yuriy Novostavskiy <yuriy@novostavskiy.kyiv.ua>
2026-07-01 17:27:39 -04:00
08143fc16f fix(helm): support Helm v4 force/server-side apply flags (#1164) (#1177)
* fix(helm): support Helm v4 force/server-side apply flags

Helm v4 deprecated --force and enables server-side apply by default, so
playbooks relying on force=true broke with "Flag --force has been
deprecated" and "cannot use server-side apply and force replace together".
Because force always meant a client-side delete/recreate replacement, the
module now reproduces that behaviour on v4 (--server-side=false
--force-replace) so existing playbooks keep working unchanged across both
Helm versions.

To let users opt into Helm v4's server-side world explicitly, add
server_side and force_conflicts options. These are mutually exclusive with
force (a client-side replacement cannot coexist with a server-side mode),
keeping the surface unambiguous and surfacing bad combinations up front
instead of as cryptic Helm errors.

AI-assisted commit with Claude Opus

* fix(linter) reformat tests/unit/modules/test_module_helm.py with black

(cherry picked from commit 3634105366)

Co-authored-by: Yuriy Novostavskiy <yuriy@novostavskiy.kyiv.ua>
2026-07-01 14:12:24 -04:00
457a7dc534 Point to Python 3.13 for ansible-core devel (#1174) (#1176)
(cherry picked from commit ceeafa8c6d)

Co-authored-by: Bianca Henderson <bianca@redhat.com>
2026-07-01 12:19:06 -04:00
Bianca HendersonandGitHub edee5c994d [manual backport stable-6] Fix CI Test Collision (#1162) (#1167)
* Fix CI Test Collision (#1162)

* Fix CI concurrency issue

* More CI fixes

* Fix coverage job install

* Install correct test dependencies

(cherry picked from commit d211f316ad)

* Restore cancel-in-progress: true
2026-06-30 12:01:51 -04:00
a523a195cb ci: suppress SonarCloud python:S5443 for test code (#1165) (#1169)
Unit tests pass hardcoded '/tmp/...' strings as fake module arguments (for
example chart_ref) into fully mocked helm commands, so no file is ever
created and there is no real exposure. SonarCloud's python:S5443 still
raises a security hotspot on each literal and, because it only scores new
code, drops a PR's security rating even though the same pattern already
pervades the existing test suite.

Scope the suppression to tests/** only. Production code creates temporary
files via tempfile.mkstemp / NamedTemporaryFile and remains covered by the
rule, where it carries real value.

AI-assisted commit with Claude Opus

(cherry picked from commit 0836e96c2d)

Co-authored-by: Yuriy Novostavskiy <yuriy@novostavskiy.kyiv.ua>
2026-06-30 11:48:49 -04:00
7f5c2183c0 CI - configure precommit hook to block commit when files from .claude… (#1149) (#1171)
* CI - configure precommit hook to block commit when files from .claude/ and/or .vscode/ directories are staged

* fix sanity issue - shebang

* Remove local hook and update documentation

(cherry picked from commit a4fc40732a)

Co-authored-by: Bikouo Aubin <79859644+abikouo@users.noreply.github.com>
2026-06-30 10:58:06 +02:00
294c2fce4a Fix workflow concurrency issue (#1159) (#1161)
(cherry picked from commit bb80dde66d)

Co-authored-by: Bianca Henderson <bianca@redhat.com>
2026-06-26 12:03:25 -04:00
ebc015955e Fix all-green CI workflow (#1153) (#1158)
(cherry picked from commit 8bf31513f5)

Co-authored-by: Bianca Henderson <bianca@redhat.com>
2026-06-26 10:53:17 -04:00
57f4bf76cd helm_registry_auth: document/test stdout for registry success messages (Helm 4.2.1) (#1147) (#1156)
* helm: document/test stdout for registry success messages (Helm 4.2.1)

Helm < 4.2.1 prints registry success messages (Login Succeeded, Pushed,
Pulled, Digest) to stderr (helm/helm#13464); Helm >= 4.2.1 moves them to
stdout (helm/helm#32056). The modules key on the return code, so logic is
unaffected, but the RETURN docs and integration assertions assumed stderr.

- helm_registry_auth: note the version-dependent output stream in
  the RETURN documentation.
- helm_registry_auth integration tests: assert success messages against the
  stdout+stderr union so they pass on both old and new Helm.

Fixes: #1146

Co-Authored-By: Claude Opus 4.8

* ci: empty commit to re-trigger ci

(cherry picked from commit ae90b60fd6)

Co-authored-by: Yuriy Novostavskiy <yuriy@novostavskiy.kyiv.ua>
2026-06-25 16:07:10 -04:00
63f490d123 ci: suppress SonarCloud python:S7498 for argument_spec dict() convention (#1152) (#1155)
Ansible module argument_spec is conventionally defined with the dict(...)
constructor rather than {...} literals, for readability and consistency
across the collection. SonarCloud's python:S7498 ("Literal syntax should
be preferred...") flags this as a false positive and re-fires on every
new module argument. Ignore the rule project-wide via sonar-project.properties.

Fixes #1151

(cherry picked from commit 1c20b53bdc)

Co-authored-by: Yuriy Novostavskiy <yuriy@novostavskiy.kyiv.ua>
2026-06-25 14:07:07 -04:00
1d49a942d9 Manual backport of SonarQube configuration to stable-6 branch (#1136)
* Manual backport of SonarQube configuration to stable-6 branch

* Add CI.md and align README with collection standards (#1124)

Include CI.md from #1124 and update README.md to match the Red Hat
Ansible Certified Collection layout from main, with stable-6 branch
references for repository links.

Co-authored-by: Cursor <cursoragent@cursor.com>

* Revert changes to some README links

---------

Co-authored-by: Cursor <cursoragent@cursor.com>
2026-05-29 17:31:59 -04:00
d8ae230bcf docs: clarify ansible turbo mode with version compatibility notice (#1120) (#1132)
The docs/ansible_turbo_mode.rst file was accidentally removed in PR#988,
breaking the link referenced in README.md. Restore it so users following
that link get the full Turbo mode documentation rather than a 404.

Additionally, document the ansible-core version compatibility issue for
cloud.common (see ansible-collections/cloud.common@5e3430d and
kubernetes.core PR #1109): Turbo mode is incompatible with ansible-core
>= 2.19 because cloud.common no longer supports it. Without this
clarification users on newer ansible-core versions encounter silent or
confusing failures when ENABLE_TURBO_MODE=1 is set.

Update README.md with the same warning so the incompatibility is visible
before users follow the link to the full docs.

Addresses: #927
(cherry picked from commit 248e0d7db9)

Co-authored-by: Yuriy Novostavskiy <yuriy@novostavskiy.kiev.ua>
2026-05-26 09:58:23 -04:00
71e9aba89c Fix unit test failures in CI (#1133) (#1135)
(cherry picked from commit f69761f37c)

Co-authored-by: Bianca Henderson <bianca@redhat.com>
2026-05-25 15:53:21 -04:00
fdebba58bc Kubeconfig module improvement (#1123) (#1131)
* Add kubeconfig module for managing Kubernetes config files

* Remove unnecessary requirement & Change version

* Move functions to module_utils

* Add unit tests

* Add kubeconfig module for managing Kubernetes config files

* Remove unnecessary requirement & Change version

* Move functions to module_utils

* Add unit tests

* Avoid linter errors

* Improve documentation clarity

* Redact sensitive kubeconfig information

* Imprvoe verbosity

* Move import statement for to_native to avoid linters check failure

* Fix linting error

* Add remove behavior

* Add tests for remove behavior

* Imporve documentation

* Add changelog

---------


(cherry picked from commit 53c6c0ee80)

Co-authored-by: Youssef Ali <154611350+YoussefKhalidAli@users.noreply.github.com>
Co-authored-by: Bianca Henderson <bianca@redhat.com>
2026-05-19 14:38:15 -04:00
e87fe77453 Update pod deletion conditions for local storage used in a daemon set pod (#1095) (#1128)
* Update pod deletion conditions for local storage used in a daemon set pod

Refactor pod deletion logic to handle local storage in daemon set pods correctly.

* Add bugfix for k8s_drain handling local storage pods

Fix logic for handling pods with local storage in k8s_drain.

* Refactor filter_pods function for clarity and efficiency

* Fix sanity and linter errors

---------


(cherry picked from commit b58b2ca70e)

Co-authored-by: Juan Morete <morete@gmail.com>
Co-authored-by: Bianca Henderson <bianca@redhat.com>
2026-05-15 15:16:01 -04:00
714c2f6711 fix(helm_repository): strip trailing slashes from repo_url (#1121) (#1126)
Helm normalizes repository URLs internally, so a URL supplied with a
trailing slash and the same URL without one are treated as different
entries. This causes the module to fail every run when the user
provides a trailing slash, even though the repository is already
correctly registered.

Strip the trailing slash from repo_url before comparing against the
existing repository list so repeated runs with the same input are
idempotent.

Fixes #480

(cherry picked from commit 8a58d3b6de)

Co-authored-by: Yuriy Novostavskiy <yuriy@novostavskiy.kiev.ua>
2026-05-14 10:56:28 -04:00
2fb6546b03 docs: add until example to k8s_info (#885) (#1119)
I would liked to have an example like this when I was using the
documentation.

(cherry picked from commit 4d7dc2a7d1)

Co-authored-by: Birger Johan Nordølum <33870508+MindTooth@users.noreply.github.com>
2026-05-06 10:16:32 -04:00
ef9fb67688 Add kubeconfig module for managing Kubernetes config files (#1104) (#1122)
* Add kubeconfig module for managing Kubernetes config files

* Remove unnecessary requirement & Change version

* Move functions to module_utils

* Add unit tests

* Add kubeconfig module for managing Kubernetes config files

* Remove unnecessary requirement & Change version

* Move functions to module_utils

* Add unit tests

* Avoid linter errors

* Improve documentation clarity

* Redact sensitive kubeconfig information

* Imprvoe verbosity

* Move import statement for to_native to avoid linters check failure

* Fix linting error

---------


(cherry picked from commit e79ed52a4d)

Co-authored-by: Youssef Ali <154611350+YoussefKhalidAli@users.noreply.github.com>
Co-authored-by: Bianca Henderson <bianca@redhat.com>
2026-05-06 10:15:42 -04:00
Bianca HendersonandGitHub 90bc4c4b3b Release prep for 6.4.0 (#1101)
SUMMARY

Prep kubernetes.core 6.4.0 release

COMPONENT NAME

Multiple

Reviewed-by: Bianca Henderson <beeankha@gmail.com>
Reviewed-by: Yuriy Novostavskiy <yuriy@novostavskiy.kyiv.ua>
Reviewed-by: Bikouo Aubin
Reviewed-by: Hannah DeFazio <h2defazio@gmail.com>
2026-04-22 21:04:10 +00:00
1590c6a4cc Update URL reference in integration-test CI file (#1112) (#1114)
(cherry picked from commit 210467b26d)

Co-authored-by: Bianca Henderson <bianca@redhat.com>
2026-04-22 14:14:06 -04:00
76eccacab6 ci: conditionally test turbo mode and cloud.common (#1109) (#1111)
The cloud.common collection is incompatible with ansible-core >= 2.19.0.
With the current testing matrix using Python 3.12 and the ansible
milestone (currently 2.22), this incompatibility causes integration
tests to fail.

Instead of completely removing turbo mode from the testing matrix, this
commit adds ansible-core 2.18 to the matrix and excludes the combination
of the ansible milestone and turbo mode. The checkout and installation
of the cloud.common collection are now conditionally executed only when
turbo mode is enabled.

(cherry picked from commit 11f619b69e)

Co-authored-by: Yuriy Novostavskiy <yuriy@novostavskiy.kiev.ua>
2026-04-21 14:37:48 -04:00
620abbac26 trivial(doc): post #1090 cosmetic update (#1097) (#1107)
SUMMARY
Name of the Helm plays in the integration test framework test updated to reflect the actual version of Helm (addressed comments #1090 (review))
Updated documentation for the modules updated in the PR with the https://github.com/ansible-network/collection_prep, as per CONTRIBUTING.md
ISSUE TYPE

Docs Pull Request

COMPONENT NAME

tests/integration/targets/helm_v3_*/play.yaml
docs/kubernetes.core.helm*.rst

ADDITIONAL INFORMATION
Only cosmetic changes in this PR, so the label skip-changelog is suggested

Reviewed-by: Bianca Henderson <beeankha@gmail.com>
(cherry picked from commit 16e92a20e8)

Co-authored-by: Yuriy Novostavskiy <yuriy@novostavskiy.kyiv.ua>
2026-04-21 11:31:11 +02:00
66a820e03a Add sanity test ignores for ansible-core 2.22 (#1102) (#1106)
The `devel` and `milestone` branches for ansible-core have been bumped to
`2.22.0.dev0` as the `stable-2.21` branch was created. Testing against `devel`
and `milestone` now uses 2.22, which requires creation of the
`tests/sanity/ignore-2.22.txt` file in all maintained collection branches.

# Please enter the commit message for your changes. Lines starting
# with '#' will be ignored, and an empty message aborts the commit.
#
# On branch ignore-2.22
# Changes to be committed:
#	new file:   tests/sanity/ignore-2.22.txt
#

(cherry picked from commit 58f8f2e6e9)

Co-authored-by: Yuriy Novostavskiy <yuriy@novostavskiy.kiev.ua>
2026-04-20 18:34:35 -04:00
patchback[bot]andGitHub a3f2438e9d Ensure compatibility with Helm v4 for the collection (#1090) (#1096)
This is a backport of PR #1090 as merged into main (e6076e5).
SUMMARY

Ensure compatibility with Helm v4 for modules helm_plugin and helm_plugin_info
Partially addresses #1038

ISSUE TYPE


Feature Pull Request

COMPONENT NAME

helm_plugin
helm_plugin_info
helm_info
helm_pull
helm_registry_auth
helm
helm_template

Reviewed-by: Bikouo Aubin
Reviewed-by: Matthew Johnson
2026-03-17 15:03:02 +00:00
patchback[bot]andGitHub 0709ea31c9 Support take_ownership parameter in helm installation (#1034) (#1092)
This is a backport of PR #1034 as merged into main (42acb4f).
SUMMARY
Adds support for the take_ownership for initial release installation operations.
ISSUE TYPE

Bugfix Pull Request

COMPONENT NAME
plugins/modules/helm.py
ADDITIONAL INFORMATION
I recently had to migrate a namespace k8s from flat manifest installation into helm a release.
I was so glad to see the take_ownership feature but realized that it work only after first installation of the release.
Seeing no reason to denied this use case i suggest this very simple changes.
To reproduce it:

Create a new namespace in any cluster.
Create a secret
Install any helm chart that deploy the same secret using take_ownership: true.
2026-02-19 16:40:12 +00:00
patchback[bot]andGitHub 44ab1fc478 Add check_mode support for k8s_drain module (#1086) (#1091)
This is a backport of PR #1086 as merged into main (d239adb).
SUMMARY

Closes #1037

added support for check_mode
Converted warnings into informational display when user has explicitly requested to delete daemontset-managed pods, unmanaged pods or pods with local storage


ISSUE TYPE


Feature Pull Request

COMPONENT NAME

k8s_drain

Reviewed-by: Bianca Henderson <beeankha@gmail.com>
2026-02-16 20:35:22 +00:00
Bianca HendersonandGitHub 80c33c5573 Prep 6.3.0 release (#1084)
SUMMARY

Prep kubernetes.core 6.3.0 release

COMPONENT NAME

Multiple

Reviewed-by: Bianca Henderson <beeankha@gmail.com>
Reviewed-by: Bikouo Aubin
Reviewed-by: Mike Graves <mgraves@redhat.com>
Reviewed-by: Alina Buzachis
Reviewed-by: Yuriy Novostavskiy <yuriy@novostavskiy.kyiv.ua>
Reviewed-by: Rahmanim Benny <brahmani@redhat.com>
2026-02-03 17:03:41 +00:00
patchback[bot]andGitHub 73dc94be68 Add idempotency to helm_pull module (#1055) (#1080)
This is a backport of PR #1055 as merged into main (34beacf).
SUMMARY
This PR implements idempotency for the helm_pull module, addressing issue #889.

New force parameter with defaults to False.
implemented chart_exists() function
checks chart existence before downloading, returns changed=False when chart exists

ISSUE TYPE

Bugfix Pull Request

COMPONENT NAME
helm_pull
ADDITIONAL INFORMATION
Force parameter added for backward compatibility and edge cases.
Implemented with the partial support of GitHub Copilot with Claude Sonnet 4.5 model

Reviewed-by: Bianca Henderson <beeankha@gmail.com>
2026-01-29 18:22:52 +00:00
patchback[bot]andGitHub 1bc65230bb Fix incorrect assertion in helm_pull integration test (#1077) (#1079)
This is a backport of PR #1077 as merged into main (23b6cec).
SUMMARY

The error message emitted for incorrect helm version has changed since the merge of #1039. This PR updates the related assertion in the helm_pull integration test

Reviewed-by: Bianca Henderson <beeankha@gmail.com>
2026-01-29 17:44:05 +00:00
patchback[bot]andGitHub 91427a5b6a chore(CI): prevent patchback bot from labeling new PRs (#1062) (#1064)
This is a backport of PR #1062 as merged into main (987c029).
SUMMARY
Currently, the patchback bot creates PRs with cherry-picks of PRs that are labeled with stable-* label, and this PR (as any new PR) gets labeled as needs_triage. This is unnecessary as it intentional PR created by the CI job.
This pull request introduces a small update to ensure that the workflow only runs if the pull request is not created by the patchback[bot] user to avoid unnecessary labels.
ISSUE TYPE

Bugfix Pull Request

COMPONENT NAME
.github/workflows/label-new-prs.yaml
ADDITIONAL INFORMATION
No changelog is required 

Reviewed-by: Bianca Henderson <beeankha@gmail.com>
2026-01-29 16:00:40 +00:00
patchback[bot]andGitHub 1d1a23b1ab Replace passing `warnings to exit_json with AnsibleModule.warn` for the few modules (#1033) (#1073)
This is a backport of PR #1033 as merged into main (3e32c12).
SUMMARY
Using exit_json or fail_json for warnings is deprecated in ansible-core>=2.19.0 and will be removed in ansible-core>=2.23.0
Tested with ansible-core 2.19.3 as the latest released version at the time of the start of this PR and with 2.16.0 as the lowest version supported by kubernetes.core 6.x
Resolves: #1031
ISSUE TYPE

Bugfix Pull Request

COMPONENT NAME
k8s_drain
k8s_rollback
k8s_scale
ADDITIONAL INFORMATION
The initial version of this PR covers only the module k8s_drain, with the following commits extended to k8s_rollback
k8s_scale

Reviewed-by: Bianca Henderson <beeankha@gmail.com>
Reviewed-by: Mike Graves <mgraves@redhat.com>
2026-01-26 21:14:44 +00:00
patchback[bot]andGitHub 6edc84678d Limit compatibility to Helm =>v3.0.0,<4.0.0 (#1039) (#1071)
This is a backport of PR #1039 as merged into main (13791ec).
SUMMARY
Helm v4 is a major version with backward-incompatible changes, including to the flags and output of the Helm CLI and to the SDK. This version is currently not supported in the kubernetes.core. This PR is related to #1038 and is a short-term solution to mark compatibility explicitly
ISSUE TYPE

Bugfix Pull Request
Docs Pull Request

COMPONENT NAME

helm
helm_template
helm_info
helm_repository
helm_pull
helm_registry_auth
helm_plugin
helm_plugin_info

ADDITIONAL INFORMATION
Added `validate_helm_version()`` method to AnsibleHelmModule that enforces version constraint >=3.0.0,<4.0.0.
Fails fast with clear error message: "Helm version must be >=3.0.0,<4.0.0, current version is {version}"
Some modules (i.e. helm_registry_auth) technically is compatible with Helm v4, but validation was added to all helm modules.
Partially coauthored by GitHub Copilot with Claude Sonnet 4 model.
Addresses issue #1038

Reviewed-by: Bianca Henderson <beeankha@gmail.com>
Reviewed-by: Mike Graves <mgraves@redhat.com>
2026-01-26 19:47:46 +00:00
patchback[bot]andGitHub 66bd8620e4 Replace deprecated ansible.module_utils._text imports (#1053) (#1070)
This is a backport of PR #1053 as merged into main (452fb3d).
SUMMARY
Importing from ansible.module_utils._text is deprecated in ansible-core 2.20 and removed in 2.24. All imports of to_bytes, to_native, and to_text now use ansible.module_utils.common.text.converters.
Before:
from ansible.module_utils._text import to_bytes, to_native, to_text

After:
from ansible.module_utils.common.text.converters import to_bytes, to_native, to_text

ISSUE TYPE

Bugfix Pull Request

COMPONENT NAME
plugins/module_utils/common.py
plugins/action/k8s_info.py
plugins/connection/kubectl.py
plugins/module_utils/{copy.py, k8s/runner.py}
plugins/modules/{k8s_cp.py, k8s_drain.py, k8s_exec.py, k8s_json_patch.py, k8s_scale.py, k8s_taint.py}
ADDITIONAL INFORMATION
It's not an actual Bugfix, more a lifecycle management to ensure compatibility with future Ansible versions.
Tested with ansible-core 2.20 to ensure no deprecation warnings are raised and with ansible-core 2.16 to ensure backward compatibility.
Patrially coauthored-by: GitHub Copilot with Claude Code 4.5 model.
Addresses issue #1052.

Reviewed-by: Bianca Henderson <beeankha@gmail.com>
2026-01-26 15:22:45 +00:00
patchback[bot]andGitHub 94b43dc582 Fix K8S_AUTH_VERIFY_SSL environment value handling in kubectl connection plugin (#1049) (#1069)
This is a backport of PR #1049 as merged into main (12abc9b).
SUMMARY
Fixed a bug where setting K8S_AUTH_VERIFY_SSL=true (or any string value) caused the value to be treated as a separate kubectl command argument instead of being properly converted to a boolean.
The option key name is validate_certs, which does NOT end with "verify_ssl", so the original condition key.endswith("verify_ssl") at line 327 failed. This caused the code to fall through to the else block which added the value as separate
arguments: ["--insecure-skip-tls-verify", "true"], making "true" appear as a kubectl command.
Fixes #1021
ISSUE TYPE

Bugfix Pull Request

COMPONENT NAME
kubernetes.core.kubectl
ADDITIONAL INFORMATION
Changes Made

Changed condition from key.endswith("verify_ssl") to key == "validate_certs"
Added import of boolean function from ansible.module_utils.parsing.convert_bool
Added proper boolean conversion using boolean(self.get_option(key), strict=False)

Partially used LLM (GitHub Copilot with Claude Sonnet 4).
Before Fix
K8S_AUTH_VERIFY_SSL=true
Command: ['/usr/bin/kubectl', '--insecure-skip-tls-verify', 'true', 'exec', ...]

                                                            ^^^^^ treated as kubectl command (BUG!)

After Fix
K8S_AUTH_VERIFY_SSL=true
Command: ['/usr/bin/kubectl', '--insecure-skip-tls-verify=false', 'exec', ...]
                                                           ^^^^^ properly converted (FIXED!)

Reviewed-by: Bianca Henderson <beeankha@gmail.com>
2026-01-23 20:24:44 +00:00
patchback[bot]andGitHub 3c4f9cee60 chore(doc): update typos (#1059) (#1061)
This is a backport of PR #1059 as merged into main (6c00f7c).
SUMMARY
This trivial documentation-only pull request correcting a few errors in README.md.

Documentation corrections:

Fixed a broken Markdown link for the GitHub repository in the support request section.
Corrected the reference from LICENCE to LICENSE to match the actual file name.



ISSUE TYPE

Docs Pull Request

COMPONENT NAME
README.md
ADDITIONAL INFORMATION
Trivial documentation-only change, no changelog is required.

Reviewed-by: Bianca Henderson <beeankha@gmail.com>
2026-01-15 21:30:22 +00:00
patchback[bot]andGitHub a54b4a13b6 address sanity issues (#1056) (#1058)
This is a backport of PR #1056 as merged into main (bd1cacc).
SUMMARY


helm/helm_info - Deprecate some parameters and add new ones to resolve sanity issues.
k8s - the return block doc is not aligned with what the module returns


ISSUE TYPE


Bugfix Pull Request

COMPONENT NAME

helm, helm_info, k8s
Fixes: #1046

Reviewed-by: Bikouo Aubin
Reviewed-by: Bianca Henderson <beeankha@gmail.com>
2026-01-14 17:08:35 +00:00
patchback[bot]andGitHub e16b3c46b0 Add new workflow to label prs with needs_triage (#1045) (#1048)
This is a backport of PR #1045 as merged into main (9cfa903).
SUMMARY
This pr adds a new workflow for labeling new and reopened prs that are not marked as draft. The needs_triage label will be removed if the pr is marked as draft during development and re-added once the pr is marked as ready for review.
After consulting with the team, we decided to label prs in a new workflow to allow for the prs and issues to have different labels in the future.
ACA-2362
ISSUE TYPE

Feature Pull Request

COMPONENT NAME
github workflow
Reported CI Issues
Sanity tests: #1046

Reviewed-by: Bianca Henderson <beeankha@gmail.com>
2025-12-18 14:29:05 +00:00
bc60523372 Add 2.21 ignore file for sanity tests (#1032) (#1036)
SUMMARY

Resolves #1027

Reviewed-by: Yuriy Novostavskiy <yuriy@novostavskiy.kyiv.ua>
Reviewed-by: GomathiselviS <gomathiselvi@gmail.com>
(cherry picked from commit 1c16a2d2b5)

Co-authored-by: Bianca Henderson <bianca@redhat.com>
2025-10-24 09:28:46 -04:00
patchback[bot]andGitHub 64f3f07c5a Extend k8s action group (#992) (#1026)
This is a backport of PR #992 as merged into main (798f549).
SUMMARY


Add all k8s_* modules to the action group in order to esaily set kubeconfig parameter
ISSUE TYPE


Bugfix Pull Request

COMPONENT NAME

meta
ADDITIONAL INFORMATION

Reviewed-by: Bianca Henderson <beeankha@gmail.com>
2025-10-14 20:47:03 +00:00
patchback[bot]andGitHub d6492b66d9 Selectively redact sensitive kubeconfig data from logs (#1014) (#1024)
This is a backport of PR #1014 as merged into main (4fa3648).
SUMMARY

Resolves #782

ISSUE TYPE


Bugfix Pull Request

ADDITIONAL INFORMATION


The proper redaction of kubeconfig data can be seen by running this example playbook with verbosity of -vvv against the code in this PR.
Prior to these changes, all info was redacted (as shown in the example below):
ok: [local] => {
    "changed": false,
    "invocation": {
        "module_args": {
            "api_key": null,
            "binary_path": null,
            "ca_cert": null,
            "context": null,
            "get_all_values": false,
            "host": null,
            "kubeconfig": {
                "apiVersion": "VALUE_SPECIFIED_IN_NO_LOG_PARAMETER",
                "clusters": [
                    {
                        "cluster": {
                            "insecure-skip-tls-verify": true,
                            "server": "VALUE_SPECIFIED_IN_NO_LOG_PARAMETER"
                        },
                        "name": "VALUE_SPECIFIED_IN_NO_LOG_PARAMETER"
                    },
                    {
                        "cluster": {
                            "certificate-authority-data": "VALUE_SPECIFIED_IN_NO_LOG_PARAMETER",
                            "server": "VALUE_SPECIFIED_IN_NO_LOG_PARAMETER"
                        },
                        "name": "VALUE_SPECIFIED_IN_NO_LOG_PARAMETER"
                    },
                    {
                        "cluster": {
                            "certificate-authority": "VALUE_SPECIFIED_IN_NO_LOG_PARAMETER",
                            "extensions": [
                                {
                                    "extension": {
                                        "last-update": "VALUE_SPECIFIED_IN_NO_LOG_PARAMETER",
                                        "provider": "VALUE_SPECIFIED_IN_NO_LOG_PARAMETER",
                                        "version": "VALUE_SPECIFIED_IN_NO_LOG_PARAMETER"
                                    },
                                    "name": "VALUE_SPECIFIED_IN_NO_LOG_PARAMETER"
                                }
                            ],
                            "server": "VALUE_SPECIFIED_IN_NO_LOG_PARAMETER"
                        },
                        "name": "VALUE_SPECIFIED_IN_NO_LOG_PARAMETER"
                    }
                ],
                "contexts": [
                    {
                        "context": {
                            "cluster": "VALUE_SPECIFIED_IN_NO_LOG_PARAMETER",
                            "user": "VALUE_SPECIFIED_IN_NO_LOG_PARAMETER"
                        },
                        "name": "VALUE_SPECIFIED_IN_NO_LOG_PARAMETER"
                    },
                    {
                        "context": {
                            "cluster": "VALUE_SPECIFIED_IN_NO_LOG_PARAMETER",
                            "user": "VALUE_SPECIFIED_IN_NO_LOG_PARAMETER"
                        },
                        "name": "VALUE_SPECIFIED_IN_NO_LOG_PARAMETER"
                    },
[output shortened]

With the changes in this PR, only sensitive data is redacted:
ok: [local] => {
    "changed": false,
    "invocation": {
        "module_args": {
            "api_key": null,
            "binary_path": null,
            "ca_cert": null,
            "context": null,
            "get_all_values": false,
            "host": null,
            "kubeconfig": {
                "apiVersion": "v1",
                "clusters": [
                    {
                        "cluster": {
                            "insecure-skip-tls-verify": true,
                            "server": "<server address>"
                        },
                        "name": "exercise"
                    },
                    {
                        "cluster": {
                            "certificate-authority-data": "VALUE_SPECIFIED_IN_NO_LOG_PARAMETER",
                            "server": "<server address>"
                        },
                        "name": "kind-drain-test"
                    },
                    {
                        "cluster": {
                            "certificate-authority": "<path to .crt>",
                            "extensions": [
                                {
                                    "extension": {
                                        "last-update": "Tue, 07 Oct 2025 11:25:54 EDT",
                                        "provider": "minikube.sigs.k8s.io",
                                        "version": "v1.35.0"
                                    },
                                    "name": "cluster_info"
                                }
                            ],
                            "server": "<server address>"
                        },
                        "name": "minikube"
                    }
                ],
                "contexts": [
                    {
                        "context": {
                            "cluster": "exercise-pod",
                            "user": "bianca"
                        },
                        "name": "exercise"
                    },
                    {
                        "context": {
                            "cluster": "kind-drain-test",
                            "user": "kind-drain-test"
                        },
                        "name": "kind-drain-test"
                    },
[output shortened]

Reviewed-by: GomathiselviS <gomathiselvi@gmail.com>
2025-10-14 19:16:05 +00:00
patchback[bot]andGitHub 4d5388ddf8 775 document proxy configurations (#1018) (#1020)
This is a backport of PR #1018 as merged into main (ae624cf).
SUMMARY
Added documentation for no_proxy, proxy, and proxy_headers parameters that were missing from the k8s lookup plugin. These parameters are already implemented in the codebase but were not documented.
no_proxy: Comma separated list of hosts that shouldn't use proxy
proxy: HTTP proxy URL for connections
proxy_headers: Dictionary of proxy headers with suboptions for proxy_basic_auth, basic_auth, and user_agent
Fixes #775
ISSUE TYPE

Docs Pull Request

COMPONENT NAME
k8s lookup
Additional comment
This is a reissue of #993, which was lost during the latest release due to me PR incorrectly from my fork's main branch. Linter errors on the previous PR should already be resolved.
This had the backport-5, backport-6 and skip-changelog labels.

Reviewed-by: Bianca Henderson <beeankha@gmail.com>
2025-10-10 17:30:10 +00:00
Bianca HendersonandGitHub 6dadd06252 Add missing changelog fragments from 5.4.0 and 5.4.1 releases (#1015)
Reviewed-by: Mandar Kulkarni <mandar242@gmail.com>
Reviewed-by: Yuriy Novostavskiy <yuriy@novostavskiy.kyiv.ua>
2025-10-07 20:38:26 +00:00
Bianca HendersonandGitHub 69dc7d5c5d Prep 6.2.0 release (#1011)
SUMMARY

Prep kubernetes.core 6.2.0 release

COMPONENT NAME
Multiple

Reviewed-by: Bikouo Aubin
Reviewed-by: Yuriy Novostavskiy <yuriy@novostavskiy.kyiv.ua>
Reviewed-by: Alina Buzachis
Reviewed-by: Bianca Henderson <beeankha@gmail.com>
Reviewed-by: Mandar Kulkarni <mandar242@gmail.com>
2025-10-07 18:18:54 +00:00
patchback[bot]andGitHub 2fa1c2c6e5 Add support of local environment variables in kustomize lookup plugin (#786) (#1010)
This is a backport of PR #786 as merged into main (87344b9).
SUMMARY
kustomize doesn't support an environment that makes it impossible to use HTTP_PROXY or provide some templatized parameters.
This PR is the result of the issue #783
ISSUE TYPE

Feature Pull Request

COMPONENT NAME
kubernetes.core.kustomize lookup plugin

Reviewed-by: Bikouo Aubin
Reviewed-by: Bianca Henderson <beeankha@gmail.com>
2025-10-03 14:34:41 +00:00
patchback[bot]andGitHub f2623dd3cf update doc following #971 (#1006) (#1008)
This is a backport of PR #1006 as merged into main (200d64f).
SUMMARY
In the PR #971, support for copying files to initContainers, and this change includes a minor update for DOCUMENTATION for the k8s_cp module; however, docs/kubernetes.core.k8s_cp_module.rst wasn't updated, and it's a trivial change following the Updating documentation section of the CONTRIBUTING.md
ISSUE TYPE

Docs Pull Request

COMPONENT NAME
docs/kubernetes.core.k8s_cp_module.rst
ADDITIONAL INFORMATION
As it is a trivial change and related to #971, I didn't created a chnagelog fragment and suggest adding skip-changelog label.
To be backported to stable-5 and stable-6

Reviewed-by: Bianca Henderson <beeankha@gmail.com>
2025-10-02 20:11:20 +00:00
patchback[bot]andGitHub 8772d8c997 Add the PR head as reference to the checkout action of the splitter job. (#981) (#1005)
This is a backport of PR #981 as merged into main (ec35c74).
SUMMARY
During the workflow checks of one of my previous pull requests, I ran into an error as result of a new integration test that was added in the main branch but which was not present in my pull request (https://github.com/ansible-collections/kubernetes.core/actions/runs/16787189478/job/47540604109). I'd find out that the reference for the repository checkout for the splitter job was not set and therefor it referenced to the main branch.
With this change, the head of the pull request is used as reference for the repository checkout action, in the splitter job. This way it will not fail when someone creates a PR that doesn't have newly added integration tests that were added to the main branch in the meantime. It also adds that newly added integration tests will be tested during the PR workflow checks already.
ISSUE TYPE

Bugfix Pull Request

COMPONENT NAME
bugfix in the workflow
ADDITIONAL INFORMATION
n/a

Reviewed-by: Bianca Henderson <beeankha@gmail.com>
2025-10-02 19:12:05 +00:00
patchback[bot]andGitHub a32108f64f Added support for copying files to init Containers. (#971) (#1003)
This is a backport of PR #971 as merged into main (027700c).
SUMMARY
Was going trough the list with issues and found 958; which seemed a quick fix.
What I fixed with with this PR:

Added support for copying files to init containers.
Fixed the format message when an exec is failing for a pod (the order was wrong).
Added a check if the container that you try to run copy for is started.

ISSUE TYPE

Bugfix Pull Request

COMPONENT NAME
copy.py module
ADDITIONAL INFORMATION
Some testing.
Verify that the pod does not exist:
kubectl -n default get pod/yorick
Output:
Error from server (NotFound): pods "yorick" not found

Run the playbook to create the file, create the deployment, wait for the init container to be ready, copy the created file to the init container, cat the copied file (using kubernetes.core.k8s_exec) that is now in the init container and try to copy the created file to the (not started) container (which fails - to see the new error message for it):
cat << EOF | ansible-playbook /dev/stdin
- hosts: localhost
  gather_facts: False
  tasks:

  - ansible.builtin.copy:
      content: |
        Hi there
      dest: /tmp/yorick.txt

  - name: Deploy pod with initContainer with an unlimited while loop
    kubernetes.core.k8s:
      kubeconfig: "~/.kube/config"
      definition:
        apiVersion: v1
        kind: Pod
        metadata:
          name: "yorick"
          namespace: "default"
        spec:
          initContainers:
            - name: "yorick-init"
              image: busybox:latest
              command: ["/bin/sh"]
              args:
                - "-c"
                - |
                  echo "Init container started, waiting for file..."
                  # Wait for the file to be copied
                  while :;do
                    echo "Waiting for file"
                    sleep 5
                  done
                  echo "File received! Init container completing..."
          containers:
            - name: "yorick-container"
              image: busybox:latest
              command: ["/bin/sh"]
              args:
                - "-c"
                - |
                  # Keep container running for testing
                  sleep 300

  - kubernetes.core.k8s_info:
      kubeconfig: "~/.kube/config"
      api_version: v1
      kind: Pod
      name: "yorick"
      namespace: "default"
    register: pod_status
    until: >-
      pod_status.resources|length > 0
      and 'initContainerStatuses' in pod_status.resources.0.status
      and pod_status.resources.0.status.initContainerStatuses|length > 0
      and pod_status.resources.0.status.initContainerStatuses.0.started|bool

  - name: Copy /tmp/yorick.txt to the yorick-init init container
    kubernetes.core.k8s_cp:
      kubeconfig: "~/.kube/config"
      namespace: default
      pod: yorick
      remote_path: /tmp/yorick.txt
      local_path: /tmp/yorick.txt
      container: yorick-init

  - name: Execute a command
    kubernetes.core.k8s_exec:
      kubeconfig: "~/.kube/config"
      namespace: default
      pod: yorick
      container: yorick-init
      command: cat /tmp/yorick.txt
    register: exec_out

  - ansible.builtin.debug:
      var: exec_out.stdout

  - name: Try to copy /tmp/yorick.txt to the yorick-container container
    kubernetes.core.k8s_cp:
      kubeconfig: "~/.kube/config"
      namespace: default
      pod: yorick
      remote_path: /tmp/yorick.txt
      local_path: /tmp/yorick.txt
      container: yorick-container
EOF
Output:
PLAY [localhost] ********************************************************************************************************************************************************************

TASK [ansible.builtin.copy] *********************************************************************************************************************************************************
Thursday 31 July 2025  02:01:21 +0200 (0:00:00.016)       0:00:00.016 *********
ok: [localhost]

TASK [Deploy pod with initContainer with an unlimited while loop] *******************************************************************************************************************
Thursday 31 July 2025  02:01:21 +0200 (0:00:00.788)       0:00:00.804 *********
changed: [localhost]

TASK [kubernetes.core.k8s_info] *****************************************************************************************************************************************************
Thursday 31 July 2025  02:01:25 +0200 (0:00:03.963)       0:00:04.768 *********
FAILED - RETRYING: [localhost]: kubernetes.core.k8s_info (3 retries left).
ok: [localhost]

TASK [Copy /tmp/yorick.txt to the yorick-init init container] ***********************************************************************************************************************
Thursday 31 July 2025  02:01:32 +0200 (0:00:06.598)       0:00:11.366 *********
changed: [localhost]

TASK [Execute a command] ************************************************************************************************************************************************************
Thursday 31 July 2025  02:01:39 +0200 (0:00:07.017)       0:00:18.383 *********
changed: [localhost]

TASK [ansible.builtin.debug] ********************************************************************************************************************************************************
Thursday 31 July 2025  02:01:40 +0200 (0:00:00.644)       0:00:19.028 *********
ok: [localhost] => {
    "exec_out.stdout": "Hi there\n"
}

TASK [Try to copy /tmp/yorick.txt to the yorick-container container] ****************************************************************************************************************
Thursday 31 July 2025  02:01:40 +0200 (0:00:00.021)       0:00:19.050 *********
fatal: [localhost]: FAILED! => {
    "changed": false
}

MSG:

Pod container yorick-container is not started

PLAY RECAP **************************************************************************************************************************************************************************
localhost                  : ok=6    changed=3    unreachable=0    failed=1    skipped=0    rescued=0    ignored=0

Playbook run took 0 days, 0 hours, 0 minutes, 21 seconds

Reviewed-by: Bianca Henderson <beeankha@gmail.com>
2025-09-25 15:07:52 +00:00
patchback[bot]andGitHub 365e5e9159 Add support for skip-schema-validation in helm module (#995) (#1001)
This is a backport of PR #995 as merged into main (da93cce).
SUMMARY
This pull request adds support for a new skip_schema_validation option to the helm module, allowing users to disable JSON schema validation for Helm charts and values (requires helm >= 3.16.0).
ISSUE TYPE

Feature Pull Request

COMPONENT NAME
helm
ADDITIONAL INFORMATION
Added the skip_schema_validation boolean parameter to the helm module, allowing users to disable JSON schema validation for charts and values. This option is only available with Helm versions >= 3.16.0, and an appropriate error is raised for older versions.
Added integration tests to verify the behavior of the skip_schema_validation option, including cases for both supported and unsupported Helm versions.
Closes #994

Reviewed-by: Bianca Henderson <beeankha@gmail.com>
2025-09-24 20:29:07 +00:00
patchback[bot]andGitHub 448a68da3d Changelog fixes (#989) (#990)
This is a backport of PR #989 as merged into main (6158300).
SUMMARY

Changelog fixes

ISSUE TYPE


Docs Pull Request

Reviewed-by: Bianca Henderson <beeankha@gmail.com>
Reviewed-by: Chyna Sanders
2025-09-22 20:14:29 +00:00
patchback[bot]andGitHub 46acab9c4c [CI Fix] Remove ansible.module_utils.six imports (#998) (#1000)
This is a backport of PR #998 as merged into main (448d3fe).
SUMMARY
This PR is essentially attempting Option B from issue #996 (Option A is implemented here); this code update accounts for the recent merge of sanity: warn on ansible.module_utils.six imports #85651.

Reviewed-by: Bianca Henderson <beeankha@gmail.com>
Reviewed-by: Mandar Kulkarni <mandar242@gmail.com>
2025-09-22 16:49:02 +00:00
Bianca HendersonandGitHub fdb77182c8 Update/correct stable-6 changelog (#987)
SUMMARY
A part of the changelog referring to reverted changes was left in; this PR updates the changelog files to accurately reflect the state of stable-6/6.1.0 release.

Reviewed-by: Yuriy Novostavskiy
Reviewed-by: Alina Buzachis
2025-08-13 08:34:52 +00:00
Alina BuzachisandGitHub fa3d94f793 Prep kubernetes.core 6.1.0 (#977)
SUMMARY


ISSUE TYPE


Bugfix Pull Request
Docs Pull Request
Feature Pull Request
New Module Pull Request

COMPONENT NAME

ADDITIONAL INFORMATION

Reviewed-by: Yuriy Novostavskiy
Reviewed-by: Bianca Henderson <beeankha@gmail.com>
Reviewed-by: GomathiselviS <gomathiselvi@gmail.com>
2025-08-12 18:25:31 +00:00
patchback[bot]andGitHub 9ec27cf37c CI fix for 976 (#982) (#985)
This is a backport of PR #982 as merged into main (a861079).
SUMMARY
Exclude plugins/connection/kubectl.py from ansible-lint, as this file contains only examples that is simplificated and may not be accordingally to linter rules.
resolves #976
ISSUE TYPE

Bugfix Pull Request

COMPONENT NAME
CI
ADDITIONAL INFORMATION

Reviewed-by: Alina Buzachis
Reviewed-by: Bianca Henderson <beeankha@gmail.com>
2025-08-12 15:59:34 +00:00
Bianca HendersonandGitHub 10cb241256 Reapply "Remove kubeconfig value from module invocation log (#826)" (#899) (#966) (#979)
This reverts commit 1d962fb from stable-6 (i.e., reapplies the changes from #966); this is a temporary fix for #782 as it will re-introduce #870.

Reviewed-by: Alina Buzachis
Reviewed-by: GomathiselviS <gomathiselvi@gmail.com>
2025-08-11 16:48:04 +00:00
patchback[bot]andGitHub 92e1f581fe fix(k8s,service): Hide fields first before creating diffs (#915) (#963)
This is a backport of PR #915 as merged into main (6a0635a).
SUMMARY

By hiding fields first before creating a diff hidden fields will not be shown in the resulting diffs and therefore will also not trigger the changed condition.
The issue can only be reproduced when a mutating webhook changes the object while the kubernetes.core.k8s module is working with it.

kubevirt/kubevirt.core#145
ISSUE TYPE


Bugfix Pull Request

COMPONENT NAME

kubernetes.core.module_utils.k8s.service
ADDITIONAL INFORMATION


Run kubernetes.core.k8s and create object with hidden fields. After run kubernetes.core.k8s again and let a webhook mutate the object that the module is working with. The module should return with changed: no.

Reviewed-by: Alina Buzachis
2025-08-04 18:03:21 +00:00
patchback[bot]andGitHub 7f69aff0d6 k8s_json_patch: support the hidden_fields param (#964) (#972)
This is a backport of PR #964 as merged into main (c48778d).
SUMMARY
Add support for hidden_fields on k8s_json_patch

ISSUE TYPE

Feature Pull Request

COMPONENT NAME
k8s_json_patch
ADDITIONAL INFORMATION
Works exactly the same as k8s
Haven't pushed the doc yet, because of many changes. Will do it on a separate commit if the tests pass.
1st commit here, sorry if I forget some things.
Thanks!

Reviewed-by: Bianca Henderson <beeankha@gmail.com>
2025-08-01 18:24:39 +00:00
patchback[bot]andGitHub 8c65ac066d Add support for take-ownership Helm flag (#957) (#969)
This is a backport of PR #957 as merged into main (cf3c3a9).
SUMMARY
Add support for take-ownership Helm flag added in Helm 3.17.0
ISSUE TYPE

Feature Pull Request

COMPONENT NAME

kubernetes.core.helm

Reviewed-by: Bianca Henderson <beeankha@gmail.com>
2025-07-28 15:48:39 +00:00
patchback[bot]andGitHub 1d962fb932 Revert "Remove kubeconfig value from module invocation log (#826)" (#899) (#966)
This is a backport of PR #899 as merged into main (1705ced).
This reverts commit 6efabd3.
SUMMARY

Fixes #870
A better solution is necessary to address #782. The current code makes getting manifests practically unusable. We need to revert this commit until a better solution is found.

ISSUE TYPE


Bugfix Pull Request

COMPONENT NAME

kubeconfig

Reviewed-by: Bianca Henderson <beeankha@gmail.com>
2025-07-22 21:29:21 +00:00
patchback[bot]andGitHub 27ce23aa72 Fix integration test with ansibe-core 2.20 (#951) (#960)
This is a backport of PR #951 as merged into main (f568c9d).
SUMMARY
Now that ansible-core 2.19.0rc1 has been released, ansible-core’s devel branch has been bumped from 2.19.0.dev0 to 2.20.0.dev0. This potentially requires collection CIs to be updated which rely on devel using tests/sanity/ignore-2.19.txt, for example. Also it’s now time to add stable-2.19 to CI if you relied on devel to cover 2.19 so far. Note that milestone has also been updated to 2.20.0dev0.
During testing, I noticed that the failed test tasks/test_helm_not_installed.yml due to the new error message with ansible 2.20, please find here and following comments.
ISSUE TYPE

Bugfix Pull Request

COMPONENT NAME
test/CI (tasks/test_helm_not_installed.yml)
ADDITIONAL INFORMATION
to be cherry-picked to the stable-6 and stable-5

Reviewed-by: Bianca Henderson <beeankha@gmail.com>
2025-07-15 15:34:33 +00:00
patchback[bot]andGitHub 993652b581 Add more functionality coverage to k8s_rollback integration test (#950) (#956)
This is a backport of PR #950 as merged into main (94e4235).
SUMMARY

Resolves #344

This revision adds the following test coverage:

Label Selectors: Tests rollback using label selectors to target specific deployments.
No Rollout History: Tests the warning scenario when attempting to rollback a deployment with only one revision.
Unsupported Resource Types: Tests error handling when trying to rollback unsupported resources like Services.
Non-existent Resources: Tests behavior when attempting to rollback resources that don't exist.
Multiple Resource Rollback: Tests bulk rollback operations using label selectors on multiple deployments.
Return Value Validation: Comprehensive validation of the rollback_info structure and content.
Field Selectors: Tests rollback using field selectors to target specific resources.
Check Mode Validation: Additional validation of check mode behavior and return values.

COMPONENT NAME

tests/integration/targets/k8s_rollback/tasks/main.yml

Reviewed-by: Bianca Henderson <beeankha@gmail.com>
2025-07-14 14:36:29 +00:00
patchback[bot]andGitHub 9bd9d22db3 Fix the integration test for helm_registry_auth with helm >= 3.18.0 and clarify idempotency. (#946) (#953)
This is a backport of PR #946 as merged into main (642eb93).
SUMMARY
Fix the integration test for helm_registry_auth with helm >= 3.18.0 and clarify idempotency.
Fixes #944
ISSUE TYPE

Bugfix Pull Request

COMPONENT NAME
helm_registry_auth
ADDITIONAL INFORMATION
Caused by the changes in helm starting from 3.18.0

Reviewed-by: Bikouo Aubin
Reviewed-by: Bianca Henderson <beeankha@gmail.com>
2025-07-08 15:56:48 +00:00
patchback[bot]andGitHub 0593426918 Add plain_http parameter to helm, helm_pull and helm_template (#934) (#949)
This is a backport of PR #934 as merged into main (775959c).
SUMMARY

This change introduces the plain_http parameter to modules that can interact with OCI registries. This in needed in cases where the OCI registry does not use SSL encryption, forcing Helm to send HTTP requests instead of HTTPS

ISSUE TYPE


Feature Pull Request

COMPONENT NAME

helm, helm_pull and helm_template
ADDITIONAL INFORMATION


This is the output when trying to use an OCI registry that is not configured to use SSL certs.

fatal: [localhost]: FAILED! => {"changed": false, "command": "/usr/local/bin/helm show chart 'oci://<http-registry>/charts/foo'", "msg": "Failure when executing Helm command. Exited 1.\nstdout: \nstderr: Error: Get \"https://<http-registry>/v2/charts/foo/tags/list\": http: server gave HTTP response to HTTPS client\n", "stderr": "Error: Get \"https://<http-registry>/v2/charts/foo/tags/list\": http: server gave HTTP response to HTTPS client\n", "stderr_lines": ["Error: Get \"https://<http-registry>/v2/charts/foo/tags/list\": http: server gave HTTP response to HTTPS client"], "stdout": "", "stdout_lines": []}

Reviewed-by: Bikouo Aubin
2025-06-12 10:53:42 +00:00
Bianca HendersonandGitHub 8fa5b201a4 Prep release 6.0.0 (#933)
SUMMARY

Prep kubernetes.core 6.0.0
Prerequisite: Release of community.okd/redhat.openshift 4.0.2 needs to happen first

ISSUE TYPE


Feature Pull Request

COMPONENT NAME
Multiple

Reviewed-by: Bikouo Aubin
2025-06-03 16:56:33 +00:00
179 changed files with 1196 additions and 4203 deletions
-3
View File
@@ -1,9 +1,6 @@
---
profile: production
warn_list:
- no-log-password
exclude_paths:
- .ansible/
- .github/
+4
View File
@@ -1,4 +1,8 @@
# https://docs.ansible.com/ansible-lint/docs/rules/
# no-changed-when is not requried for examples
plugins/connection/kubectl.py no-changed-when
# false positive result
plugins/connection/kubectl.py var-naming[no-reserved]
plugins/connection/kubectl.py jinja[invalid]
# collection EE metadata is not an ansible-builder definition file
meta/execution-environment.yml schema[execution-environment]
+27 -3
View File
@@ -81,6 +81,8 @@ jobs:
steps:
- run: |
python -c "
import sys
required = ['sanity', 'units', 'coverage']
if '${{ github.event_name }}' == 'pull_request':
required = ['security-check', 'linters', 'sanity', 'units', 'coverage']
@@ -91,7 +93,29 @@ jobs:
'units': '${{ needs.units.result }}',
'coverage': '${{ needs.coverage.result }}',
}
ok = all(results[j] == 'success' for j in required)
skipped_ok = all(results[j] in ('success', 'skipped') for j in results)
assert ok and skipped_ok, f'required={required} results={results}'
for name in required:
if results[name] == 'failure':
print(f'all_green: required job failed: {name} results={results}', file=sys.stderr)
sys.exit(1)
# cancel-in-progress superseded this run; do not fail (newer run is authoritative)
if any(v == 'cancelled' for v in results.values()):
print(
'all_green: one or more jobs cancelled (usually concurrency); skipping strict gate.',
results,
)
sys.exit(0)
not_ok = [j for j in required if results[j] != 'success']
if not_ok:
print(f'all_green: required jobs not success: {not_ok} results={results}', file=sys.stderr)
sys.exit(1)
for job, status in results.items():
if job not in required and status not in ('success', 'skipped'):
print(f'all_green: unexpected {job}={status} results={results}', file=sys.stderr)
sys.exit(1)
print('all_green OK', results)
"
-20
View File
@@ -1,20 +0,0 @@
---
name: Run collection certification checks
permissions:
contents: read
on:
pull_request:
branches:
- main
- stable-*
workflow_dispatch:
concurrency:
group: cert-ver-${{ github.head_ref || github.run_id }}
cancel-in-progress: true
jobs:
call:
uses: ansible-collections/partner-certification-checker/.github/workflows/certification-reusable.yml@f4bf7ba4d3f008b2db8fc6a812fa3f89fdf42c2e # v4.1.0
@@ -1,210 +0,0 @@
name: Integration tests Helm
concurrency:
group: integration-tests-helm-${{ github.head_ref }}
cancel-in-progress: true
on:
pull_request:
types:
- opened
- reopened
- labeled
- unlabeled
- synchronize
branches:
- main
- stable-*
permissions: {}
jobs:
splitter:
env:
source_dir: "./source"
runs-on: ubuntu-latest
outputs:
helm_targets: ${{ steps.select-targets.outputs.targets }}
permissions:
pull-requests: read
contents: read
steps:
- name: Checkout the collection repository
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
with:
path: ${{ env.source_dir }}
fetch-depth: "0"
ref: ${{ github.event.pull_request.head.sha }}
persist-credentials: false
- name: list changes for pull request
id: splitter
uses: ansible-network/github_actions/.github/actions/ansible_test_splitter@4678c74a7d712d55e663c88f66eec6d9c3642550
with:
collections_to_test: ${{ env.source_dir }}
total_jobs: 8
- name: Select Helm targets
id: select-targets
run: |
import os, json
with open(os.environ.get('GITHUB_OUTPUT'), "a", encoding="utf-8") as fh:
data = os.environ.get("ALL_TEST_TARGETS")
targets = []
for target in data.split(";"):
if target and ':' in target:
targets.extend([v for v in target.split(':', maxsplit=1)[1].split(',') if v.startswith('helm')])
fh.write(f'targets={json.dumps(targets)}\n')
shell: python
env:
ALL_TEST_TARGETS: ${{ steps.splitter.outputs.test_targets }}
integration:
runs-on: ubuntu-latest
timeout-minutes: 60
needs:
- splitter
if: ${{ needs.splitter.outputs.helm_targets != '' && needs.splitter.outputs.helm_targets != '[]' }}
env:
source: "./source"
ansible_posix: "./ansible_posix"
community_general: "./community_general"
ansible-version: "milestone"
python-version: "3.13"
permissions:
contents: read
strategy:
fail-fast: false
matrix:
helm-version:
- v3.0.0
- v3.1.0
- v3.8.0
- v3.10.3
- v3.15.4
- v3.16.0
- v3.17.0
- v3.22.0
- v4.0.0
- v4.2.1
- latest
ansible_test_target: ${{ fromJson(needs.splitter.outputs.helm_targets) }}
exclude:
# helm_registry_auth: only test against recent versions to reduce CI cost
- ansible_test_target: "helm_registry_auth"
helm-version: "v3.0.0"
- ansible_test_target: "helm_registry_auth"
helm-version: "v3.1.0"
- ansible_test_target: "helm_registry_auth"
helm-version: "v3.8.0"
- ansible_test_target: "helm_registry_auth"
helm-version: "v3.10.3"
- ansible_test_target: "helm_registry_auth"
helm-version: "v3.15.4"
- ansible_test_target: "helm_registry_auth"
helm-version: "v3.16.0"
# helm install/upgrade --create-namespace requires helm >= 3.2.0
- ansible_test_target: "helm_diff"
helm-version: "v3.0.0"
- ansible_test_target: "helm_diff"
helm-version: "v3.1.0"
- ansible_test_target: "helm_diff"
helm-version: "v3.8.0"
- ansible_test_target: "helm_diff"
helm-version: "v3.10.3"
# UPGRADE FAILED: conflict occurred while applying object helm-diff/test-chart-another-configmap /v1
- ansible_test_target: "helm_diff"
helm-version: "v4.0.0"
- ansible_test_target: "helm_repository"
helm-version: "v3.0.0"
- ansible_test_target: "helm_repository"
helm-version: "v3.1.0"
- ansible_test_target: "helm_kubeconfig"
helm-version: "v3.0.0"
- ansible_test_target: "helm_kubeconfig"
helm-version: "v3.1.0"
- ansible_test_target: "helm_set_values"
helm-version: "v3.0.0"
- ansible_test_target: "helm_set_values"
helm-version: "v3.1.0"
- ansible_test_target: "helm_set_values"
helm-version: "v3.8.0"
- ansible_test_target: "helm"
helm-version: "v3.0.0"
- ansible_test_target: "helm"
helm-version: "v3.1.0"
- ansible_test_target: "helm_uninstall"
helm-version: "v3.0.0"
- ansible_test_target: "helm_uninstall"
helm-version: "v3.1.0"
name: "${{ matrix.ansible_test_target }}-${{ matrix.helm-version }}"
steps:
- name: Checkout kubernetes.core repository
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
with:
path: ${{ env.source }}
ref: ${{ github.event.pull_request.head.sha }}
persist-credentials: false
- name: Set up Python ${{ env.python-version }}
uses: actions/setup-python@5fda3b95a4ea91299a34e894583c3862153e4b97 # v7.0.0
with:
python-version: ${{ env.python-version }}
# install ansible
- name: Install ansible-core (${{ env.ansible-version }})
env:
ANSIBLE_VERSION: ${{ env.ansible-version }}
run: |
curl -sSL --proto '=https' --tlsv1.2 --retry 5 --retry-delay 10 --retry-all-errors \
"https://github.com/ansible/ansible/archive/${ANSIBLE_VERSION}.tar.gz" \
-o ansible.tar.gz
python3 -m pip install --disable-pip-version-check ./ansible.tar.gz
rm ansible.tar.gz
shell: bash
- name: Build and install collection
id: install-src
uses: ansible-network/github_actions/.github/actions/build_install_collection@4678c74a7d712d55e663c88f66eec6d9c3642550
with:
install_python_dependencies: true
source_path: ${{ env.source }}
- name: create kubernetes cluster
uses: helm/kind-action@ef37e7f390d99f746eb8b610417061a60e82a6cc # v1.14.0
with:
node_image: "kindest/node:v1.29.2"
- name: "Install Helm version ${{ matrix.helm-version }}"
uses: azure/setup-helm@9bc31f4ebc9c6b171d7bfbaa5d006ae7abdb4310 # v5.0.1
with:
version: '${{ matrix.helm-version }}'
- name: Verify Helm Installation
run: helm version
- name: Disable selinux with selinux_please_lie_to_me
run: |
python3 -m pip uninstall -y selinux
python3 -m pip install --only-binary=:all: selinux_please_lie_to_me==1.0.1
shell: bash
- name: Install python requirements
run: python3 -m pip install -r requirements.txt -r test-requirements.txt
shell: bash
working-directory: ${{ steps.install-src.outputs.collection_path }}
- name: Run integration tests
run: >-
ansible-test integration
--diff
--no-temp-workdir
--color
--skip-tags False
--retry-on-error
--continue-on-error
--python ${{ env.python-version }}
-v
${{ matrix.ansible_test_target }}
shell: bash
working-directory: ${{ steps.install-src.outputs.collection_path }}
+11 -43
View File
@@ -17,8 +17,9 @@ jobs:
source_dir: "./source"
runs-on: ubuntu-latest
outputs:
test_targets: ${{ steps.select-targets.outputs.targets }}
test_jobs: ${{ steps.select-targets.outputs.jobs }}
test_targets: ${{ steps.splitter.outputs.test_targets }}
test_targets_json: ${{ steps.splitter.outputs.test_targets_json }}
test_jobs: ${{ steps.splitter.outputs.test_jobs }}
steps:
- name: Checkout the collection repository
uses: actions/checkout@v3
@@ -34,40 +35,18 @@ jobs:
collections_to_test: ${{ env.source_dir }}
total_jobs: 8
- name: Remove all Helm related targets
id: select-targets
run: |
import os, json
with open(os.environ.get('GITHUB_OUTPUT'), "a", encoding="utf-8") as fh:
data = os.environ.get("ALL_TEST_TARGETS")
index = 0
result = {}
for target in data.split(";"):
if target and ':' in target:
k8s = [v for v in target.split(':', maxsplit=1)[1].split(',') if not v.startswith('helm')]
if k8s:
result[index] = ' '.join(k8s)
index += 1
fh.write(f'targets={json.dumps(result)}\n')
fh.write(f'jobs={json.dumps(list(result.keys()))}\n')
shell: python
env:
ALL_TEST_TARGETS: ${{ steps.splitter.outputs.test_targets }}
- name: Display splitter output
env:
TARGETS: ${{ steps.select-targets.outputs.targets }}
JOBS: ${{ steps.select-targets.outputs.jobs }}
run: |
echo "targets => $TARGETS"
echo "jobs => $JOBS"
echo "test_targets=${{ steps.splitter.outputs.test_targets }}"
echo "test_targets_json=${{ steps.splitter.outputs.test_targets_json }}"
echo "test_jobs=${{ steps.splitter.outputs.test_jobs }}"
shell: bash
integration:
runs-on: ubuntu-latest
timeout-minutes: 60
needs:
- splitter
if: ${{ needs.splitter.outputs.test_jobs != '' && needs.splitter.outputs.test_jobs != '[]' }}
if: ${{ needs.splitter.outputs.test_targets != '' }}
env:
source: "./source"
cloud_common: "./cloudcommon"
@@ -77,24 +56,15 @@ jobs:
fail-fast: false
matrix:
# Ref must match a branch/tag on github.com/ansible/ansible (e.g. stable-2.18, not 2.18).
#
ansible-version: ["stable-2.18", "stable-2.21", "milestone"]
ansible-version: ["stable-2.18", "milestone"]
enable-turbo-mode: [true, false]
python-version: ["3.12", "3.13"]
exclude:
# stable-2.18 is used mainly because turbo mode, no reason to test it with turbo mode disabled
- ansible-version: "stable-2.18"
enable-turbo-mode: false
# turbo mode is supported only by ansible<2.19
- ansible-version: "milestone"
enable-turbo-mode: true
- ansible-version: "stable-2.21"
enable-turbo-mode: true
# stable-2.18 supports 3.12
# stable-2.18 supports 3.12; milestone (devel) requires >=3.13
- ansible-version: "stable-2.18"
python-version: "3.13"
- ansible-version: "stable-2.21"
python-version: "3.12"
- ansible-version: "milestone"
python-version: "3.12"
workflow-id: ${{ fromJson(needs.splitter.outputs.test_jobs) }}
@@ -108,14 +78,12 @@ jobs:
fh.write(f'ansible_test_targets={json.loads(os.environ.get("ALL_TEST_TARGETS")).get(os.environ.get("WORKFLOW_ID"))}\n')
shell: python
env:
ALL_TEST_TARGETS: ${{ needs.splitter.outputs.test_targets }}
ALL_TEST_TARGETS: ${{ needs.splitter.outputs.test_targets_json }}
WORKFLOW_ID: ${{ matrix.workflow-id }}
- name: Display ansible test targets
env:
ANSIBLE_TEST_TARGETS: ${{ steps.read-targets.outputs.ansible_test_targets }}
run: |
echo "ansible_test_targets -> $ANSIBLE_TEST_TARGETS"
echo "ansible_test_targets -> ${{ steps.read-targets.outputs.ansible_test_targets }}"
- name: Checkout kubernetes.core repository
uses: actions/checkout@v3
-18
View File
@@ -1,18 +0,0 @@
---
name: label new issues
on:
issues:
types:
- opened
- reopened
jobs:
add_label:
runs-on: ubuntu-latest
permissions:
contents: write
issues: write
steps:
- uses: actions-ecosystem/action-add-labels@v1
with:
labels: needs_triage
+1 -2
View File
@@ -16,13 +16,12 @@ tests/integration/cloud-config-*
.ansible
# Helm charts
tests/integration/*.tgz
tests/integration/*-chart-*.tgz
tests/integration/targets/*/*.tgz
# ansible-test generated file
tests/integration/inventory
tests/integration/*-*.yml
tests/integration/integration_config.yml
# IDE and editor settings
.vscode/
+1 -1
View File
@@ -1,6 +1,6 @@
repos:
- repo: https://github.com/ansible/cloud-content-ci-automation
rev: 77f45b0357b6b3c27b04e934f0f51c9b50b7aa25
rev: precommit_hook
hooks:
- id: block-ide-ai-files
always_run: true
+3 -145
View File
@@ -4,48 +4,6 @@ Kubernetes Collection Release Notes
.. contents:: Topics
v6.6.0
======
Minor Changes
-------------
- Remove the remaining ``ansible.module_utils.six`` import to avoid deprecation warnings, replacing it with the Python standard library equivalent (https://github.com/ansible-collections/kubernetes.core/pull/1197).
- helm - Add ``wait_for_jobs`` option to wait for all Jobs to complete before marking a Helm release as successful. Requires Helm >= 3.5.0 (https://github.com/ansible-collections/kubernetes.core/pull/1140).
- helm - add the ``cleanup_on_fail`` option, mapping to the ``--cleanup-on-fail`` flag, to allow deletion of new resources created during a failed upgrade. It complements ``atomic`` and can be combined with it, but cannot be used with ``replace``, since that deploys through ``helm install`` which does not accept the flag (https://github.com/ansible-collections/kubernetes.core/pull/1206).
- helm - warn when ``reuse_values`` or ``reset_then_reuse_values`` is requested in a combination helm ignores, which happens by default because ``reset_values`` defaults to ``true``, and whenever either is combined with ``replace``. The option descriptions and the examples now state that ``reset_values`` has to be set to ``false`` for either option to take effect (https://github.com/ansible-collections/kubernetes.core/pull/1230).
- k8s lookup - warn when ``ENABLE_TURBO_MODE`` is set but the ``cloud.common`` collection is not installed, instead of silently falling back to the standard lookup base (https://github.com/ansible-collections/kubernetes.core/pull/1242).
- k8s_cp - Add the ``copy_timeout`` option (default 300 seconds) bounding how long the module will spend streaming an archive to a pod and waiting for the remote ``tar`` to finish, so that a stalled copy fails instead of hanging indefinitely (https://github.com/ansible-collections/kubernetes.core/pull/1217).
- k8s_cp - Stream the tar archive to the pod chunk by chunk instead of building the whole archive in memory first, which cuts peak memory use when copying large files (https://github.com/ansible-collections/kubernetes.core/pull/1217).
- k8s_cp - When copying to a pod, the module now also uses ``/bin/sh`` and ``head`` in the container, when present, to confirm the copy completed. Containers without them keep the previous behaviour and get a warning that completion could not be verified (https://github.com/ansible-collections/kubernetes.core/pull/1217).
- k8s_info - Support for metadata-only fetches in k8s_info module (https://github.com/ansible-collections/kubernetes.core/pull/1030)
- meta - Add ``helm_plugin`` and ``helm_plugin_info`` to the ``helm`` action group, and ``k8s_taint`` to the ``k8s`` action group, so that ``module_defaults`` set on those groups applies to them (https://github.com/ansible-collections/kubernetes.core/pull/1216).
- use `collections.abc` instead of deprecated `ansible.module_utils.common._collections_compat` (https://github.com/ansible-collections/kubernetes.core/pull/1057).
- waiter - Add ``job_complete`` predicate to support waiting for Job resources to reach ``Complete`` or ``Failed`` condition (https://github.com/ansible-collections/kubernetes.core/issues/1201).
Deprecated Features
-------------------
- Ansible Turbo mode (``ENABLE_TURBO_MODE``) has been deprecated and will be removed in release 8.0.0, as it depends on the ``cloud.common`` collection, which is being retired (https://github.com/ansible-collections/kubernetes.core/pull/1242).
- helm - the ``status.values`` return value has been deprecated and will be removed in version 8.0.0. Use ``status.release_values`` instead (https://github.com/ansible-collections/kubernetes.core/issues/1239).
- helm - the ``wait_timeout`` parameter has been deprecated and will be removed in version 7.0.0. Use ``timeout`` instead (https://github.com/ansible-collections/kubernetes.core/issues/1239).
- helm_info - the ``status.values`` return value has been deprecated and will be removed in version 8.0.0. Use ``status.release_values`` instead (https://github.com/ansible-collections/kubernetes.core/issues/1239).
- k8s_exec - the ``return_code`` return value has been deprecated and will be removed in version 7.0.0. Use ``rc`` instead (https://github.com/ansible-collections/kubernetes.core/issues/1239).
- k8s_service - the ``merge_type=json`` option has been deprecated and will be removed in version 7.0.0. Use ``kubernetes.core.k8s_json_patch`` module instead (https://github.com/ansible-collections/kubernetes.core/issues/1239).
Bugfixes
--------
- Ansible Turbo mode - ignore ``ENABLE_TURBO_MODE`` on ansible-core 2.19.0 and later, where the ``cloud.common`` collection is not supported, and fall back to the standard ``AnsibleModule`` instead of failing with ``byte indices must be integers or slices, not str`` (https://github.com/ansible-collections/kubernetes.core/pull/1242).
- helm - do not pass the upgrade-only ``--reuse-values`` and ``--reset-then-reuse-values`` flags to ``helm install``, which rejected them with ``unknown flag`` whenever ``reuse_values`` or ``reset_then_reuse_values`` was combined with ``replace`` (https://github.com/ansible-collections/kubernetes.core/pull/1230).
- helm - fix the ``reuse_values`` example, which set only ``reuse_values=true``. ``reset_values`` defaults to ``true`` and helm ignores ``--reuse-values`` whenever ``--reset-values`` is passed, so following the example reset the release values instead of reusing them (https://github.com/ansible-collections/kubernetes.core/pull/1230).
- helm - skip Helm's OCI registry progress messages when parsing the output of ``helm show chart``. As of Helm 4.2.1 these are printed to stdout instead of stderr (https://github.com/helm/helm/pull/32056), which made installing a chart from an OCI registry fail with a YAML scanner error when the chart version contained a ``+`` (https://github.com/ansible-collections/kubernetes.core/pull/1223).
- helm_repository - normalize both sides of the repository URL comparison, so that a repository already registered with a trailing slash is recognized as matching instead of failing with ``Repository already have a repository named <name>`` (https://github.com/ansible-collections/kubernetes.core/pull/1236).
- helm_template - strip Helm's OCI registry progress messages from the returned ``stdout``, which is documented to contain only the rendered templates (https://github.com/ansible-collections/kubernetes.core/pull/1223).
- k8s lookup - ignore ``ENABLE_TURBO_MODE`` on ansible-core 2.19.0 and later, where the ``cloud.common`` collection is not supported. Fall back to the standard ``LookupBase`` instead of failing with a traceback (https://github.com/ansible-collections/kubernetes.core/pull/1253).
- k8s_cp - Fix silent truncation when copying to a pod. The module closed the exec connection immediately after writing the last chunk of the tar archive, which killed the remote ``tar`` before it had finished extracting, and never checked the process exit status, so a partial copy was reported as a success. The archive is now bounded with ``head -c`` so ``tar`` gets a clean EOF and exits on its own, and the module waits for that exit and fails on a non-zero status (https://github.com/ansible-collections/kubernetes.core/pull/1217).
- k8s_info - Handle empty template output gracefully by returning ``changed=false`` instead of failing when Jinja2 template renders to an empty string (https://github.com/ansible-collections/kubernetes.core/issues/1042).
v6.5.0
======
@@ -184,112 +142,12 @@ Bugfixes
v6.0.0
======
Release Summary
---------------
This major release removes the deprecated ``k8s`` inventory plugin and also removes ``ansible-core<2.16`` support.
Breaking Changes / Porting Guide
--------------------------------
- Remove deprecated ``k8s`` invetory plugin (https://github.com/ansible-collections/kubernetes.core/pull/867).
- Remove support for ``ansible-core<2.16`` (https://github.com/ansible-collections/kubernetes.core/pull/867).
v5.5.0
======
Release Summary
---------------
This minor release deprecates Ansible Turbo mode (``ENABLE_TURBO_MODE``), the ``status.values`` return value of the ``helm`` and ``helm_info`` modules, the ``wait_timeout`` parameter of the ``helm`` module, the ``return_code`` return value of the ``k8s_exec`` module, and the ``merge_type=json`` option of the ``k8s_service`` module. It also includes bugfixes for ``helm_repository`` URL comparison and for empty template output handling in ``k8s_info``.
Minor Changes
-------------
- Remove the remaining ``ansible.module_utils.six`` import to avoid deprecation warnings, replacing it with the Python standard library equivalent (https://github.com/ansible-collections/kubernetes.core/pull/1197).
- k8s lookup - warn when ``ENABLE_TURBO_MODE`` is set but the ``cloud.common`` collection is not installed, instead of silently falling back to the standard lookup base (https://github.com/ansible-collections/kubernetes.core/pull/1242).
Deprecated Features
-------------------
- Ansible Turbo mode (``ENABLE_TURBO_MODE``) has been deprecated and will be removed in release 8.0.0, as it depends on the ``cloud.common`` collection, which is being retired (https://github.com/ansible-collections/kubernetes.core/pull/1242).
- helm - the ``status.values`` return value has been deprecated and will be removed in version 8.0.0. Use ``status.release_values`` instead (https://github.com/ansible-collections/kubernetes.core/issues/1239).
- helm - the ``wait_timeout`` parameter has been deprecated and will be removed in version 7.0.0. Use ``timeout`` instead (https://github.com/ansible-collections/kubernetes.core/issues/1239).
- helm_info - the ``status.values`` return value has been deprecated and will be removed in version 8.0.0. Use ``status.release_values`` instead (https://github.com/ansible-collections/kubernetes.core/issues/1239).
- k8s_exec - the ``return_code`` return value has been deprecated and will be removed in version 7.0.0. Use ``rc`` instead (https://github.com/ansible-collections/kubernetes.core/issues/1239).
- k8s_service - the ``merge_type=json`` option has been deprecated and will be removed in version 7.0.0. Use ``kubernetes.core.k8s_json_patch`` module instead (https://github.com/ansible-collections/kubernetes.core/issues/1239).
Bugfixes
--------
- Ansible Turbo mode - ignore ``ENABLE_TURBO_MODE`` on ansible-core 2.19.0 and later, where the ``cloud.common`` collection is not supported, and fall back to the standard ``AnsibleModule`` instead of failing with ``byte indices must be integers or slices, not str`` (https://github.com/ansible-collections/kubernetes.core/pull/1242).
- helm_repository - normalize both sides of the repository URL comparison, so that a repository already registered with a trailing slash is recognized as matching instead of failing with ``Repository already have a repository named <name>`` (https://github.com/ansible-collections/kubernetes.core/pull/1236).
- k8s lookup - ignore ``ENABLE_TURBO_MODE`` on ansible-core 2.19.0 and later, where the ``cloud.common`` collection is not supported. Fall back to the standard ``LookupBase`` instead of failing with a traceback (https://github.com/ansible-collections/kubernetes.core/pull/1253).
- k8s_info - Handle empty template output gracefully by returning ``changed=false`` instead of failing when Jinja2 template renders to an empty string (https://github.com/ansible-collections/kubernetes.core/issues/1042).
v5.4.4
======
Release Summary
---------------
This release corrects the documented and enforced minimum ``ansible-core`` version to ``>=2.16.0``.
Bugfixes
--------
- meta - Update ``requires_ansible`` in ``runtime.yml`` and README to ``>=2.16.0`` to match the actual minimum supported ``ansible-core`` version (https://github.com/ansible-collections/kubernetes.core/pull/1193).
v5.4.3
======
Release Summary
---------------
This release contains bugfixes such as improved idempotency for helm repository URLs with trailing slashes.
Bugfixes
--------
- ee - Add ``meta/execution-environment.yml`` to decouple ansible-builder EE builds from the ``openshift-clients`` system dependency declared in ``bindep.txt``, which is not available in standard UBI repositories and caused builds to fail with ``No package matches 'openshift-clients'`` (https://github.com/ansible-collections/kubernetes.core/issues/1141).
- helm_repository - Correct handling of repository URLs with trailing slashes (https://github.com/ansible-collections/kubernetes.core/pull/1121).
- k8s_drain - Fix logic for handling pods with local storage to correctly check for empty_dir volumes in replicated pods and pods managed by DaemonSets (https://github.com/ansible-collections/kubernetes.core/pull/1095).
v5.4.2
======
Release Summary
---------------
This release includes bugfixes such as replacing the passing of ``warnings`` to ``exit_json`` with ``AnsibleModule.warn`` as well as a security update for selectively redacting sensitive information from kubeconfig, and adds a new ``release_values`` key to the ``status`` return value.
Minor Changes
-------------
- helm - Add ``release_values`` key to ``status`` return value that can be accessed using Jinja2 dot notation (https://github.com/ansible-collections/kubernetes.core/pull/1056).
- helm_info - Add ``release_values`` key to ``status`` return value that can be accessed using Jinja2 dot notation (https://github.com/ansible-collections/kubernetes.core/pull/1056).
Deprecated Features
-------------------
- helm - the ``status.values`` return value has been deprecated and will be removed in a release after 2027-01-08. Use ``status.release_values`` instead (https://github.com/ansible-collections/kubernetes.core/pull/1056).
- helm_info - the ``status.values`` return value has been deprecated and will be removed in a release after 2027-01-08. Use ``status.release_values`` instead (https://github.com/ansible-collections/kubernetes.core/pull/1056).
Security Fixes
--------------
- Selectively redact sensitive info from kubeconfig instead of applying blanket ``no_log=True`` (https://github.com/ansible-collections/kubernetes.core/pull/1014).
Bugfixes
--------
- Add idempotency for ``helm_pull`` module (https://github.com/ansible-collections/kubernetes.core/pull/1055).
- Fixed a bug where setting ``K8S_AUTH_VERIFY_SSL=true`` (or any string value) caused the value to be treated as a separate ``kubectl`` command argument (https://github.com/ansible-collections/kubernetes.core/pull/1049).
- Limit supported versions of Helm to <4.0.0 (https://github.com/ansible-collections/kubernetes.core/pull/1039).
- Replace passing ``warnings`` to ``exit_json`` with ``AnsibleModule.warn`` in the ``k8s_drain``, ``k8s_rollback.py`` and ``k8s_scale.py`` modules as it deprecated in ``ansible-core>=2.19.0`` and will be removed in ``ansible-core>=2.23.0`` (https://github.com/ansible-collections/kubernetes.core/pull/1033).
- k8s - Fix return block from the module documentation (https://github.com/ansible-collections/kubernetes.core/pull/1056).
- meta - Add ``k8s_cluster_info``, ``k8s_json_patch`` and ``k8s_rollback`` to k8s action group (https://github.com/ansible-collections/kubernetes.core/pull/992).
v5.4.1
======
@@ -329,15 +187,15 @@ This release includes minor changes, bug fixes and also bumps ``ansible-lint`` v
Minor Changes
-------------
- Bump version of ``ansible-lint`` to 25.1.2 (https://github.com/ansible-collections/kubernetes.core/pull/919).
- action/k8s_info - update templating mechanism with changes from ``ansible-core 2.19`` (https://github.com/ansible-collections/kubernetes.core/pull/888).
- helm - add ``reset_then_reuse_values`` support to helm module (https://github.com/ansible-collections/kubernetes.core/issues/803).
- helm - add support for ``insecure_skip_tls_verify`` option to helm and ``helm_repository`` (https://github.com/ansible-collections/kubernetes.core/issues/694).
- kubernetes.core - Bump version of ``ansible-lint`` to ``25.1.2`` (https://github.com/ansible-collections/kubernetes.core/pull/919).
- helm - add support for ``insecure_skip_tls_verify`` option to helm and helm_repository(https://github.com/ansible-collections/kubernetes.core/issues/694).
Bugfixes
--------
- module_utils/k8s/service - fix issue when trying to delete resource using `delete_options` and `check_mode=true` (https://github.com/ansible-collections/kubernetes.core/issues/892).
- module_utils/k8s/service - fix issue when trying to delete resource using ``delete_options`` and ``check_mode=true`` (https://github.com/ansible-collections/kubernetes.core/issues/892).
v5.2.0
======
+1 -1
View File
@@ -1,5 +1,5 @@
# Also needs to be updated in galaxy.yml
VERSION = 7.0.0-dev0
VERSION = 6.5.0
TEST_ARGS ?= ""
PYTHON_VERSION ?= `python -c 'import platform; print(".".join(platform.python_version_tuple()[0:2]))'`
+11 -21
View File
@@ -94,27 +94,23 @@ Before using the Kubernetes collection, you need to install it with the Ansible
ansible-galaxy collection install kubernetes.core
Red Hat customers can install certified content from [Ansible Automation Hub](https://console.redhat.com/ansible/automation-hub). Configure Automation Hub as the primary content source for the Ansible Galaxy CLI by following the [Red Hat configuration guide](https://docs.redhat.com/en/documentation/red_hat_ansible_automation_platform/2.4/html/getting_started_with_automation_hub/configure-hub-primary), then install the collection with `ansible-galaxy collection install kubernetes.core`.
You can also include it in a `requirements.yml` file and install it via `ansible-galaxy collection install -r requirements.yml`, using the format:
```yaml
---
collections:
- name: kubernetes.core
version: 6.6.0
version: 6.5.0
```
### Installing the Kubernetes Python Library
Content in this collection requires the [Kubernetes Python client](https://pypi.org/project/kubernetes/) to interact with Kubernetes' APIs. For installs outside an execution environment, install it with:
Content in this collection requires the [Kubernetes Python client](https://pypi.org/project/kubernetes/) to interact with Kubernetes' APIs. You can install it with:
```bash
pip3 install kubernetes
```
Execution environments install this dependency when they are built with `ansible-builder`; you do not need to install it separately with `pip3` in that case.
## Use Cases
It's preferable to use content in this collection using their Fully Qualified Collection Namespace (FQCN), for example `kubernetes.core.k8s_info`:
@@ -185,9 +181,7 @@ For documentation on how to use individual modules and other content included in
## Ansible Turbo Mode Tech Preview
> **Deprecated:** Ansible Turbo mode (`ENABLE_TURBO_MODE`) is deprecated and will be removed in a future major release (planned for 8.0.0), since it depends on the `cloud.common` collection, which is being retired. Setting `ENABLE_TURBO_MODE` will keep emitting a deprecation warning until support is removed, at which point the variable will have no effect.
> **Note:** Ansible Turbo mode is supported only with ``ansible-core`` versions **lower than 2.19**. Starting from ``ansible-core`` 2.19, the ``cloud.common`` collection is no longer supported, and therefore Ansible Turbo mode is also not supported in ``kubernetes.core``. If ``ENABLE_TURBO_MODE`` is set to ``1`` (or any truthy value) with ``ansible-core >= 2.19.0``, Turbo mode is ignored and a warning is emitted; modules run without it.
> **Note:** Ansible Turbo mode is supported only with ``ansible-core`` versions **lower than 2.19**. Starting from ``ansible-core`` 2.19, the ``cloud.common`` collection is no longer supported, and therefore Ansible Turbo mode is also not supported in ``kubernetes.core``. If ``ENABLE_TURBO_MODE`` is set to ``1`` (or any truthy value) with ``ansible-core >= 2.19.0``, it may lead to fails.
The ``kubernetes.core`` collection supports Ansible Turbo mode as a tech preview via the ``cloud.common`` collection (requires `ansible-core < 2.19`). By default, this feature is disabled. To enable Turbo mode for modules, set the environment variable `ENABLE_TURBO_MODE=1` on the managed node. For example:
@@ -203,7 +197,7 @@ The ``kubernetes.core`` collection supports Ansible Turbo mode as a tech preview
To enable Turbo mode for k8s lookup plugin, set the environment variable `ENABLE_TURBO_MODE=1` on the managed node. This is not working when
defined in the playbook using `environment` keyword as above, you must set it using `export ENABLE_TURBO_MODE=1`.
Please read more about Ansible Turbo mode - [here](https://github.com/ansible-collections/kubernetes.core/blob/main/docs/ansible_turbo_mode.rst).
Please read more about Ansible Turbo mode - [here](https://github.com/ansible-collections/kubernetes.core/blob/stable-6/docs/ansible_turbo_mode.rst).
## Testing
@@ -219,8 +213,6 @@ You can run the collection's test suites with the commands:
make test-integration
make test-unit
For instructions on running Helm integration tests locally, see the [integration tests README](https://github.com/ansible-collections/kubernetes.core/blob/main/tests/integration/README.md).
### Testing with `molecule`
There are also integration tests in the `molecule` directory which are meant to be run against a local Kubernetes cluster, e.g. using [KinD](https://kind.sigs.k8s.io) or [Minikube](https://minikube.sigs.k8s.io). To set up a local cluster using KinD and run Molecule:
@@ -232,7 +224,7 @@ There are also integration tests in the `molecule` directory which are meant to
If you want to develop new content for this collection or improve what is already here, clone the Git repository into one of the configured [`COLLECTIONS_PATHS`](https://docs.ansible.com/ansible/latest/reference_appendices/config.html#collections-paths) and work on it there.
See [Contributing to kubernetes.core](https://github.com/ansible-collections/kubernetes.core/blob/main/CONTRIBUTING.md).
See [Contributing to kubernetes.core](https://github.com/ansible-collections/kubernetes.core/blob/stable-6/CONTRIBUTING.md).
Join the Ansible community:
@@ -249,8 +241,6 @@ This project follows the [Ansible Code of Conduct](https://docs.ansible.com/ansi
## Support
This collection is maintained by Red Hat Ansible Cloud Content.
As Red Hat Ansible Certified Content, this collection is entitled to support through the Ansible Automation Platform (AAP) using the **Create issue** button on the top right corner. If a support case cannot be opened with Red Hat and the collection has been obtained either from Galaxy or GitHub, there may be community help available on the [Ansible Forum](https://forum.ansible.com/).
> **Note:** The `stable-4` branch (all `4.x.y` releases) is no longer supported. No backports or releases are performed on `stable-4`.
@@ -259,7 +249,7 @@ We announce releases and important changes through Ansible's [The Bullhorn newsl
We take part in the global quarterly [Ansible Contributor Summit](https://github.com/ansible/community/wiki/Contributor-Summit). Track The Bullhorn and join when announced.
For the latest supported versions, see [Release Notes and Roadmap](https://github.com/ansible-collections/kubernetes.core/blob/main/README.md#release-notes-and-roadmap).
For the latest supported versions, see [Release Notes and Roadmap](https://github.com/ansible-collections/kubernetes.core/blob/stable-6/README.md#release-notes-and-roadmap).
Report bugs, request features, or ask questions by opening an issue in the [GitHub repository](https://github.com/ansible-collections/kubernetes.core/).
@@ -271,7 +261,7 @@ Releases are automatically built and pushed to Ansible Galaxy for any new tag. B
1. The `version` in `galaxy.yml`
2. This README's `requirements.yml` example
3. The `VERSION` in `Makefile`
2. Update the [CHANGELOG](CHANGELOG.rst):
2. Update the CHANGELOG:
1. Make sure you have [`antsibull-changelog`](https://pypi.org/project/antsibull-changelog/) installed.
2. Make sure there are fragments for all known changes in `changelogs/fragments`.
3. Run `antsibull-changelog release`.
@@ -286,9 +276,9 @@ The process for [uploading a supported release to Automation Hub](https://docs.r
* [Using Ansible collections](https://docs.ansible.com/ansible/devel/user_guide/collections_using.html)
* [Ansible communication guide](https://docs.ansible.com/ansible/devel/community/communication.html)
* [Continuous integration (CI) overview](https://github.com/ansible-collections/kubernetes.core/blob/main/CI.md)
* [SonarCloud integration](https://github.com/ansible-collections/kubernetes.core/blob/main/SONARCLOUD.md)
* [Ansible Turbo mode (tech preview)](https://github.com/ansible-collections/kubernetes.core/blob/main/docs/ansible_turbo_mode.rst)
* [Continuous integration (CI) overview](https://github.com/ansible-collections/kubernetes.core/blob/stable-6/CI.md)
* [SonarCloud integration](https://github.com/ansible-collections/kubernetes.core/blob/stable-6/SONARCLOUD.md)
* [Ansible Turbo mode (tech preview)](https://github.com/ansible-collections/kubernetes.core/blob/stable-6/docs/ansible_turbo_mode.rst)
### Code of conduct
@@ -300,4 +290,4 @@ If you encounter abusive behavior, please refer to the [policy violations](https
GNU General Public License v3.0 or later
See [LICENSE](https://github.com/ansible-collections/kubernetes.core/blob/main/LICENSE) to see the full text.
See [LICENSE](https://github.com/ansible-collections/kubernetes.core/blob/stable-6/LICENSE) to see the full text.
+1 -1
View File
@@ -21,7 +21,7 @@ Workflow files:
Scanner configuration lives in [sonar-project.properties](sonar-project.properties).
The **coverage** job (in **`all_green`**) uses **`ansible-test`** (`units --coverage`, then **`coverage combine`** / **`coverage xml`**), then writes **`coverage.xml`** with workspace paths normalized for Sonar. **`pytest-cov`** is listed in **`tests/unit/requirements.txt`** for parity and any direct pytest runs; **`ansible-test`** still owns the coverage data used in CI.
The **coverage** job (in **`all_green`**) uses **`ansible-test`** (`units --coverage`, then **`coverage combine`** / **`coverage xml`**) with **ansible-core `stable-2.18`** on **`stable-6`**, then writes **`coverage.xml`** with workspace paths normalized for Sonar. **`pytest-cov`** is listed in **`tests/unit/requirements.txt`** for parity and any direct pytest runs; **`ansible-test`** still owns the coverage data used in CI.
**`sonarcloud.yml`** declares a required secret **`ANSIBLE_COLLECTIONS_ORG_SONAR_TOKEN_CICD_BOT`** and **`permissions: contents: read`**, **`pull-requests: read`**.
-235
View File
@@ -1073,132 +1073,6 @@ releases:
- 20250922-remove-ansible-six-imports.yaml
- 5.4.1.yml
release_date: '2025-10-07'
5.4.2:
changes:
bugfixes:
- Add idempotency for ``helm_pull`` module (https://github.com/ansible-collections/kubernetes.core/pull/1055).
- Fixed a bug where setting ``K8S_AUTH_VERIFY_SSL=true`` (or any string value)
caused the value to be treated as a separate ``kubectl`` command argument
(https://github.com/ansible-collections/kubernetes.core/pull/1049).
- Limit supported versions of Helm to <4.0.0 (https://github.com/ansible-collections/kubernetes.core/pull/1039).
- Replace passing ``warnings`` to ``exit_json`` with ``AnsibleModule.warn``
in the ``k8s_drain``, ``k8s_rollback.py`` and ``k8s_scale.py`` modules as
it deprecated in ``ansible-core>=2.19.0`` and will be removed in ``ansible-core>=2.23.0``
(https://github.com/ansible-collections/kubernetes.core/pull/1033).
- k8s - Fix return block from the module documentation (https://github.com/ansible-collections/kubernetes.core/pull/1056).
- meta - Add ``k8s_cluster_info``, ``k8s_json_patch`` and ``k8s_rollback`` to
k8s action group (https://github.com/ansible-collections/kubernetes.core/pull/992).
deprecated_features:
- helm - the ``status.values`` return value has been deprecated and will be
removed in a release after 2027-01-08. Use ``status.release_values`` instead
(https://github.com/ansible-collections/kubernetes.core/pull/1056).
- helm_info - the ``status.values`` return value has been deprecated and will
be removed in a release after 2027-01-08. Use ``status.release_values`` instead
(https://github.com/ansible-collections/kubernetes.core/pull/1056).
minor_changes:
- helm - Add ``release_values`` key to ``status`` return value that can be accessed
using Jinja2 dot notation (https://github.com/ansible-collections/kubernetes.core/pull/1056).
- helm_info - Add ``release_values`` key to ``status`` return value that can
be accessed using Jinja2 dot notation (https://github.com/ansible-collections/kubernetes.core/pull/1056).
release_summary: This release includes bugfixes such as replacing the passing
of ``warnings`` to ``exit_json`` with ``AnsibleModule.warn`` as well as a
security update for selectively redacting sensitive information from kubeconfig,
and adds a new ``release_values`` key to the ``status`` return value.
security_fixes:
- Selectively redact sensitive info from kubeconfig instead of applying blanket
``no_log=True`` (https://github.com/ansible-collections/kubernetes.core/pull/1014).
fragments:
- 1033-warnings-deprecations.yaml
- 20251002-fix-k8s-actiongroup.yaml
- 20251007-selective-kubeconfig-redaction.yaml
- 20251115-limit-versions-of-helm.yaml
- 20251220-fix-K8S_AUTH_VERIFY_SSL-in-kubectl-connecton-plugion.yaml
- 20260107-add-idempodency-for-helm-pull.yaml
- 20260108-fix-sanity-failures.yml
- 5-4-2.yaml
release_date: '2026-02-03'
5.4.3:
changes:
bugfixes:
- ee - Add ``meta/execution-environment.yml`` to decouple ansible-builder EE
builds from the ``openshift-clients`` system dependency declared in ``bindep.txt``,
which is not available in standard UBI repositories and caused builds to fail
with ``No package matches 'openshift-clients'`` (https://github.com/ansible-collections/kubernetes.core/issues/1141).
- helm_repository - Correct handling of repository URLs with trailing slashes
(https://github.com/ansible-collections/kubernetes.core/pull/1121).
- k8s_drain - Fix logic for handling pods with local storage to correctly check
for empty_dir volumes in replicated pods and pods managed by DaemonSets (https://github.com/ansible-collections/kubernetes.core/pull/1095).
release_summary: This release contains bugfixes such as improved idempotency
for helm repository URLs with trailing slashes.
fragments:
- 1173-security-check-workflow.yml
- 20260306-k8s_drain-delete-logic-fixes-for-daemonsets.yaml
- 20260506-improve_idempotency_for_helm_repository.yaml
- 5-4-3.yml
- fix-openshift-clients-ee-dependency.yaml
release_date: '2026-07-08'
5.4.4:
changes:
bugfixes:
- meta - Update ``requires_ansible`` in ``runtime.yml`` and README to ``>=2.16.0``
to match the actual minimum supported ``ansible-core`` version (https://github.com/ansible-collections/kubernetes.core/pull/1193).
release_summary: This release corrects the documented and enforced minimum ``ansible-core``
version to ``>=2.16.0``.
release_date: '2026-07-09'
5.5.0:
changes:
bugfixes:
- Ansible Turbo mode - ignore ``ENABLE_TURBO_MODE`` on ansible-core 2.19.0 and
later, where the ``cloud.common`` collection is not supported, and fall back
to the standard ``AnsibleModule`` instead of failing with ``byte indices must
be integers or slices, not str`` (https://github.com/ansible-collections/kubernetes.core/pull/1242).
- helm_repository - normalize both sides of the repository URL comparison, so
that a repository already registered with a trailing slash is recognized as
matching instead of failing with ``Repository already have a repository named
<name>`` (https://github.com/ansible-collections/kubernetes.core/pull/1236).
- k8s lookup - ignore ``ENABLE_TURBO_MODE`` on ansible-core 2.19.0 and later,
where the ``cloud.common`` collection is not supported. Fall back to the standard
``LookupBase`` instead of failing with a traceback (https://github.com/ansible-collections/kubernetes.core/pull/1253).
- k8s_info - Handle empty template output gracefully by returning ``changed=false``
instead of failing when Jinja2 template renders to an empty string (https://github.com/ansible-collections/kubernetes.core/issues/1042).
deprecated_features:
- Ansible Turbo mode (``ENABLE_TURBO_MODE``) has been deprecated and will be
removed in release 8.0.0, as it depends on the ``cloud.common`` collection,
which is being retired (https://github.com/ansible-collections/kubernetes.core/pull/1242).
- helm - the ``status.values`` return value has been deprecated and will be
removed in version 8.0.0. Use ``status.release_values`` instead (https://github.com/ansible-collections/kubernetes.core/issues/1239).
- helm - the ``wait_timeout`` parameter has been deprecated and will be removed
in version 7.0.0. Use ``timeout`` instead (https://github.com/ansible-collections/kubernetes.core/issues/1239).
- helm_info - the ``status.values`` return value has been deprecated and will
be removed in version 8.0.0. Use ``status.release_values`` instead (https://github.com/ansible-collections/kubernetes.core/issues/1239).
- k8s_exec - the ``return_code`` return value has been deprecated and will be
removed in version 7.0.0. Use ``rc`` instead (https://github.com/ansible-collections/kubernetes.core/issues/1239).
- k8s_service - the ``merge_type=json`` option has been deprecated and will
be removed in version 7.0.0. Use ``kubernetes.core.k8s_json_patch`` module
instead (https://github.com/ansible-collections/kubernetes.core/issues/1239).
minor_changes:
- Remove the remaining ``ansible.module_utils.six`` import to avoid deprecation
warnings, replacing it with the Python standard library equivalent (https://github.com/ansible-collections/kubernetes.core/pull/1197).
- k8s lookup - warn when ``ENABLE_TURBO_MODE`` is set but the ``cloud.common``
collection is not installed, instead of silently falling back to the standard
lookup base (https://github.com/ansible-collections/kubernetes.core/pull/1242).
release_summary: This minor release deprecates Ansible Turbo mode (``ENABLE_TURBO_MODE``),
the ``status.values`` return value of the ``helm`` and ``helm_info`` modules,
the ``wait_timeout`` parameter of the ``helm`` module, the ``return_code``
return value of the ``k8s_exec`` module, and the ``merge_type=json`` option
of the ``k8s_service`` module. It also includes bugfixes for ``helm_repository``
URL comparison and for empty template output handling in ``k8s_info``.
fragments:
- 1253-k8s-lookup-turbo-version-check.yml
- 20250108-fix-empty-template-output.yaml
- 20260723-remove-module-utils-six.yaml
- 20260908-helm-repository-trailing-slash.yaml
- 20260911-deprecate-status-values.yaml
- 20260911-update-deprecation-notices.yaml
- 5.5.0.yml
- deprecate-enable-turbo-mode.yml
- fix-ansible-lint-warnings.yaml
release_date: '2026-09-15'
6.0.0:
changes:
breaking_changes:
@@ -1377,112 +1251,3 @@ releases:
name: kubeconfig
namespace: ''
release_date: '2026-07-08'
6.6.0:
changes:
bugfixes:
- Ansible Turbo mode - ignore ``ENABLE_TURBO_MODE`` on ansible-core 2.19.0 and
later, where the ``cloud.common`` collection is not supported, and fall back
to the standard ``AnsibleModule`` instead of failing with ``byte indices must
be integers or slices, not str`` (https://github.com/ansible-collections/kubernetes.core/pull/1242).
- helm - do not pass the upgrade-only ``--reuse-values`` and ``--reset-then-reuse-values``
flags to ``helm install``, which rejected them with ``unknown flag`` whenever
``reuse_values`` or ``reset_then_reuse_values`` was combined with ``replace``
(https://github.com/ansible-collections/kubernetes.core/pull/1230).
- helm - fix the ``reuse_values`` example, which set only ``reuse_values=true``.
``reset_values`` defaults to ``true`` and helm ignores ``--reuse-values``
whenever ``--reset-values`` is passed, so following the example reset the
release values instead of reusing them (https://github.com/ansible-collections/kubernetes.core/pull/1230).
- helm - skip Helm's OCI registry progress messages when parsing the output
of ``helm show chart``. As of Helm 4.2.1 these are printed to stdout instead
of stderr (https://github.com/helm/helm/pull/32056), which made installing
a chart from an OCI registry fail with a YAML scanner error when the chart
version contained a ``+`` (https://github.com/ansible-collections/kubernetes.core/pull/1223).
- helm_repository - normalize both sides of the repository URL comparison, so
that a repository already registered with a trailing slash is recognized as
matching instead of failing with ``Repository already have a repository named
<name>`` (https://github.com/ansible-collections/kubernetes.core/pull/1236).
- helm_template - strip Helm's OCI registry progress messages from the returned
``stdout``, which is documented to contain only the rendered templates (https://github.com/ansible-collections/kubernetes.core/pull/1223).
- k8s lookup - ignore ``ENABLE_TURBO_MODE`` on ansible-core 2.19.0 and later,
where the ``cloud.common`` collection is not supported. Fall back to the standard
``LookupBase`` instead of failing with a traceback (https://github.com/ansible-collections/kubernetes.core/pull/1253).
- k8s_cp - Fix silent truncation when copying to a pod. The module closed the
exec connection immediately after writing the last chunk of the tar archive,
which killed the remote ``tar`` before it had finished extracting, and never
checked the process exit status, so a partial copy was reported as a success.
The archive is now bounded with ``head -c`` so ``tar`` gets a clean EOF and
exits on its own, and the module waits for that exit and fails on a non-zero
status (https://github.com/ansible-collections/kubernetes.core/pull/1217).
- k8s_info - Handle empty template output gracefully by returning ``changed=false``
instead of failing when Jinja2 template renders to an empty string (https://github.com/ansible-collections/kubernetes.core/issues/1042).
deprecated_features:
- Ansible Turbo mode (``ENABLE_TURBO_MODE``) has been deprecated and will be
removed in release 8.0.0, as it depends on the ``cloud.common`` collection,
which is being retired (https://github.com/ansible-collections/kubernetes.core/pull/1242).
- helm - the ``status.values`` return value has been deprecated and will be
removed in version 8.0.0. Use ``status.release_values`` instead (https://github.com/ansible-collections/kubernetes.core/issues/1239).
- helm - the ``wait_timeout`` parameter has been deprecated and will be removed
in version 7.0.0. Use ``timeout`` instead (https://github.com/ansible-collections/kubernetes.core/issues/1239).
- helm_info - the ``status.values`` return value has been deprecated and will
be removed in version 8.0.0. Use ``status.release_values`` instead (https://github.com/ansible-collections/kubernetes.core/issues/1239).
- k8s_exec - the ``return_code`` return value has been deprecated and will be
removed in version 7.0.0. Use ``rc`` instead (https://github.com/ansible-collections/kubernetes.core/issues/1239).
- k8s_service - the ``merge_type=json`` option has been deprecated and will
be removed in version 7.0.0. Use ``kubernetes.core.k8s_json_patch`` module
instead (https://github.com/ansible-collections/kubernetes.core/issues/1239).
minor_changes:
- Remove the remaining ``ansible.module_utils.six`` import to avoid deprecation
warnings, replacing it with the Python standard library equivalent (https://github.com/ansible-collections/kubernetes.core/pull/1197).
- helm - Add ``wait_for_jobs`` option to wait for all Jobs to complete before
marking a Helm release as successful. Requires Helm >= 3.5.0 (https://github.com/ansible-collections/kubernetes.core/pull/1140).
- helm - add the ``cleanup_on_fail`` option, mapping to the ``--cleanup-on-fail``
flag, to allow deletion of new resources created during a failed upgrade.
It complements ``atomic`` and can be combined with it, but cannot be used
with ``replace``, since that deploys through ``helm install`` which does not
accept the flag (https://github.com/ansible-collections/kubernetes.core/pull/1206).
- helm - warn when ``reuse_values`` or ``reset_then_reuse_values`` is requested
in a combination helm ignores, which happens by default because ``reset_values``
defaults to ``true``, and whenever either is combined with ``replace``. The
option descriptions and the examples now state that ``reset_values`` has to
be set to ``false`` for either option to take effect (https://github.com/ansible-collections/kubernetes.core/pull/1230).
- k8s lookup - warn when ``ENABLE_TURBO_MODE`` is set but the ``cloud.common``
collection is not installed, instead of silently falling back to the standard
lookup base (https://github.com/ansible-collections/kubernetes.core/pull/1242).
- k8s_cp - Add the ``copy_timeout`` option (default 300 seconds) bounding how
long the module will spend streaming an archive to a pod and waiting for the
remote ``tar`` to finish, so that a stalled copy fails instead of hanging
indefinitely (https://github.com/ansible-collections/kubernetes.core/pull/1217).
- k8s_cp - Stream the tar archive to the pod chunk by chunk instead of building
the whole archive in memory first, which cuts peak memory use when copying
large files (https://github.com/ansible-collections/kubernetes.core/pull/1217).
- k8s_cp - When copying to a pod, the module now also uses ``/bin/sh`` and ``head``
in the container, when present, to confirm the copy completed. Containers
without them keep the previous behaviour and get a warning that completion
could not be verified (https://github.com/ansible-collections/kubernetes.core/pull/1217).
- k8s_info - Support for metadata-only fetches in k8s_info module (https://github.com/ansible-collections/kubernetes.core/pull/1030)
- meta - Add ``helm_plugin`` and ``helm_plugin_info`` to the ``helm`` action
group, and ``k8s_taint`` to the ``k8s`` action group, so that ``module_defaults``
set on those groups applies to them (https://github.com/ansible-collections/kubernetes.core/pull/1216).
- use `collections.abc` instead of deprecated `ansible.module_utils.common._collections_compat`
(https://github.com/ansible-collections/kubernetes.core/pull/1057).
- waiter - Add ``job_complete`` predicate to support waiting for Job resources
to reach ``Complete`` or ``Failed`` condition (https://github.com/ansible-collections/kubernetes.core/issues/1201).
fragments:
- 1253-k8s-lookup-turbo-version-check.yml
- 20250108-fix-empty-template-output.yaml
- 20251027-metadata-only-fetches.yaml
- 20260109-fix-deprecated-calls.yaml
- 20260723-remove-module-utils-six.yaml
- 20260805-add-job-wait-condition.yaml
- 20260807-helm-cleanup-on-fail.yaml
- 20260807-helm-wait-for-jobs.yaml
- 20260812-action-groups.yaml
- 20260813-k8s-cp-truncation.yaml
- 20260817-helm-oci-registry-progress-on-stdout.yml
- 20260826-helm-value-reuse-options.yaml
- 20260908-helm-repository-trailing-slash.yaml
- 20260911-deprecate-status-values.yaml
- 20260911-update-deprecation-notices.yaml
- deprecate-enable-turbo-mode.yml
- fix-ansible-lint-warnings.yaml
release_date: '2026-09-16'
@@ -1,3 +0,0 @@
---
bugfixes:
- helm - Remove `--plain-http` option from `helm diff upgrade`, as it is not supported by the helm-diff plugin (https://github.com/ansible-collections/kubernetes.core/pull/1232).
@@ -1,4 +0,0 @@
---
bugfixes:
- k8s, k8s_service - emit warnings through ``AnsibleModule.warn`` instead of putting them in the result dict that is unpacked into ``exit_json``/``fail_json``. Passing ``warnings`` that way is deprecated since ansible-core 2.19 and will be removed in 2.23, so every run that produced a warning (for example the "No meaningful diff was generated" hint, warnings returned by the Kubernetes API, or ``validate`` findings) also emitted a deprecation warning (https://github.com/ansible-collections/kubernetes.core/pull/1267).
- k8s - warnings raised while processing a multi-document manifest are now shown to the user. They were previously nested under ``result.results[*].warnings``, where ansible-core never picked them up, so they were silently dropped whenever more than one resource was processed (https://github.com/ansible-collections/kubernetes.core/pull/1267).
+1 -8
View File
@@ -12,19 +12,12 @@ Following document provides overview of Ansible Turbo mode in ``kubernetes.core`
:depth: 1
.. warning::
Ansible Turbo mode is **deprecated** and will be removed in a future major release
(planned for 8.0.0), as it depends on the ``cloud.common`` collection, which is being
retired. Setting ``ENABLE_TURBO_MODE`` now emits a deprecation warning; once support is
removed, the variable will have no effect. Start planning your migration away from
Turbo mode.
.. warning::
Ansible Turbo mode is supported only with ``ansible-core`` versions **lower than 2.19**.
Starting from ``ansible-core`` 2.19, the ``cloud.common`` collection is no longer supported,
and therefore Ansible Turbo mode is also not supported in ``kubernetes.core``.
If ``ENABLE_TURBO_MODE`` is set to ``1`` (or any truthy value) with ``ansible-core >= 2.19.0``,
Turbo mode is ignored and a warning is emitted; modules run without it.
it may lead to failures.
Synopsis
--------
@@ -42,92 +42,6 @@ Basic authentication is also supported using the ``username`` and ``password`` o
To disable SSL certificate verification, set ``verify_ssl`` to false.
Sharing options across tasks with action groups
===============================================
Repeating the same authentication options on every task gets verbose quickly. The collection
defines two `action groups <https://docs.ansible.com/ansible/latest/playbook_guide/playbooks_module_defaults.html#module-defaults-groups>`_
so you can set them once with ``module_defaults``:
``kubernetes.core.k8s``
Modules that talk to the Kubernetes API and accept the standard authentication options
(``kubeconfig``, ``context``, ``host``, ``api_key``, ``validate_certs``, and so on):
``k8s``, ``k8s_cluster_info``, ``k8s_cp``, ``k8s_drain``, ``k8s_exec``, ``k8s_info``,
``k8s_json_patch``, ``k8s_log``, ``k8s_rollback``, ``k8s_scale``, ``k8s_service``, and
``k8s_taint``.
``kubernetes.core.helm``
Modules that shell out to the ``helm`` binary and accept its shared authentication
options (``binary_path``, ``kubeconfig``, ``context``, ``host``, ``api_key``,
``ca_cert``, ``validate_certs``): ``helm``, ``helm_info``, ``helm_plugin``,
``helm_plugin_info``, and ``helm_repository``.
Prefix the group name with ``group/`` to use it:
.. code-block:: yaml
- hosts: localhost
module_defaults:
group/kubernetes.core.k8s:
kubeconfig: /path/to/kubeconfig
context: staging
group/kubernetes.core.helm:
binary_path: /path/to/helm
kubeconfig: /path/to/kubeconfig
context: staging
tasks:
- name: Create a namespace
kubernetes.core.k8s:
definition:
apiVersion: v1
kind: Namespace
metadata:
name: monitoring
- name: Read it back
kubernetes.core.k8s_info:
kind: Namespace
name: monitoring
- name: Add the prometheus chart repository
kubernetes.core.helm_repository:
name: prometheus-community
repo_url: https://prometheus-community.github.io/helm-charts
- name: Deploy the kube-prometheus-stack chart
kubernetes.core.helm:
name: kube-prometheus-stack
chart_ref: prometheus-community/kube-prometheus-stack
release_namespace: monitoring
- name: Collect the releases in that namespace
kubernetes.core.helm_info:
name: kube-prometheus-stack
release_namespace: monitoring
Every task picks up ``kubeconfig`` and ``context`` from its group without repeating them, the
``helm`` modules additionally pick up ``binary_path``, and an option set on an individual task
still wins over the group default.
.. note::
Always write the group name fully qualified as ``group/kubernetes.core.k8s``. A bare
``group/k8s`` refers to the legacy ``k8s`` group that ansible-core defined back when the
Kubernetes modules shipped in core itself. The two are not the same group, and the legacy
one does not cover the modules in this collection.
Some modules are deliberately **not** in these groups because they do not accept the shared
authentication options, and including them would make ``module_defaults`` fail for everyone
using the group:
- ``helm_pull`` and ``helm_template`` accept only ``binary_path``.
- ``helm_registry_auth`` accepts ``binary_path`` and its own ``host``, which is an OCI
registry URL rather than a Kubernetes API server.
- ``kubeconfig`` writes a kubeconfig file locally and takes no cluster connection options.
Pass options to those modules directly, or give them their own per-module ``module_defaults``
entry.
Reporting an issue
==================
+1 -18
View File
@@ -427,23 +427,6 @@ Common return values are documented `here <https://docs.ansible.com/projects/ans
<br/>
</td>
</tr>
<tr>
<td class="elbow-placeholder">&nbsp;</td>
<td colspan="1">
<div class="ansibleOptionAnchor" id="return-"></div>
<b>release_values</b>
<a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a>
<div style="font-size: small">
<span style="color: purple">dictionary</span>
</div>
<div style="font-style: italic; font-size: small; color: darkgreen">added in 6.3.0</div>
</td>
<td>always</td>
<td>
<div>Dict of Values used to deploy.</div>
<br/>
</td>
</tr>
<tr>
<td class="elbow-placeholder">&nbsp;</td>
<td colspan="1">
@@ -505,7 +488,7 @@ Common return values are documented `here <https://docs.ansible.com/projects/ans
<td>always</td>
<td>
<div>Dict of Values used to deploy</div>
<div>This return value has been deprecated and will be removed in version 8.0.0. Use RV(status.release_values) instead.</div>
<div>This return value has been deprecated and will be removed in a release after 2027-01-08. Use RV(status.release_values) instead.</div>
<br/>
</td>
</tr>
+5 -72
View File
@@ -157,29 +157,6 @@ Parameters
<div>Chart version to install. If this is not specified, the latest version is installed.</div>
</td>
</tr>
<tr>
<td colspan="2">
<div class="ansibleOptionAnchor" id="parameter-"></div>
<b>cleanup_on_fail</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">boolean</span>
</div>
<div style="font-style: italic; font-size: small; color: darkgreen">added in 6.6.0</div>
</td>
<td>
<ul style="margin: 0; padding: 0"><b>Choices:</b>
<li><div style="color: blue"><b>no</b>&nbsp;&larr;</div></li>
<li>yes</li>
</ul>
</td>
<td>
<div>Allow deletion of new resources created during a failed upgrade.</div>
<div>Maps to the <code>--cleanup-on-fail</code> flag, which is available since helm 3.0.0 and was not renamed in Helm v4.</div>
<div>Complements O(atomic) rather than replacing it, and the two can be combined so that a rollback also drops resources orphaned by the failed upgrade.</div>
<div>Helm only accepts this flag on <code>helm upgrade</code>, so it cannot be used together with O(replace), which deploys through <code>helm install</code>.</div>
</td>
</tr>
<tr>
<td colspan="2">
<div class="ansibleOptionAnchor" id="parameter-"></div>
@@ -545,9 +522,7 @@ Parameters
</td>
<td>
<div>When upgrading package, reset the values to the ones built into the chart, apply the last release&#x27;s values and merge in any overrides from parameters O(release_values), O(values_files) or O(set_values).</div>
<div>Helm ignores this when <code>--reset-values</code> or <code>--reuse-values</code> is passed. Since O(reset_values) defaults to V(true), it has to be set to V(false), and O(reuse_values) left unset or V(false), for this option to take any effect.</div>
<div><code>helm install</code> does not accept <code>--reset-then-reuse-values</code>, so this option is ignored when O(replace) is set.</div>
<div>The module warns whenever one of those combinations makes this option a no-op.</div>
<div>If O(reset_values) or O(reuse_values) is set to V(True), this is ignored.</div>
<div>This feature requires helm diff &gt;= 3.9.12.</div>
</td>
</tr>
@@ -569,7 +544,6 @@ Parameters
</td>
<td>
<div>When upgrading package, reset the values to the ones built into the chart.</div>
<div>Defaults to V(true), which makes helm ignore O(reuse_values) and O(reset_then_reuse_values). Set it to V(false) to use either of them.</div>
</td>
</tr>
<tr>
@@ -589,10 +563,8 @@ Parameters
</ul>
</td>
<td>
<div>When upgrading package, specifies whether to reuse the last release&#x27;s values and merge in any overrides from parameters O(release_values), O(values_files) or O(set_values).</div>
<div>Helm ignores this when <code>--reset-values</code> is passed. Since O(reset_values) defaults to V(true), it has to be set to V(false) for this option to take any effect.</div>
<div><code>helm install</code> does not accept <code>--reuse-values</code>, so this option is ignored when O(replace) is set.</div>
<div>The module warns whenever one of those combinations makes this option a no-op.</div>
<div>When upgrading package, specifies wether to reuse the last release&#x27;s values and merge in any overrides from parameters <em>release_values</em>, <em>values_files</em> or <em>set_values</em>.</div>
<div>If <em>reset_values</em> is set to <code>True</code>, this is ignored.</div>
</td>
</tr>
<tr>
@@ -839,28 +811,6 @@ Parameters
<div>When <em>release_state</em> is set to <code>absent</code>, will wait until all the resources are deleted before returning. It will wait for as long as <em>wait_timeout</em>. This feature requires helm&gt;=3.7.0. Added in version 2.3.0.</div>
</td>
</tr>
<tr>
<td colspan="2">
<div class="ansibleOptionAnchor" id="parameter-"></div>
<b>wait_for_jobs</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">boolean</span>
</div>
<div style="font-style: italic; font-size: small; color: darkgreen">added in 6.6.0</div>
</td>
<td>
<ul style="margin: 0; padding: 0"><b>Choices:</b>
<li><div style="color: blue"><b>no</b>&nbsp;&larr;</div></li>
<li>yes</li>
</ul>
</td>
<td>
<div>When <em>release_state</em> is set to <code>present</code>, and <em>wait</em> is set to <code>True</code>, wait until all jobs are in a completed state before marking the release as successful.</div>
<div>Ignored when used without O(wait).</div>
<div>Requires Helm &gt;= 3.5.0</div>
</td>
</tr>
<tr>
<td colspan="2">
<div class="ansibleOptionAnchor" id="parameter-"></div>
@@ -874,7 +824,7 @@ Parameters
</td>
<td>
<div>Timeout when wait option is enabled (helm2 is a number of seconds, helm3 is a duration).</div>
<div>The use of <em>wait_timeout</em> to wait for kubernetes commands to complete has been deprecated and will be removed in version 7.0.0. Use O(timeout) instead.</div>
<div>The use of <em>wait_timeout</em> to wait for kubernetes commands to complete has been deprecated and will be removed after 2022-12-01.</div>
</td>
</tr>
</table>
@@ -985,7 +935,6 @@ Examples
release_namespace: default
force: True
wait: True
wait_for_jobs: True
replace: True
update_repo_cache: True
disable_hook: True
@@ -1005,37 +954,21 @@ Examples
enabled: True
# Deploy latest version
# 'reset_values' defaults to true and helm ignores '--reuse-values' when it is set,
# so it has to be turned off explicitly.
- name: Deploy latest version of Grafana chart using reuse_values
kubernetes.core.helm:
name: test
chart_ref: stable/grafana
release_namespace: monitoring
reuse_values: true
reset_values: false
values:
replicas: 2
version: 3e8ec0b2dffa40fb97d5342e4af887de95faa8c61a62480dd7f8aa03dffcf533
# Same for 'reset_then_reuse_values', which helm ignores when either
# '--reset-values' or '--reuse-values' is set.
- name: Deploy latest version of Grafana chart using reset_then_reuse_values
kubernetes.core.helm:
name: test
chart_ref: stable/grafana
release_namespace: monitoring
reset_then_reuse_values: true
reset_values: false
values:
replicas: 2
Return Values
-------------
Common return values are documented `here <https://docs.ansible.com/projects/ansible/latest/reference_appendices/common_return_values.html#common-return-values>`_, the following are the fields unique to this module:
Common return values are documented `here <https://docs.ansible.com/projects/ansible/latest/reference_appendices/common_return_values.html#common-return-values>`_, the following are the fields unique to this module:
.. raw:: html
@@ -1219,7 +1152,7 @@ Common return values are documented `here <https://docs.ansible.com/projects/ans
<td>always</td>
<td>
<div>Dict of Values used to deploy.</div>
<div>This return value has been deprecated and will be removed in version 8.0.0. Use RV(status.release_values) instead.</div>
<div>This return value has been deprecated and will be removed in a release after 2027-01-08. Use RV(status.release_values) instead.</div>
<br/>
</td>
</tr>
-20
View File
@@ -152,25 +152,6 @@ Parameters
<div>The name of a context found in the config file. Can also be specified via K8S_AUTH_CONTEXT environment variable.</div>
</td>
</tr>
<tr>
<td colspan="2">
<div class="ansibleOptionAnchor" id="parameter-"></div>
<b>copy_timeout</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">integer</span>
</div>
<div style="font-style: italic; font-size: small; color: darkgreen">added in 6.6.0</div>
</td>
<td>
<b>Default:</b><br/><div style="color: blue">300</div>
</td>
<td>
<div>Maximum time in seconds to spend streaming the archive to the pod and waiting for the remote <code>tar</code> process to finish extracting it.</div>
<div>Raise this when copying large files over a slow connection.</div>
<div>This option is ignored when <em>state</em> is set to <code>from_pod</code>.</div>
</td>
</tr>
<tr>
<td colspan="2">
<div class="ansibleOptionAnchor" id="parameter-"></div>
@@ -531,7 +512,6 @@ Notes
.. note::
- the tar binary is required on the container when copying from local filesystem to pod.
- a POSIX shell at ``/bin/sh`` and ``head`` are also used, when present, to bound the archive sent to the container so that the module can confirm the copy finished. Without them the copy still runs but completion cannot be verified, and a warning is emitted.
- the (init) container has to be started before you copy files or directories to it.
- To avoid SSL certificate validation errors when ``validate_certs`` is *True*, the full certificate chain for the API server must be provided via ``ca_cert`` or in the kubeconfig file.
+1 -1
View File
@@ -535,7 +535,7 @@ Common return values are documented `here <https://docs.ansible.com/projects/ans
</td>
<td></td>
<td>
<div>The command status code. This attribute is deprecated and will be removed in version 7.0.0. Use RV(result.rc) instead.</div>
<div>The command status code. This attribute is deprecated and will be removed in a future release. Please use rc instead.</div>
<br/>
</td>
</tr>
-29
View File
@@ -280,29 +280,6 @@ Parameters
<div>List of label selectors to use to filter results</div>
</td>
</tr>
<tr>
<td colspan="2">
<div class="ansibleOptionAnchor" id="parameter-"></div>
<b>metadata_only</b>
<a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">boolean</span>
</div>
<div style="font-style: italic; font-size: small; color: darkgreen">added in 6.6.0</div>
</td>
<td>
<ul style="margin: 0; padding: 0"><b>Choices:</b>
<li><div style="color: blue"><b>no</b>&nbsp;&larr;</div></li>
<li>yes</li>
</ul>
</td>
<td>
<div>Request metadata only response from the Kubernetes API server.</div>
<div>This feature is useful for clients that only need to check for the existence of an object,</div>
<div>or that only need to read its metadata.</div>
<div>It can significantly reduce the size of the response from the API server.</div>
</td>
</tr>
<tr>
<td colspan="2">
<div class="ansibleOptionAnchor" id="parameter-"></div>
@@ -739,12 +716,6 @@ Examples
retries: 60
delay: 15
- name: Get a list of all pods metadata only
kubernetes.core.k8s_info:
kind: Pod
metadata_only: true
register: pod_metadata_list
Return Values
+1 -1
View File
@@ -813,7 +813,7 @@ Parameters
</ul>
</td>
<td>
<div>Determines if an object should be created, patched, or deleted. When set to <code>present</code>, an object will be created if it does not already exist, and an existing object will be patched if its attributes differ from those specified using <em>resource_definition</em> or <em>src</em>. If set to <code>absent</code>, an existing object will be deleted.</div>
<div>Determines if an object should be created, patched, or deleted. When set to <code>present</code>, an object will be created, if it does not already exist. If set to <code>absent</code>, an existing object will be deleted. If set to <code>present</code>, an existing object will be patched, if its attributes differ from those specified using <em>resource_definition</em> or <em>src</em>.</div>
<div><code>patched</code> state is an existing resource that has a given patch applied. If the resource doesn&#x27;t exist, silently skip it (do not raise an error).</div>
</td>
</tr>
+1 -2
View File
@@ -247,7 +247,6 @@ Parameters
<div>See <a href='https://kubernetes.io/docs/tasks/run-application/update-api-object-kubectl-patch/#use-a-json-merge-patch-to-update-a-deployment'>https://kubernetes.io/docs/tasks/run-application/update-api-object-kubectl-patch/#use-a-json-merge-patch-to-update-a-deployment</a></div>
<div>If more than one <code>merge_type</code> is given, the merge_types will be tried in order</div>
<div>This defaults to <code>[&#x27;strategic-merge&#x27;, &#x27;merge&#x27;]</code>, which is ideal for using the same parameters on resource kinds that combine Custom Resources and built-in resources.</div>
<div><em>merge_type=json</em> has been deprecated and will be removed in version 7.0.0. Use <span class='module'>kubernetes.core.k8s_json_patch</span> instead.</div>
</td>
</tr>
<tr>
@@ -509,7 +508,7 @@ Parameters
</ul>
</td>
<td>
<div>Determines if an object should be created, patched, or deleted. When set to <code>present</code>, an object will be created if it does not already exist, and an existing object will be patched if its attributes differ from those specified using <em>resource_definition</em> or <em>src</em>. If set to <code>absent</code>, an existing object will be deleted.</div>
<div>Determines if an object should be created, patched, or deleted. When set to <code>present</code>, an object will be created, if it does not already exist. If set to <code>absent</code>, an existing object will be deleted. If set to <code>present</code>, an existing object will be patched, if its attributes differ from those specified using <em>resource_definition</em> or <em>src</em>.</div>
</td>
</tr>
<tr>
@@ -383,7 +383,6 @@ Examples
# and requires python to be installed in the image
- name: Run a command in a pod
ansible.builtin.command: echo "Hello, World!"
changed_when: false
- name: Run a command in a pod using local kubectl with inventory variables
# Example inventory:
@@ -408,7 +407,6 @@ Examples
# and requires python to be installed in the image
- name: Run a command in a pod
ansible.builtin.command: echo "Hello, World!"
changed_when: false
- name: Run a command in a pod using dynamic inventory
hosts: localhost
@@ -442,7 +440,6 @@ Examples
# be aware that the command is executed as the user that started the container
# and requires python to be installed in the image
ansible.builtin.command: echo "Hello, World!"
changed_when: false
delegate_to: "{{ my_app_pod_name }}"
+1 -1
View File
@@ -25,7 +25,7 @@ tags:
- openshift
- okd
- cluster
version: 7.0.0-dev0
version: 6.5.0
build_ignore:
- .DS_Store
- "*.tar.gz"
-1
View File
@@ -1,5 +1,4 @@
---
version: 3
dependencies:
python: requirements.txt
system: meta/ee-bindep.txt
-8
View File
@@ -1,17 +1,10 @@
---
requires_ansible: '>=2.16.0'
# Only modules that accept the shared authentication options belong in these
# groups: HELM_AUTH_ARG_SPEC for helm, AUTH_ARG_SPEC for k8s. Adding a module
# that does not accept them makes module_defaults fail for every user of the
# group. This excludes helm_pull, helm_registry_auth, helm_template and
# kubeconfig, which only take a subset (or none) of those options.
action_groups:
helm:
- helm
- helm_info
- helm_plugin
- helm_plugin_info
- helm_repository
k8s:
- k8s
@@ -25,7 +18,6 @@ action_groups:
- k8s_rollback
- k8s_scale
- k8s_service
- k8s_taint
plugin_routing:
inventory:
+2 -11
View File
@@ -35,11 +35,7 @@ def _from_yaml_to_definition(buffer):
import yaml
except ImportError:
raise AnsibleError("Failed to import the required Python library (PyYAML).")
# Handle empty template output
if buffer is None:
return []
return [doc for doc in yaml.safe_load_all(buffer) if doc is not None]
return list(yaml.safe_load_all(buffer))
ENV_KUBECONFIG_PATH_SEPARATOR = ";" if platform.system() == "Windows" else ":"
@@ -384,15 +380,10 @@ class ActionModule(ActionBase):
template = self._task.args.get("template", None)
if template:
self.load_template(template, new_module_args, task_vars)
# If template rendered to empty definition, return early with no changes
if not new_module_args.get("definition"):
result["changed"] = False
return self._ensure_invocation(result)
local_path = self._task.args.get("local_path")
state = self._task.args.get("state", None)
is_local_pod_upload = local_path and state == "to_pod" and not remote_transport
if is_local_pod_upload:
if local_path and state == "to_pod" and not remote_transport:
new_module_args["local_path"] = self.get_file_realpath(local_path)
# Execute the k8s_* module.
+4 -7
View File
@@ -196,7 +196,6 @@ EXAMPLES = r"""
# and requires python to be installed in the image
- name: Run a command in a pod
ansible.builtin.command: echo "Hello, World!"
changed_when: false
- name: Run a command in a pod using local kubectl with inventory variables
# Example inventory:
@@ -221,20 +220,19 @@ EXAMPLES = r"""
# and requires python to be installed in the image
- name: Run a command in a pod
ansible.builtin.command: echo "Hello, World!"
changed_when: false
- name: Run a command in a pod using dynamic inventory
hosts: localhost
gather_facts: no
vars:
kubeconfig: /root/.kube/config
k8s_namespace: my-namespace
namespace: my-namespace
my_app: my-app
tasks:
- name: Get My App pod info based on label
kubernetes.core.k8s_info:
kubeconfig: "{{ kubeconfig }}"
namespace: "{{ k8s_namespace }}"
namespace: "{{ namespace }}"
kind: Pod
label_selectors: app.kubernetes.io/name = "{{ my_app }}"
register: my_app_pod
@@ -249,13 +247,12 @@ EXAMPLES = r"""
ansible_connection: kubernetes.core.kubectl
ansible_kubectl_kubeconfig: "{{ kubeconfig }}"
ansible_kubectl_pod: "{{ my_app_pod_name }}"
ansible_kubectl_namespace: "{{ k8s_namespace }}"
ansible_kubectl_namespace: "{{ namespace }}"
- name: Run a command in My App pod
# be aware that the command is executed as the user that started the container
# and requires python to be installed in the image
ansible.builtin.command: echo "Hello, World!"
changed_when: false
delegate_to: "{{ my_app_pod_name }}"
"""
@@ -265,11 +262,11 @@ import os.path
import shutil
import subprocess
import tempfile
from shlex import quote as shlex_quote
from ansible.errors import AnsibleError, AnsibleFileNotFound
from ansible.module_utils.common.text.converters import to_bytes
from ansible.module_utils.parsing.convert_bool import boolean
from ansible.module_utils.six.moves import shlex_quote
from ansible.parsing.yaml.loader import AnsibleLoader
from ansible.plugins.connection import BUFSIZE, ConnectionBase
from ansible.utils.display import Display
+3 -2
View File
@@ -16,8 +16,9 @@ options:
state:
description:
- Determines if an object should be created, patched, or deleted. When set to C(present), an object will be
created if it does not already exist, and an existing object will be patched if its attributes differ from
those specified using I(resource_definition) or I(src). If set to C(absent), an existing object will be deleted.
created, if it does not already exist. If set to C(absent), an existing object will be deleted. If set to
C(present), an existing object will be patched, if its attributes differ from those specified using
I(resource_definition) or I(src).
type: str
default: present
choices: [ absent, present ]
+1 -33
View File
@@ -209,60 +209,28 @@ RETURN = """
"""
import os
from collections.abc import KeysView
from ansible.errors import AnsibleError
from ansible.module_utils.ansible_release import __version__ as ansible_version
from ansible.module_utils.common._collections_compat import KeysView
from ansible.module_utils.common.validation import check_type_bool
from ansible.utils.display import Display
from ansible_collections.kubernetes.core.plugins.module_utils.k8s.client import (
get_api_client,
)
from ansible_collections.kubernetes.core.plugins.module_utils.k8s.resource import (
create_definitions,
)
from ansible_collections.kubernetes.core.plugins.module_utils.version import (
LooseVersion,
)
display = Display()
# cloud.common declares requires_ansible '>=2.15.0,<2.19'. On newer ansible-core the
# import still succeeds, so the version has to be checked explicitly: relying on
# ImportError alone lets turbo mode fail later with an unrelated traceback.
TURBO_UNSUPPORTED_CORE = "2.19.0"
try:
enable_turbo_mode = check_type_bool(os.environ.get("ENABLE_TURBO_MODE"))
except TypeError:
enable_turbo_mode = False
if enable_turbo_mode:
display.deprecated(
"ENABLE_TURBO_MODE is deprecated, as it relies on the cloud.common "
"collection which is being retired. Setting this environment "
"variable will have no effect once support is removed.",
version="8.0.0",
collection_name="kubernetes.core",
)
if LooseVersion(ansible_version) >= LooseVersion(TURBO_UNSUPPORTED_CORE):
display.warning(
"ENABLE_TURBO_MODE is ignored on ansible-core %s: Ansible Turbo mode requires "
"the cloud.common collection, which supports ansible-core < %s only. "
"Continuing without Turbo mode." % (ansible_version, TURBO_UNSUPPORTED_CORE)
)
enable_turbo_mode = False
if enable_turbo_mode:
try:
from ansible_collections.cloud.common.plugins.plugin_utils.turbo.lookup import (
TurboLookupBase as LookupBase,
)
except ImportError:
display.warning(
"ENABLE_TURBO_MODE is set but the cloud.common collection is not installed. "
"Continuing without Turbo mode."
)
from ansible.plugins.lookup import LookupBase # noqa: F401
else:
from ansible.plugins.lookup import LookupBase # noqa: F401
-30
View File
@@ -5,39 +5,13 @@ __metaclass__ = type
import os
from ansible.module_utils.ansible_release import __version__ as ansible_version
from ansible.module_utils.common.validation import check_type_bool
from ansible.module_utils.common.warnings import deprecate, warn
from ansible_collections.kubernetes.core.plugins.module_utils.version import (
LooseVersion,
)
# cloud.common declares requires_ansible '>=2.15.0,<2.19'. On newer ansible-core the
# import still succeeds, so the version has to be checked explicitly: relying on
# ImportError alone lets turbo mode fail later with an unrelated traceback.
TURBO_UNSUPPORTED_CORE = "2.19.0"
try:
enable_turbo_mode = check_type_bool(os.environ.get("ENABLE_TURBO_MODE"))
except TypeError:
enable_turbo_mode = False
if enable_turbo_mode:
deprecate(
"ENABLE_TURBO_MODE is deprecated, as it relies on the cloud.common collection "
"which is being retired. Setting this environment variable will have no effect "
"once support is removed.",
version="8.0.0",
collection_name="kubernetes.core",
)
if LooseVersion(ansible_version) >= LooseVersion(TURBO_UNSUPPORTED_CORE):
warn(
"ENABLE_TURBO_MODE is ignored on ansible-core %s: Ansible Turbo mode requires "
"the cloud.common collection, which supports ansible-core < %s only. "
"Continuing without Turbo mode." % (ansible_version, TURBO_UNSUPPORTED_CORE)
)
enable_turbo_mode = False
if enable_turbo_mode:
try:
from ansible_collections.cloud.common.plugins.module_utils.turbo.module import ( # noqa: F401
@@ -46,10 +20,6 @@ if enable_turbo_mode:
AnsibleModule.collection_name = "kubernetes.core"
except ImportError:
warn(
"ENABLE_TURBO_MODE is set but the cloud.common collection is not installed. "
"Continuing without Turbo mode."
)
from ansible.module_utils.basic import AnsibleModule # noqa: F401
else:
from ansible.module_utils.basic import AnsibleModule # noqa: F401
-15
View File
@@ -144,18 +144,3 @@ DELETE_OPTS_ARG_SPEC = {
"options": {"resourceVersion": {"type": "str"}, "uid": {"type": "str"}},
},
}
METADATA_ONLY_HEADERS_SPEC = {
"accept": {"type": "str"},
}
METADATA_ONLY_HEADER_VALUES = {
"partial_object": (
"application/json;as=PartialObjectMetadata;g=meta.k8s.io;v=v1,"
"application/json;q=0.9"
),
"partial_object_list": (
"application/json;as=PartialObjectMetadataList;g=meta.k8s.io;v=v1,"
"application/json;q=0.9"
),
}
+53 -178
View File
@@ -18,9 +18,7 @@ from __future__ import absolute_import, division, print_function
__metaclass__ = type
import os
import shlex
import tarfile
import time
from abc import ABCMeta, abstractmethod
from select import select
from tempfile import NamedTemporaryFile, TemporaryFile
@@ -298,156 +296,14 @@ class K8SCopyToPod(K8SCopy):
Copy files/directory from local filesystem into remote Pod
"""
# Size of the chunks the tar archive is written to stdin with.
CHUNK_SIZE = 1024 * 1024
SHELL = "/bin/sh"
def __init__(self, module, client):
super(K8SCopyToPod, self).__init__(module, client)
self.files_to_copy = list()
self.named_temp_file = None
self.copy_timeout = module.params.get("copy_timeout")
def close_temp_file(self):
if self.named_temp_file:
self.named_temp_file.close()
def _fail(self, response, msg, stderr=(), **kwargs):
"""Fail, keeping whatever the remote already wrote to stderr.
An early close or a stall is usually the symptom, not the cause: tar
has typically said why on stderr first.
"""
if stderr:
msg = "{0}: {1}".format(msg, "".join(stderr))
response.close()
self.close_temp_file()
self.module.fail_json(
msg="Failed to copy local file/directory into Pod: {0}".format(msg),
**kwargs,
)
def tar_command(self, dest_file):
if self.no_preserve:
command = [
"tar",
"--no-same-permissions",
"--no-same-owner",
"-xmf",
"-",
]
else:
command = ["tar", "-xmf", "-"]
if dest_file.startswith("/"):
command.extend(["-C", "/"])
return command
def can_bound_stream(self):
"""Whether the container can run ``sh -c 'head -c ...'``."""
error, _out, _err = self._run_from_pod(
cmd=[self.SHELL, "-c", "command -v head"]
)
return (error or {}).get("status") == "Success"
def remote_command(self, dest_file, archive_size):
"""Build the command that extracts the archive inside the container.
The websocket exec protocol the kubernetes client speaks (v4) cannot
half-close stdin, so the only EOF the remote process can get is the
connection going away. Relying on that races with tar finishing and
truncates the file (issue #776), and tar cannot be relied on to stop at
the end-of-archive marker either -- busybox tar blocks for EOF.
Piping through ``head -c`` bounds the stream at the exact archive size,
so tar sees a clean EOF, exits on its own, and the API server reports
its exit status on the error channel. Only where the container has no
shell do we fall back to feeding tar directly, which cannot confirm
that the copy completed.
"""
command = self.tar_command(dest_file)
if not self.can_bound_stream():
self.module.warn(
"Container has no '{0}' with 'head', falling back to writing the"
" archive straight to tar. The module cannot confirm the copy"
" completed; verify the file after copying.".format(self.SHELL)
)
return command, False
return [
self.SHELL,
"-c",
"head -c {0} | {1}".format(
archive_size, " ".join(shlex.quote(arg) for arg in command)
),
], True
def _stream_tar_to_pod(self, response, tar_buffer, wait_for_exit):
"""Feed the archive to the remote extractor and wait for it to finish.
Writing the last chunk only hands the bytes to the local socket; they
still have to cross the API server and reach the container. Closing the
connection at that point kills the extractor mid-write and silently
truncates the file, which is what issue #776 reports.
"""
stdout, stderr = [], []
def drain(timeout):
response.update(timeout=timeout)
if response.peek_stdout():
stdout.append(response.read_stdout().rstrip("\n"))
if response.peek_stderr():
stderr.append(response.read_stderr().rstrip("\n"))
deadline = time.monotonic() + self.copy_timeout
chunk = tar_buffer.read(self.CHUNK_SIZE)
while chunk:
if not response.is_open():
self._fail(
response,
"connection to Pod {0}/{1} closed before the whole archive was"
" sent, the remote file is incomplete".format(
self.namespace, self.name
),
stderr,
)
if time.monotonic() > deadline:
self._fail(
response,
"timed out after {0}s sending the archive to Pod {1}/{2}".format(
self.copy_timeout, self.namespace, self.name
),
stderr,
)
# Non-blocking, keeps the receive buffer clear while we write.
drain(0)
response.write_stdin(chunk)
chunk = tar_buffer.read(self.CHUNK_SIZE)
if not wait_for_exit:
# No way to make the extractor exit, so no status to collect: read
# whatever it has already said and close, as the module always did.
drain(0)
response.close()
return None, stdout, stderr
# The archive is on the wire; wait for the extractor to consume it,
# exit, and have its status reported on the error channel.
while response.is_open():
if time.monotonic() > deadline:
self._fail(
response,
"timed out after {0}s waiting for tar to finish extracting on Pod"
" {1}/{2}".format(self.copy_timeout, self.namespace, self.name),
stderr,
)
drain(1)
error = yaml.safe_load(response.read_channel(ERROR_CHANNEL)) or {}
response.close()
return error, stdout, stderr
def run(self):
# remove trailing slash from destination path
dest_file = self.remote_path.rstrip("/")
@@ -480,46 +336,65 @@ class K8SCopyToPod(K8SCopy):
dest_file = os.path.join(dest_file, os.path.basename(src_file))
if not self.check_mode:
if self.no_preserve:
tar_command = [
"tar",
"--no-same-permissions",
"--no-same-owner",
"-xmf",
"-",
]
else:
tar_command = ["tar", "-xmf", "-"]
if dest_file.startswith("/"):
tar_command.extend(["-C", "/"])
response = stream(
self.api_instance.connect_get_namespaced_pod_exec,
self.name,
self.namespace,
command=tar_command,
stderr=True,
stdin=True,
stdout=True,
tty=False,
_preload_content=False,
**self.container_arg,
)
with TemporaryFile() as tar_buffer:
# Build the archive first: bounding the remote read needs its
# exact size.
with tarfile.open(fileobj=tar_buffer, mode="w") as tar:
tar.add(src_file, dest_file)
archive_size = tar_buffer.tell()
tar_buffer.seek(0)
commands = []
# push command in chunk mode
size = 1024 * 1024
while True:
data = tar_buffer.read(size)
if not data:
break
commands.append(data)
command, wait_for_exit = self.remote_command(dest_file, archive_size)
response = stream(
self.api_instance.connect_get_namespaced_pod_exec,
self.name,
self.namespace,
command=command,
stderr=True,
stdin=True,
stdout=True,
tty=False,
_preload_content=False,
**self.container_arg,
)
error, stdout, stderr = self._stream_tar_to_pod(
response, tar_buffer, wait_for_exit
)
if error is not None and error.get("status") != "Success":
self._fail(
response,
"".join(stderr) or error.get("message", "unknown error"),
command=command,
)
if error is None and stderr:
# Legacy path: no exit status to go on, so any output is fatal.
self._fail(response, "".join(stderr), command=command)
if stderr:
self.module.warn(
"tar wrote to stderr while extracting into Pod {0}/{1}: {2}".format(
self.namespace, self.name, "".join(stderr)
stderr, stdout = [], []
while response.is_open():
if response.peek_stdout():
stdout.append(response.read_stdout().rstrip("\n"))
if response.peek_stderr():
stderr.append(response.read_stderr().rstrip("\n"))
if commands:
cmd = commands.pop(0)
response.write_stdin(cmd)
else:
break
response.close()
if stderr:
self.close_temp_file()
self.module.fail_json(
command=tar_command,
msg="Failed to copy local file/directory into Pod due to: {0}".format(
"".join(stderr)
),
)
)
self.close_temp_file()
if self.content:
self.module.exit_json(
-47
View File
@@ -32,53 +32,6 @@ except ImportError:
HAS_YAML = False
# Helm's registry client writes these progress messages to stdout as of helm 4.2.1
# (helm/helm#32056); earlier versions sent them to stderr. Anything that parses the
# stdout of a helm command which may pull from an OCI registry has to skip them.
# Kept verbatim from helm's pkg/registry/client.go so that a reworded message fails
# to match, and therefore fails loudly, rather than silently eating real output.
REGISTRY_PROGRESS_RE = re.compile(r"^(?:Pulled|Pushed|Digest): \S")
REGISTRY_UNDERSCORE_SUFFIX = " contains an underscore.\n"
REGISTRY_UNDERSCORE_MESSAGE = """
OCI artifact references (e.g. tags) do not support the plus sign (+). To support
storing semantic versions, Helm adopts the convention of changing plus (+) to
an underscore (_) in chart version tags when pushing to a registry and back to
a plus (+) when pulling from a registry.
"""
REGISTRY_UNDERSCORE_MESSAGE_LINES = len(REGISTRY_UNDERSCORE_MESSAGE.splitlines())
def strip_registry_progress(out):
"""
Drop OCI registry progress messages from the front of a helm command's stdout.
Helm emits 'Pulled:'/'Pushed:' and 'Digest:' lines, followed - when the
reference contains an underscore - by a free-text explanation that is not
valid YAML. Since helm 4.2.1 these land on stdout ahead of the real output,
so 'helm show chart' can no longer be parsed and 'helm template' no longer
returns only rendered manifests.
"""
lines = out.splitlines(keepends=True)
index = 0
while index < len(lines):
if REGISTRY_PROGRESS_RE.match(lines[index]):
index += 1
elif lines[index].endswith(REGISTRY_UNDERSCORE_SUFFIX):
# helm prints its registryUnderscoreMessage right after this line, led
# by a blank line. Anything else is not a message we know about.
start = index + 1
end = start + REGISTRY_UNDERSCORE_MESSAGE_LINES
if "".join(lines[start:end]) != REGISTRY_UNDERSCORE_MESSAGE:
break
index = end
else:
break
return "".join(lines[index:])
def parse_helm_plugin_list(output=None):
"""
Parse `helm plugin list`, return list of plugins
-1
View File
@@ -181,7 +181,6 @@ def _create_headers(module=None, **kwargs):
header_map = {
"impersonate_user": "Impersonate-User",
"impersonate_groups": "Impersonate-Group",
"accept": "Accept",
}
headers = {}
+10 -6
View File
@@ -92,10 +92,10 @@ def run_module(module) -> None:
for definition in definitions:
result = {"changed": False, "result": {}}
warnings = []
if module.params.get("validate") is not None:
for warning in validate(client, module, definition):
module.warn(warning)
warnings = validate(client, module, definition)
try:
result = perform_action(svc, definition, module.params)
@@ -109,12 +109,16 @@ def run_module(module) -> None:
except AttributeError:
pass
error["msg"] = to_native(e)
if warnings:
error.setdefault("warnings", []).extend(warnings)
if module.params.get("continue_on_error"):
result["error"] = error
else:
module.fail_json(**error)
if warnings:
result.setdefault("warnings", []).extend(warnings)
changed |= result["changed"]
results.append(result)
@@ -173,7 +177,7 @@ def perform_action(svc, definition: Dict, params: Dict) -> Dict:
result["method"] = "apply"
elif not existing:
if state == "patched":
svc.module.warn(
result.setdefault("warnings", []).append(
"resource 'kind={kind},name={name}' was not found but will not be "
"created as 'state' parameter has been set to '{state}'".format(
kind=kind, name=definition["metadata"].get("name"), state=state
@@ -190,8 +194,8 @@ def perform_action(svc, definition: Dict, params: Dict) -> Dict:
instance, warnings = svc.update(resource, definition, existing)
result["method"] = "update"
for warning in warnings:
svc.module.warn(warning)
if warnings:
result["warnings"] = warnings
# If needed, wait and/or create diff
success = True
@@ -213,7 +217,7 @@ def perform_action(svc, definition: Dict, params: Dict) -> Dict:
existing = {}
match, diffs = diff_objects(existing, instance, hidden_fields)
if match and diffs:
svc.module.warn(
result.setdefault("warnings", []).append(
"No meaningful diff was generated, but the API may not be idempotent "
"(only metadata.generation or metadata.resourceVersion were changed)"
)
+6 -19
View File
@@ -47,18 +47,6 @@ def pod_ready(pod: ResourceInstance) -> bool:
)
def job_complete(job: ResourceInstance) -> bool:
return bool(
job.status
and job.status.conditions
and any(
condition["type"] in ("Complete", "Failed")
and boolean(condition["status"], strict=False)
for condition in job.status.conditions
)
)
def daemonset_ready(daemonset: ResourceInstance) -> bool:
return bool(
daemonset.status
@@ -101,18 +89,18 @@ def custom_condition(condition: Dict, resource: ResourceInstance) -> bool:
if not matches:
return False
# There should never be more than one condition of a specific type
match_condition: ResourceField = matches[0]
if match_condition.status == "Unknown":
if match_condition.status == condition["status"]:
match: ResourceField = matches[0]
if match.status == "Unknown":
if match.status == condition["status"]:
if "reason" not in condition:
return True
if condition["reason"]:
return match_condition.reason == condition["reason"]
return match.reason == condition["reason"]
return False
status = True if match_condition.status == "True" else False
status = True if match.status == "True" else False
if status == boolean(condition["status"], strict=False):
if condition.get("reason"):
return match_condition.reason == condition["reason"]
return match.reason == condition["reason"]
return True
return False
@@ -155,7 +143,6 @@ RESOURCE_PREDICATES = {
"DaemonSet": daemonset_ready,
"Deployment": deployment_ready,
"Pod": pod_ready,
"Job": job_complete,
"StatefulSet": statefulset_ready,
"ClusterOperator": cluster_operator_ready,
}
+1 -3
View File
@@ -15,6 +15,4 @@ __metaclass__ = type
#
# from ansible.module_utils.compat.version import LooseVersion
from ._version import LooseVersion # noqa: F401 # pylint: disable=unused-import
__all__ = ["LooseVersion"]
from ._version import LooseVersion # noqa: F401
+74 -217
View File
@@ -132,19 +132,15 @@ options:
version_added: 2.4.0
reuse_values:
description:
- When upgrading package, specifies whether to reuse the last release's values and merge in any overrides from parameters O(release_values),
O(values_files) or O(set_values).
- Helm ignores this when C(--reset-values) is passed. Since O(reset_values) defaults to V(true), it has to be set to V(false)
for this option to take any effect.
- C(helm install) does not accept C(--reuse-values), so this option is ignored when O(replace) is set.
- The module warns whenever one of those combinations makes this option a no-op.
- When upgrading package, specifies wether to reuse the last release's values and merge in any overrides from parameters I(release_values),
I(values_files) or I(set_values).
- If I(reset_values) is set to C(True), this is ignored.
type: bool
required: false
version_added: 3.0.0
reset_values:
description:
- When upgrading package, reset the values to the ones built into the chart.
- Defaults to V(true), which makes helm ignore O(reuse_values) and O(reset_then_reuse_values). Set it to V(false) to use either of them.
type: bool
required: false
default: True
@@ -153,10 +149,7 @@ options:
description:
- When upgrading package, reset the values to the ones built into the chart, apply the last release's values and merge in any overrides from
parameters O(release_values), O(values_files) or O(set_values).
- Helm ignores this when C(--reset-values) or C(--reuse-values) is passed. Since O(reset_values) defaults to V(true), it has to be
set to V(false), and O(reuse_values) left unset or V(false), for this option to take any effect.
- C(helm install) does not accept C(--reset-then-reuse-values), so this option is ignored when O(replace) is set.
- The module warns whenever one of those combinations makes this option a no-op.
- If O(reset_values) or O(reuse_values) is set to V(True), this is ignored.
- This feature requires helm diff >= 3.9.12.
type: bool
required: false
@@ -194,19 +187,10 @@ options:
It will wait for as long as I(wait_timeout). This feature requires helm>=3.7.0. Added in version 2.3.0.
default: False
type: bool
wait_for_jobs:
description:
- When I(release_state) is set to C(present), and I(wait) is set to C(True), wait until all jobs are in a
completed state before marking the release as successful.
- Ignored when used without O(wait).
- Requires Helm >= 3.5.0
version_added: 6.6.0
default: False
type: bool
wait_timeout:
description:
- Timeout when wait option is enabled (helm2 is a number of seconds, helm3 is a duration).
- The use of I(wait_timeout) to wait for kubernetes commands to complete has been deprecated and will be removed in version 7.0.0. Use O(timeout) instead.
- The use of I(wait_timeout) to wait for kubernetes commands to complete has been deprecated and will be removed after 2022-12-01.
type: str
timeout:
description:
@@ -223,18 +207,6 @@ options:
O(atomic) option works the same way regardless of the installed Helm version.
type: bool
default: False
cleanup_on_fail:
description:
- Allow deletion of new resources created during a failed upgrade.
- Maps to the C(--cleanup-on-fail) flag, which is available since helm 3.0.0 and
was not renamed in Helm v4.
- Complements O(atomic) rather than replacing it, and the two can be combined so
that a rollback also drops resources orphaned by the failed upgrade.
- Helm only accepts this flag on C(helm upgrade), so it cannot be used together
with O(replace), which deploys through C(helm install).
type: bool
default: False
version_added: 6.6.0
server_side:
description:
- Control Helm v4 server-side apply when installing or upgrading a release.
@@ -413,7 +385,6 @@ EXAMPLES = r"""
release_namespace: default
force: True
wait: True
wait_for_jobs: True
replace: True
update_repo_cache: True
disable_hook: True
@@ -433,30 +404,15 @@ EXAMPLES = r"""
enabled: True
# Deploy latest version
# 'reset_values' defaults to true and helm ignores '--reuse-values' when it is set,
# so it has to be turned off explicitly.
- name: Deploy latest version of Grafana chart using reuse_values
kubernetes.core.helm:
name: test
chart_ref: stable/grafana
release_namespace: monitoring
reuse_values: true
reset_values: false
values:
replicas: 2
version: 3e8ec0b2dffa40fb97d5342e4af887de95faa8c61a62480dd7f8aa03dffcf533
# Same for 'reset_then_reuse_values', which helm ignores when either
# '--reset-values' or '--reuse-values' is set.
- name: Deploy latest version of Grafana chart using reset_then_reuse_values
kubernetes.core.helm:
name: test
chart_ref: stable/grafana
release_namespace: monitoring
reset_then_reuse_values: true
reset_values: false
values:
replicas: 2
"""
RETURN = r"""
@@ -498,8 +454,8 @@ status:
returned: always
description:
- Dict of Values used to deploy.
- This return value has been deprecated and will be removed in version 8.0.0.
Use RV(status.release_values) instead.
- This return value has been deprecated and will be removed in a release after
2027-01-08. Use RV(status.release_values) instead.
release_values:
type: dict
returned: always
@@ -545,7 +501,6 @@ from ansible.module_utils.basic import missing_required_lib
from ansible_collections.kubernetes.core.plugins.module_utils.helm import (
AnsibleHelmModule,
parse_helm_plugin_list,
strip_registry_progress,
)
from ansible_collections.kubernetes.core.plugins.module_utils.helm_args_common import (
HELM_AUTH_ARG_SPEC,
@@ -593,13 +548,6 @@ def get_release_status(module, release_name, all_status=False):
release["release_values"] = module.get_values(release_name)
release["values"] = release["release_values"]
# Add deprecation warning for status.values
module.deprecate(
"The 'status.values' return value is deprecated and will be removed in version 8.0.0. Use 'status.release_values' instead.",
version="8.0.0",
collection_name="kubernetes.core",
)
return release
@@ -643,52 +591,7 @@ def fetch_chart_info(
rc, out, err = module.run_helm_command(inspect_command)
return yaml.safe_load(strip_registry_progress(out))
def validate_value_options(
module, replace, reuse_values, reset_values, reset_then_reuse_values
):
"""
Check the value-reuse options against each other and against 'replace'.
'helm install' accepts none of these flags, so 'replace' drops all three. The rest
are precedence rules helm applies silently: '--reset-values' wins over
'--reuse-values', and both win over '--reset-then-reuse-values'. Since 'reset_values'
defaults to true, requesting either of the other two on its own is a no-op.
Warn rather than fail throughout. Every one of these combinations is accepted by
playbooks today: 'reuse_values' has existed since 3.0.0, and a release that is
already converged never reaches deploy(), so the invalid command was never built.
Failing here would turn tasks that pass today into tasks that fail.
"""
if replace:
for name, requested in (
("reuse_values", reuse_values is not None),
("reset_then_reuse_values", reset_then_reuse_values),
):
if requested:
module.warn(
"{0} is ignored because replace=true deploys through 'helm install',"
" which does not accept the flag.".format(name)
)
return
if reset_values:
for name, requested in (
("reuse_values", reuse_values),
("reset_then_reuse_values", reset_then_reuse_values),
):
if requested:
module.warn(
"{0} is ignored because reset_values is true. "
"Set reset_values=false to make it take effect.".format(name)
)
elif reuse_values and reset_then_reuse_values:
module.warn(
"reset_then_reuse_values is ignored because reuse_values is true. "
"Set reuse_values=false to make it take effect."
)
return yaml.safe_load(out)
def deploy(
@@ -698,14 +601,12 @@ def deploy(
release_values,
chart_name,
wait,
wait_for_jobs,
wait_timeout,
disable_hook,
force,
values_files,
history_max,
atomic=False,
cleanup_on_fail=False,
create_namespace=False,
replace=False,
post_renderer=None,
@@ -733,41 +634,27 @@ def deploy(
deploy_command += " --dependency-update"
else:
deploy_command = command + " upgrade -i" # install/upgrade
if reset_values:
deploy_command += " --reset-values"
if take_ownership:
deploy_command += " --take-ownership"
# '--reset-values', '--reuse-values' and '--reset-then-reuse-values' are all
# upgrade-only flags, so they must not leak into the 'replace' branch above.
# validate_value_options() has already warned about that combination.
if reset_values:
deploy_command += " --reset-values"
if reuse_values is not None:
deploy_command += " --reuse-values=" + str(reuse_values)
if reuse_values is not None:
deploy_command += " --reuse-values=" + str(reuse_values)
if reset_then_reuse_values:
helm_version = module.get_helm_version()
if LooseVersion(helm_version) < LooseVersion("3.14.0"):
module.fail_json(
msg="reset_then_reuse_values requires helm >= 3.14.0, current version is {0}".format(
helm_version
)
if reset_then_reuse_values:
helm_version = module.get_helm_version()
if LooseVersion(helm_version) < LooseVersion("3.14.0"):
module.fail_json(
msg="reset_then_reuse_values requires helm >= 3.14.0, current version is {0}".format(
helm_version
)
else:
deploy_command += " --reset-then-reuse-values"
)
else:
deploy_command += " --reset-then-reuse-values"
if wait:
deploy_command += " --wait"
if wait_for_jobs:
helm_version = module.get_helm_version()
if LooseVersion(helm_version) < LooseVersion("3.5.0"):
module.fail_json(
msg="wait_for_jobs requires helm >= 3.5.0, current version is {0}".format(
helm_version
)
)
else:
deploy_command += " --wait-for-jobs"
if wait_timeout is not None:
deploy_command += " --timeout " + wait_timeout
@@ -780,17 +667,6 @@ def deploy(
else:
deploy_command += " --atomic"
if cleanup_on_fail:
# '--cleanup-on-fail' is only accepted by 'helm upgrade', so it cannot be
# combined with 'replace', which deploys through 'helm install'. The flag
# exists since helm 3.0.0 and kept its name in v4, so no version gate is
# needed on top of the module-wide helm >= 3.0.0 requirement.
if replace:
module.fail_json(
msg="cleanup_on_fail is only supported by 'helm upgrade' and cannot be used with replace=true"
)
deploy_command += " --cleanup-on-fail"
if timeout:
deploy_command += " --timeout " + timeout
@@ -956,6 +832,7 @@ def helmdiff_check(
reset_values=True,
reset_then_reuse_values=False,
insecure_skip_tls_verify=False,
plain_http=False,
skip_schema_validation=False,
):
"""
@@ -988,10 +865,10 @@ def helmdiff_check(
if set_value_args:
cmd += " " + set_value_args
if not replace and reuse_values:
if reuse_values:
cmd += " --reuse-values"
if not replace and reset_then_reuse_values:
if reset_then_reuse_values:
helm_diff_version = get_plugin_version("diff")
helm_version = module.get_helm_version()
fail_msg = ""
@@ -1023,6 +900,17 @@ def helmdiff_check(
else:
cmd += " --skip-schema-validation"
if plain_http:
helm_version = module.get_helm_version()
if LooseVersion(helm_version) < LooseVersion("3.13.0"):
module.fail_json(
msg="plain_http requires helm >= 3.13.0, current version is {0}".format(
helm_version
)
)
else:
cmd += " --plain-http"
rc, out, err = module.run_helm_command(cmd)
return (len(out.strip()) > 0, out.strip())
@@ -1054,58 +942,44 @@ def default_check(release_status, chart_info, values=None, values_files=None):
def argument_spec():
arg_spec = copy.deepcopy(HELM_AUTH_ARG_SPEC)
arg_spec.update(
{
"chart_ref": {"type": "path"},
"chart_repo_url": {"type": "str"},
"chart_version": {"type": "str"},
"dependency_update": {
"type": "bool",
"default": False,
"aliases": ["dep_up"],
},
"release_name": {"type": "str", "required": True, "aliases": ["name"]},
"release_namespace": {
"type": "str",
"required": True,
"aliases": ["namespace"],
},
"release_state": {
"default": "present",
"choices": ["present", "absent"],
"aliases": ["state"],
},
"release_values": {"type": "dict", "default": {}, "aliases": ["values"]},
"values_files": {"type": "list", "default": [], "elements": "str"},
"update_repo_cache": {"type": "bool", "default": False},
"disable_hook": {"type": "bool", "default": False},
"force": {"type": "bool", "default": False},
"purge": {"type": "bool", "default": True},
"wait": {"type": "bool", "default": False},
"wait_for_jobs": {"type": "bool", "default": False},
"wait_timeout": {"type": "str"},
"timeout": {"type": "str"},
"atomic": {"type": "bool", "default": False},
"server_side": {"type": "str", "choices": ["auto", "true", "false"]},
"force_conflicts": {"type": "bool", "default": False},
"create_namespace": {"type": "bool", "default": False},
"post_renderer": {"type": "str"},
"replace": {"type": "bool", "default": False},
"skip_crds": {"type": "bool", "default": False},
"history_max": {"type": "int"},
"set_values": {"type": "list", "elements": "dict"},
"reuse_values": {"type": "bool"},
"reset_values": {"type": "bool", "default": True},
"reset_then_reuse_values": {"type": "bool", "default": False},
"insecure_skip_tls_verify": {
"type": "bool",
"default": False,
"aliases": ["skip_tls_certs_check"],
},
"plain_http": {"type": "bool", "default": False},
"take_ownership": {"type": "bool", "default": False},
"skip_schema_validation": {"type": "bool", "default": False},
"cleanup_on_fail": {"type": "bool", "default": False},
}
dict(
chart_ref=dict(type="path"),
chart_repo_url=dict(type="str"),
chart_version=dict(type="str"),
dependency_update=dict(type="bool", default=False, aliases=["dep_up"]),
release_name=dict(type="str", required=True, aliases=["name"]),
release_namespace=dict(type="str", required=True, aliases=["namespace"]),
release_state=dict(
default="present", choices=["present", "absent"], aliases=["state"]
),
release_values=dict(type="dict", default={}, aliases=["values"]),
values_files=dict(type="list", default=[], elements="str"),
update_repo_cache=dict(type="bool", default=False),
disable_hook=dict(type="bool", default=False),
force=dict(type="bool", default=False),
purge=dict(type="bool", default=True),
wait=dict(type="bool", default=False),
wait_timeout=dict(type="str"),
timeout=dict(type="str"),
atomic=dict(type="bool", default=False),
server_side=dict(type="str", choices=["auto", "true", "false"]),
force_conflicts=dict(type="bool", default=False),
create_namespace=dict(type="bool", default=False),
post_renderer=dict(type="str"),
replace=dict(type="bool", default=False),
skip_crds=dict(type="bool", default=False),
history_max=dict(type="int"),
set_values=dict(type="list", elements="dict"),
reuse_values=dict(type="bool"),
reset_values=dict(type="bool", default=True),
reset_then_reuse_values=dict(type="bool", default=False),
insecure_skip_tls_verify=dict(
type="bool", default=False, aliases=["skip_tls_certs_check"]
),
plain_http=dict(type="bool", default=False),
take_ownership=dict(type="bool", default=False),
skip_schema_validation=dict(type="bool", default=False),
)
)
return arg_spec
@@ -1128,14 +1002,6 @@ def main():
supports_check_mode=True,
)
# Add deprecation warning for wait_timeout
if module.params.get("wait_timeout") is not None:
module.deprecate(
"The 'wait_timeout' parameter is deprecated and will be removed in version 7.0.0. Use 'timeout' instead.",
version="7.0.0",
collection_name="kubernetes.core",
)
if not IMP_YAML:
module.fail_json(msg=missing_required_lib("yaml"), exception=IMP_YAML_ERR)
@@ -1159,10 +1025,8 @@ def main():
force = module.params.get("force")
purge = module.params.get("purge")
wait = module.params.get("wait")
wait_for_jobs = module.params.get("wait_for_jobs")
wait_timeout = module.params.get("wait_timeout")
atomic = module.params.get("atomic")
cleanup_on_fail = module.params.get("cleanup_on_fail")
server_side = module.params.get("server_side")
force_conflicts = module.params.get("force_conflicts")
create_namespace = module.params.get("create_namespace")
@@ -1235,10 +1099,6 @@ def main():
)
changed = True
elif release_state == "present":
validate_value_options(
module, replace, reuse_values, reset_values, reset_then_reuse_values
)
if chart_version is not None:
helm_cmd += " --version=" + chart_version
@@ -1292,13 +1152,11 @@ def main():
release_values,
chart_ref,
wait,
wait_for_jobs,
wait_timeout,
disable_hook,
False,
values_files=values_files,
atomic=atomic,
cleanup_on_fail=cleanup_on_fail,
server_side=server_side,
force_conflicts=force_conflicts,
create_namespace=create_namespace,
@@ -1350,6 +1208,7 @@ def main():
reset_values=reset_values,
reset_then_reuse_values=reset_then_reuse_values,
insecure_skip_tls_verify=insecure_skip_tls_verify,
plain_http=plain_http,
skip_schema_validation=skip_schema_validation,
)
if would_change and module._diff:
@@ -1379,13 +1238,11 @@ def main():
release_values,
chart_ref,
wait,
wait_for_jobs,
wait_timeout,
disable_hook,
force,
values_files=values_files,
atomic=atomic,
cleanup_on_fail=cleanup_on_fail,
server_side=server_side,
force_conflicts=force_conflicts,
create_namespace=create_namespace,
+2 -10
View File
@@ -119,8 +119,8 @@ status:
returned: always
description:
- Dict of Values used to deploy
- This return value has been deprecated and will be removed in version 8.0.0.
Use RV(status.release_values) instead.
- This return value has been deprecated and will be removed in a release after
2027-01-08. Use RV(status.release_values) instead.
release_values:
type: dict
returned: always
@@ -213,14 +213,6 @@ def get_release_status(module, release_name, release_state, get_all_values=False
release["release_values"] = module.get_values(release_name, get_all_values)
release["values"] = release["release_values"]
# Add deprecation warning for status.values
module.deprecate(
"The 'status.values' return value is deprecated and will be removed in version 8.0.0. Use 'status.release_values' instead.",
version="8.0.0",
collection_name="kubernetes.core",
)
release["manifest"] = module.get_manifest(release_name)
release["notes"] = module.get_notes(release_name)
release["hooks"] = module.get_hooks(release_name)
+1 -1
View File
@@ -331,7 +331,7 @@ def main():
insecure_skip_tls_verify,
)
changed = True
elif repository_status["url"].rstrip("/") != repo_url:
elif repository_status["url"] != repo_url:
module.fail_json(
msg="Repository already have a repository named {0}".format(repo_name)
)
-4
View File
@@ -228,7 +228,6 @@ except ImportError:
from ansible.module_utils.basic import missing_required_lib
from ansible_collections.kubernetes.core.plugins.module_utils.helm import (
AnsibleHelmModule,
strip_registry_progress,
)
from ansible_collections.kubernetes.core.plugins.module_utils.version import (
LooseVersion,
@@ -395,9 +394,6 @@ def main():
if not check_mode:
rc, out, err = module.run_helm_command(tmpl_cmd)
# 'stdout' is documented to hold the rendered templates, so keep helm's
# OCI registry progress messages out of it.
out = strip_registry_progress(out)
else:
out = err = ""
rc = 0
+3 -2
View File
@@ -40,8 +40,9 @@ options:
state:
description:
- Determines if an object should be created, patched, or deleted. When set to C(present), an object will be
created if it does not already exist, and an existing object will be patched if its attributes differ from
those specified using I(resource_definition) or I(src). If set to C(absent), an existing object will be deleted.
created, if it does not already exist. If set to C(absent), an existing object will be deleted. If set to
C(present), an existing object will be patched, if its attributes differ from those specified using
I(resource_definition) or I(src).
- C(patched) state is an existing resource that has a given patch applied. If the resource doesn't exist, silently skip it (do not raise an error).
type: str
default: present
-13
View File
@@ -76,21 +76,9 @@ options:
- This option is ignored when I(content) is set or when I(state) is set to C(from_pod).
type: bool
default: False
copy_timeout:
description:
- Maximum time in seconds to spend streaming the archive to the pod and waiting for the remote
C(tar) process to finish extracting it.
- Raise this when copying large files over a slow connection.
- This option is ignored when I(state) is set to C(from_pod).
type: int
default: 300
version_added: 6.6.0
notes:
- the tar binary is required on the container when copying from local filesystem to pod.
- a POSIX shell at C(/bin/sh) and C(head) are also used, when present, to bound the archive
sent to the container so that the module can confirm the copy finished. Without them the
copy still runs but completion cannot be verified, and a warning is emitted.
- the (init) container has to be started before you copy files or directories to it.
"""
@@ -192,7 +180,6 @@ def argspec():
"choices": ["to_pod", "from_pod"],
}
argument_spec["no_preserve"] = {"type": "bool", "default": False}
argument_spec["copy_timeout"] = {"type": "int", "default": 300}
return argument_spec
+1 -8
View File
@@ -118,7 +118,7 @@ result:
type: int
version_added: 2.2.0
return_code:
description: The command status code. This attribute is deprecated and will be removed in version 7.0.0. Use RV(result.rc) instead.
description: The command status code. This attribute is deprecated and will be removed in a future release. Please use rc instead.
type: int
"""
@@ -219,13 +219,6 @@ def execute_module(module, client):
else:
rc = int(err["details"]["causes"][0]["message"])
# Add deprecation warning for return_code return value
module.deprecate(
"The 'return_code' return value is deprecated and will be removed in version 7.0.0. Use 'rc' instead.",
version="7.0.0",
collection_name="kubernetes.core",
)
module.exit_json(
# Some command might change environment, but ultimately failing at end
changed=True,
+10 -40
View File
@@ -53,15 +53,6 @@ options:
type: list
elements: str
version_added: 3.0.0
metadata_only:
description:
- Request metadata only response from the Kubernetes API server.
- This feature is useful for clients that only need to check for the existence of an object,
- or that only need to read its metadata.
- It can significantly reduce the size of the response from the API server.
type: bool
default: false
version_added: 6.6.0
extends_documentation_fragment:
- kubernetes.core.k8s_auth_options
@@ -144,12 +135,6 @@ EXAMPLES = r"""
(ocp_bootstrap_status.resources[0].data.status == 'complete')
retries: 60
delay: 15
- name: Get a list of all pods metadata only
kubernetes.core.k8s_info:
kind: Pod
metadata_only: true
register: pod_metadata_list
"""
RETURN = r"""
@@ -194,8 +179,6 @@ from ansible_collections.kubernetes.core.plugins.module_utils.ansiblemodule impo
)
from ansible_collections.kubernetes.core.plugins.module_utils.args_common import (
AUTH_ARG_SPEC,
METADATA_ONLY_HEADER_VALUES,
METADATA_ONLY_HEADERS_SPEC,
WAIT_ARG_SPEC,
)
from ansible_collections.kubernetes.core.plugins.module_utils.k8s.client import (
@@ -233,16 +216,15 @@ def argspec():
args = copy.deepcopy(AUTH_ARG_SPEC)
args.update(WAIT_ARG_SPEC)
args.update(
{
"kind": {"required": True},
"api_version": {"default": "v1", "aliases": ["api", "version"]},
"name": {},
"namespace": {},
"label_selectors": {"type": "list", "elements": "str", "default": []},
"field_selectors": {"type": "list", "elements": "str", "default": []},
"hidden_fields": {"type": "list", "elements": "str"},
"metadata_only": {"type": "bool", "default": False},
}
dict(
kind=dict(required=True),
api_version=dict(default="v1", aliases=["api", "version"]),
name=dict(),
namespace=dict(),
label_selectors=dict(type="list", elements="str", default=[]),
field_selectors=dict(type="list", elements="str", default=[]),
hidden_fields=dict(type="list", elements="str"),
)
)
return args
@@ -251,20 +233,8 @@ def main():
module = AnsibleK8SModule(
module_class=AnsibleModule, argument_spec=argspec(), supports_check_mode=True
)
metadata_only_headers = {}
if module.params["metadata_only"]:
metadata_only_headers = copy.deepcopy(METADATA_ONLY_HEADERS_SPEC)
metadata_only_headers.update(
{"accept": METADATA_ONLY_HEADER_VALUES["partial_object_list"]}
)
if module.params["name"]:
metadata_only_headers.update(
{"accept": METADATA_ONLY_HEADER_VALUES["partial_object"]}
)
try:
client = get_api_client(module, **metadata_only_headers)
client = get_api_client(module)
svc = K8sService(client, module)
execute_module(module, svc)
except CoreException as e:
-10
View File
@@ -36,7 +36,6 @@ options:
- If more than one C(merge_type) is given, the merge_types will be tried in order
- This defaults to C(['strategic-merge', 'merge']), which is ideal for using the same parameters
on resource kinds that combine Custom Resources and built-in resources.
- I(merge_type=json) has been deprecated and will be removed in version 7.0.0. Use M(kubernetes.core.k8s_json_patch) instead.
choices:
- json
- merge
@@ -252,15 +251,6 @@ def main():
supports_check_mode=True,
)
# Add deprecation warning for merge_type=json
merge_type = module.params.get("merge_type")
if merge_type and "json" in merge_type:
module.deprecate(
"The 'merge_type=json' option is deprecated and will be removed in version 7.0.0. Use the 'kubernetes.core.k8s_json_patch' module instead.",
version="7.0.0",
collection_name="kubernetes.core",
)
try:
client = get_api_client(module=module)
svc = K8sService(client, module)
+2 -34
View File
@@ -9,26 +9,15 @@ sonar.python.coverage.reportPaths=coverage.xml
sonar.tests=tests/unit,tests/integration
sonar.python.version=3.12
sonar.newCode.referenceBranch=main
sonar.newCode.referenceBranch=stable-6
sonar.exclusions=tests/**,.tox/**
# Exclude test code from copy/paste detection. 'sonar.exclusions' above only
# filters the *source* set (it disambiguates 'sonar.sources=.' from
# 'sonar.tests'), so test files are still indexed as tests and still scored for
# duplication. Unit tests here are unittest.TestCase classes: every class needs
# its own setUp, and per-case arrange/assert blocks are deliberately repeated so
# a failing test reads on its own. Because SonarCloud scores only *new code* on
# a pull request, any PR adding cases to an already-repetitive test module
# inherits duplication accrued across earlier PRs. Production code under
# plugins/ stays fully covered by duplication analysis.
sonar.cpd.exclusions=tests/**
# Ansible module argument_spec is conventionally defined with the dict(...)
# constructor (not {...} literals) for readability and consistency across the
# collection. Suppress python:S7498 ("prefer literal syntax"), which conflicts
# with that convention and otherwise re-fires on every new module argument.
sonar.issue.ignore.multicriteria=e1,e2,e3,e4,e5
sonar.issue.ignore.multicriteria=e1,e2,e3
sonar.issue.ignore.multicriteria.e1.ruleKey=python:S7498
sonar.issue.ignore.multicriteria.e1.resourceKey=**/*.py
@@ -45,24 +34,3 @@ sonar.issue.ignore.multicriteria.e2.resourceKey=tests/**/*.py
# to simplify maintenance. Suppress githubactions:S7637 ("use full commit SHA").
sonar.issue.ignore.multicriteria.e3.ruleKey=githubactions:S7637
sonar.issue.ignore.multicriteria.e3.resourceKey=.github/workflows/**/*.yaml
# Workflows across this repo install ansible-core from a GitHub source
# archive (required for devel/milestone builds, which have no published
# wheel) and install this collection's shared test-requirements.txt /
# requirements.txt. Suppress githubactions:S8541 ("omitting --only-binary
# :all:") repo-wide for workflow files: forcing wheel-only installs would
# break the ansible-core source install and fails outright on the
# test-requirements.txt pin coverage==4.5.4, which has no Python 3.13 wheel.
# Scoped the same way as e3 above, since a filename-only resourceKey (as
# originally used here) does not reliably suppress issues already raised
# against this project.
sonar.issue.ignore.multicriteria.e4.ruleKey=githubactions:S8541
sonar.issue.ignore.multicriteria.e4.resourceKey=.github/workflows/**/*.yaml
# Same shared test-requirements.txt / requirements.txt as above are not
# hash-locked; that is a repo-wide dependency-management concern affecting
# every existing workflow. Suppress githubactions:S8544 ("dependencies
# without locking resolved versions") repo-wide for workflow files rather
# than diverging from established practice.
sonar.issue.ignore.multicriteria.e5.ruleKey=githubactions:S8544
sonar.issue.ignore.multicriteria.e5.resourceKey=.github/workflows/**/*.yaml
+1 -1
View File
@@ -1,2 +1,2 @@
modules:
python_requires: ">=3.9"
python_requires: ">=3.6"
-46
View File
@@ -1,46 +0,0 @@
# Running Helm Integration Tests Locally
This guide explains how to run the `helm*` integration test targets locally using `ansible-test`.
## Prerequisites
- `ansible-test` available in your environment (installed with `ansible-core`)
- A Kubernetes cluster accessible via `kubectl` (for targets that interact with a cluster)
## Configuration
Create an `integration_config.yml` file under `tests/integration/` with the following variables:
```yaml
setup_helm_version: vx.x.x # e.g v4.2.1
helm_install_path: /path/to/helm/directory
```
### Variables
| Variable | Description |
|---|---|
| `setup_helm_version` | The Helm version to install (e.g. `v4.2.1`). The `v` prefix is optional and will be added automatically if omitted. |
| `helm_install_path` | Path to a directory that either already contains a `helm` executable matching the version set in `setup_helm_version`, or an empty/non-existent directory where Helm will be downloaded and installed. |
If a `helm` binary already exists at `<helm_install_path>/helm`, the setup will skip the download and use the existing binary directly.
## Running Tests
Run a specific Helm test target with:
```bash
ansible-test integration --python <version> -v --no-temp-workdir <target>
```
For example, to run the `helm` target with Python 3.12:
```bash
ansible-test integration --python 3.12 -v --no-temp-workdir helm
```
You can run multiple targets in a single command:
```bash
ansible-test integration --python 3.12 -v --no-temp-workdir helm helm_diff helm_plugin
```
+1 -4
View File
@@ -1,4 +1 @@
helm
helm_info
helm_plugin
helm_template
disabled # used by test targets helm_vX_XX_XX
@@ -1,6 +1,6 @@
---
helm_binary: "helm"
setup_helm_version_binary_path: "{{ helm_binary }}"
helm_default_archive_name: "helm-{{ helm_version }}-{{ ansible_system | lower }}-amd64.tar.gz"
helm_binary: "/tmp/helm/{{ ansible_system | lower }}-amd64/helm"
chart_test: "ingress-nginx"
chart_test_oci: "oci://registry-1.docker.io/bitnamicharts/redis"
@@ -31,4 +31,3 @@ test_namespace:
- "helm-insecure-{{ helm_version | replace('.', '-') }}"
- "helm-test-take-ownership-{{ helm_version | replace('.', '-') }}"
- "helm-skip-schema-validation-{{ helm_version | replace('.', '-') }}"
- "helm-wait-for-jobs-{{ helm_version | replace('.', '-') }}"
@@ -1,6 +0,0 @@
apiVersion: v2
name: test-chart-job
description: A chart with a Job for testing wait_for_jobs
type: application
version: 0.1.0
appVersion: "default"
@@ -1,21 +0,0 @@
apiVersion: batch/v1
kind: Job
metadata:
name: "{{ .Release.Name }}-job"
spec:
backoffLimit: 0
template:
spec:
automountServiceAccountToken: false
restartPolicy: Never
containers:
- name: test
image: "busybox:1.37"
command: ["sh", "-c", "echo done"]
resources:
requests:
cpu: "50m"
memory: "32Mi"
ephemeral-storage: "16Mi"
limits:
memory: "64Mi"
@@ -0,0 +1,96 @@
#!/usr/bin/python
# -*- coding: utf-8 -*-
# Copyright: (c) 2021, Ansible Project
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
from __future__ import absolute_import, division, print_function
__metaclass__ = type
DOCUMENTATION = r"""
---
module: helm_test_version
short_description: check helm executable version
author:
- Aubin Bikouo (@abikouo)
requirements:
- "helm (https://github.com/helm/helm/releases)"
description:
- validate version of helm binary is lower than the specified version.
options:
binary_path:
description:
- The path of a helm binary to use.
required: false
type: path
version:
description:
- version to test against helm binary.
type: str
default: 3.7.0
"""
EXAMPLES = r"""
- name: validate helm binary version is lower than 3.5.0
helm_test_version:
binary_path: path/to/helm
version: "3.5.0"
"""
RETURN = r"""
message:
type: str
description: Text message describing the test result.
returned: always
sample: 'version installed: 3.4.5 is lower than version 3.5.0'
result:
type: bool
description: Test result.
returned: always
sample: 1
"""
import re
from ansible.module_utils.basic import AnsibleModule
from ansible_collections.kubernetes.core.plugins.module_utils.version import (
LooseVersion,
)
def main():
module = AnsibleModule(
argument_spec=dict(
binary_path=dict(type="path"),
version=dict(type="str", default="3.7.0"),
),
)
bin_path = module.params.get("binary_path")
version = module.params.get("version")
if bin_path is not None:
helm_cmd_common = bin_path
else:
helm_cmd_common = "helm"
helm_cmd_common = module.get_bin_path(helm_cmd_common, required=True)
rc, out, err = module.run_command([helm_cmd_common, "version"])
if rc != 0:
module.fail_json(msg="helm version failed.", err=err, out=out, rc=rc)
m = re.match(r'version.BuildInfo{Version:"v([0-9\.]*)",', out)
installed_version = m.group(1)
message = "version installed: %s" % installed_version
if LooseVersion(installed_version) < LooseVersion(version):
message += " is lower than version %s" % version
module.exit_json(changed=False, result=True, message=message)
else:
message += " is greater than version %s" % version
module.exit_json(changed=False, result=False, message=message)
if __name__ == "__main__":
main()
@@ -1,5 +1,3 @@
---
dependencies:
- setup_helm_version
collections:
- kubernetes.core
+15 -4
View File
@@ -1,11 +1,22 @@
---
- name: Ensure helm is not installed
ansible.builtin.file:
path: "/tmp/helm"
file:
path: "{{ item }}"
state: absent
with_items:
- "/tmp/helm"
- name: Check failed if helm is not installed
ansible.builtin.include_tasks: test_helm_not_installed.yml
include_tasks: test_helm_not_installed.yml
- name: Install Helm v4
ansible.builtin.include_role:
name: install_helm
vars:
helm_version: v3.6.0
- name: Test helm uninstall
ansible.builtin.include_tasks: test_helm_uninstall.yml
- name: Run tests
ansible.builtin.include_tasks: run_test.yml
include_tasks: run_test.yml
@@ -1,18 +1,22 @@
---
- name: "Install {{ helm_version }}"
include_role:
name: install_helm
- name: Main helm tests
block:
- name: Install helm-diff plugin
helm_plugin:
binary_path: "{{ helm_binary }}"
plugin_path: https://github.com/databus23/helm-diff
plugin_version: "{{ helm_version | string is ansible.builtin.version('4.0.0', '>=') | ternary('v3.14.0', 'v3.10.0') }}"
plugin_version: "{{ helm_version is version('v4.0.0', '>=') | ternary('v3.14.0', 'v3.10.0') }}"
verify: false
- name: "Ensure we honor the environment variables"
ansible.builtin.include_tasks: test_read_envvars.yml
include_tasks: test_read_envvars.yml
- name: Deploy charts
ansible.builtin.include_tasks: "tests_chart/{{ test_chart_type }}.yml"
include_tasks: "tests_chart/{{ test_chart_type }}.yml"
loop_control:
loop_var: test_chart_type
with_items:
@@ -20,34 +24,30 @@
- from_repository
- from_url
- name: Test helm upgrade with reuse_values
ansible.builtin.include_tasks: test_helm_reuse_values.yml
- name: test helm upgrade with reuse_values
include_tasks: test_helm_reuse_values.yml
- name: Test helm upgrade with reset_then_reuse_values
ansible.builtin.include_tasks: test_helm_reset_then_reuse_values.yml
when: helm_version | string is ansible.builtin.version('3.14.0', '>=')
- name: test helm upgrade with reset_then_reuse_values
include_tasks: test_helm_reset_then_reuse_values.yml
- name: Test helm dependency update
ansible.builtin.include_tasks: test_up_dep.yml
- name: test helm dependency update
include_tasks: test_up_dep.yml
- name: Test helm install with chart name containing space
ansible.builtin.include_tasks: test_helm_with_space_into_chart_name.yml
include_tasks: test_helm_with_space_into_chart_name.yml
# https://github.com/ansible-collections/community.kubernetes/issues/296
- name: Test Skip CRDS feature in helm chart install
ansible.builtin.include_tasks: test_crds.yml
include_tasks: test_crds.yml
- name: Test insecure registry flag feature
ansible.builtin.include_tasks: test_helm_insecure.yml
include_tasks: test_helm_insecure.yml
- name: Test take ownership flag feature
ansible.builtin.include_tasks: test_helm_take_ownership.yml
include_tasks: test_helm_take_ownership.yml
- name: Test helm skip_schema_validation
ansible.builtin.include_tasks: test_skip_schema_validation.yml
- name: Test helm wait_for_jobs
ansible.builtin.include_tasks: test_helm_wait_for_jobs.yml
include_tasks: test_skip_schema_validation.yml
always:
- name: Remove helm-diff plugin
@@ -14,7 +14,7 @@
register: install
- name: Validate that insecure flag is not set
ansible.builtin.assert:
assert:
that:
- install is changed
- '"--insecure-skip-tls-verify" not in install.command'
@@ -30,18 +30,18 @@
ignore_errors: true
- name: Validate that insecure flag IS set if helm version is >= 3.16.0
ansible.builtin.assert:
assert:
that:
- install is changed
- '"--insecure-skip-tls-verify" in install.command'
when: helm_version | string is ansible.builtin.version("3.16.0", ">=")
when: '"v3.16.0" <= helm_version'
- name: Validate that feature fails for helm < 3.16.0
ansible.builtin.assert:
assert:
that:
- install is failed
- '"insecure_skip_tls_verify requires helm >= 3.16.0" in install.msg'
when: helm_version | string is ansible.builtin.version("3.16.0", "<")
when: 'helm_version < "v3.16.0"'
always:
- name: Remove helm namespace
@@ -1,7 +1,7 @@
---
- name: Failed test when helm is not installed
helm:
binary_path: "{{ helm_binary }}_fake"
binary_path: "{{ helm_binary}}_fake"
name: test
chart_ref: "{{ chart_test }}"
namespace: "helm-test"
@@ -9,7 +9,15 @@
register: helm_missing_binary
- name: Assert that helm is not installed
ansible.builtin.assert:
assert:
that:
- helm_missing_binary is failed
- "'No such file or directory' in helm_missing_binary.msg"
when: ansible_version.full is version('2.20', '<')
- name: Assert that helm is not installed (ansible 2.20+)
assert:
that:
- helm_missing_binary is failed
- "'Error executing command' in helm_missing_binary.msg"
when: ansible_version.full is version('2.20', '>=')
@@ -32,7 +32,7 @@
register: release_value
- name: Validate that chart values are as expected
ansible.builtin.assert:
assert:
that:
- install is changed
- '"--reset-then-reuse-values" not in install.command'
@@ -80,7 +80,7 @@
register: release_value
- name: Validate that chart values are as expected
ansible.builtin.assert:
assert:
that:
- upgrade is changed
- '"--reset-then-reuse-values" in upgrade.command'
@@ -32,7 +32,7 @@
register: release_value
- name: Validate that chart values are as expected
ansible.builtin.assert:
assert:
that:
- install is changed
- '"--reuse-values=True" not in install.command'
@@ -72,7 +72,7 @@
register: release_value
- name: Validate that chart values are as expected
ansible.builtin.assert:
assert:
that:
- upgrade is changed
- '"--reuse-values=True" in upgrade.command'
@@ -14,7 +14,7 @@
register: install
- name: Validate that take-ownership flag is not set
ansible.builtin.assert:
assert:
that:
- install is changed
- '"--take-ownership" not in install.command'
@@ -50,18 +50,18 @@
ignore_errors: true
- name: Validate that take-ownership flag IS set if helm version is >= 3.17.0
ansible.builtin.assert:
assert:
that:
- upgrade is changed
- '"--take-ownership" in upgrade.command'
when: helm_version | string is ansible.builtin.version("3.17.0", ">=")
when: '"v3.17.0" <= helm_version'
- name: Validate that feature fails for helm < 3.17.0
ansible.builtin.assert:
assert:
that:
- upgrade is failed
- '"take_ownership requires helm >= 3.17.0" in upgrade.msg'
when: helm_version | string is ansible.builtin.version("3.17.0", "<")
when: 'helm_version < "v3.17.0"'
- name: Upgrade chart (take-onwership flag not set)
helm:
@@ -79,18 +79,18 @@
ignore_errors: true
- name: Validate that take-ownership flag IS set if helm version is >= 3.17.0
ansible.builtin.assert:
assert:
that:
- upgrade is changed
- '"--take-ownership" not in upgrade.command'
when: helm_version | string is ansible.builtin.version("3.17.0", ">=")
when: '"v3.17.0" <= helm_version'
- name: Validate that feature fails for helm < 3.17.0
ansible.builtin.assert:
assert:
that:
- upgrade is changed
- upgrade.msg is not defined
when: helm_version | string is ansible.builtin.version("3.17.0", "<")
when: 'helm_version < "v3.17.0"'
always:
- name: Remove helm namespace
@@ -0,0 +1,97 @@
- name: validate helm version lower than 3.7.0
helm_test_version:
binary_path: "{{ helm_binary }}"
version: "3.7.0"
register: test_version
- vars:
chart_source: "https://github.com/kubernetes/kube-state-metrics/releases/download/kube-state-metrics-helm-chart-2.13.3/kube-state-metrics-2.13.3.tgz"
chart_name: "test-wait-uninstall"
chart_name_pending: "test-uninstall-pending-release"
helm_namespace: "{{ test_namespace[1] }}"
block:
- name: Install chart
helm:
binary_path: "{{ helm_binary }}"
name: "{{ chart_name }}"
chart_ref: "{{ chart_source }}"
namespace: "{{ helm_namespace }}"
create_namespace: true
- name: Delete chart with wait
helm:
state: absent
binary_path: "{{ helm_binary }}"
name: "{{ chart_name }}"
namespace: "{{ helm_namespace }}"
wait: yes
register: uninstall
- name: assert warning has been raised
assert:
that:
- uninstall.warnings is defined
- '"helm uninstall support option --wait for helm release >= 3.7.0" in uninstall.warnings'
- name: Install Helm v4
ansible.builtin.include_role:
name: install_helm
vars:
helm_version: v4.0.0
- name: Install chart
helm:
binary_path: "{{ helm_binary }}"
name: "{{ chart_name }}"
chart_ref: "{{ chart_source }}"
namespace: "{{ helm_namespace }}"
create_namespace: true
- name: uninstall chart again using recent version
helm:
state: absent
binary_path: "{{ helm_binary }}"
name: "{{ chart_name }}"
namespace: "{{ helm_namespace }}"
wait: yes
register: uninstall
# Test uninstall chart release with 'pending-install' status
- name: Create chart release with 'pending-install' status
helm_test_pending:
binary_path: "{{ helm_binary }}"
chart_ref: "{{ chart_source }}"
chart_release: "{{ chart_name_pending }}"
chart_release_namespace: "{{ helm_namespace }}"
- name: Uninstall chart release with 'pending-install' status
helm:
binary_path: "{{ helm_binary }}"
release_name: "{{ chart_name_pending }}"
namespace: "{{ helm_namespace }}"
release_state: absent
register: _uninstall
- name: Get Helm release details
helm_info:
binary_path: "{{ helm_binary }}"
release_namespace: "{{ helm_namespace }}"
release_state: pending
release_name: "{{ chart_name_pending }}"
register: _info
- name: assert release does not exist anymore
assert:
that:
- _uninstall is changed
- _info.status is undefined
always:
- name: Remove namespace
k8s:
kind: Namespace
name: "{{ helm_namespace }}"
state: absent
ignore_errors: true
when: test_version.result
@@ -1,59 +0,0 @@
---
- name: Test helm wait_for_jobs
vars:
helm_namespace: "{{ test_namespace[15] }}"
chart_local: "{{ role_path }}/files/test-chart-job"
block:
- name: Install chart with wait and wait_for_jobs
helm:
binary_path: "{{ helm_binary }}"
chart_ref: "{{ chart_local }}"
release_name: test-wait-for-jobs
release_namespace: "{{ helm_namespace }}"
create_namespace: true
wait: true
wait_for_jobs: true
wait_timeout: "120s"
register: install
ignore_errors: true
- name: Validate wait_for_jobs with helm >= 3.5.0 works
ansible.builtin.assert:
that:
- install is changed
- "'--wait' in install.command"
- "'--wait-for-jobs' in install.command"
when: "helm_version | string is ansible.builtin.version('3.5.0', '>=')"
- name: Validate wait_for_jobs with helm < 3.5.0 fails
ansible.builtin.assert:
that:
- install is failed
- "'wait_for_jobs requires helm >= 3.5.0' in install.msg"
when: "helm_version | string is ansible.builtin.version('3.5.0', '<')"
- name: Install chart with wait_for_jobs but without wait
helm:
binary_path: "{{ helm_binary }}"
chart_ref: "{{ chart_local }}"
release_name: test-wait-for-jobs-no-wait
release_namespace: "{{ helm_namespace }}"
create_namespace: true
wait_for_jobs: true
register: install_no_wait
- name: Validate wait_for_jobs is ignored without wait
ansible.builtin.assert:
that:
- install_no_wait is changed
- "'--wait-for-jobs' not in install_no_wait.command"
- "'--wait' not in install_no_wait.command"
always:
- name: Remove helm namespace
k8s:
api_version: v1
kind: Namespace
name: "{{ helm_namespace }}"
state: absent
@@ -27,7 +27,7 @@
register: install_chart
- name: Assert that chart is installed
ansible.builtin.assert:
assert:
that:
- install_chart is changed
- install_chart.status.status | lower == 'deployed'
@@ -40,7 +40,7 @@
register: chart_info
- name: Assert that Chart is installed (using helm_info)
ansible.builtin.assert:
assert:
that:
- chart_info.status.status | lower == 'deployed'
@@ -22,22 +22,22 @@
ignore_errors: true
- name: Debug install result
ansible.builtin.debug:
debug:
var: install
- name: Validate skip_schema_validation with helm >= 3.16.0 works
ansible.builtin.assert:
assert:
that:
- install is changed
- "'--skip-schema-validation' in install.command"
when: "helm_version | string is ansible.builtin.version('3.16.0', '>=')"
when: "helm_version is ansible.builtin.version('v3.16.0', '>=')"
- name: Validate skip_schema_validation with helm < 3.16.0 fails
ansible.builtin.assert:
assert:
that:
- install is failed
- "'skip_schema_validation requires helm >= 3.16.0' in install.msg"
when: "helm_version | string is ansible.builtin.version('3.16.0', '<')"
when: "helm_version is ansible.builtin.version('v3.16.0', '<')"
always:
- name: Remove helm namespace
@@ -3,8 +3,8 @@
vars:
helm_namespace: "{{ test_namespace[3] }}"
block:
- name: Copy chart
ansible.builtin.copy:
- name: copy chart
copy:
src: "{{ item }}"
dest: /tmp
loop:
@@ -19,16 +19,16 @@
chart_version: "{{ chart_source_version | default(omit) }}"
namespace: "{{ helm_namespace }}"
dependency_update: false
create_namespace: true
create_namespace: yes
register: release
- name: "Get stats of the subchart"
ansible.builtin.stat:
stat:
path: "/tmp/test-chart/Chart.lock"
register: stat_result
- name: "Check if the subchart not exist in chart"
ansible.builtin.assert:
assert:
that:
- not stat_result.stat.exists
success_msg: "subchart not exist in the chart directory"
@@ -41,12 +41,12 @@
chart_ref: "/tmp/test-chart"
chart_version: "{{ chart_source_version | default(omit) }}"
namespace: "{{ helm_namespace }}"
create_namespace: true
create_namespace: yes
dependency_update: true
ignore_errors: true
register: release
- ansible.builtin.assert:
- assert:
that:
- release.warnings[0] == "There is no dependencies block defined in Chart.yaml. Dependency update will not be performed. Please consider add dependencies block or disable dependency_update to remove this warning."
success_msg: "warning when there is no dependencies block with dependency_update enabled"
@@ -59,16 +59,16 @@
chart_version: "{{ chart_source_version | default(omit) }}"
namespace: "{{ helm_namespace }}"
dependency_update: true
create_namespace: true
create_namespace: yes
register: release
- name: "Get stats of the subchart"
ansible.builtin.stat:
stat:
path: "/tmp/dep-up/Chart.lock"
register: stat_result
- name: "Check if the subchart exists in chart"
ansible.builtin.assert:
assert:
that:
- stat_result.stat.exists
success_msg: "subchart exist in the chart directory"
@@ -82,7 +82,7 @@
state: absent
- name: "Remove charts"
ansible.builtin.file:
file:
state: absent
path: "/tmp/{{ item }}"
loop:
@@ -92,8 +92,8 @@
# Helm_template module
- name: "Test dependency update for helm_template module"
block:
- name: Copy chart
ansible.builtin.copy:
- name: copy chart
copy:
src: "{{ item }}"
dest: /tmp
loop:
@@ -110,7 +110,7 @@
register: result
- name: "Get stats of the subchart"
ansible.builtin.stat:
stat:
path: "{{ item }}"
register: stat_result
loop:
@@ -118,7 +118,7 @@
- /tmp/dep_up/charts/test-chart/templates/configmap.yaml
- name: "Check if the subchart exist in chart"
ansible.builtin.assert:
assert:
that:
- stat_result.results[0].stat.exists
- stat_result.results[1].stat.exists
@@ -135,7 +135,7 @@
register: result
- name: "Get stats of the subchart"
ansible.builtin.stat:
stat:
path: "{{ item }}"
register: stat_result
loop:
@@ -143,7 +143,7 @@
- /tmp/test-chart/templates/configmap.yaml
- name: "Check if the subchart not exist in chart"
ansible.builtin.assert:
assert:
that:
- not stat_result.results[0].stat.exists
- stat_result.results[1].stat.exists
@@ -152,7 +152,7 @@
always:
- name: "Remove charts"
ansible.builtin.file:
file:
state: absent
path: "/tmp/{{ item }}"
loop:
@@ -5,12 +5,12 @@
chart_release_replaced_name: "test-{{ chart_name | default(source) }}-001"
block:
- name: Create temp directory
ansible.builtin.tempfile:
tempfile:
state: directory
register: tmpdir
- name: Set temp directory fact
ansible.builtin.set_fact:
set_fact:
temp_dir: "{{ tmpdir.path }}"
- name: Check helm_info empty
@@ -21,7 +21,7 @@
register: empty_info
- name: "Assert that no charts are installed with helm_info"
ansible.builtin.assert:
assert:
that:
- empty_info.status is undefined
@@ -36,7 +36,7 @@
register: install_fail
- name: "Assert that Install fail {{ chart_test }} from {{ source }}"
ansible.builtin.assert:
assert:
that:
- install_fail is failed
- "'Error: create: failed to create: namespaces \"' + helm_namespace + '\" not found' in install_fail.stderr"
@@ -53,7 +53,7 @@
check_mode: true
- name: "Assert that {{ chart_test }} chart is installed from {{ source }} in check mode"
ansible.builtin.assert:
assert:
that:
- install_check_mode is changed
- install_check_mode.status is defined
@@ -70,7 +70,7 @@
register: install
- name: "Assert that {{ chart_test }} chart version {{ chart_test_version }} is installed from {{ source }}"
ansible.builtin.assert:
assert:
that:
- install is changed
- install.status.chart == chart_test+"-"+chart_test_version
@@ -94,7 +94,7 @@
register: release_state_content_info
- name: "Assert that {{ chart_test }} chart version {{ chart_test_version }} is installed from {{ source }} with helm_info"
ansible.builtin.assert:
assert:
that:
- content_info.status.chart == chart_test+"-"+chart_test_version
- content_info.status.status | lower == 'deployed'
@@ -111,7 +111,7 @@
diff: true
- name: Assert idempotency
ansible.builtin.assert:
assert:
that:
- install is not changed
- install.status.chart == chart_test+"-"+chart_test_version
@@ -128,7 +128,7 @@
register: install
- name: "Assert that {{ chart_test }} chart is upgraded with new var from {{ source }}"
ansible.builtin.assert:
assert:
that:
- install is changed
- install.status.status | lower == 'deployed'
@@ -147,7 +147,7 @@
diff: true
- name: Assert idempotency after add vars
ansible.builtin.assert:
assert:
that:
- install is not changed
- install.status.status | lower == 'deployed'
@@ -164,7 +164,7 @@
register: install
- name: "Assert that {{ chart_test }} chart is upgraded with new var from {{ source }}"
ansible.builtin.assert:
assert:
that:
- install is changed
- install.status.status | lower == 'deployed'
@@ -182,7 +182,7 @@
diff: true
- name: Assert idempotency after removing vars
ansible.builtin.assert:
assert:
that:
- install is not changed
- install.status.status | lower == 'deployed'
@@ -199,7 +199,7 @@
register: install
- name: "Assert that {{ chart_test }} chart is upgraded with new version from {{ source }}"
ansible.builtin.assert:
assert:
that:
- install is changed
- install.status.status | lower == 'deployed'
@@ -216,7 +216,7 @@
diff: true
- name: Assert idempotency after upgrade
ansible.builtin.assert:
assert:
that:
- install is not changed
- install.status.status | lower == 'deployed'
@@ -231,7 +231,7 @@
register: install
- name: "Assert that {{ chart_test }} chart is removed from {{ source }}"
ansible.builtin.assert:
assert:
that:
- install is changed
@@ -245,7 +245,7 @@
diff: true
- name: Assert idempotency
ansible.builtin.assert:
assert:
that:
- install is not changed
@@ -260,7 +260,7 @@
register: install
- name: "Assert that {{ chart_test }} chart is installed from {{ source }}"
ansible.builtin.assert:
assert:
that:
- install is changed
@@ -269,12 +269,12 @@
binary_path: "{{ helm_binary }}"
state: absent
name: "{{ chart_release_replaced_name }}"
purge: false
purge: False
namespace: "{{ helm_namespace }}"
register: install
- name: Check if chart is removed
ansible.builtin.assert:
assert:
that:
- install is changed
@@ -285,11 +285,11 @@
chart_ref: "{{ chart_source }}"
chart_version: "{{ chart_test_version }}"
namespace: "{{ helm_namespace }}"
replace: true
replace: True
register: install
- name: "Assert that {{ chart_test }} chart is installed from {{ source }}"
ansible.builtin.assert:
assert:
that:
- install is changed
@@ -302,7 +302,7 @@
register: install
- name: Check if chart is removed
ansible.builtin.assert:
assert:
that:
- install is changed
@@ -318,7 +318,7 @@
register: install
- name: "Assert that {{ chart_test }} chart has var from {{ source }}"
ansible.builtin.assert:
assert:
that:
- install is changed
- install.status.status | lower == 'deployed'
@@ -337,7 +337,7 @@
register: install
- name: "Assert the result is consistent"
ansible.builtin.assert:
assert:
that:
- not (install is changed)
@@ -358,7 +358,7 @@
- "{{ role_path }}/files/values.yaml"
register: result
- ansible.builtin.assert:
- assert:
that:
- result is changed
- result is not failed
@@ -366,11 +366,11 @@
- result.command is match(helm_binary+" template "+chart_source)
- name: Check templates created
ansible.builtin.stat:
stat:
path: "{{ temp_dir }}/{{ chart_test }}/templates"
register: result
- ansible.builtin.assert:
- assert:
that:
result.stat.exists
@@ -379,7 +379,7 @@
binary_path: "{{ helm_binary }}"
chart_ref: "{{ chart_source }}"
chart_version: "{{ chart_test_version }}"
disable_hook: true
disable_hook: True
release_name: "myrelease"
release_namespace: "myreleasenamespace"
show_only:
@@ -389,7 +389,7 @@
register: result
when: chart_source is search("test-chart")
- ansible.builtin.assert:
- assert:
that:
- result is changed
- result is not failed
@@ -412,14 +412,14 @@
register: result
- name: Assert that release fails with non-existent context
ansible.builtin.assert:
assert:
that:
- result is failed
- "'context \"does-not-exist\" does not exist' in result.stderr"
always:
- name: Clean up temp dir
ansible.builtin.file:
file:
state: absent
path: "{{ temp_dir }}"
ignore_errors: true
@@ -1,2 +1,3 @@
---
helm_binary: "/tmp/helm/{{ ansible_system | lower }}-amd64/helm"
helm_namespace: helm-diff
@@ -1,6 +1,5 @@
---
dependencies:
- remove_namespace
- install_helm
- setup_helm_registry
- setup_helm
- setup_helm_version
@@ -0,0 +1,7 @@
---
- connection: local
gather_facts: true
hosts: localhost
roles:
- helm_diff
+5
View File
@@ -0,0 +1,5 @@
#!/usr/bin/env bash
set -eux
export ANSIBLE_CALLBACKS_ENABLED=profile_tasks
export ANSIBLE_ROLES_PATH=../
ansible-playbook playbook.yaml "$@"
@@ -1,8 +1,4 @@
---
- name: Define default value for helm binary path
ansible.builtin.set_fact:
helm_binary: "{{ setup_helm_binary_path | default('helm') }}"
- name: Test helm diff functionality
vars:
test_chart_ref: "/tmp/test-chart"
@@ -14,11 +10,10 @@
binary_path: "{{ helm_binary }}"
state: present
plugin_path: https://github.com/databus23/helm-diff
verify: false
plugin_version: "{{ helm_version | string is ansible.builtin.version('4.0.0', '>=') | ternary('3.14.0', '3.10.0') }}"
plugin_version: 3.9.13
- name: Copy test chart
ansible.builtin.copy:
copy:
src: "test-chart/"
dest: "{{ test_chart_ref }}"
@@ -31,13 +26,13 @@
create_namespace: true
register: install
- ansible.builtin.assert:
- assert:
that:
- install is changed
- name: Modify local chart
ansible.builtin.blockinfile:
create: true
blockinfile:
create: yes
path: "{{ test_chart_ref }}/templates/anothermap.yaml"
block: !unsafe |
apiVersion: v1
@@ -60,7 +55,7 @@
- name: Check if helm diff check is correct
vars:
foo_bar_value: "+ foo: bar"
ansible.builtin.assert:
assert:
that:
- foo_bar_value in diff_result.diff.prepared
@@ -72,7 +67,7 @@
chart_ref: "{{ test_chart_ref }}"
register: install
- ansible.builtin.assert:
- assert:
that:
- install is changed
@@ -82,12 +77,12 @@
name: test-chart
namespace: "{{ helm_namespace }}"
chart_ref: "{{ test_chart_ref }}"
check_mode: true
check_mode: yes
diff: true
register: diff_result
- name: Check if no diff in check mode when no change
ansible.builtin.assert:
assert:
that:
- '"diff" not in diff_result'
@@ -99,12 +94,12 @@
chart_ref: "{{ test_chart_ref }}"
register: install
- ansible.builtin.assert:
- assert:
that:
- install is not changed
- name: Modify values
ansible.builtin.blockinfile:
blockinfile:
create: true
path: "{{ test_chart_ref }}/values.yml"
block: |
@@ -121,7 +116,7 @@
- "{{ test_chart_ref }}/values.yml"
register: install
- ansible.builtin.assert:
- assert:
that:
- install is changed
@@ -135,7 +130,7 @@
- "{{ test_chart_ref }}/values.yml"
register: install
- ansible.builtin.assert:
- assert:
that:
- install is not changed
@@ -151,7 +146,7 @@
- "{{ test_chart_ref }}/values.yml"
register: install
- ansible.builtin.assert:
- assert:
that:
- install is changed
@@ -167,7 +162,7 @@
- "{{ test_chart_ref }}/values.yml"
register: install
- ansible.builtin.assert:
- assert:
that:
- install is not changed
@@ -186,7 +181,7 @@
value_type: string
register: install
- ansible.builtin.assert:
- assert:
that:
- install is changed
@@ -205,7 +200,7 @@
value_type: string
register: install
- ansible.builtin.assert:
- assert:
that:
- install is not changed
@@ -218,7 +213,7 @@
ignore_errors: true
- name: Define chart variables
ansible.builtin.set_fact:
set_fact:
test_chart_values:
myValue: 'Some ConfigMap data value'
myConfigmapName: 'ansible-config-from-url'
@@ -252,9 +247,7 @@
path: '{{ _tmpd.path }}'
- name: Log into Helm registry
ansible.builtin.shell: >-
echo 'pass123!' | {{ helm_binary }} registry login -u testuser --password-stdin localhost:6035
{{ helm_version | string is ansible.builtin.version("3.18.0", ">=") | ternary('--plain-http', '--insecure') }}
ansible.builtin.command: "{{ helm_binary }} registry login -u testuser -p 'pass123!' localhost:6035"
- name: Install chart from remote URL
helm:
@@ -264,7 +257,6 @@
namespace: "{{ helm_namespace }}"
name: another-chart
release_values: "{{ test_chart_values }}"
plain_http: "{{ helm_version | string is ansible.builtin.version('3.13.0', '>=') }}"
- name: Upgrade chart
helm:
@@ -274,21 +266,44 @@
namespace: "{{ helm_namespace }}"
name: another-chart
release_values: "{{ test_chart_values }}"
plain_http: "{{ helm_version | string is ansible.builtin.version('3.13.0', '>=') }}"
check_mode: true
register: _upgrade
- name: Assert that module raised a warning
ansible.builtin.assert:
assert:
that:
- not _upgrade.changed
- _upgrade.warnings is defined
- _upgrade.warnings | length == 1
- _upgrade.warnings[0] == "The default idempotency check can fail to report changes in certain cases. Install helm diff >= 3.4.1 for better results."
- name: Install helm diff (version=3.4.1)
helm_plugin:
binary_path: "{{ helm_binary }}"
state: present
plugin_path: https://github.com/databus23/helm-diff
plugin_version: 3.4.1
- name: Upgrade chart once again
helm:
binary_path: "{{ helm_binary }}"
chart_ref: "{{ test_chart_ref_url }}"
chart_version: 0.1.0
namespace: "{{ helm_namespace }}"
name: another-chart
release_values: "{{ test_chart_values }}"
check_mode: true
register: _upgrade_2
- name: Assert that module raised a warning
assert:
that:
- _upgrade_2.changed
- _upgrade_2.warnings is not defined
always:
- name: Remove chart directory
ansible.builtin.file:
file:
path: "{{ test_chart_ref }}"
state: absent
ignore_errors: true
@@ -309,7 +324,6 @@
wait: true
ignore_errors: true
- ansible.builtin.include_tasks: reuse_values.yml
- include_tasks: reuse_values.yml
- ansible.builtin.include_tasks: reset_then_reuse_values.yml
when: helm_version | string is ansible.builtin.version('3.8.0', '>')
- include_tasks: reset_then_reuse_values.yml
@@ -1,6 +1,6 @@
---
- name: Create temporary directory for helm chart
ansible.builtin.tempfile:
tempfile:
suffix: .helm
state: directory
register: helm_dir
@@ -16,8 +16,7 @@
binary_path: "{{ helm_binary }}"
state: present
plugin_path: https://github.com/databus23/helm-diff
verify: false
plugin_version: "{{ helm_version | string is ansible.builtin.version('4.0.0', '>=') | ternary('3.14.0', '3.10.0') }}"
plugin_version: 3.9.14
- name: Copy test chart
ansible.builtin.copy:
@@ -59,7 +58,7 @@
register: helm_upgrade
- name: Ensure task did not reported change
ansible.builtin.assert:
assert:
that:
- helm_upgrade is not changed
@@ -76,7 +75,7 @@
register: helm_upgrade
- name: Ensure task reported change
ansible.builtin.assert:
assert:
that:
- helm_upgrade is changed
@@ -89,24 +88,19 @@
ignore_errors: true
- name: Delete Helm folders
ansible.builtin.file:
file:
path: /tmp/helm/
state: absent
- name: Install old version of helm
ansible.builtin.include_role:
name: setup_helm
name: install_helm
vars:
setup_helm_version: "v3.8.0"
helm_install_path: "{{ helm_dir.path }}/helm_v3_8_0"
- name: Set path to helm binary v3.8.0
ansible.builtin.set_fact:
helm_binary_path_v3_8_0: "{{ helm_dir.path }}/helm_v3_8_0/helm"
helm_version: "v3.8.0"
- name: Upgrade helm release (with reset_then_reuse_values=true)
kubernetes.core.helm:
binary_path: "{{ helm_binary_path_v3_8_0 }}"
binary_path: "{{ helm_binary }}"
chart_ref: "{{ test_chart_path }}"
reuse_values: false
reset_then_reuse_values: true
@@ -118,26 +112,25 @@
ignore_errors: true
- name: Debug
ansible.builtin.debug:
debug:
var: helm_upgrade
- name: Ensure warning for Helm version
ansible.builtin.assert:
assert:
that:
- helm_upgrade is failed
- '"reset_then_reuse_values requires helm >= 3.14.0, current version is" in helm_upgrade.msg'
- name: Install helm diff
helm_plugin:
binary_path: "{{ helm_binary_path_v3_8_0 }}"
binary_path: "{{ helm_binary }}"
state: present
plugin_path: https://github.com/databus23/helm-diff
plugin_version: "3.8.0"
verify: false
- name: Upgrade helm release (with reset_then_reuse_values=true)
kubernetes.core.helm:
binary_path: "{{ helm_binary_path_v3_8_0 }}"
binary_path: "{{ helm_binary }}"
chart_ref: "{{ test_chart_path }}"
reuse_values: false
reset_then_reuse_values: true
@@ -149,23 +142,23 @@
ignore_errors: true
- name: Debug
ansible.builtin.debug:
debug:
var: helm_upgrade
- name: Ensure warning for Helm Diff version
ansible.builtin.assert:
assert:
that:
- helm_upgrade is failed
- '"reset_then_reuse_values requires helm diff >= 3.9.12, current version is" in helm_upgrade.msg'
always:
- name: Delete Helm folders
ansible.builtin.file:
file:
path: /tmp/helm/
state: absent
- name: Remove temporary directory
ansible.builtin.file:
file:
path: "{{ helm_dir.path }}"
state: absent
ignore_errors: true
@@ -1,6 +1,6 @@
---
- name: Create temporary directory for helm chart
ansible.builtin.tempfile:
tempfile:
suffix: .helm
state: directory
register: helm_dir
@@ -17,8 +17,7 @@
binary_path: "{{ helm_binary }}"
state: present
plugin_path: https://github.com/databus23/helm-diff
verify: false
plugin_version: "{{ helm_version | string is ansible.builtin.version('4.0.0', '>=') | ternary('3.14.0', '3.10.0') }}"
plugin_version: 3.9.4
- name: Copy test chart
ansible.builtin.copy:
@@ -51,7 +50,7 @@
register: helm_upgrade
- name: Ensure task did not reported change
ansible.builtin.assert:
assert:
that:
- helm_upgrade is not changed
@@ -67,7 +66,7 @@
register: helm_upgrade
- name: Ensure task reported change
ansible.builtin.assert:
assert:
that:
- helm_upgrade is changed
@@ -4,4 +4,7 @@ test_namespace:
- "helm-in-memory-kubeconfig"
- "helm-kubeconfig-with-ca-cert"
- "helm-kubeconfig-with-insecure-skip-tls-verify"
helm_binary: helm
helm_versions:
- v3.10.3
- v3.16.4
- v4.0.0
@@ -1,2 +1,5 @@
---
- ansible.builtin.include_tasks: run_tests.yml
loop: "{{ helm_versions }}"
loop_control:
loop_var: helm_version
@@ -1,6 +1,10 @@
---
- name: Run tests
- name: Run tests with helm version "{{ helm_version }}"
block:
- name: "Install Helm"
ansible.builtin.include_role:
name: install_helm
- name: Test helm with in-memory kubeconfig
ansible.builtin.include_tasks: "from_in_memory_kubeconfig.yml"
@@ -1,3 +0,0 @@
time=10
helm
helm_template
@@ -1,17 +0,0 @@
---
helm_oci_namespace: helm-oci-registry-progress
test_namespace: "{{ helm_oci_namespace }}"
# Matches the registry stood up by the setup_helm_registry role.
helm_oci_registry: "localhost:6035"
helm_oci_registry_username: testuser
helm_oci_registry_password: 'pass123!'
helm_oci_repo_path: testing
helm_oci_chart_name: test-chart-plus-version
# '+' is not allowed in an OCI tag, so Helm stores this as '1.0.0_build.1'.
helm_oci_chart_version: 1.0.0+build.1
# A version without build metadata, to cover the case where the progress messages
# happen to be valid YAML and so corrupt the parsed output silently.
helm_oci_chart_version_plain: 1.0.1
helm_binary: "helm"
@@ -1,6 +0,0 @@
apiVersion: v2
name: test-chart-plus-version
description: A chart whose version carries semver build metadata
type: application
version: 1.0.0+build.1
appVersion: "default"
@@ -1,6 +0,0 @@
apiVersion: v1
kind: ConfigMap
metadata:
name: test-chart-plus-version-configmap
data:
myValue: test
@@ -1,5 +0,0 @@
---
dependencies:
- remove_namespace
- setup_helm_registry
- setup_helm_version
@@ -1,155 +0,0 @@
---
# Regression test for https://github.com/ansible-collections/kubernetes.core/issues/1222
#
# Helm >= 4.2.1 writes OCI registry progress messages to stdout rather than stderr
# (helm/helm#32056): 'Pulled:', 'Digest:' and, when the reference contains an
# underscore, a free-text explanation. Helm rewrites '+' to '_' in OCI tags, so a
# chart version carrying semver build metadata is what triggers that explanation,
# which is not valid YAML.
#
# The helm module parses the stdout of 'helm show chart', and helm_template returns
# the stdout of 'helm template' as its documented result, so both have to skip those
# messages. Without the fix, the helm task below fails with
# "could not find expected ':'".
- name: Test OCI charts whose version contains build metadata
# Helm >= 4.2.1 is required for this test to be meaningful: that is the release which
# moved the OCI registry progress messages from stderr to stdout (helm/helm#32056).
when: helm_version | string is ansible.builtin.version('4.2.1', '>=')
vars:
chart_ref: "oci://{{ helm_oci_registry }}/{{ helm_oci_repo_path }}/{{ helm_oci_chart_name }}"
block:
- name: Create temporary directory to hold the chart
ansible.builtin.tempfile:
state: directory
suffix: .chart
register: _tmpd
- name: Copy the test chart
ansible.builtin.copy:
src: "{{ helm_oci_chart_name }}"
dest: "{{ _tmpd.path }}/"
- name: Log into the helm registry
ansible.builtin.command: >-
{{ helm_binary }} registry login --plain-http
-u {{ helm_oci_registry_username }} -p {{ helm_oci_registry_password }}
{{ helm_oci_registry }}
- name: Package and push both chart versions
ansible.builtin.command: "{{ item }}"
loop:
- >-
{{ helm_binary }} package {{ _tmpd.path }}/{{ helm_oci_chart_name }}
--version {{ helm_oci_chart_version }} --destination {{ _tmpd.path }}
- >-
{{ helm_binary }} package {{ _tmpd.path }}/{{ helm_oci_chart_name }}
--version {{ helm_oci_chart_version_plain }} --destination {{ _tmpd.path }}
- >-
{{ helm_binary }} push --plain-http
{{ _tmpd.path }}/{{ helm_oci_chart_name }}-{{ helm_oci_chart_version }}.tgz
oci://{{ helm_oci_registry }}/{{ helm_oci_repo_path }}
- >-
{{ helm_binary }} push --plain-http
{{ _tmpd.path }}/{{ helm_oci_chart_name }}-{{ helm_oci_chart_version_plain }}.tgz
oci://{{ helm_oci_registry }}/{{ helm_oci_repo_path }}
register: _push
- name: Ensure Helm stored the build metadata version with an underscore
ansible.builtin.assert:
that:
- "'1.0.0_build.1' in (_push.results[2].stdout + _push.results[2].stderr)"
fail_msg: >-
Expected Helm to rewrite '+' to '_' when pushing the chart tag. Without
that rewrite this target no longer covers the case it was written for.
# helm - the version with build metadata is the case that failed outright.
- name: Install the chart from the OCI registry
kubernetes.core.helm:
binary_path: "{{ helm_binary }}"
name: "{{ helm_oci_chart_name }}"
chart_ref: "{{ chart_ref }}"
chart_version: "{{ helm_oci_chart_version }}"
release_namespace: "{{ helm_oci_namespace }}"
create_namespace: true
plain_http: true
register: _install
- name: Ensure the release reports the chart version verbatim
ansible.builtin.assert:
that:
- _install is changed
- _install.status.chart == helm_oci_chart_name ~ '-' ~ helm_oci_chart_version
- name: Install the same chart again
kubernetes.core.helm:
binary_path: "{{ helm_binary }}"
name: "{{ helm_oci_chart_name }}"
chart_ref: "{{ chart_ref }}"
chart_version: "{{ helm_oci_chart_version }}"
release_namespace: "{{ helm_oci_namespace }}"
plain_http: true
register: _reinstall
- name: Ensure the module is idempotent
ansible.builtin.assert:
that:
- _reinstall is not changed
# helm_template - stdout is documented to hold only the rendered templates. Both
# chart versions are checked: the plain one covers the case where the progress
# messages are valid YAML and would otherwise be parsed as a manifest.
- name: Render the chart from the OCI registry
kubernetes.core.helm_template:
binary_path: "{{ helm_binary }}"
chart_ref: "{{ chart_ref }}"
chart_version: "{{ item }}"
release_name: "{{ helm_oci_chart_name }}"
plain_http: true
loop:
- "{{ helm_oci_chart_version }}"
- "{{ helm_oci_chart_version_plain }}"
register: _template
- name: Ensure stdout holds the rendered manifests and nothing else
ansible.builtin.assert:
that:
- "'Pulled:' not in item.stdout"
- "'Digest:' not in item.stdout"
- "'contains an underscore' not in item.stdout"
- item.stdout.startswith('---')
- (item.stdout | from_yaml_all | list | map(attribute='kind') | list) == ['ConfigMap']
fail_msg: "helm_template stdout was not only rendered manifests: {{ item.stdout[:200] }}"
loop: "{{ _template.results }}"
loop_control:
label: "{{ item.item }}"
always:
- name: Uninstall the release
kubernetes.core.helm:
binary_path: "{{ helm_binary }}"
name: "{{ helm_oci_chart_name }}"
release_namespace: "{{ helm_oci_namespace }}"
state: absent
when: helm_binary is defined
ignore_errors: true
- name: Remove the test namespace
kubernetes.core.k8s:
api_version: v1
kind: Namespace
name: "{{ helm_oci_namespace }}"
state: absent
wait: true
ignore_errors: true
- name: Log out of the helm registry
ansible.builtin.command: "{{ helm_binary }} registry logout {{ helm_oci_registry }}"
when: helm_binary is defined
ignore_errors: true
- name: Remove the temporary directory
ansible.builtin.file:
path: "{{ _tmpd.path }}"
state: absent
when: _tmpd is defined and _tmpd.path is defined
ignore_errors: true
@@ -0,0 +1 @@
redis*
@@ -1,12 +0,0 @@
---
helm_binary: helm
setup_helm_version_binary_path: "{{ helm_binary }}"
test_namespace: helm-plain-http
# Matches the plain-HTTP registry stood up by the setup_helm_registry role.
registry_host: "localhost:6035"
registry_username: testuser
registry_password: 'pass123!'
registry_repo_path: testing
chart_name: test-chart-plain-http
chart_version: "0.1.0"
@@ -1,6 +0,0 @@
apiVersion: v2
name: test-chart-plain-http
description: A minimal chart used to exercise plain_http against a plain-HTTP OCI registry
type: application
version: 0.1.0
appVersion: "default"
@@ -1,6 +0,0 @@
apiVersion: v1
kind: ConfigMap
metadata:
name: test-chart-plain-http-configmap
data:
myValue: test
@@ -0,0 +1,4 @@
[all]
helm-3.12.3 helm_version=v3.12.3 test_namespace=helm-plain-http-v3-12-3 tests_should_failed=true
helm-3.18.2 helm_version=v3.18.2 test_namespace=helm-plain-http-v3-18-2 tests_should_failed=false
helm-4.0.0 helm_version=v4.0.0 test_namespace=helm-plain-http-v4-0-0 tests_should_failed=false
@@ -1,5 +0,0 @@
---
dependencies:
- setup_namespace
- setup_helm_registry
- setup_helm_version
@@ -0,0 +1,15 @@
- name: Run test for helm plain http option
hosts: all
gather_facts: true
strategy: free
vars:
ansible_connection: local
ansible_python_interpreter: "{{ ansible_playbook_python }}"
chart_test_oci: "oci://registry-1.docker.io/bitnamicharts/redis"
roles:
- role: setup_namespace
tasks:
- ansible.builtin.include_tasks: tasks/test.yaml
@@ -0,0 +1,95 @@
---
- name: Run test for helm
block:
- name: Create temporary directory to install chart In
ansible.builtin.tempfile:
state: directory
suffix: .helm
register: install_path
- name: Install required helm version
ansible.builtin.include_role:
name: install_helm
vars:
helm_install_path: "{{ install_path.path }}"
# helm
- name: Run helm with plain_http
kubernetes.core.helm:
binary_path: "{{ helm_binary }}"
chart_ref: "{{ chart_test_oci }}"
release_name: test-secure
release_namespace: "{{ test_namespace }}"
create_namespace: true
plain_http: true
register: install_chart
ignore_errors: true
- name: Ensure module failed as expected
ansible.builtin.assert:
that:
- install_chart is failed
- '"plain_http requires helm >= 3.13.0" in install_chart.msg'
when: tests_should_failed | bool
- name: Ensure the result command contains the expected option
ansible.builtin.assert:
that:
- install_chart is not failed
- '"--plain-http" in install_chart.command'
when: not (tests_should_failed | bool)
# helm_pull
- name: Trying to download helm chart with option plain_http
kubernetes.core.helm_pull:
chart_ref: "{{ chart_test_oci }}"
destination: "{{ playbook_dir }}"
binary_path: "{{ helm_binary }}"
plain_http: true
register: pull_chart
ignore_errors: true
- name: Ensure module failed as expected
ansible.builtin.assert:
that:
- pull_chart is failed
- '"plain_http requires helm >= 3.13.0" in pull_chart.msg'
when: tests_should_failed | bool
- name: Ensure the result command contains the expected option
ansible.builtin.assert:
that:
- pull_chart is not failed
- '"--plain-http" in pull_chart.command'
when: not (tests_should_failed | bool)
# helm_template
- name: Test helm render template
kubernetes.core.helm_template:
binary_path: "{{ helm_binary }}"
chart_ref: "{{ chart_test_oci }}"
output_dir: "{{ playbook_dir }}"
plain_http: true
register: template
ignore_errors: true
- name: Ensure module failed as expected
ansible.builtin.assert:
that:
- template is failed
- '"plain_http requires helm >= 3.13.0" in template.msg'
when: tests_should_failed | bool
- name: Ensure the result command contains the expected option
ansible.builtin.assert:
that:
- template is not failed
- '"--plain-http" in template.command'
when: not (tests_should_failed | bool)
always:
- name: Delete temporary file
ansible.builtin.file:
path: "{{ install_path.path }}"
state: absent
ignore_errors: true
+4
View File
@@ -0,0 +1,4 @@
#!/usr/bin/env bash
set -eux
export ANSIBLE_ROLES_PATH=../
ansible-playbook playbooks/play.yaml -i inventory.ini "$@"
@@ -1,167 +0,0 @@
---
- name: Test plain_http against a plain-HTTP OCI registry
vars:
plain_http_supported: "{{ helm_version | string is ansible.builtin.version('3.13.0', '>=') }}"
chart_ref_oci: "oci://{{ registry_host }}/{{ registry_repo_path }}/{{ chart_name }}"
block:
- name: Create a temporary directory to hold the chart
ansible.builtin.tempfile:
state: directory
suffix: .chart
register: _tmpd
# helm < 3.13.0 cannot talk to a plain-HTTP OCI registry: the modules reject
# plain_http before issuing any helm command, so no chart has to be present.
- name: Ensure plain_http is rejected on unsupported helm versions
when: not (plain_http_supported | bool)
block:
- name: Attempt helm install with plain_http
kubernetes.core.helm:
binary_path: "{{ helm_binary }}"
chart_ref: "{{ chart_ref_oci }}"
chart_version: "{{ chart_version }}"
release_name: test-secure
release_namespace: "{{ test_namespace }}"
create_namespace: true
plain_http: true
register: install_chart
ignore_errors: true
- name: Ensure helm failed with the version error
ansible.builtin.assert:
that:
- install_chart is failed
- '"plain_http requires helm >= 3.13.0" in install_chart.msg'
- name: Attempt helm_pull with plain_http
kubernetes.core.helm_pull:
chart_ref: "{{ chart_ref_oci }}"
chart_version: "{{ chart_version }}"
destination: "{{ _tmpd.path }}"
binary_path: "{{ helm_binary }}"
plain_http: true
register: pull_chart
ignore_errors: true
- name: Ensure helm_pull failed with the version error
ansible.builtin.assert:
that:
- pull_chart is failed
- '"plain_http requires helm >= 3.13.0" in pull_chart.msg'
- name: Attempt helm_template with plain_http
kubernetes.core.helm_template:
binary_path: "{{ helm_binary }}"
chart_ref: "{{ chart_ref_oci }}"
chart_version: "{{ chart_version }}"
plain_http: true
register: template
ignore_errors: true
- name: Ensure helm_template failed with the version error
ansible.builtin.assert:
that:
- template is failed
- '"plain_http requires helm >= 3.13.0" in template.msg'
# helm >= 3.13.0 exercises plain HTTP end to end against the registry stood up
# by the setup_helm_registry role, so the assertions prove the flag actually
# reaches a plain-HTTP registry rather than just appearing in the command.
- name: Exercise plain_http end to end
when: plain_http_supported | bool
block:
- name: Copy the test chart
ansible.builtin.copy:
src: "{{ chart_name }}"
dest: "{{ _tmpd.path }}/"
- name: Push the chart to the plain-HTTP registry
ansible.builtin.include_role:
name: push_to_helm_registry
vars:
chart_local_path: "{{ _tmpd.path }}/{{ chart_name }}"
chart_repo_path: "{{ registry_repo_path }}"
helm_binary_path: "{{ helm_binary }}"
- name: Log into the helm registry
ansible.builtin.shell: >-
echo '{{ registry_password }}' | {{ helm_binary }} registry login
-u {{ registry_username }} --password-stdin {{ registry_host }}
{{ helm_version | string is ansible.builtin.version('3.18.0', '>=') | ternary('--plain-http', '') }}
- name: Install the chart over plain HTTP
kubernetes.core.helm:
binary_path: "{{ helm_binary }}"
chart_ref: "{{ chart_ref_oci }}"
chart_version: "{{ chart_version }}"
release_name: test-secure
release_namespace: "{{ test_namespace }}"
create_namespace: true
plain_http: true
register: install_chart
- name: Ensure the release installed over plain HTTP
ansible.builtin.assert:
that:
- install_chart is changed
- '"--plain-http" in install_chart.command'
- name: Pull the chart over plain HTTP
kubernetes.core.helm_pull:
chart_ref: "{{ chart_ref_oci }}"
chart_version: "{{ chart_version }}"
destination: "{{ _tmpd.path }}"
binary_path: "{{ helm_binary }}"
plain_http: true
register: pull_chart
- name: Ensure the chart was pulled over plain HTTP
ansible.builtin.assert:
that:
- pull_chart is not failed
- '"--plain-http" in pull_chart.command'
- name: Render the chart over plain HTTP
kubernetes.core.helm_template:
binary_path: "{{ helm_binary }}"
chart_ref: "{{ chart_ref_oci }}"
chart_version: "{{ chart_version }}"
plain_http: true
register: template
- name: Ensure the chart rendered over plain HTTP
ansible.builtin.assert:
that:
- template is not failed
- '"--plain-http" in template.command'
- "'kind: ConfigMap' in template.stdout"
always:
- name: Uninstall the release
kubernetes.core.helm:
binary_path: "{{ helm_binary }}"
release_name: test-secure
release_namespace: "{{ test_namespace }}"
state: absent
when: plain_http_supported | bool
ignore_errors: true
- name: Remove the test namespace
kubernetes.core.k8s:
api_version: v1
kind: Namespace
name: "{{ test_namespace }}"
state: absent
wait: true
ignore_errors: true
- name: Log out of the helm registry
ansible.builtin.command: "{{ helm_binary }} registry logout {{ registry_host }}"
when: plain_http_supported | bool
ignore_errors: true
- name: Remove the temporary directory
ansible.builtin.file:
path: "{{ _tmpd.path }}"
state: absent
ignore_errors: true
@@ -1,2 +1,2 @@
---
helm_binary: "helm"
helm_binary: "/tmp/helm/{{ ansible_system | lower }}-amd64/helm"

Some files were not shown because too many files have changed in this diff Show More