Update README, add kubernetes support

README.md

@@ -1,12 +1,12 @@
 # decort-ansible
-Ansible modules for Digital Energy Orchestration Technology (DECORT) platform v3.5.0 and above
+Ansible modules for Digital Energy Orchestration Technology (DECORT) platform v3.6.1 and above.
 
 Note that this module may produce unreliable results when used with older DECORT API versions. 
 
 Requirements:
 * Ansible 2.7 or higher
-* Python 2.6 or higher
+* Python 3.7 or higher
-* PyJWT Python module
+* PyJWT 2.0.0 Python module or higher
 * requests Python module
 * netaddr Python module
 * DECORT cloud platform version 3.5.0 or higher

examples/main.yaml

@@ -188,3 +188,136 @@
        var: my_pfw.facts
     delegate_to: localhost
 
+  - name: Create k8s cluster with params
+    decort_k8s:
+      authenticator: jwt
+      jwt: "{{ token.jwt }}"
+      controller_url: "{{ decort_ctrl }}"
+      k8s_name: "k8s_cluster_name"
+      wg_name: "k8s_wg_name"
+      k8ci_id: "{{ k8ci_id }}"
+      rg_id: "{{ my_rg.facts.id }}"
+      master_count: 1
+      master_cpu: 2
+      master_ram_mb: 2048
+      master_disk_gb: 20
+      worker_count: 3
+      worker_cpu: 1
+      worker_ram_mb: 1024
+      worker_disk_gb: 20
+      extnet_id: "{{ target_ext_net_id }}"
+      with_lb: True
+      state: present
+    register: k8s
+    delegate_to: localhost
+
+  - name: print out the result
+    debug:
+       var: k8s
+    delegate_to: localhost
+
+  - name: Disable k8s cluster
+    decort_k8s:
+      authenticator: jwt
+      jwt: "{{ token.jwt }}"
+      controller_url: "{{ decort_ctrl }}"
+      k8s_name: "k8s_cluster_name"
+      wg_name: "k8s_wg_name"
+      k8ci_id: "{{ k8ci_id }}"
+      rg_id: "{{ my_rg.facts.id }}"
+      state: disabled
+    register: k8s
+    delegate_to: localhost
+
+  - name: print out the result
+    debug:
+       var: k8s
+    delegate_to: localhost
+
+  - name: Delete in trash k8s cluster
+    decort_k8s:
+      authenticator: jwt
+      jwt: "{{ token.jwt }}"
+      controller_url: "{{ decort_ctrl }}"
+      k8s_name: "k8s_cluster_name"
+      wg_name: "k8s_wg_name"
+      k8ci_id: "{{ k8ci_id }}"
+      rg_id: "{{ my_rg.facts.id }}"
+      state: absent
+      permanent: False
+    register: k8s
+    delegate_to: localhost
+
+  - name: print out the result
+    debug:
+       var: k8s
+    delegate_to: localhost
+
+  - name: Restore from trash deleted k8s cluster
+    decort_k8s:
+      authenticator: jwt
+      jwt: "{{ token.jwt }}"
+      controller_url: "{{ decort_ctrl }}"
+      k8s_name: "k8s_cluster_name"
+      wg_name: "k8s_wg_name"
+      k8ci_id: "{{ k8ci_id }}"
+      rg_id: "{{ my_rg.facts.id }}"
+      state: enabled
+    register: k8s
+    delegate_to: localhost
+
+  - name: print out the result
+    debug:
+       var: k8s
+    delegate_to: localhost
+
+  - name: Enable k8s cluster 
+    decort_k8s:
+      authenticator: jwt
+      jwt: "{{ token.jwt }}"
+      controller_url: "{{ decort_ctrl }}"
+      k8s_name: "k8s_cluster_name"
+      wg_name: "k8s_wg_name"
+      k8ci_id: "{{ k8ci_id }}"
+      rg_id: "{{ my_rg.facts.id }}"
+      state: enabled
+    register: k8s
+    delegate_to: localhost
+
+  - name: Enable k8s cluster
+    decort_k8s:
+      authenticator: jwt
+      jwt: "{{ token.jwt }}"
+      controller_url: "{{ decort_ctrl }}"
+      k8s_name: "k8s_cluster_name"
+      wg_name: "k8s_wg_name"
+      k8ci_id: "{{ k8ci_id }}"
+      rg_id: "{{ my_rg.facts.id }}"
+      state: enabled
+      started: True
+    register: k8s
+    delegate_to: localhost
+
+  - name: print out the result
+    debug:
+       var: k8s
+    delegate_to: localhost
+
+  - name: Destroy k8s cluster
+    decort_k8s:
+      authenticator: jwt
+      jwt: "{{ token.jwt }}"
+      controller_url: "{{ decort_ctrl }}"
+      k8s_name: "k8s_cluster_name"
+      wg_name: "k8s_wg_name"
+      k8ci_id: "{{ k8ci_id }}"
+      rg_id: "{{ my_rg.facts.id }}"
+      state: absent
+      permanent: True
+    register: k8s
+    delegate_to: localhost
+
+  - name: print out the result
+    debug:
+       var: k8s
+    delegate_to: localhost

library/decort_disk.py

@@ -1,7 +1,7 @@
 #!/usr/bin/python
 #
 # Digital Enegry Cloud Orchestration Technology (DECORT) modules for Ansible
-# Copyright: (c) 2018-2020 Digital Energy Cloud Solutions LLC
+# Copyright: (c) 2018-2021 Digital Energy Cloud Solutions LLC
 #
 # Apache License 2.0 (see http://www.apache.org/licenses/LICENSE-2.0.txt)
 #
@@ -30,7 +30,7 @@ requirements:
      - requests Python module
      - netaddr Python module
      - decort_utils utility library (module)
-     - DECORT cloud platform version 3.4.2 or higher
+     - DECORT cloud platform version 3.6.1 or higher
 notes:
      - Environment variables can be used to pass selected parameters to the module, see details below.
      - Specified Oauth2 provider must be trusted by the DECORT cloud controller on which JWT will be used.
@@ -274,7 +274,7 @@ def decort_disk_package_facts(disk_facts, check_mode=False):
     ret_dict['size'] = disk_facts['sizeMax']
     ret_dict['state'] = disk_facts['status']
     ret_dict['account_id'] = disk_facts['accountId']
-    ret_dict['sep_id'] = disk_facts['sepid']
+    ret_dict['sep_id'] = disk_facts['sepId']
     ret_dict['pool'] = disk_facts['pool']
     ret_dict['attached_to'] = disk_facts['vmid']
     ret_dict['gid'] = disk_facts['gid']
@@ -454,10 +454,10 @@ def main():
                     # request to place this disk on the same SEP as the specified OS image
                     # validate specified OS image and assign SEP ID accordingly
                     image_id, image_facts = decon.image_find(amodule.params['place_with'], "", 0)
-                    target_sep_id = image_facts['sepid']
+                    target_sep_id = image_facts['sepId']
                 else:
-                    # no new SEP ID is explicitly specified, and no place_with option - use sep_id from the disk_facts
+                    # no new SEP ID is explicitly specified, and no place_with option - use sepId from the disk_facts
-                    target_sep_id = disk_facts['sepid']
+                    target_sep_id = disk_facts['sepId']
                 disk_id = decon.disk_provision(disk_name=disk_facts['name'], # as this disk was found, its name is in the facts
                                                size=amodule.params['size'],
                                                account_id=validated_acc_id, 
@@ -495,7 +495,7 @@ def main():
                 # request to place this disk on the same SEP as the specified OS image
                 # validate specified OS image and assign SEP ID accordingly
                 image_id, image_facts = decon.image_find(amodule.params['place_with'], "", 0)
-                target_sep_id = image_facts['sepid']
+                target_sep_id = image_facts['sepId']
             else:
                 # no SEP ID is explicitly specified, and no place_with option - we do not know where
                 # to place the new disk - fail the module

library/decort_jwt.py

@@ -1,7 +1,7 @@
 #!/usr/bin/python
 #
 # Digital Enegry Cloud Orchestration Technology (DECORT) modules for Ansible
-# Copyright: (c) 2018-2020 Digital Energy Cloud Solutions LLC
+# Copyright: (c) 2018-2021 Digital Energy Cloud Solutions LLC
 #
 # Apache License 2.0 (see http://www.apache.org/licenses/LICENSE-2.0.txt)
 #
@@ -32,7 +32,7 @@ requirements:
      - PyJWT module
      - requests module
      - decort_utils utility library (module)
-     - DECORT cloud platform version 3.4.2 or higher
+     - DECORT cloud platform version 3.6.1 or higher
 options:
     app_id:
         description:

library/decort_k8s.py

@@ -0,0 +1,236 @@
+#!/usr/bin/python
+#
+# Digital Enegry Cloud Orchestration Technology (DECORT) modules for Ansible
+# Copyright: (c) 2018-2021 Digital Energy Cloud Solutions LLC
+#
+# Apache License 2.0 (see http://www.apache.org/licenses/LICENSE-2.0.txt)
+#
+
+#
+# Author: Aleksandr Malyavin (aleksandr.malyavin@digitalenergy.online)
+#
+
+ANSIBLE_METADATA = {'metadata_version': '1.1',
+                    'status': ['preview'],
+                    'supported_by': 'community'}
+
+
+from ansible.module_utils.basic import AnsibleModule
+from ansible.module_utils.basic import env_fallback
+
+from ansible.module_utils.decort_utils import *
+
+
+def decort_k8s_package_facts(arg_k8s_facts, arg_check_mode=False):
+    """Package a dictionary of k8s facts according to the decort_k8s module specification. This dictionary will
+    be returned to the upstream Ansible engine at the completion of the module run.
+
+    @param arg_k8s_facts: dictionary with k8s facts as returned by API call to .../k8s/get
+    @param arg_check_mode: boolean that tells if this Ansible module is run in check mode
+    """
+
+    ret_dict = dict(id=0,
+                    name="none",
+                    state="CHECK_MODE",
+                    )
+
+    if arg_check_mode:
+        # in check mode return immediately with the default values
+        return ret_dict
+
+    if arg_k8s_facts is None:
+        # if void facts provided - change state value to ABSENT and return
+        ret_dict['state'] = "ABSENT"
+        return ret_dict
+
+    ret_dict['id'] = arg_k8s_facts['id']
+    ret_dict['name'] = arg_k8s_facts['name']
+    ret_dict['techStatus'] = arg_k8s_facts['techStatus']
+    ret_dict['state'] = arg_k8s_facts['status']
+
+    return ret_dict
+
+def decort_k8s_parameters():
+    """Build and return a dictionary of parameters expected by decort_k8s module in a form accepted
+    by AnsibleModule utility class."""
+
+    return dict(
+        account_id=dict(type='int', required=False),
+        account_name=dict(type='str', required=False, default=''),
+        annotation=dict(type='str', required=False, default=''),
+        app_id=dict(type='str',
+                    required=False,
+                    fallback=(env_fallback, ['DECORT_APP_ID'])),
+        app_secret=dict(type='str',
+                        required=False,
+                        fallback=(env_fallback, ['DECORT_APP_SECRET']),
+                        no_log=True),
+        authenticator=dict(type='str',
+                           required=True,
+                           choices=['legacy', 'oauth2', 'jwt']),
+        controller_url=dict(type='str', required=True),
+        # datacenter=dict(type='str', required=False, default=''),
+        jwt=dict(type='str',
+                 required=False,
+                 fallback=(env_fallback, ['DECORT_JWT']),
+                 no_log=True),
+        oauth2_url=dict(type='str',
+                        required=False,
+                        fallback=(env_fallback, ['DECORT_OAUTH2_URL'])),
+        password=dict(type='str',
+                      required=False,
+                      fallback=(env_fallback, ['DECORT_PASSWORD']),
+                      no_log=True),
+        quotas=dict(type='dict', required=False),
+        state=dict(type='str',
+                   default='present',
+                   choices=['absent', 'disabled', 'enabled', 'present']),
+        permanent=dict(type='bool', default=False),
+        started=dict(type='bool', default=True),
+        user=dict(type='str',
+                  required=False,
+                  fallback=(env_fallback, ['DECORT_USER'])),
+        k8s_name=dict(type='str', required=True),
+        rg_id=dict(type='int', required=True),
+        k8ci_id=dict(type='int', required=True),
+        wg_name=dict(type='str', required=True),
+        master_count=dict(type='int', default=1),
+        master_cpu=dict(type='int', default=2),
+        master_ram_mb=dict(type='int', default=2048),
+        master_disk_gb=dict(type='int', default=10),
+        worker_count=dict(type='int', default=1),
+        worker_cpu=dict(type='int', default=1),
+        worker_ram_mb=dict(type='int', default=1024),
+        worker_disk_gb=dict(type='int', default=0),
+        extnet_id=dict(type='int',  default=0),
+        description=dict(type='str', default="Created by decort ansible module"),
+        with_lb=dict(type='bool', default=True),
+        verify_ssl=dict(type='bool', required=False, default=True),
+        workflow_callback=dict(type='str', required=False),
+        workflow_context=dict(type='str', required=False),
+    )
+
+
+def main():
+    module_parameters = decort_k8s_parameters()
+
+    amodule = AnsibleModule(argument_spec=module_parameters,
+                            supports_check_mode=True,
+                            mutually_exclusive=[
+                                ['oauth2', 'password'],
+                                ['password', 'jwt'],
+                                ['jwt', 'oauth2'],
+                            ],
+                            required_together=[
+                                ['app_id', 'app_secret'],
+                                ['user', 'password'],
+                            ],
+                            )
+
+    decon = DecortController(amodule)
+    k8s_id, k8s_facts = decon.k8s_find(arg_k8s_name=amodule.params['k8s_name'],
+                                    arg_check_state=False)
+    k8s_should_exist = True
+
+    if k8s_id:
+        if k8s_facts['status'] in ["MODELED", "DISABLING", "ENABLING", "DELETING", "DESTROYING", "CREATING",
+                                   "RESTORING"] and amodule.params['state'] != "present":
+            decon.result['failed'] = True
+            decon.result['changed'] = False
+            decon.result['msg'] = ("No change can be done for existing k8s ID {} because of its current "
+                                   "status '{}'").format(k8s_id, k8s_facts['status'])
+        elif k8s_facts['status'] in ["DISABLED", "ENABLED", "CREATED", "DELETED"] and amodule.params['state'] == "absent":
+            if amodule.params['permanent'] is True:
+                decon.k8s_delete(k8s_id, True)
+                k8s_facts['status'] = 'DESTROYED'
+                k8s_should_exist = False
+            else:
+                decon.k8s_delete(k8s_id)
+                k8s_facts['status'] = 'DELETED'
+                k8s_should_exist = True
+        elif k8s_facts['status'] == "ENABLED" and amodule.params['started'] is True:
+            decon.k8s_state(k8s_facts, amodule.params['state'], amodule.params['started'])
+        elif k8s_facts['status'] == amodule.params['state'].upper():
+            decon.k8s_state(k8s_facts, amodule.params['state'])
+        elif k8s_facts['status'] in ["ENABLED", "CREATED"] and amodule.params['state'] == "disabled":
+            decon.k8s_state(k8s_facts, 'disabled')
+        elif k8s_facts['status'] in ["DISABLED", "CREATED"]:
+            if amodule.params['state'] == 'enabled':
+                decon.k8s_state(k8s_facts, 'enabled', amodule.params['started'])
+            elif amodule.params['state'] == "disabled":
+                decon.k8s_state(k8s_facts, 'disabled')
+            k8s_should_exist = True
+        elif k8s_facts['status'] == "DELETED":
+            if amodule.params['state'] in ('enabled', 'present'):
+                decon.k8s_restore(k8s_id)
+                k8s_should_exist = True
+            elif amodule.params['state'] == 'disabled':
+                decon.result['failed'] = True
+                decon.result['changed'] = False
+                decon.result['msg'] = ("Invalid target state '{}' requested for k8s ID {} in the "
+                                       "current status '{}'").format(k8s_id,
+                                                                     amodule.params['state'],
+                                                                     k8s_facts['status'])
+                k8s_should_exist = False
+        elif k8s_facts['status'] == "DESTROYED":
+            if amodule.params['state'] in ('present', 'enabled'):
+                k8s_should_exist = True
+            elif amodule.params['state'] == 'absent':
+                # nop
+                decon.result['failed'] = False
+                decon.result['changed'] = False
+                decon.result['msg'] = ("No state change required for k8s ID {} because of its "
+                                       "current status '{}'").format(k8s_id,
+                                                                     k8s_facts['status'])
+                k8s_should_exist = False
+            elif amodule.params['state'] == 'disabled':
+                # error
+                decon.result['failed'] = True
+                decon.result['changed'] = False
+                decon.result['msg'] = ("Invalid target state '{}' requested for k8s ID {} in the "
+                                       "current status '{}'").format(k8s_id,
+                                                                     amodule.params['state'],
+                                                                     k8s_facts['status'])
+    else:
+        k8s_should_exist = False
+        if amodule.params['state'] == 'absent':
+            decon.result['failed'] = False
+            decon.result['changed'] = False
+            decon.result['msg'] = ("Nothing to do as target state 'absent' was requested for "
+                                   "non-existent k8s name '{}'").format(amodule.params['k8s_name'])
+        elif amodule.params['state'] in ('present', 'enabled'):
+            decon.check_amodule_argument('k8s_name')
+            k8s_id = decon.k8s_provision(amodule.params['k8s_name'],
+                                         amodule.params['wg_name'],
+                                         amodule.params['k8ci_id'],
+                                         amodule.params['rg_id'],
+                                         amodule.params['master_count'],
+                                         amodule.params['master_cpu'],
+                                         amodule.params['master_ram_mb'],
+                                         amodule.params['master_disk_gb'],
+                                         amodule.params['worker_count'],
+                                         amodule.params['worker_cpu'],
+                                         amodule.params['worker_ram_mb'],
+                                         amodule.params['worker_disk_gb'],
+                                         amodule.params['extnet_id'],
+                                         amodule.params['with_lb'],
+                                         amodule.params['description'],
+                                         )
+            k8s_should_exist = True
+        elif amodule.params['state'] == 'disabled':
+            decon.result['failed'] = True
+            decon.result['changed'] = False
+            decon.result['msg'] = ("Invalid target state '{}' requested for non-existent "
+                                   "k8s name '{}' ").format(amodule.params['state'],
+                                                            amodule.params['k8s_name'])
+    if decon.result['failed']:
+        amodule.fail_json(**decon.result)
+    else:
+        if k8s_should_exist:
+            if decon.result['changed']:
+                _, k8s_facts = decon.k8s_find(arg_k8s_id=k8s_id)
+        decon.result['facts'] = decort_k8s_package_facts(k8s_facts, amodule.check_mode)
+        amodule.exit_json(**decon.result)
+
+if __name__ == "__main__":
+    main()

library/decort_kvmvm.py

@@ -1,7 +1,7 @@
 #!/usr/bin/python
 #
 # Digital Enegry Cloud Orchestration Technology (DECORT) modules for Ansible
-# Copyright: (c) 2018-2020 Digital Energy Cloud Solutions LLC
+# Copyright: (c) 2018-2021 Digital Energy Cloud Solutions LLC
 #
 # Apache License 2.0 (see http://www.apache.org/licenses/LICENSE-2.0.txt)
 #
@@ -32,7 +32,7 @@ requirements:
      - requests Python module
      - netaddr Python module
      - decort_utils utility library (module)
-     - DECORT cloud platform version 3.4.2 or higher
+     - DECORT cloud platform version 3.6.1 or higher
 notes:
      - Environment variables can be used to pass selected parameters to the module, see details below.
      - Specified Oauth2 provider must be trusted by the DECORT cloud controller on which JWT will be used.
@@ -77,8 +77,8 @@ options:
         - Architecture of the KVM VM. DECORT supports KVM hosts based on Intel x86 and IBM PowerPC hardware.
         - This parameter is used when new KVM VM is created and ignored for all other operations.
         - Module may fail if your DECORT installation does not have physical nodes of specified architecture.
-        default: KVM_X86
+        default: X86_64
-        choices: [ KVM_X86, KVM_PPC ]
+        choices: [ X86_64, PPC64_LE ]
         required: yes
     authenticator:
         description:
@@ -439,8 +439,8 @@ class decort_kvmvm(DecortController):
                                                                      check_state=False)
 
         if self.comp_id:
-            if self.comp_info['status'] != 'DESTROYED' and self.comp_info['arch'] not in ["KVM_X86", "KVM_PPC"]:
+            if self.comp_info['status'] != 'DESTROYED' and self.comp_info['arch'] not in ["X86_64", "PPC64_LE"]:
-                # If we found a Compute in a non-DESTROYED state and it is not of type KVM_*, abort the module
+                # If we found a Compute in a non-DESTROYED state and it is not of type valid arch, abort the module
                 self.result['failed'] = True
                 self.result['msg'] = ("Compute ID {} architecture '{}' is not supported by "
                                       "decort_kvmvm module.").format(self.comp_id, 
@@ -500,7 +500,7 @@ class decort_kvmvm(DecortController):
         self.check_amodule_argument('cpu')
         self.check_amodule_argument('ram')
 
-        if self.amodule.params['arch'] not in ["KVM_X86", "KVM_PPC"]:
+        if self.amodule.params['arch'] not in ["X86_64", "PPC64_LE"]:
             self.result['failed'] = True
             self.result['msg'] = ("Unsupported architecture '{}' is specified for "
                                   "KVM VM create.").format(self.amodule.params['arch'])
@@ -743,7 +743,7 @@ class decort_kvmvm(DecortController):
                             required=False,
                             fallback=(env_fallback, ['DECORT_APP_SECRET']),
                             no_log=True),
-            arch=dict(type='str', choices=['KVM_X86', 'KVM_PPC'], default='KVM_X86'),
+            arch=dict(type='str', choices=['X86_64', 'PPC64_LE'], default='X86_64'),
             authenticator=dict(type='str',
                                required=True,
                                choices=['legacy', 'oauth2', 'jwt']),

library/decort_osimage.py

@@ -1,7 +1,7 @@
 #!/usr/bin/python
 #
 # Digital Enegry Cloud Orchestration Technology (DECORT) modules for Ansible
-# Copyright: (c) 2018-2020 Digital Energy Cloud Solutions LLC
+# Copyright: (c) 2018-2021 Digital Energy Cloud Solutions LLC
 #
 # Apache License 2.0 (see http://www.apache.org/licenses/LICENSE-2.0.txt)
 #
@@ -33,7 +33,7 @@ requirements:
      - requests Python module
      - netaddr Python module
      - decort_utils utility library (module)
-     - DECORT cloud platform version 3.4.2 or higher.
+     - DECORT cloud platform version 3.6.1 or higher.
 notes:
      - Environment variables can be used to pass selected parameters to the module, see details below.
      - Specified Oauth2 provider must be trusted by the DECORT cloud controller on which JWT will be used.
@@ -203,7 +203,7 @@ def decort_osimage_package_facts(arg_osimage_facts, arg_check_mode=False):
     ret_dict['size'] = arg_osimage_facts['size']
     ret_dict['type'] = arg_osimage_facts['type']
     # ret_dict['arch'] = arg_osimage_facts['architecture']
-    ret_dict['sep_id'] = arg_osimage_facts['sepid']
+    ret_dict['sep_id'] = arg_osimage_facts['sepId']
     ret_dict['pool'] = arg_osimage_facts['pool']
     ret_dict['state'] = arg_osimage_facts['status']
 

library/decort_pfw.py

@@ -1,7 +1,7 @@
 #!/usr/bin/python
 #
 # Digital Enegry Cloud Orchestration Technology (DECORT) modules for Ansible
-# Copyright: (c) 2018-2020 Digital Energy Cloud Solutions LLC
+# Copyright: (c) 2018-2021 Digital Energy Cloud Solutions LLC
 #
 # Apache License 2.0 (see http://www.apache.org/licenses/LICENSE-2.0.txt)
 #
@@ -30,7 +30,7 @@ requirements:
      - requests Python module
      - netaddr Python module
      - decort_utils utility library (module)
-     - DECORT cloud platform version 3.4.2 or higher
+     - DECORT cloud platform version 3.6.1 or higher
 notes:
      - Environment variables can be used to pass selected parameters to the module, see details below.
      - Specified Oauth2 provider must be trusted by the DECORT cloud controller on which JWT will be used.

library/decort_rg.py

@@ -1,7 +1,7 @@
 #!/usr/bin/python
 #
 # Digital Enegry Cloud Orchestration Technology (DECORT) modules for Ansible
-# Copyright: (c) 2018-2020 Digital Energy Cloud Solutions LLC
+# Copyright: (c) 2018-2021 Digital Energy Cloud Solutions LLC
 #
 # Apache License 2.0 (see http://www.apache.org/licenses/LICENSE-2.0.txt)
 #
@@ -30,7 +30,7 @@ requirements:
      - requests Python module
      - netaddr Python module
      - decort_utils utility library (module)
-     - DECORT cloud platform version 3.4.2 or higher
+     - DECORT cloud platform version 3.6.1 or higher
 notes:
      - Environment variables can be used to pass selected parameters to the module, see details below.
      - Specified Oauth2 provider must be trusted by the DECORT cloud controller on which JWT will be used.

library/decort_vins.py

@@ -1,7 +1,7 @@
 #!/usr/bin/python
 #
 # Digital Enegry Cloud Orchestration Technology (DECORT) modules for Ansible
-# Copyright: (c) 2018-2020 Digital Energy Cloud Solutions LLC
+# Copyright: (c) 2018-2021 Digital Energy Cloud Solutions LLC
 #
 # Apache License 2.0 (see http://www.apache.org/licenses/LICENSE-2.0.txt)
 #
@@ -30,7 +30,7 @@ requirements:
      - requests Python module
      - netaddr Python module
      - decort_utils utility library (module)
-     - DECORT cloud platform version 3.4.2 or higher
+     - DECORT cloud platform version 3.6.1 or higher
 notes:
      - Environment variables can be used to pass selected parameters to the module, see details below.
      - Specified Oauth2 provider must be trusted by the DECORT cloud controller on which JWT will be used.
@@ -273,7 +273,7 @@ def decort_vins_package_facts(arg_vins_facts, arg_check_mode=False):
     ret_dict['name'] = arg_vins_facts['name']
     ret_dict['state'] = arg_vins_facts['status']
     ret_dict['account_id'] = arg_vins_facts['accountId']
-    ret_dict['rg_id'] = arg_vins_facts['rgid']
+    ret_dict['rg_id'] = arg_vins_facts['rgId']
     ret_dict['int_net_addr'] = arg_vins_facts['network']
     ret_dict['gid'] = arg_vins_facts['gid']
 
@@ -284,15 +284,15 @@ def decort_vins_package_facts(arg_vins_facts, arg_check_mode=False):
     else:
         ret_dict['ext_ip_addr'] = ""
         ret_dict['ext_net_id'] = -1
-    
+
     # arg_vins_facts['vnfs']['GW']['config']
     #   ext_ip_addr -> ext_net_ip
     #   ???         -> ext_net_id
     # tech_status   -> techStatus
 
-
     return ret_dict
 
+
 def decort_vins_parameters():
     """Build and return a dictionary of parameters expected by decort_vins module in a form accepted
     by AnsibleModule utility class."""
@@ -342,6 +342,7 @@ def decort_vins_parameters():
         workflow_context=dict(type='str', required=False),
     )
 
+
 # Workflow digest:
 # 1) authenticate to DECORT controller & validate authentication by issuing API call - done when creating DECORTController
 # 2) check if the ViNS with this id or name exists under specified account / resource group
@@ -368,12 +369,12 @@ def main():
     decon = DecortController(amodule)
 
     vins_id = 0
-    vins_level = "" # "ID" if specified by ID, "RG" - at resource group, "ACC" - at account level
+    vins_level = ""  # "ID" if specified by ID, "RG" - at resource group, "ACC" - at account level
-    vins_facts = None # will hold ViNS facts
+    vins_facts = None  # will hold ViNS facts
     validated_rg_id = 0
-    rg_facts = None # will hold RG facts
+    rg_facts = None  # will hold RG facts
     validated_acc_id = 0
-    acc_facts = None # will hold Account facts
+    acc_facts = None  # will hold Account facts
 
     if amodule.params['vins_id']:
         # expect existing ViNS with the specified ID
@@ -383,56 +384,56 @@ def main():
             decon.result['failed'] = True
             decon.result['msg'] = "Specified ViNS ID {} not found.".format(amodule.params['vins_id'])
             decon.fail_json(**decon.result)
-        vins_level="ID"
+        vins_level = "ID"
         validated_acc_id = vins_facts['accountId']
-        validated_rg_id = vins_facts['rgid']
+        validated_rg_id = vins_facts['rgId']
     elif amodule.params['rg_id']:
         # expect ViNS @ RG level in the RG with specified ID
-        vins_level="RG"
+        vins_level = "RG"
-        # This call to rg_find will abort the module if no RG with such ID is present 
+        # This call to rg_find will abort the module if no RG with such ID is present
-        validated_rg_id, rg_facts = decon.rg_find(0, # account ID set to 0 as we search for RG by RG ID
+        validated_rg_id, rg_facts = decon.rg_find(0,  # account ID set to 0 as we search for RG by RG ID
-                                    amodule.params['rg_id'], arg_rg_name="")
+                                                  amodule.params['rg_id'], arg_rg_name="")
         # This call to vins_find may return vins_id=0 if no ViNS found
         vins_id, vins_facts = decon.vins_find(vins_id=0, vins_name=amodule.params['vins_name'],
-                                                account_id=0, 
+                                              account_id=0,
-                                                rg_id=amodule.params['rg_id'],
+                                              rg_id=amodule.params['rg_id'],
-                                                check_state=False)
+                                              check_state=False)
         # TODO: add checks and setup ViNS presence flags accordingly
         pass
     elif amodule.params['account_id'] or amodule.params['account_name'] != "":
-        # Specified account must be present and accessible by the user, otherwise abort the module 
+        # Specified account must be present and accessible by the user, otherwise abort the module
         validated_acc_id, acc_facts = decon.account_find(amodule.params['account_name'], amodule.params['account_id'])
         if not validated_acc_id:
             decon.result['failed'] = True
             decon.result['msg'] = ("Current user does not have access to the requested account "
-                                    "or non-existent account specified.")
+                                   "or non-existent account specified.")
             decon.fail_json(**decon.result)
-        if amodule.params['rg_name'] != "": # at this point we know that rg_id=0
+        if amodule.params['rg_name'] != "":  # at this point we know that rg_id=0
             # expect ViNS @ RG level in the RG with specified name under specified account
-            # RG with the specified name must be present under the account, otherwise abort the module    
+            # RG with the specified name must be present under the account, otherwise abort the module
             validated_rg_id, rg_facts = decon.rg_find(validated_acc_id, 0, amodule.params['rg_name'])
-            if (not validated_rg_id or 
+            if (not validated_rg_id or
-                rg_facts['status'] in ["DESTROYING", "DESTROYED", "DELETING", "DELETED", "DISABLING", "ENABLING"]):
+                    rg_facts['status'] in ["DESTROYING", "DESTROYED", "DELETING", "DELETED", "DISABLING", "ENABLING"]):
                 decon.result['failed'] = True
                 decon.result['msg'] = "RG name '{}' not found or has invalid state.".format(amodule.params['rg_name'])
                 decon.fail_json(**decon.result)
             # This call to vins_find may return vins_id=0 if no ViNS with this name found under specified RG
             vins_id, vins_facts = decon.vins_find(vins_id=0, vins_name=amodule.params['vins_name'],
-                                                    account_id=0, # set to 0, as we are looking for ViNS under RG 
+                                                  account_id=0,  # set to 0, as we are looking for ViNS under RG
-                                                    rg_id=validated_rg_id,
+                                                  rg_id=validated_rg_id,
-                                                    check_state=False)
+                                                  check_state=False)
             vins_level = "RG"
             # TODO: add checks and setup ViNS presence flags accordingly
-        else: # At this point we know for sure that rg_name="" and rg_id=0
+        else:  # At this point we know for sure that rg_name="" and rg_id=0
             # So we expect ViNS @ account level
             # This call to vins_find may return vins_id=0 if no ViNS found
             vins_id, vins_facts = decon.vins_find(vins_id=0, vins_name=amodule.params['vins_name'],
-                                                    account_id=validated_acc_id, 
+                                                  account_id=validated_acc_id,
-                                                    rg_id=0,
+                                                  rg_id=0,
-                                                    check_state=False)
+                                                  check_state=False)
             vins_level = "ACC"
             # TODO: add checks and setup ViNS presence flags accordingly
-    else: 
+    else:
         # this is "invalid arguments combination" sink
         # if we end up here, it means that module was invoked with vins_id=0 and rg_id=0
         decon.result['failed'] = True
@@ -453,12 +454,12 @@ def main():
     #
     # When managing existing ViNS we need to account for both "static" and "transient"
     # status. Full range of ViNS statii is as follows:
-    # 
+    #
     # "MODELED", "CREATED", "ENABLED", "ENABLING", "DISABLED", "DISABLING", "DELETED", "DELETING", "DESTROYED", "DESTROYING"
-    # 
+    #
 
     vins_should_exist = False
-    
+
     if vins_id:
         vins_should_exist = True
         if vins_facts['status'] in ["MODELED", "DISABLING", "ENABLING", "DELETING", "DESTROYING"]:
@@ -526,7 +527,7 @@ def main():
                 # annotation - take from module arguments
                 vins_id = decon.vins_provision(vins_facts['name'],
                                                validated_acc_id, validated_rg_id,
-                                               amodule.params['ipcidr'], 
+                                               amodule.params['ipcidr'],
                                                amodule.params['ext_net_id'], amodule.params['ext_ip_addr'],
                                                amodule.params['annotation'])
                 vins_should_exist = True
@@ -559,18 +560,17 @@ def main():
             decon.check_amodule_argument('vins_name')
             # as we already have account ID and RG ID we can create ViNS and get vins_id on success
             vins_id = decon.vins_provision(amodule.params['vins_name'],
-                                            validated_acc_id, validated_rg_id,
+                                           validated_acc_id, validated_rg_id,
-                                            amodule.params['ipcidr'], 
+                                           amodule.params['ipcidr'],
-                                            amodule.params['ext_net_id'], amodule.params['ext_ip_addr'],
+                                           amodule.params['ext_net_id'], amodule.params['ext_ip_addr'],
-                                            amodule.params['annotation'])
+                                           amodule.params['annotation'])
-            vins_should_exist = True            
+            vins_should_exist = True
         elif amodule.params['state'] == 'disabled':
             decon.result['failed'] = True
             decon.result['changed'] = False
             decon.result['msg'] = ("Invalid target state '{}' requested for non-existent "
                                    "ViNS name '{}'").format(amodule.params['state'],
                                                             amodule.params['vins_name'])
-    
     #
     # conditional switch end - complete module run
     #