helm - add support for -set options when running helm install (#546)

helm - add support for -set options when running helm install

SUMMARY

helm support setting options -set, -set-string, -set-file and -set-json when running helm install

ISSUE TYPE


Feature Pull Request

COMPONENT NAME

helm
ADDITIONAL INFORMATION

Reviewed-by: Alina Buzachis <None>
Reviewed-by: Bikouo Aubin <None>
Reviewed-by: Mike Graves <mgraves@redhat.com>

plugins/module_utils/helm.py

@@ -215,6 +215,56 @@ class AnsibleHelmModule(object):
             return {}
         return yaml.safe_load(out)
 
+    def parse_yaml_content(self, content):
+
+        if not HAS_YAML:
+            self.fail_json(msg=missing_required_lib("yaml"), exception=HAS_YAML)
+
+        try:
+            return list(yaml.safe_load_all(content))
+        except (IOError, yaml.YAMLError) as exc:
+            self.fail_json(
+                msg="Error parsing YAML content: {0}".format(exc), raw_data=content
+            )
+
+    def get_manifest(self, release_name):
+
+        command = [
+            self.get_helm_binary(),
+            "get",
+            "manifest",
+            release_name,
+        ]
+        rc, out, err = self.run_helm_command(" ".join(command))
+        if rc != 0:
+            self.fail_json(msg=err)
+        return self.parse_yaml_content(out)
+
+    def get_notes(self, release_name):
+
+        command = [
+            self.get_helm_binary(),
+            "get",
+            "notes",
+            release_name,
+        ]
+        rc, out, err = self.run_helm_command(" ".join(command))
+        if rc != 0:
+            self.fail_json(msg=err)
+        return out
+
+    def get_hooks(self, release_name):
+        command = [
+            self.get_helm_binary(),
+            "get",
+            "hooks",
+            release_name,
+        ]
+        rc, out, err = self.run_helm_command(" ".join(command))
+        if rc != 0:
+            self.fail_json(msg=err)
+        return self.parse_yaml_content(out)
+
     def get_helm_plugin_list(self):
         """
         Return `helm plugin list`
@@ -230,3 +280,24 @@ class AnsibleHelmModule(object):
                 rc=rc,
             )
         return (rc, out, err, helm_plugin_list)
+
+    def get_helm_set_values_args(self, set_values):
+        if any(v.get("value_type") == "json" for v in set_values):
+            if LooseVersion(self.get_helm_version()) < LooseVersion("3.10.0"):
+                self.fail_json(
+                    msg="This module requires helm >= 3.10.0, to use set_values parameter with value type set to 'json'. current version is {0}".format(
+                        self.get_helm_version()
+                    )
+                )
+
+        options = []
+        for opt in set_values:
+            value_type = opt.get("value_type", "raw")
+            value = opt.get("value")
+
+            if value_type == "raw":
+                options.append("--set " + value)
+            else:
+                options.append("--set-{0} '{1}'".format(value_type, value))
+
+        return " ".join(options)

plugins/modules/helm.py

@@ -105,6 +105,31 @@ options:
       - Run C(helm repo update) before the operation. Can be run as part of the package installation or as a separate step (see Examples).
     default: false
     type: bool
+  set_values:
+    description:
+      - Values to pass to chart configuration
+    required: false
+    type: list
+    elements: dict
+    suboptions:
+      value:
+        description:
+          - Value to pass to chart configuration (e.g phase=prod).
+        type: str
+        required: true
+      value_type:
+        description:
+          - Use C(raw) set individual value.
+          - Use C(string) to force a string for an individual value.
+          - Use C(file) to set individual values from a file when the value itself is too long for the command line or is dynamically generated.
+          - Use C(json) to set json values (scalars/objects/arrays). This feature requires helm>=3.10.0.
+        default: raw
+        choices:
+          - raw
+          - string
+          - json
+          - file
+    version_added: '2.4.0'
 
 #Helm options
   disable_hook:
@@ -232,6 +257,15 @@ EXAMPLES = r"""
     state: absent
     update_repo_cache: true
 
+- name: Deploy Grafana chart using set values on target
+  kubernetes.core.helm:
+    name: test
+    chart_ref: stable/grafana
+    release_namespace: monitoring
+    set_values:
+      - value: phase=prod
+        value_type: string
+
 # From git
 - name: Git clone stable repo on HEAD
   ansible.builtin.git:
@@ -438,6 +472,7 @@ def deploy(
     skip_crds=False,
     timeout=None,
     dependency_update=None,
+    set_value_args=None,
 ):
     """
     Install/upgrade/rollback release chart
@@ -495,6 +530,9 @@ def deploy(
     if history_max is not None:
         deploy_command += " --history-max=%s" % str(history_max)
 
+    if set_value_args:
+        deploy_command += " " + set_value_args
+
     deploy_command += " " + release_name + " " + chart_name
     return deploy_command
 
@@ -643,6 +681,7 @@ def argument_spec():
             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"),
         )
     )
     return arg_spec
@@ -692,6 +731,7 @@ def main():
     skip_crds = module.params.get("skip_crds")
     history_max = module.params.get("history_max")
     timeout = module.params.get("timeout")
+    set_values = module.params.get("set_values")
 
     if update_repo_cache:
         run_repo_update(module)
@@ -760,6 +800,10 @@ def main():
                 )
 
         if release_status is None:  # Not installed
+            set_value_args = None
+            if set_values:
+                set_value_args = module.get_helm_set_values_args(set_values)
+
             helm_cmd = deploy(
                 helm_cmd,
                 release_name,
@@ -778,6 +822,7 @@ def main():
                 skip_crds=skip_crds,
                 history_max=history_max,
                 timeout=timeout,
+                set_value_args=set_value_args,
             )
             changed = True
 
@@ -813,6 +858,10 @@ def main():
                 )
 
             if force or would_change:
+                set_value_args = None
+                if set_values:
+                    set_value_args = module.get_helm_set_values_args(set_values)
+
                 helm_cmd = deploy(
                     helm_cmd,
                     release_name,
@@ -831,6 +880,7 @@ def main():
                     history_max=history_max,
                     timeout=timeout,
                     dependency_update=dependency_update,
+                    set_value_args=set_value_args,
                 )
                 changed = True
 

plugins/modules/helm_info.py

@@ -117,6 +117,23 @@ status:
       type: str
       returned: always
       description: Dict of Values used to deploy
+    hooks:
+      type: list
+      elements: dict
+      description: Hooks of the release
+      returned: always
+      version_added: "2.4.0"
+    notes:
+      type: str
+      description: Notes of the release
+      returned: always
+      version_added: "2.4.0"
+    manifest:
+      type: list
+      elements: dict
+      description: Manifest of the release
+      returned: always
+      version_added: "2.4.0"
 """
 
 import traceback
@@ -185,6 +202,9 @@ def get_release_status(module, release_name, release_state, get_all_values=False
         return None
 
     release["values"] = module.get_values(release_name, get_all_values)
+    release["manifest"] = module.get_manifest(release_name)
+    release["notes"] = module.get_notes(release_name)
+    release["hooks"] = module.get_hooks(release_name)
 
     return release
 

plugins/modules/helm_template.py

@@ -114,6 +114,31 @@ options:
       - Run C(helm repo update) before the operation. Can be run as part of the template generation or as a separate step.
     default: false
     type: bool
+  set_values:
+    description:
+      - Values to pass to chart configuration.
+    required: false
+    type: list
+    elements: dict
+    suboptions:
+      value:
+        description:
+          - Value to pass to chart configuration (e.g phase=prod).
+        type: str
+        required: true
+      value_type:
+        description:
+          - Use C(raw) set individual value.
+          - Use C(string) to force a string for an individual value.
+          - Use C(file) to set individual values from a file when the value itself is too long for the command line or is dynamically generated.
+          - Use C(json) to set json values (scalars/objects/arrays). This feature requires helm>=3.10.0.
+        default: raw
+        choices:
+          - raw
+          - string
+          - json
+          - file
+    version_added: '2.4.0'
 """
 
 EXAMPLES = r"""
@@ -201,6 +226,7 @@ def template(
     release_values=None,
     values_files=None,
     include_crds=False,
+    set_values=None,
 ):
     cmd += " template "
 
@@ -244,6 +270,9 @@ def template(
     if include_crds:
         cmd += " --include-crds"
 
+    if set_values:
+        cmd += " " + set_values
+
     return cmd
 
 
@@ -264,6 +293,7 @@ def main():
             show_only=dict(type="list", default=[], elements="str"),
             values_files=dict(type="list", default=[], elements="str"),
             update_repo_cache=dict(type="bool", default=False),
+            set_values=dict(type="list", elements="dict"),
         ),
         supports_check_mode=True,
     )
@@ -282,6 +312,7 @@ def main():
     release_values = module.params.get("release_values")
     values_files = module.params.get("values_files")
     update_repo_cache = module.params.get("update_repo_cache")
+    set_values = module.params.get("set_values")
 
     if not IMP_YAML:
         module.fail_json(msg=missing_required_lib("yaml"), exception=IMP_YAML_ERR)
@@ -292,6 +323,10 @@ def main():
         update_cmd = helm_cmd + " repo update"
         module.run_helm_command(update_cmd)
 
+    set_values_args = None
+    if set_values:
+        set_values_args = module.get_helm_set_values_args(set_values)
+
     tmpl_cmd = template(
         helm_cmd,
         chart_ref,
@@ -306,6 +341,7 @@ def main():
         show_only=show_only,
         values_files=values_files,
         include_crds=include_crds,
+        set_values=set_values_args,
     )
 
     if not check_mode: