+ |
+
+ reset_then_reuse_values
+
+
+ boolean
+
+ added in 5.1.0
+ |
+
+
+ |
+
+ 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 release_values, values_files or set_values.
+ If reset_values or reuse_values is set to True, this is ignored.
+ |
+
|
diff --git a/plugins/modules/helm.py b/plugins/modules/helm.py
index 079285d7bc..d316a9dd30 100644
--- a/plugins/modules/helm.py
+++ b/plugins/modules/helm.py
@@ -145,6 +145,15 @@
required: false
default: True
version_added: 2.5.0
+ reset_then_reuse_values:
+ 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 I(release_values), I(values_files) or I(set_values).
+ - If I(reset_values) or I(reuse_values) is set to C(True), this is ignored.
+ type: bool
+ required: false
+ default: False
+ version_added: 5.1.0
#Helm options
disable_hook:
@@ -509,6 +518,7 @@ def deploy(
set_value_args=None,
reuse_values=None,
reset_values=True,
+ reset_then_reuse_values=False,
):
"""
Install/upgrade/rollback release chart
@@ -526,6 +536,9 @@ def deploy(
if reuse_values is not None:
deploy_command += " --reuse-values=" + str(reuse_values)
+ if reset_then_reuse_values:
+ deploy_command += " --reset-then-reuse-values"
+
if wait:
deploy_command += " --wait"
if wait_timeout is not None:
@@ -642,6 +655,7 @@ def helmdiff_check(
set_value_args=None,
reuse_values=None,
reset_values=True,
+ reset_then_reuse_values=False,
):
"""
Use helm diff to determine if a release would change by upgrading a chart.
@@ -676,6 +690,9 @@ def helmdiff_check(
if reuse_values:
cmd += " --reuse-values"
+ if reset_then_reuse_values:
+ cmd += " --reset-then-reuse-values"
+
rc, out, err = module.run_helm_command(cmd)
return (len(out.strip()) > 0, out.strip())
@@ -735,6 +752,7 @@ def argument_spec():
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),
)
)
return arg_spec
@@ -787,6 +805,7 @@ def main():
set_values = module.params.get("set_values")
reuse_values = module.params.get("reuse_values")
reset_values = module.params.get("reset_values")
+ reset_then_reuse_values = module.params.get("reset_then_reuse_values")
if update_repo_cache:
run_repo_update(module)
@@ -883,6 +902,7 @@ def main():
set_value_args=set_value_args,
reuse_values=reuse_values,
reset_values=reset_values,
+ reset_then_reuse_values=reset_then_reuse_values,
)
changed = True
@@ -908,6 +928,7 @@ def main():
set_value_args,
reuse_values=reuse_values,
reset_values=reset_values,
+ reset_then_reuse_values=reset_then_reuse_values,
)
if would_change and module._diff:
opt_result["diff"] = {"prepared": prepared}
@@ -943,6 +964,7 @@ def main():
set_value_args=set_value_args,
reuse_values=reuse_values,
reset_values=reset_values,
+ reset_then_reuse_values=reset_then_reuse_values,
)
changed = True
diff --git a/tests/integration/targets/helm/tasks/test_helm_reset_then_reuse_values.yml.yml b/tests/integration/targets/helm/tasks/test_helm_reset_then_reuse_values.yml.yml
new file mode 100644
index 0000000000..236a69ae31
--- /dev/null
+++ b/tests/integration/targets/helm/tasks/test_helm_reset_then_reuse_values.yml.yml
@@ -0,0 +1,77 @@
+---
+- name: Test helm reset_then_reuse_values
+ vars:
+ helm_namespace: "{{ test_namespace[9] }}"
+ chart_release_values:
+ replica:
+ replicaCount: 3
+ master:
+ count: 1
+ kind: Deployment
+ chart_reset_then_reuse_values:
+ replica:
+ replicaCount: 1
+ master:
+ count: 3
+ block:
+ - name: Initial chart installation
+ helm:
+ binary_path: "{{ helm_binary }}"
+ chart_ref: redis
+ chart_repo_url: https://charts.bitnami.com/bitnami
+ release_name: test-redis
+ release_namespace: "{{ helm_namespace }}"
+ create_namespace: true
+ release_values: "{{ chart_release_values }}"
+ register: install
+
+ - name: Get value set as string
+ helm_info:
+ binary_path: "{{ helm_binary }}"
+ release_name: test-redis
+ release_namespace: "{{ helm_namespace }}"
+ register: release_value
+
+ - name: Validate that chart values are as expected
+ assert:
+ that:
+ - install is changed
+ - '"--reset-then-reuse-values" not in install.command'
+ - release_value["status"]["values"] == chart_release_values
+
+ - name: Upgrade chart using reset_then_reuse_values=true
+ helm:
+ binary_path: "{{ helm_binary }}"
+ chart_ref: redis
+ chart_repo_url: https://charts.bitnami.com/bitnami
+ release_name: test-redis
+ release_namespace: "{{ helm_namespace }}"
+ reuse_values: false
+ reset_values: false
+ reset_then_reuse_values: true
+ release_values: "{{ chart_reset_then_reuse_values }}"
+ register: upgrade
+
+ - name: Get value set as string
+ helm_info:
+ binary_path: "{{ helm_binary }}"
+ release_name: test-redis
+ release_namespace: "{{ helm_namespace }}"
+ register: release_value
+
+ - name: Validate that chart values are as expected
+ assert:
+ that:
+ - upgrade is changed
+ - '"--reset-then-reuse-values" in upgrade.command'
+ - '"--reuse-values" not in upgrade.command'
+ - '"--reset-values" not in upgrade.command'
+ - release_value["status"]["values"] == chart_release_values | combine(chart_reset_then_reuse_values, recursive=true)
+
+ always:
+ - name: Remove helm namespace
+ k8s:
+ api_version: v1
+ kind: Namespace
+ name: "{{ helm_namespace }}"
+ state: absent
diff --git a/tests/integration/targets/helm_diff/tasks/reset_then_reuse_values.yml.yml b/tests/integration/targets/helm_diff/tasks/reset_then_reuse_values.yml.yml
new file mode 100644
index 0000000000..44a68d7bb3
--- /dev/null
+++ b/tests/integration/targets/helm_diff/tasks/reset_then_reuse_values.yml.yml
@@ -0,0 +1,94 @@
+---
+- name: Create temporary directory for helm chart
+ tempfile:
+ suffix: .helm
+ state: directory
+ register: helm_dir
+
+- name: Test helm diff functionality
+ vars:
+ test_chart_path: "{{ helm_dir.path }}/test-chart-reuse-values"
+ test_release_name: "myrelease"
+
+ block:
+ - name: Install helm diff
+ kubernetes.core.helm_plugin:
+ binary_path: "{{ helm_binary }}"
+ state: present
+ plugin_path: https://github.com/databus23/helm-diff
+ plugin_version: 3.9.4
+
+ - name: Copy test chart
+ ansible.builtin.copy:
+ src: "test-chart-reuse-values"
+ dest: "{{ helm_dir.path }}"
+
+ - name: Create helm release
+ kubernetes.core.helm:
+ state: present
+ binary_path: "{{ helm_binary }}"
+ chart_ref: "{{ test_chart_path }}"
+ release_name: "{{ test_release_name }}"
+ release_namespace: "{{ helm_namespace }}"
+ create_namespace: true
+ release_values:
+ ansible_version: devel
+ phase: ci
+ wait: true
+
+ - name: Upgrade helm release (reset_values=false and reuse_values=false and reset_then_reuse_values=true)
+ kubernetes.core.helm:
+ binary_path: "{{ helm_binary }}"
+ chart_ref: "{{ test_chart_path }}"
+ reset_values: false
+ reuse_values: false
+ reset_then_reuse_values: true
+ release_name: "{{ test_release_name }}"
+ release_namespace: "{{ helm_namespace }}"
+ values:
+ ansible_version: devel
+ register: helm_upgrade
+
+ - name: Ensure task did not reported change
+ assert:
+ that:
+ - helm_upgrade is not changed
+
+ - name: Upgrade helm release (reset_then_reuse_values=true with default value for reset_values and reuse_values=false)
+ kubernetes.core.helm:
+ binary_path: "{{ helm_binary }}"
+ chart_ref: "{{ test_chart_path }}"
+ reuse_values: false
+ reset_then_reuse_values: true
+ release_name: "{{ test_release_name }}"
+ release_namespace: "{{ helm_namespace }}"
+ values:
+ ansible_version: devel
+ register: helm_upgrade
+
+ - name: Ensure task reported change
+ assert:
+ that:
+ - helm_upgrade is changed
+
+ always:
+ - name: Remove temporary directory
+ file:
+ path: "{{ helm_dir.path }}"
+ state: absent
+ ignore_errors: true
+
+ - name: Uninstall helm diff
+ kubernetes.core.helm_plugin:
+ binary_path: "{{ helm_binary }}"
+ state: absent
+ plugin_name: diff
+ ignore_errors: true
+
+ - name: Remove helm namespace
+ kubernetes.core.k8s:
+ api_version: v1
+ kind: Namespace
+ name: "{{ helm_namespace }}"
+ state: absent
+ ignore_errors: true
|