helm - add support for in-memory kubeconfig (#497)

helm - add support for in-memory kubeconfig

SUMMARY

closes #492

ISSUE TYPE


Feature Pull Request

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

plugins/modules/helm.py

@@ -336,6 +336,7 @@ command:
 import re
 import tempfile
 import traceback
+import copy
 from ansible_collections.kubernetes.core.plugins.module_utils.version import (
     LooseVersion,
 )
@@ -348,13 +349,17 @@ except ImportError:
     IMP_YAML_ERR = traceback.format_exc()
     IMP_YAML = False
 
-from ansible.module_utils.basic import AnsibleModule, missing_required_lib, env_fallback
+from ansible.module_utils.basic import AnsibleModule, missing_required_lib
 from ansible_collections.kubernetes.core.plugins.module_utils.helm import (
     run_helm,
     get_values,
     get_helm_plugin_list,
     parse_helm_plugin_list,
     get_helm_version,
+    get_helm_binary,
+)
+from ansible_collections.kubernetes.core.plugins.module_utils.helm_args_common import (
+    HELM_AUTH_ARG_SPEC,
 )
 
 
@@ -531,13 +536,12 @@ def load_values_files(values_files):
     return values
 
 
-def get_plugin_version(command, plugin):
+def get_plugin_version(helm_bin, plugin):
     """
     Check if helm plugin is installed and return corresponding version
     """
 
-    cmd = command + " plugin"
-    rc, output, err = get_helm_plugin_list(module, helm_bin=cmd)
+    rc, output, err = get_helm_plugin_list(module, helm_bin=helm_bin)
     out = parse_helm_plugin_list(module, output=output.splitlines())
 
     if not out:
@@ -612,11 +616,10 @@ def default_check(release_status, chart_info, values=None, values_files=None):
     )
 
 
-def main():
-    global module
-    module = AnsibleModule(
-        argument_spec=dict(
-            binary_path=dict(type="path"),
+def argument_spec():
+    arg_spec = copy.deepcopy(HELM_AUTH_ARG_SPEC)
+    arg_spec.update(
+        dict(
             chart_ref=dict(type="path"),
             chart_repo_url=dict(type="str"),
             chart_version=dict(type="str"),
@@ -629,19 +632,8 @@ def main():
             release_values=dict(type="dict", default={}, aliases=["values"]),
             values_files=dict(type="list", default=[], elements="str"),
             update_repo_cache=dict(type="bool", default=False),
-            # Helm options
             disable_hook=dict(type="bool", default=False),
             force=dict(type="bool", default=False),
-            context=dict(
-                type="str",
-                aliases=["kube_context"],
-                fallback=(env_fallback, ["K8S_AUTH_CONTEXT"]),
-            ),
-            kubeconfig=dict(
-                type="path",
-                aliases=["kubeconfig_path"],
-                fallback=(env_fallback, ["K8S_AUTH_KUBECONFIG"]),
-            ),
             purge=dict(type="bool", default=True),
             wait=dict(type="bool", default=False),
             wait_timeout=dict(type="str"),
@@ -652,23 +644,15 @@ def main():
             replace=dict(type="bool", default=False),
             skip_crds=dict(type="bool", default=False),
             history_max=dict(type="int"),
-            # Generic auth key
-            host=dict(type="str", fallback=(env_fallback, ["K8S_AUTH_HOST"])),
-            ca_cert=dict(
-                type="path",
-                aliases=["ssl_ca_cert"],
-                fallback=(env_fallback, ["K8S_AUTH_SSL_CA_CERT"]),
-            ),
-            validate_certs=dict(
-                type="bool",
-                default=True,
-                aliases=["verify_ssl"],
-                fallback=(env_fallback, ["K8S_AUTH_VERIFY_SSL"]),
-            ),
-            api_key=dict(
-                type="str", no_log=True, fallback=(env_fallback, ["K8S_AUTH_API_KEY"])
-            ),
-        ),
+        )
+    )
+    return arg_spec
+
+
+def main():
+    global module
+    module = AnsibleModule(
+        argument_spec=argument_spec(),
         required_if=[
             ("release_state", "present", ["release_name", "chart_ref"]),
             ("release_state", "absent", ["release_name"]),
@@ -687,7 +671,6 @@ def main():
 
     changed = False
 
-    bin_path = module.params.get("binary_path")
     chart_ref = module.params.get("chart_ref")
     chart_repo_url = module.params.get("chart_repo_url")
     chart_version = module.params.get("chart_version")
@@ -712,10 +695,8 @@ def main():
     history_max = module.params.get("history_max")
     timeout = module.params.get("timeout")
 
-    if bin_path is not None:
-        helm_cmd_common = bin_path
-    else:
-        helm_cmd_common = module.get_bin_path("helm", required=True)
+    helm_cmd_common = get_helm_binary(module)
+    helm_bin = helm_cmd_common
 
     if update_repo_cache:
         run_repo_update(module, helm_cmd_common)
@@ -808,7 +789,7 @@ def main():
 
         else:
 
-            helm_diff_version = get_plugin_version(helm_cmd_common, "diff")
+            helm_diff_version = get_plugin_version(helm_bin, "diff")
             if helm_diff_version and (
                 not chart_repo_url
                 or (

plugins/modules/helm_info.py

@@ -112,6 +112,7 @@ status:
 """
 
 import traceback
+import copy
 
 try:
     import yaml
@@ -121,10 +122,15 @@ except ImportError:
     IMP_YAML_ERR = traceback.format_exc()
     IMP_YAML = False
 
-from ansible.module_utils.basic import AnsibleModule, missing_required_lib, env_fallback
+from ansible.module_utils.basic import AnsibleModule, missing_required_lib
 from ansible_collections.kubernetes.core.plugins.module_utils.helm import (
     run_helm,
     get_values,
+    get_helm_binary,
+)
+from ansible_collections.kubernetes.core.plugins.module_utils.helm_args_common import (
+    HELM_AUTH_ARG_SPEC,
+    HELM_AUTH_MUTUALLY_EXCLUSIVE,
 )
 
 
@@ -176,63 +182,34 @@ def get_release_status(module, command, release_name, release_state):
     return release
 
 
+def argument_spec():
+    arg_spec = copy.deepcopy(HELM_AUTH_ARG_SPEC)
+    arg_spec.update(
+        dict(
+            release_name=dict(type="str", required=True, aliases=["name"]),
+            release_namespace=dict(type="str", required=True, aliases=["namespace"]),
+            release_state=dict(type="list", default=[], elements="str"),
+        )
+    )
+    return arg_spec
+
+
 def main():
     global module
 
     module = AnsibleModule(
-        argument_spec=dict(
-            binary_path=dict(type="path"),
-            release_name=dict(type="str", required=True, aliases=["name"]),
-            release_namespace=dict(type="str", required=True, aliases=["namespace"]),
-            # Helm options
-            context=dict(
-                type="str",
-                aliases=["kube_context"],
-                fallback=(env_fallback, ["K8S_AUTH_CONTEXT"]),
-            ),
-            kubeconfig=dict(
-                type="path",
-                aliases=["kubeconfig_path"],
-                fallback=(env_fallback, ["K8S_AUTH_KUBECONFIG"]),
-            ),
-            # Generic auth key
-            host=dict(type="str", fallback=(env_fallback, ["K8S_AUTH_HOST"])),
-            ca_cert=dict(
-                type="path",
-                aliases=["ssl_ca_cert"],
-                fallback=(env_fallback, ["K8S_AUTH_SSL_CA_CERT"]),
-            ),
-            validate_certs=dict(
-                type="bool",
-                default=True,
-                aliases=["verify_ssl"],
-                fallback=(env_fallback, ["K8S_AUTH_VERIFY_SSL"]),
-            ),
-            api_key=dict(
-                type="str", no_log=True, fallback=(env_fallback, ["K8S_AUTH_API_KEY"])
-            ),
-            release_state=dict(type="list", default=[], elements="str"),
-        ),
-        mutually_exclusive=[
-            ("context", "ca_cert"),
-            ("context", "validate_certs"),
-            ("kubeconfig", "ca_cert"),
-            ("kubeconfig", "validate_certs"),
-        ],
+        argument_spec=argument_spec(),
+        mutually_exclusive=HELM_AUTH_MUTUALLY_EXCLUSIVE,
         supports_check_mode=True,
     )
 
     if not IMP_YAML:
         module.fail_json(msg=missing_required_lib("yaml"), exception=IMP_YAML_ERR)
 
-    bin_path = module.params.get("binary_path")
     release_name = module.params.get("release_name")
     release_state = module.params.get("release_state")
 
-    if bin_path is not None:
-        helm_cmd_common = bin_path
-    else:
-        helm_cmd_common = module.get_bin_path("helm", required=True)
+    helm_cmd_common = get_helm_binary(module)
 
     release_status = get_release_status(
         module, helm_cmd_common, release_name, release_state

plugins/modules/helm_plugin.py

@@ -108,21 +108,24 @@ rc:
   sample: 1
 """
 
-from ansible.module_utils.basic import AnsibleModule, env_fallback
+import copy
+from ansible.module_utils.basic import AnsibleModule
 from ansible_collections.kubernetes.core.plugins.module_utils.helm import (
     run_helm,
     get_helm_plugin_list,
     parse_helm_plugin_list,
+    get_helm_binary,
+)
+from ansible_collections.kubernetes.core.plugins.module_utils.helm_args_common import (
+    HELM_AUTH_ARG_SPEC,
+    HELM_AUTH_MUTUALLY_EXCLUSIVE,
 )
 
 
-def main():
-    module = AnsibleModule(
-        argument_spec=dict(
-            binary_path=dict(type="path"),
-            state=dict(
-                type="str", default="present", choices=["present", "absent", "latest"]
-            ),
+def argument_spec():
+    arg_spec = copy.deepcopy(HELM_AUTH_ARG_SPEC)
+    arg_spec.update(
+        dict(
             plugin_path=dict(
                 type="str",
             ),
@@ -132,60 +135,38 @@ def main():
             plugin_version=dict(
                 type="str",
             ),
-            # Helm options
-            context=dict(
+            state=dict(
                 type="str",
-                aliases=["kube_context"],
-                fallback=(env_fallback, ["K8S_AUTH_CONTEXT"]),
+                default="present",
+                choices=["present", "absent", "latest"],
             ),
-            kubeconfig=dict(
-                type="path",
-                aliases=["kubeconfig_path"],
-                fallback=(env_fallback, ["K8S_AUTH_KUBECONFIG"]),
-            ),
-            # Generic auth key
-            host=dict(type="str", fallback=(env_fallback, ["K8S_AUTH_HOST"])),
-            ca_cert=dict(
-                type="path",
-                aliases=["ssl_ca_cert"],
-                fallback=(env_fallback, ["K8S_AUTH_SSL_CA_CERT"]),
-            ),
-            validate_certs=dict(
-                type="bool",
-                default=True,
-                aliases=["verify_ssl"],
-                fallback=(env_fallback, ["K8S_AUTH_VERIFY_SSL"]),
-            ),
-            api_key=dict(
-                type="str", no_log=True, fallback=(env_fallback, ["K8S_AUTH_API_KEY"])
-            ),
-        ),
+        )
+    )
+    return arg_spec
+
+
+def mutually_exclusive():
+    mutually_ex = copy.deepcopy(HELM_AUTH_MUTUALLY_EXCLUSIVE)
+    mutually_ex.append(("plugin_name", "plugin_path"))
+    return mutually_ex
+
+
+def main():
+    module = AnsibleModule(
+        argument_spec=argument_spec(),
         supports_check_mode=True,
         required_if=[
             ("state", "present", ("plugin_path",)),
             ("state", "absent", ("plugin_name",)),
             ("state", "latest", ("plugin_name",)),
         ],
-        mutually_exclusive=[
-            ("plugin_name", "plugin_path"),
-            ("context", "ca_cert"),
-            ("context", "validate_certs"),
-            ("kubeconfig", "ca_cert"),
-            ("kubeconfig", "validate_certs"),
-        ],
+        mutually_exclusive=mutually_exclusive(),
     )
 
-    bin_path = module.params.get("binary_path")
     state = module.params.get("state")
+    helm_bin = get_helm_binary(module)
 
-    if bin_path is not None:
-        helm_cmd_common = bin_path
-    else:
-        helm_cmd_common = "helm"
-
-    helm_cmd_common = module.get_bin_path(helm_cmd_common, required=True)
-
-    helm_cmd_common += " plugin"
+    helm_cmd_common = helm_bin + " plugin"
 
     if state == "present":
         helm_cmd_common += " install %s" % module.params.get("plugin_path")
@@ -227,7 +208,7 @@ def main():
             )
     elif state == "absent":
         plugin_name = module.params.get("plugin_name")
-        rc, output, err = get_helm_plugin_list(module, helm_bin=helm_cmd_common)
+        rc, output, err = get_helm_plugin_list(module, helm_bin=helm_bin)
         out = parse_helm_plugin_list(module, output=output.splitlines())
 
         if not out:
@@ -281,7 +262,7 @@ def main():
         )
     elif state == "latest":
         plugin_name = module.params.get("plugin_name")
-        rc, output, err = get_helm_plugin_list(module, helm_bin=helm_cmd_common)
+        rc, output, err = get_helm_plugin_list(module, helm_bin=helm_bin)
         out = parse_helm_plugin_list(module, output=output.splitlines())
 
         if not out:

plugins/modules/helm_plugin_info.py

@@ -70,73 +70,43 @@ rc:
   sample: 1
 """
 
-from ansible.module_utils.basic import AnsibleModule, env_fallback
+import copy
+from ansible.module_utils.basic import AnsibleModule
 from ansible_collections.kubernetes.core.plugins.module_utils.helm import (
     get_helm_plugin_list,
     parse_helm_plugin_list,
+    get_helm_binary,
+)
+from ansible_collections.kubernetes.core.plugins.module_utils.helm_args_common import (
+    HELM_AUTH_ARG_SPEC,
+    HELM_AUTH_MUTUALLY_EXCLUSIVE,
 )
 
 
 def main():
-    module = AnsibleModule(
-        argument_spec=dict(
-            binary_path=dict(type="path"),
+
+    argument_spec = copy.deepcopy(HELM_AUTH_ARG_SPEC)
+    argument_spec.update(
+        dict(
             plugin_name=dict(
                 type="str",
             ),
-            # Helm options
-            context=dict(
-                type="str",
-                aliases=["kube_context"],
-                fallback=(env_fallback, ["K8S_AUTH_CONTEXT"]),
-            ),
-            kubeconfig=dict(
-                type="path",
-                aliases=["kubeconfig_path"],
-                fallback=(env_fallback, ["K8S_AUTH_KUBECONFIG"]),
-            ),
-            # Generic auth key
-            host=dict(type="str", fallback=(env_fallback, ["K8S_AUTH_HOST"])),
-            ca_cert=dict(
-                type="path",
-                aliases=["ssl_ca_cert"],
-                fallback=(env_fallback, ["K8S_AUTH_SSL_CA_CERT"]),
-            ),
-            validate_certs=dict(
-                type="bool",
-                default=True,
-                aliases=["verify_ssl"],
-                fallback=(env_fallback, ["K8S_AUTH_VERIFY_SSL"]),
-            ),
-            api_key=dict(
-                type="str", no_log=True, fallback=(env_fallback, ["K8S_AUTH_API_KEY"])
-            ),
-        ),
-        mutually_exclusive=[
-            ("context", "ca_cert"),
-            ("context", "validate_certs"),
-            ("kubeconfig", "ca_cert"),
-            ("kubeconfig", "validate_certs"),
-        ],
+        )
+    )
+
+    module = AnsibleModule(
+        argument_spec=argument_spec,
+        mutually_exclusive=HELM_AUTH_MUTUALLY_EXCLUSIVE,
         supports_check_mode=True,
     )
 
-    bin_path = module.params.get("binary_path")
-
-    if bin_path is not None:
-        helm_cmd_common = bin_path
-    else:
-        helm_cmd_common = "helm"
-
-    helm_cmd_common = module.get_bin_path(helm_cmd_common, required=True)
-
-    helm_cmd_common += " plugin"
+    helm_bin = get_helm_binary(module)
 
     plugin_name = module.params.get("plugin_name")
 
     plugin_list = []
 
-    rc, output, err = get_helm_plugin_list(module, helm_bin=helm_cmd_common)
+    rc, output, err = get_helm_plugin_list(module, helm_bin=helm_bin)
 
     out = parse_helm_plugin_list(module, output=output.splitlines())
 
@@ -155,7 +125,7 @@ def main():
 
     module.exit_json(
         changed=True,
-        command=helm_cmd_common + " list",
+        command=helm_bin + " plugin list",
         stdout=output,
         stderr=err,
         rc=rc,

plugins/modules/helm_repository.py

@@ -97,6 +97,21 @@ options:
     type: path
     aliases: [ ssl_ca_cert ]
     version_added: "2.3.0"
+  context:
+    description:
+      - Helm option to specify which kubeconfig context to use.
+      - If the value is not specified in the task, the value of environment variable C(K8S_AUTH_CONTEXT) will be used instead.
+    type: str
+    aliases: [ kube_context ]
+    version_added: "2.4.0"
+  kubeconfig:
+    description:
+      - Helm option to specify kubeconfig path to use.
+      - If the value is not specified in the task, the value of environment variable C(K8S_AUTH_KUBECONFIG) will be used instead.
+      - The configuration can be provided as dictionary.
+    type: raw
+    aliases: [ kubeconfig_path ]
+    version_added: "2.4.0"
 """
 
 EXAMPLES = r"""
@@ -145,6 +160,7 @@ msg:
 """
 
 import traceback
+import copy
 
 try:
     import yaml
@@ -154,8 +170,15 @@ except ImportError:
     IMP_YAML_ERR = traceback.format_exc()
     IMP_YAML = False
 
-from ansible.module_utils.basic import AnsibleModule, env_fallback, missing_required_lib
-from ansible_collections.kubernetes.core.plugins.module_utils.helm import run_helm
+from ansible.module_utils.basic import AnsibleModule, missing_required_lib
+from ansible_collections.kubernetes.core.plugins.module_utils.helm import (
+    run_helm,
+    get_helm_binary,
+)
+from ansible_collections.kubernetes.core.plugins.module_utils.helm_args_common import (
+    HELM_AUTH_ARG_SPEC,
+    HELM_AUTH_MUTUALLY_EXCLUSIVE,
+)
 
 
 # Get repository from all repositories added
@@ -215,12 +238,10 @@ def delete_repository(command, repository_name):
     return remove_command
 
 
-def main():
-    global module
-
-    module = AnsibleModule(
-        argument_spec=dict(
-            binary_path=dict(type="path"),
+def argument_spec():
+    arg_spec = copy.deepcopy(HELM_AUTH_ARG_SPEC)
+    arg_spec.update(
+        dict(
             repo_name=dict(type="str", aliases=["name"], required=True),
             repo_url=dict(type="str", aliases=["url"]),
             repo_username=dict(type="str", aliases=["username"]),
@@ -229,25 +250,19 @@ def main():
                 default="present", choices=["present", "absent"], aliases=["state"]
             ),
             pass_credentials=dict(type="bool", default=False, no_log=True),
-            # Generic auth key
-            host=dict(type="str", fallback=(env_fallback, ["K8S_AUTH_HOST"])),
-            ca_cert=dict(
-                type="path",
-                aliases=["ssl_ca_cert"],
-                fallback=(env_fallback, ["K8S_AUTH_SSL_CA_CERT"]),
-            ),
-            validate_certs=dict(
-                type="bool",
-                default=True,
-                aliases=["verify_ssl"],
-                fallback=(env_fallback, ["K8S_AUTH_VERIFY_SSL"]),
-            ),
-            api_key=dict(
-                type="str", no_log=True, fallback=(env_fallback, ["K8S_AUTH_API_KEY"])
-            ),
-        ),
+        )
+    )
+    return arg_spec
+
+
+def main():
+    global module
+
+    module = AnsibleModule(
+        argument_spec=argument_spec(),
         required_together=[["repo_username", "repo_password"]],
         required_if=[("repo_state", "present", ["repo_url"])],
+        mutually_exclusive=HELM_AUTH_MUTUALLY_EXCLUSIVE,
         supports_check_mode=True,
     )
 
@@ -256,7 +271,6 @@ def main():
 
     changed = False
 
-    bin_path = module.params.get("binary_path")
     repo_name = module.params.get("repo_name")
     repo_url = module.params.get("repo_url")
     repo_username = module.params.get("repo_username")
@@ -264,10 +278,7 @@ def main():
     repo_state = module.params.get("repo_state")
     pass_credentials = module.params.get("pass_credentials")
 
-    if bin_path is not None:
-        helm_cmd = bin_path
-    else:
-        helm_cmd = module.get_bin_path("helm", required=True)
+    helm_cmd = get_helm_binary(module)
 
     repository_status = get_repository_status(module, helm_cmd, repo_name)
 

plugins/modules/helm_template.py

@@ -181,7 +181,10 @@ except ImportError:
     IMP_YAML = False
 
 from ansible.module_utils.basic import AnsibleModule, missing_required_lib
-from ansible_collections.kubernetes.core.plugins.module_utils.helm import run_helm
+from ansible_collections.kubernetes.core.plugins.module_utils.helm import (
+    run_helm,
+    get_helm_binary,
+)
 
 
 def template(
@@ -266,7 +269,6 @@ def main():
     )
 
     check_mode = module.check_mode
-    bin_path = module.params.get("binary_path")
     chart_ref = module.params.get("chart_ref")
     chart_repo_url = module.params.get("chart_repo_url")
     chart_version = module.params.get("chart_version")
@@ -284,7 +286,7 @@ def main():
     if not IMP_YAML:
         module.fail_json(msg=missing_required_lib("yaml"), exception=IMP_YAML_ERR)
 
-    helm_cmd = bin_path or module.get_bin_path("helm", required=True)
+    helm_cmd = get_helm_binary(module)
 
     if update_repo_cache:
         update_cmd = helm_cmd + " repo update"