mirror of
https://github.com/ansible-collections/kubernetes.core.git
synced 2026-11-21 22:50:20 +00:00
feat(helm): add cleanup_on_fail option (#1206)
* feat(helm): add cleanup_on_fail option atomic rolls back to the last successful revision but can leave behind resources the failed upgrade created; helm accepts both flags together so the rollback also drops those orphans. Rejected with replace=true, since that deploys via helm install, which has no --cleanup-on-fail. No version gate: the flag exists in helm 3.0.0, the module's minimum, and was not renamed in v4. * refactor(tests): share helm command-building test helpers The new cleanup_on_fail tests copied setUp and _run_with_version verbatim from the atomic tests, which SonarQube flagged as duplication on new code. Extract both to module level so the two classes share them. Scoped to the classes involved in that duplication; the other test classes in this file keep their own fixtures. * test(helm): align cleanup_on_fail assertions with review feedback Adjust the Helm unit tests to assert the expected flags for cleanup_on_fail on Helm v3 and v4, matching the behavior clarified in review feedback. Co-authored-by: abikouo <abikouo@users.noreply.github.com> --------- Co-authored-by: abikouo <abikouo@users.noreply.github.com>
This commit is contained in:
co-authored by
abikouo
parent
ec8942dd90
commit
d4ef10fc80
@@ -207,6 +207,18 @@ 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.
|
||||
@@ -607,6 +619,7 @@ def deploy(
|
||||
values_files,
|
||||
history_max,
|
||||
atomic=False,
|
||||
cleanup_on_fail=False,
|
||||
create_namespace=False,
|
||||
replace=False,
|
||||
post_renderer=None,
|
||||
@@ -667,6 +680,17 @@ 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
|
||||
|
||||
@@ -962,6 +986,7 @@ def argument_spec():
|
||||
wait_timeout=dict(type="str"),
|
||||
timeout=dict(type="str"),
|
||||
atomic=dict(type="bool", default=False),
|
||||
cleanup_on_fail=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),
|
||||
@@ -1027,6 +1052,7 @@ def main():
|
||||
wait = module.params.get("wait")
|
||||
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")
|
||||
@@ -1157,6 +1183,7 @@ def main():
|
||||
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,
|
||||
@@ -1243,6 +1270,7 @@ def main():
|
||||
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,
|
||||
|
||||
Reference in New Issue
Block a user