Add helm dependency update (#208)

Add helm dependency update SUMMARY Execute the helm dependency update under the hood when found dependencies block in Chart.yaml file. Support the execution of: Standalone dependency update by executing: helm dependency update CHART Inline dependency update when specifying the helm chart_repo_url by adding --dependency-update to the helm install command. ISSUE TYPE Feature Pull Request #191 COMPONENT NAME helm, helm_template ADDITIONAL INFORMATION There is a doc generated for history_max option for the helm module. I think that is not generated in the previous PR #164. There is others changes affect the docs/ folder when I run the collection_prep_add_docs -p . command. These changes are added in the last commit 64eab40. I let you decide rather we keep the commit or remove it. The --dependency-update insertion option is tested used a local helm chart repository create via docker. So here are the tasks that test this feature. Maybe if we create a GitHub repository for the helm chart, we can add this test code in the CI pipeline. # Test The update dependency with chart_repo_url - name: "Test chart without dependencies block and chart_repo_url defined" block: - name: "Test chart without dependencies block and chart_repo_url defined" helm: binary_path: "{{ helm_binary }}" name: test chart_ref: "ingress-nginx" chart_repo_url: https://kubernetes.github.io/ingress-nginx chart_version: "{{ chart_source_version | default(omit) }}" namespace: "{{ helm_namespace }}" create_namespace: yes register: release - assert: that: - "'--dependency-update' not in release.command" - "'upgrade' in release.command" success_msg: "Command does not contains '--dependency-update' options" fail_msg: "Command contains '--dependency-update' options" - name: "Test chart with dependencies block and chart_repo_url defined and replace True" block: - name: "Test chart with dependencies block and chart_repo_url defined and replace True" helm: binary_path: "{{ helm_binary }}" name: test1 chart_ref: "dep_up" chart_repo_url: http://repo:8080/charts chart_version: "{{ chart_source_version | default(omit) }}" namespace: "{{ helm_namespace }}" create_namespace: yes replace: true register: release - debug: var=release - assert: that: - "'--dependency-update' in release.command" - "'install' in release.command" success_msg: "Command contains '--dependency-update' options with helm install command" fail_msg: "Command not contains '--dependency-update' with helm install command" - name: "Test chart with dependencies block and chart_repo_url defined and replace False fails" block: - name: "Test chart with dependencies block and chart_repo_url defined and replace False fails" helm: binary_path: "{{ helm_binary }}" name: test2 chart_ref: "dep_up" chart_repo_url: http://repo:8080/charts chart_version: "{{ chart_source_version | default(omit) }}" namespace: "{{ helm_namespace }}" create_namespace: yes replace: false register: release ignore_errors: true - assert: that: - release.failed - release.msg == "'--dependency-update' hasn't been supported yet with 'helm upgrade'. Please use 'helm install' instead by adding 'replace' option" success_msg: "Command build fail when adding '--dependency-update' with the helm upgrade command" Reviewed-by: Mike Graves <mgraves@redhat.com> Reviewed-by: Wissem BEN CHAABANE <benchaaben.wissem@gmail.com> Reviewed-by: Bikouo Aubin <None>
2026-03-26 21:33:02 +00:00 · 2022-04-26 13:54:37 +02:00
parent f2f4b66d77
commit 4fa1fb966b
13 changed files with 967 additions and 0 deletions
--- a/plugins/modules/helm.py
+++ b/plugins/modules/helm.py
@@ -51,6 +51,17 @@ options:
      - Chart version to install. If this is not specified, the latest version is installed.
    required: false
    type: str
+  dependency_update:
+    description:
+      - Run standalone C(helm dependency update CHART) before the operation.
+      - Run inline C(--dependency-update) with C(helm install) command. This feature is not supported yet with the C(helm upgrade) command.
+      - So we should consider to use I(dependency_update) options with I(replace) option enabled when specifying I(chart_repo_url).
+      - The I(dependency_update) option require the add of C(dependencies) block in C(Chart.yaml/requirements.yaml) file.
+      - For more information please visit U(https://helm.sh/docs/helm/helm_dependency/)
+    default: false
+    type: bool
+    aliases: [ dep_up ]
+    version_added: "2.4.0"
  release_name:
    description:
      - Release name to manage.
@@ -322,6 +333,7 @@ command:
  sample: helm upgrade ...
 """

+import re
 import tempfile
 import traceback
 from ansible_collections.kubernetes.core.plugins.module_utils.version import (
@@ -385,6 +397,14 @@ def run_repo_update(module, command):
    rc, out, err = run_helm(module, repo_update_command)


+def run_dep_update(module, command, chart_ref):
+    """
+    Run dependency update
+    """
+    dep_update = command + " dependency update " + chart_ref
+    rc, out, err = run_helm(module, dep_update)
+
+
 def fetch_chart_info(module, command, chart_ref):
    """
    Get chart info
@@ -413,6 +433,7 @@ def deploy(
    post_renderer=None,
    skip_crds=False,
    timeout=None,
+    dependency_update=None,
 ):
    """
    Install/upgrade/rollback release chart
@@ -420,6 +441,8 @@ def deploy(
    if replace:
        # '--replace' is not supported by 'upgrade -i'
        deploy_command = command + " install"
+        if dependency_update:
+            deploy_command += " --dependency-update"
    else:
        deploy_command = command + " upgrade -i"  # install/upgrade

@@ -597,6 +620,7 @@ def main():
            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(
@@ -667,6 +691,7 @@ def main():
    chart_ref = module.params.get("chart_ref")
    chart_repo_url = module.params.get("chart_repo_url")
    chart_version = module.params.get("chart_version")
+    dependency_update = module.params.get("dependency_update")
    release_name = module.params.get("release_name")
    release_state = module.params.get("release_state")
    release_values = module.params.get("release_values")
@@ -729,6 +754,36 @@ def main():
        # Fetch chart info to have real version and real name for chart_ref from archive, folder or url
        chart_info = fetch_chart_info(module, helm_cmd, chart_ref)

+        if dependency_update:
+            if chart_info.get("dependencies"):
+                # Can't use '--dependency-update' with 'helm upgrade' that is the
+                # default chart install method, so if chart_repo_url is defined
+                # we can't use the dependency update command. But, in the near future
+                # we can get rid of this method and use only '--dependency-update'
+                # option. Please see https://github.com/helm/helm/pull/8810
+                if not chart_repo_url and not re.fullmatch(
+                    r"^http[s]*://[\w.:/?&=-]+$", chart_ref
+                ):
+                    run_dep_update(module, helm_cmd_common, chart_ref)
+
+                    # To not add --dependency-update option in the deploy function
+                    dependency_update = False
+                else:
+                    module.warn(
+                        "This is a not stable feature with 'chart_repo_url'. Please consider to use dependency update with on-disk charts"
+                    )
+                    if not replace:
+                        msg_fail = (
+                            "'--dependency-update' hasn't been supported yet with 'helm upgrade'. "
+                            "Please use 'helm install' instead by adding 'replace' option"
+                        )
+                        module.fail_json(msg=msg_fail)
+            else:
+                module.warn(
+                    "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."
+                )
+
        if release_status is None:  # Not installed
            helm_cmd = deploy(
                helm_cmd,
@@ -744,6 +799,7 @@ def main():
                create_namespace=create_namespace,
                post_renderer=post_renderer,
                replace=replace,
+                dependency_update=dependency_update,
                skip_crds=skip_crds,
                history_max=history_max,
                timeout=timeout,
@@ -800,6 +856,7 @@ def main():
                    skip_crds=skip_crds,
                    history_max=history_max,
                    timeout=timeout,
+                    dependency_update=dependency_update,
                )
                changed = True

--- a/plugins/modules/helm_template.py
+++ b/plugins/modules/helm_template.py
@@ -45,6 +45,15 @@ options:
      - Chart version to use. If this is not specified, the latest version is installed.
    required: false
    type: str
+  dependency_update:
+    description:
+      - Run helm dependency update before the operation.
+      - The I(dependency_update) option require the add of C(dependencies) block in C(Chart.yaml/requirements.yaml) file.
+      - For more information please visit U(https://helm.sh/docs/helm/helm_dependency/)
+    default: false
+    type: bool
+    aliases: [ dep_up ]
+    version_added: "2.4.0"
  include_crds:
    description:
      - Include custom resource descriptions in rendered templates.
@@ -167,6 +176,7 @@ def template(
    chart_ref,
    chart_repo_url=None,
    chart_version=None,
+    dependency_update=None,
    output_dir=None,
    show_only=None,
    release_values=None,
@@ -176,6 +186,9 @@ def template(
 ):
    cmd += " template " + chart_ref

+    if dependency_update:
+        cmd += " --dependency-update"
+
    if chart_repo_url:
        cmd += " --repo=" + chart_repo_url

@@ -215,6 +228,7 @@ def main():
            chart_ref=dict(type="path", required=True),
            chart_repo_url=dict(type="str"),
            chart_version=dict(type="str"),
+            dependency_update=dict(type="bool", default=False, aliases=["dep_up"]),
            include_crds=dict(type="bool", default=False),
            output_dir=dict(type="path"),
            release_namespace=dict(type="str"),
@@ -231,6 +245,7 @@ def main():
    chart_ref = module.params.get("chart_ref")
    chart_repo_url = module.params.get("chart_repo_url")
    chart_version = module.params.get("chart_version")
+    dependency_update = module.params.get("dependency_update")
    include_crds = module.params.get("include_crds")
    output_dir = module.params.get("output_dir")
    show_only = module.params.get("show_only")
@@ -251,6 +266,7 @@ def main():
    tmpl_cmd = template(
        helm_cmd,
        chart_ref,
+        dependency_update=dependency_update,
        chart_repo_url=chart_repo_url,
        chart_version=chart_version,
        output_dir=output_dir,