helm_repository: Added support for common options (#370)

helm_repository: Added support for common options SUMMARY Added support for host, api_key, ca_cert, and validate_certs in helm_repository module. Signed-off-by: Abhijeet Kasurde [email protected] ISSUE TYPE Bugfix Pull Request COMPONENT NAME changelogs/fragments/helm_repository.yml plugins/modules/helm_repository.py
ansible-collections · Feb 9, 2022 · e62a271 · e62a271
1 parent 583de32
commit e62a271
Show file tree

Hide file tree

Showing 2 changed files with 45 additions and 1 deletion.
diff --git a/changelogs/fragments/helm_repository.yml b/changelogs/fragments/helm_repository.yml
@@ -0,0 +1,3 @@
+---
+minor_changes:
+- helm_repository - added support for ``host``, ``api_key``, ``validate_certs``, and ``ca_cert``.
diff --git a/plugins/modules/helm_repository.py b/plugins/modules/helm_repository.py
@@ -72,6 +72,31 @@
     default: false
     type: bool
     version_added: 2.3.0
+  host:
+    description:
+    - Provide a URL for accessing the API. Can also be specified via C(K8S_AUTH_HOST) environment variable.
+    type: str
+    version_added: "2.3.0"
+  api_key:
+    description:
+    - Token used to authenticate with the API. Can also be specified via C(K8S_AUTH_API_KEY) environment variable.
+    type: str
+    version_added: "2.3.0"
+  validate_certs:
+    description:
+    - Whether or not to verify the API server's SSL certificates. Can also be specified via C(K8S_AUTH_VERIFY_SSL)
+      environment variable.
+    type: bool
+    aliases: [ verify_ssl ]
+    default: True
+    version_added: "2.3.0"
+  ca_cert:
+    description:
+    - Path to a CA certificate used to authenticate with the API. The full certificate chain must be provided to
+      avoid certificate validation errors. Can also be specified via C(K8S_AUTH_SSL_CA_CERT) environment variable.
+    type: path
+    aliases: [ ssl_ca_cert ]
+    version_added: "2.3.0"
 """
 
 EXAMPLES = r"""
@@ -129,7 +154,7 @@
     IMP_YAML_ERR = traceback.format_exc()
     IMP_YAML = False
 
-from ansible.module_utils.basic import AnsibleModule, missing_required_lib
+from ansible.module_utils.basic import AnsibleModule, env_fallback, missing_required_lib
 from ansible_collections.kubernetes.core.plugins.module_utils.helm import run_helm
 
 
@@ -204,6 +229,22 @@ def main():
                 default="present", choices=["present", "absent"], aliases=["state"]
             ),
             pass_credentials=dict(type="bool", default=False),
+            # 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"])
+            ),
         ),
         required_together=[["repo_username", "repo_password"]],
         required_if=[("repo_state", "present", ["repo_url"])],