Ensure compatibility with Helm v4 for the collection (#1090)

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: Bianca Henderson <beeankha@gmail.com> Reviewed-by: Yuriy Novostavskiy <yuriy@novostavskiy.kyiv.ua> Reviewed-by: Alina Buzachis
2026-03-26 21:33:02 +00:00 · 2026-03-06 15:50:14 +01:00
parent 42acb4f52b
commit e6076e5568
86 changed files with 1161 additions and 930 deletions
--- a/plugins/module_utils/helm.py
+++ b/plugins/module_utils/helm.py
@@ -40,16 +40,20 @@ def parse_helm_plugin_list(output=None):
    if not output:
        return ret

+    parsing_grammar = None
    for line in output:
        if line.startswith("NAME"):
+            parsing_grammar = [s.strip().lower() for s in line.split("\t")]
            continue
-        name, version, description = line.split("\t", 3)
-        name = name.strip()
-        version = version.strip()
-        description = description.strip()
-        if name == "":
+        if parsing_grammar is None:
            continue
-        ret.append((name, version, description))
+        plugin = {
+            parsing_grammar[i]: v.strip()
+            for i, v in enumerate(line.split("\t", len(parsing_grammar)))
+        }
+        if plugin["name"] == "":
+            continue
+        ret.append(plugin)

    return ret

@@ -202,21 +206,35 @@ class AnsibleHelmModule(object):
            return m.group(1)
        return None

-    def validate_helm_version(self):
+    def is_helm_v4(self):
+        helm_version = self.get_helm_version()
+        if helm_version is None:
+            return False
+        return LooseVersion(helm_version) >= LooseVersion("4.0.0")
+
+    def is_helm_version_compatible_with_helm_diff(self, helm_diff_version):
        """
-        Validate that Helm version is >=3.0.0 and <4.0.0.
-        Helm 4 is not yet supported.
+        Return true if the helm version is compatible with the helm diff version
+        Helm v4 requires helm diff v3.14.0
+        """
+        if not helm_diff_version:
+            return False
+        if self.is_helm_v4():
+            return LooseVersion(helm_diff_version) >= LooseVersion("3.14.0")
+        return True
+
+    def validate_helm_version(self, version="3.0.0"):
+        """
+        Validate that Helm version is >= version (default version=3.0.0).
        """
        helm_version = self.get_helm_version()
        if helm_version is None:
            self.fail_json(msg="Unable to determine Helm version")

-        if (LooseVersion(helm_version) < LooseVersion("3.0.0")) or (
-            LooseVersion(helm_version) >= LooseVersion("4.0.0")
-        ):
+        if LooseVersion(helm_version) < LooseVersion(version):
            self.fail_json(
-                msg="Helm version must be >=3.0.0,<4.0.0, current version is {0}".format(
-                    helm_version
+                msg="Helm version must be >= {0}, current version is {1}".format(
+                    version, helm_version
                )
            )

--- a/plugins/modules/helm.py
+++ b/plugins/modules/helm.py
@@ -21,7 +21,7 @@ author:
  - Matthieu Diehr (@d-matt)

 requirements:
-  - "helm (https://github.com/helm/helm/releases)"
+  - "helm >= 3.0.0 (https://github.com/helm/helm/releases)"
  - "yaml (https://pypi.org/project/PyYAML/)"

 description:
@@ -500,9 +500,13 @@ def get_release_status(module, release_name, all_status=False):
        "--filter",
        release_name,
    ]
-    if all_status:
+    if all_status and not module.is_helm_v4():
+        # --all has been removed from `helm list` command on helm v4
        list_command.append("--all")
-
+    elif not all_status:
+        # The default behavior to display only deployed releases has been removed from
+        # Helm v4
+        list_command.append("--deployed")
    rc, out, err = module.run_helm_command(list_command)

    release = get_release(yaml.safe_load(out), release_name)
@@ -739,8 +743,8 @@ def get_plugin_version(plugin):
        return None

    for line in out:
-        if line[0] == plugin:
-            return line[1]
+        if line["name"] == plugin:
+            return line["version"]
    return None


@@ -928,7 +932,7 @@ def main():
    if not IMP_YAML:
        module.fail_json(msg=missing_required_lib("yaml"), exception=IMP_YAML_ERR)

-    # Validate Helm version >=3.0.0,<4.0.0
+    # Validate Helm version >=3.0.0
    module.validate_helm_version()

    changed = False
@@ -1010,8 +1014,7 @@ def main():
            if wait:
                helm_version = module.get_helm_version()
                if LooseVersion(helm_version) < LooseVersion("3.7.0"):
-                    opt_result["warnings"] = []
-                    opt_result["warnings"].append(
+                    module.warn(
                        "helm uninstall support option --wait for helm release >= 3.7.0"
                    )
                    wait = False
@@ -1099,14 +1102,21 @@ def main():

        else:
            helm_diff_version = get_plugin_version("diff")
-            if helm_diff_version and (
-                not chart_repo_url
-                or (
-                    chart_repo_url
-                    and LooseVersion(helm_diff_version) >= LooseVersion("3.4.1")
+            helm_version_compatible = module.is_helm_version_compatible_with_helm_diff(
+                helm_diff_version
+            )
+            if (
+                helm_diff_version
+                and helm_version_compatible
+                and (
+                    not chart_repo_url
+                    or (
+                        chart_repo_url
+                        and LooseVersion(helm_diff_version) >= LooseVersion("3.4.1")
+                    )
                )
            ):
-                (would_change, prepared) = helmdiff_check(
+                would_change, prepared = helmdiff_check(
                    module,
                    release_name,
                    chart_ref,
@@ -1127,10 +1137,18 @@ def main():
                if would_change and module._diff:
                    opt_result["diff"] = {"prepared": prepared}
            else:
-                module.warn(
-                    "The default idempotency check can fail to report changes in certain cases. "
-                    "Install helm diff >= 3.4.1 for better results."
-                )
+                if helm_diff_version and not helm_version_compatible:
+                    module.warn(
+                        "Idempotency checks are currently disabled due to a version mismatch."
+                        f" Helm version {module.get_helm_version()} requires helm-diff >= 3.14.0,"
+                        f" but the environment is currently running {helm_diff_version}."
+                        " Please align the plugin versions to restore standard behavior."
+                    )
+                else:
+                    module.warn(
+                        "The default idempotency check can fail to report changes in certain cases. "
+                        "Install helm diff >= 3.4.1 for better results."
+                    )
                would_change = default_check(
                    release_status, chart_info, release_values, values_files
                )
--- a/plugins/modules/helm_info.py
+++ b/plugins/modules/helm_info.py
@@ -20,7 +20,7 @@ author:
  - Lucas Boisserie (@LucasBoisserie)

 requirements:
-  - "helm (https://github.com/helm/helm/releases)"
+  - "helm >= 3.0.0 (https://github.com/helm/helm/releases)"
  - "yaml (https://pypi.org/project/PyYAML/)"

 description:
@@ -245,7 +245,7 @@ def main():
    if not IMP_YAML:
        module.fail_json(msg=missing_required_lib("yaml"), exception=IMP_YAML_ERR)

-    # Validate Helm version >=3.0.0,<4.0.0
+    # Validate Helm version >=3.0.0
    module.validate_helm_version()

    release_name = module.params.get("release_name")
--- a/plugins/modules/helm_plugin.py
+++ b/plugins/modules/helm_plugin.py
@@ -16,7 +16,7 @@ version_added: 1.0.0
 author:
  - Abhijeet Kasurde (@Akasurde)
 requirements:
-  - "helm (https://github.com/helm/helm/releases)"
+  - "helm >= 3.0.0 (https://github.com/helm/helm/releases)"
 description:
  -  Manages Helm plugins.
 options:
@@ -48,6 +48,14 @@ options:
    required: false
    type: str
    version_added: 2.3.0
+  verify:
+    description:
+      - Verify the plugin signature before installing.
+      - This option requires helm version >= 4.0.0
+      - Used with I(state=present).
+    type: bool
+    default: true
+    version_added: 6.4.0
 extends_documentation_fragment:
  - kubernetes.core.helm_common_options
 """
@@ -118,6 +126,9 @@ from ansible_collections.kubernetes.core.plugins.module_utils.helm_args_common i
    HELM_AUTH_ARG_SPEC,
    HELM_AUTH_MUTUALLY_EXCLUSIVE,
 )
+from ansible_collections.kubernetes.core.plugins.module_utils.version import (
+    LooseVersion,
+)


 def argument_spec():
@@ -138,6 +149,10 @@ def argument_spec():
                default="present",
                choices=["present", "absent", "latest"],
            ),
+            verify=dict(
+                type="bool",
+                default=True,
+            ),
        )
    )
    return arg_spec
@@ -161,7 +176,7 @@ def main():
        mutually_exclusive=mutually_exclusive(),
    )

-    # Validate Helm version >=3.0.0,<4.0.0
+    # Validate helm version >= 3.0.0
    module.validate_helm_version()

    state = module.params.get("state")
@@ -171,8 +186,19 @@ def main():
    if state == "present":
        helm_cmd_common += " install %s" % module.params.get("plugin_path")
        plugin_version = module.params.get("plugin_version")
+        verify = module.params.get("verify")
        if plugin_version is not None:
            helm_cmd_common += " --version=%s" % plugin_version
+        if not verify:
+            helm_version = module.get_helm_version()
+            if LooseVersion(helm_version) < LooseVersion("4.0.0"):
+                module.warn(
+                    "verify parameter requires helm >= 4.0.0, current version is {0}".format(
+                        helm_version
+                    )
+                )
+            else:
+                helm_cmd_common += " --verify=false"
        if not module.check_mode:
            rc, out, err = module.run_helm_command(
                helm_cmd_common, fails_on_error=False
@@ -211,9 +237,9 @@ def main():
    elif state == "absent":
        plugin_name = module.params.get("plugin_name")
        rc, output, err, command = module.get_helm_plugin_list()
-        out = parse_helm_plugin_list(output=output.splitlines())
+        plugins = parse_helm_plugin_list(output=output.splitlines())

-        if not out:
+        if not plugins:
            module.exit_json(
                failed=False,
                changed=False,
@@ -224,12 +250,7 @@ def main():
                rc=rc,
            )

-        found = False
-        for line in out:
-            if line[0] == plugin_name:
-                found = True
-                break
-        if not found:
+        if all(plugin["name"] != plugin_name for plugin in plugins):
            module.exit_json(
                failed=False,
                changed=False,
@@ -267,9 +288,9 @@ def main():
    elif state == "latest":
        plugin_name = module.params.get("plugin_name")
        rc, output, err, command = module.get_helm_plugin_list()
-        out = parse_helm_plugin_list(output=output.splitlines())
+        plugins = parse_helm_plugin_list(output=output.splitlines())

-        if not out:
+        if not plugins:
            module.exit_json(
                failed=False,
                changed=False,
@@ -280,12 +301,7 @@ def main():
                rc=rc,
            )

-        found = False
-        for line in out:
-            if line[0] == plugin_name:
-                found = True
-                break
-        if not found:
+        if all(plugin["name"] != plugin_name for plugin in plugins):
            module.exit_json(
                failed=False,
                changed=False,
--- a/plugins/modules/helm_plugin_info.py
+++ b/plugins/modules/helm_plugin_info.py
@@ -16,7 +16,7 @@ version_added: 1.0.0
 author:
  - Abhijeet Kasurde (@Akasurde)
 requirements:
-  - "helm (https://github.com/helm/helm/releases)"
+  - "helm >= 3.0.0 (https://github.com/helm/helm/releases)"
 description:
  -  Gather information about Helm plugins installed in namespace.
 options:
@@ -98,29 +98,16 @@ def main():
        supports_check_mode=True,
    )

-    # Validate Helm version >=3.0.0,<4.0.0
+    # Validate helm version >= 3.0.0
    module.validate_helm_version()

    plugin_name = module.params.get("plugin_name")

-    plugin_list = []
-
    rc, output, err, command = module.get_helm_plugin_list()

-    out = parse_helm_plugin_list(output=output.splitlines())
-
-    for line in out:
-        if plugin_name is None:
-            plugin_list.append(
-                {"name": line[0], "version": line[1], "description": line[2]}
-            )
-            continue
-
-        if plugin_name == line[0]:
-            plugin_list.append(
-                {"name": line[0], "version": line[1], "description": line[2]}
-            )
-            break
+    plugins = parse_helm_plugin_list(output=output.splitlines())
+    if plugin_name is not None:
+        plugins = [plugin for plugin in plugins if plugin.get("name") == plugin_name]

    module.exit_json(
        changed=True,
@@ -128,7 +115,7 @@ def main():
        stdout=output,
        stderr=err,
        rc=rc,
-        plugin_list=plugin_list,
+        plugin_list=plugins,
    )


--- a/plugins/modules/helm_pull.py
+++ b/plugins/modules/helm_pull.py
@@ -21,7 +21,7 @@ description:
  - There are options for unpacking the chart after download.

 requirements:
-  - "helm >= 3.0, <4.0.0 (https://github.com/helm/helm/releases)"
+  - "helm >= 3.0.0 (https://github.com/helm/helm/releases)"

 options:
  chart_ref:
@@ -372,7 +372,7 @@ def main():
        mutually_exclusive=[("chart_version", "chart_devel")],
    )

-    # Validate Helm version >=3.0.0,<4.0.0
+    # Validate Helm version >=3.0.0
    module.validate_helm_version()

    helm_version = module.get_helm_version()
--- a/plugins/modules/helm_registry_auth.py
+++ b/plugins/modules/helm_registry_auth.py
@@ -20,7 +20,7 @@ author:
  - Yuriy Novostavskiy (@yurnov)

 requirements:
-  - "helm (https://github.com/helm/helm/releases) >= 3.8.0, <4.0.0"
+  - "helm (https://github.com/helm/helm/releases) >= 3.8.0"

 description:
  -  Helm registry authentication module allows you to login C(helm registry login) and logout C(helm registry logout) from a Helm registry.
@@ -75,6 +75,14 @@ options:
      - Path to the CA certificate SSL file for verify registry server certificate.
    required: false
    type: path
+  plain_http:
+    description:
+      - Use insecure HTTP connections for C(helm registry login).
+      - Requires Helm >= 3.18.0
+    required: false
+    type: bool
+    default: False
+    version_added: 6.4.0
  binary_path:
    description:
      - The path of a helm binary to use.
@@ -148,6 +156,7 @@ def arg_spec():
        key_file=dict(type="path", required=False),
        cert_file=dict(type="path", required=False),
        ca_file=dict(type="path", required=False),
+        plain_http=dict(type="bool", default=False),
    )


@@ -160,6 +169,7 @@ def login(
    key_file,
    cert_file,
    ca_file,
+    plain_http,
 ):
    login_command = command + " registry login " + host

@@ -177,6 +187,8 @@ def login(

    if ca_file is not None:
        login_command += " --ca-file=" + ca_file
+    if plain_http:
+        login_command += " --plain-http"

    return login_command

@@ -194,8 +206,8 @@ def main():
        supports_check_mode=True,
    )

-    # Validate Helm version >=3.0.0,<4.0.0
-    module.validate_helm_version()
+    # Validate Helm version >=3.8.0
+    module.validate_helm_version(version="3.8.0")

    changed = False

@@ -207,6 +219,19 @@ def main():
    key_file = module.params.get("key_file")
    cert_file = module.params.get("cert_file")
    ca_file = module.params.get("ca_file")
+    plain_http = module.params.get("plain_http")
+
+    helm_version = module.get_helm_version()
+
+    if plain_http:
+        if LooseVersion(helm_version) < LooseVersion("3.18.0"):
+            module.warn(
+                "plain_http option requires helm >= 3.18.0, current version is {0}".format(
+                    helm_version
+                )
+            )
+            # reset option
+            plain_http = False

    helm_cmd = module.get_helm_binary()

@@ -215,7 +240,15 @@ def main():
        changed = True
    elif state == "present":
        helm_cmd = login(
-            helm_cmd, host, insecure, username, password, key_file, cert_file, ca_file
+            helm_cmd,
+            host,
+            insecure,
+            username,
+            password,
+            key_file,
+            cert_file,
+            ca_file,
+            plain_http,
        )
        changed = True

@@ -238,7 +271,6 @@ def main():
                command=helm_cmd,
            )

-    helm_version = module.get_helm_version()
    if LooseVersion(helm_version) >= LooseVersion("3.18.0") and state == "absent":
        # https://github.com/ansible-collections/kubernetes.core/issues/944
        module.warn(
--- a/plugins/modules/helm_repository.py
+++ b/plugins/modules/helm_repository.py
@@ -20,7 +20,7 @@ author:
  - Lucas Boisserie (@LucasBoisserie)

 requirements:
-  - "helm (https://github.com/helm/helm/releases)"
+  - "helm >= 3.0.0 (https://github.com/helm/helm/releases)"
  - "yaml (https://pypi.org/project/PyYAML/)"

 description:
@@ -295,7 +295,7 @@ def main():
    if not IMP_YAML:
        module.fail_json(msg=missing_required_lib("yaml"), exception=IMP_YAML_ERR)

-    # Validate Helm version >=3.0.0,<4.0.0
+    # Validate Helm version >= 3.0.0
    module.validate_helm_version()

    changed = False
--- a/plugins/modules/helm_template.py
+++ b/plugins/modules/helm_template.py
@@ -21,6 +21,10 @@ author:
 description:
  - Render chart templates to an output directory or as text of concatenated yaml documents.

+requirements:
+  - "helm >= 3.0.0 (https://github.com/helm/helm/releases)"
+  - "yaml (https://pypi.org/project/PyYAML/)"
+
 options:
  binary_path:
    description:
@@ -347,7 +351,7 @@ def main():
    if not IMP_YAML:
        module.fail_json(msg=missing_required_lib("yaml"), exception=IMP_YAML_ERR)

-    # Validate Helm version >=3.0.0,<4.0.0
+    # Validate Helm version >=3.0.0
    module.validate_helm_version()

    helm_cmd = module.get_helm_binary()