New Modules for NDB features for 1.8.0-beta.1 release

meta/runtime.yml

@@ -63,3 +63,11 @@ action_groups:
   - ntnx_karbon_clusters_info
   - ntnx_karbon_registries
   - ntnx_karbon_registries_info
+  - ntnx_ndb_databases_info
+  - ntnx_ndb_clones_info
+  - ntnx_ndb_time_machines_info
+  - ntnx_ndb_profiles_info
+  - ntnx_ndb_db_servers_info
+  - ntnx_ndb_slas_info
+  - ntnx_ndb_databases
+  - ntnx_ndb_clusters_info

plugins/module_utils/constants.py

@@ -277,3 +277,12 @@ class EntityFilterExpressionList:
                 "right_hand_side": {"collection": "SELF_OWNED"},
             },
         }
+
+
+class NDB:
+    class DatabaseTypes:
+        POSTGRES = "postgres_database"
+
+    class StatusCodes:
+        SUCCESS = "5"
+        FAILURE = "4"

plugins/module_utils/entity.py

@@ -28,13 +28,16 @@ def __init__(
         self,
         module,
         resource_type,
+        host_ip,
         scheme="https",
         cookies=None,
         additional_headers=None,
+        port=None,
+        credentials=None,
     ):
         self.module = module
-        self.base_url = self._build_url(module, scheme, resource_type)
-        self.headers = self._build_headers(module, additional_headers)
+        self.base_url = self._build_url(scheme, resource_type, host_ip, port)
+        self.headers = self._build_headers(additional_headers, credentials)
         self.cookies = cookies
 
     def create(
@@ -90,6 +93,7 @@ def update(
         raise_error=True,
         no_response=False,
         timeout=30,
+        method="PUT",
     ):
         url = self.base_url + "/{0}".format(uuid) if uuid else self.base_url
         if endpoint:
@@ -98,7 +102,7 @@ def update(
             url = self._build_url_with_query(url, query)
         return self._fetch_url(
             url,
-            method="PUT",
+            method=method,
             data=data,
             raise_error=raise_error,
             no_response=no_response,
@@ -136,6 +140,7 @@ def delete(
         raise_error=True,
         no_response=False,
         timeout=30,
+        data=None,
     ):
         url = self.base_url + "/{0}".format(uuid) if uuid else self.base_url
         if endpoint:
@@ -145,6 +150,7 @@ def delete(
         return self._fetch_url(
             url,
             method="DELETE",
+            data=data,
             raise_error=raise_error,
             no_response=no_response,
             timeout=timeout,
@@ -287,10 +293,8 @@ def get_info_spec(self):
 
         return spec, None
 
-    def _build_url(self, module, scheme, resource_type):
-        host = module.params.get("nutanix_host")
-        url = "{proto}://{host}".format(proto=scheme, host=host)
-        port = module.params.get("nutanix_port")
+    def _build_url(self, scheme, resource_type, host_ip, port=None):
+        url = "{proto}://{host}".format(proto=scheme, host=host_ip)
         if port:
             url += ":{0}".format(port)
         if resource_type.startswith("/"):
@@ -299,12 +303,17 @@ def _build_url(self, module, scheme, resource_type):
             url += "/{0}".format(resource_type)
         return url
 
-    def _build_headers(self, module, additional_headers):
+    def _build_headers(self, additional_headers, credentials=None):
         headers = {"Content-Type": "application/json", "Accept": "application/json"}
         if additional_headers:
             headers.update(additional_headers)
-        usr = module.params.get("nutanix_username")
-        pas = module.params.get("nutanix_password")
+
+        usr = ""
+        pas = ""
+        if credentials:
+            usr = credentials.get("username")
+            pas = credentials.get("password")
+
         if usr and pas:
             cred = "{0}:{1}".format(usr, pas)
             try:
@@ -384,7 +393,7 @@ def _fetch_url(
         if no_response:
             return {"status_code": status_code}
 
-        if not resp_json:
+        if resp_json is None:
             self.module.fail_json(
                 msg="Failed to convert API response to json",
                 status_code=status_code,

plugins/module_utils/fc/fc.py

@@ -10,4 +10,12 @@ class FoundationCentral(Entity):
 
     def __init__(self, module, resource_type):
         resource_type = self.__BASEURL__ + resource_type
-        super(FoundationCentral, self).__init__(module, resource_type)
+        host_ip = module.params.get("nutanix_host")
+        port = module.params.get("nutanix_port")
+        credentials = {
+            "username": module.params.get("nutanix_username"),
+            "password": module.params.get("nutanix_password"),
+        }
+        super(FoundationCentral, self).__init__(
+            module, resource_type, host_ip, port=port, credentials=credentials
+        )

plugins/module_utils/foundation/foundation.py

@@ -10,6 +10,13 @@ class Foundation(Entity):
 
     def __init__(self, module, resource_type, additional_headers=None):
         resource_type = self.__BASEURL__ + resource_type
+        host_ip = module.params.get("nutanix_host")
+        port = module.params.get("nutanix_port")
         super(Foundation, self).__init__(
-            module, resource_type, scheme="http", additional_headers=additional_headers
+            module,
+            resource_type,
+            host_ip,
+            scheme="http",
+            additional_headers=additional_headers,
+            port=port,
         )

plugins/module_utils/karbon/karbon.py

@@ -10,6 +10,17 @@ class Karbon(Entity):
 
     def __init__(self, module, resource_type, additional_headers=None):
         resource_type = self.__BASEURL__ + resource_type
+        host_ip = module.params.get("nutanix_host")
+        port = module.params.get("nutanix_port")
+        credentials = {
+            "username": module.params.get("nutanix_username"),
+            "password": module.params.get("nutanix_password"),
+        }
         super(Karbon, self).__init__(
-            module, resource_type, additional_headers=additional_headers
+            module,
+            resource_type,
+            host_ip,
+            additional_headers=additional_headers,
+            port=port,
+            credentials=credentials,
         )

plugins/module_utils/ndb/base_module.py

@@ -0,0 +1,39 @@
+# Copyright: 2021, Ansible Project
+# Simplified BSD License (see licenses/simplified_bsd.txt or https://opensource.org/licenses/BSD-2-Clause )
+from __future__ import absolute_import, division, print_function
+
+from ansible.module_utils.basic import AnsibleModule, env_fallback
+
+__metaclass__ = type
+
+
+class NdbBaseModule(AnsibleModule):
+    argument_spec = dict(
+        ndb_host=dict(type="str", required=True, fallback=(env_fallback, ["NDB_HOST"])),
+        ndb_username=dict(
+            type="str", fallback=(env_fallback, ["NDB_USERNAME"]), required=True
+        ),
+        ndb_password=dict(
+            type="str",
+            no_log=True,
+            fallback=(env_fallback, ["NDB_PASSWORD"]),
+            required=True,
+        ),
+        validate_certs=dict(
+            type="bool", default=True, fallback=(env_fallback, ["VALIDATE_CERTS"])
+        ),
+        state=dict(type="str", choices=["present", "absent"], default="present"),
+        timeout=dict(type="int", required=False, default=35 * 60),
+        wait=dict(type="bool", default=True),
+    )
+
+    def __init__(self, **kwargs):
+        if kwargs.get("argument_spec"):
+            kwargs["argument_spec"].update(self.argument_spec)
+        else:
+            kwargs["argument_spec"] = self.argument_spec
+
+        if not kwargs.get("supports_check_mode"):
+            kwargs["supports_check_mode"] = True
+
+        super(NdbBaseModule, self).__init__(**kwargs)

plugins/module_utils/ndb/clones.py

@@ -0,0 +1,35 @@
+# This file is part of Ansible
+# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
+from __future__ import absolute_import, division, print_function
+
+__metaclass__ = type
+
+
+from .nutanix_database import NutanixDatabase
+
+
+class Clone(NutanixDatabase):
+    def __init__(self, module):
+        resource_type = "/clones"
+        super(Clone, self).__init__(module, resource_type=resource_type)
+
+    def get_clone(self, uuid=None, name=None):
+        if uuid:
+            resp = self.read(uuid=uuid, raise_error=False)
+        elif name:
+            query = {"value-type": "name", "value": name}
+            resp = self.read(query=query)
+            if not resp:
+                return None, "Clone with name {0} not found".format(name)
+            resp = resp[0]
+        else:
+            return None, "Please provide either uuid or name for fetching clone details"
+
+        if isinstance(resp, dict) and resp.get("errorCode"):
+            self.module.fail_json(
+                msg="Failed fetching clone info",
+                error=resp.get("message"),
+                response=resp,
+            )
+
+        return resp, None

plugins/module_utils/ndb/clusters.py

@@ -0,0 +1,69 @@
+# This file is part of Ansible
+# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
+from __future__ import absolute_import, division, print_function
+
+__metaclass__ = type
+
+
+from .nutanix_database import NutanixDatabase
+
+
+class Cluster(NutanixDatabase):
+    def __init__(self, module):
+        resource_type = "/clusters"
+        super(Cluster, self).__init__(module, resource_type=resource_type)
+
+    def get_uuid(
+        self,
+        value,
+        key="name",
+        data=None,
+        entity_type=None,
+        raise_error=True,
+        no_response=False,
+    ):
+        endpoint = "{0}/{1}".format(key, value)
+        resp = self.read(uuid=None, endpoint=endpoint)
+        return resp["id"]
+
+    def get_cluster(self, uuid=None, name=None):
+        if uuid:
+            resp = self.read(uuid=uuid, raise_error=False)
+        elif name:
+            endpoint = "{0}/{1}".format("name", name)
+            resp = self.read(endpoint=endpoint, raise_error=False)
+
+            # we fetch cluster using ID again to get complete info.
+            if resp and not resp.get("errorCode") and resp.get("id"):
+                resp = self.read(uuid=resp["id"])
+
+        else:
+            return (
+                None,
+                "Please provide either uuid or name for fetching cluster details",
+            )
+
+        if isinstance(resp, dict) and resp.get("errorCode"):
+            self.module.fail_json(
+                msg="Failed fetching cluster info",
+                error=resp.get("message"),
+                response=resp,
+            )
+
+        return resp, None
+
+
+# helper functions
+
+
+def get_cluster_uuid(module, config):
+    uuid = ""
+    if config.get("name"):
+        clusters = Cluster(module)
+        uuid = clusters.get_uuid(config["name"])
+    elif config.get("uuid"):
+        uuid = config["uuid"]
+    else:
+        error = "cluster config {0} doesn't have name or uuid key".format(config)
+        return error, None
+    return uuid, None