Releasing version 2.7.0

Author: Oracle Public Cloud User

CHANGELOG.md

@@ -4,6 +4,24 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/).
 This project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## [2.7.0] - 2020-9-10
+
+### Added:
+- Added VMWare (ocvp) modules
+- Added Data Integration Workspace modules
+- Added multiple Database modules and features
+- Added Network modules, features and support for it
+- Added features for Budget service
+- Added multiple Identity modules and features
+- Added support for auto_backup_window in Database service
+
+### Changed:
+- Please update to the latest version of OCI Python SDK (2.21.3).
+
+### Fixes:
+- Removed the redirect to home region in these modules oci_identity_fault_domain_facts 
+and oci_identity_availability_domain_facts.
+
 ## [2.6.0] - 2020-8-27
 
 ### Added:

InstallationGuide.md

@@ -1,4 +1,22 @@
-## Installation Steps:
+### Installing the Collection with yum
+
+You can use yum to install the Oracle Cloud Infrastructure Ansible Module Collection RPM.
+
+The RPM also installs the required dependencies: the OCI SDK for Python and Ansible.
+
+The following example shows how to use yum to install the Ansible Module Collection RPM:
+  ``` bash
+$ yum -y install oraclelinux-developer-release-el7 && sudo yum install oci-ansible-collection
+  ```
+Note:
+This installation uses Python version 3.6.
+
+To test the installation of the RPM and configuration of the SDK, you can run a sample playbook. For example:
+  ``` bash
+$ ansible-playbook-3 /usr/share/doc/oci-ansible-collection-<version>/samples/object_storage/get_namespace/sample.yaml
+  ```
+
+### Manual Installation Steps:
 ```
     sudo pip3 install virtualenv
     virtualenv venvansible
@@ -13,7 +31,7 @@ To test the installation, you can run this sample:
 venvansible/bin/ansible-playbook -vvv ~/.ansible/collections/ansible_collections/oracle/oci/samples/object_storage/get_namespace/sample.yaml
 ```
 
-## How to troubleshoot installation errors?
+### How to troubleshoot installation errors?
 #### Troubleshoot the error `oci python sdk required for this module`
 
 You will get an error if Ansible runs using python2 and the python SDK is installed under python 3.<br/>

README.md

@@ -63,10 +63,30 @@ We have also added a new [User Guide](https://github.com/oracle/oci-ansible-coll
 - MySQL
 - Big Data
 - Usage
+- VMWare
+- Data Integration
 
 ## Installation
 
-#### 1) Installing collections
+#### 1) Installing the Collection with yum
+
+You can use yum to install the Oracle Cloud Infrastructure Ansible Module Collection RPM.
+
+The RPM installs the OCI Ansible module collection and its required dependencies: the OCI SDK for Python and Ansible.
+
+The following example shows how to use yum to install the Ansible Module Collection RPM:
+  ``` bash
+$ yum -y install oraclelinux-developer-release-el7 && sudo yum install oci-ansible-collection
+  ```
+Note:
+This installation uses Python version 3.6.
+
+To test the installation of the RPM and configuration of the SDK, you can run a sample playbook. For example:
+  ``` bash
+$ ansible-playbook-3 /usr/share/doc/oci-ansible-collection-<version>/samples/object_storage/get_namespace/sample.yaml
+  ```
+
+#### 2) Installing collections from Ansible Galaxy
 
 You can install it from [Ansible Galaxy](https://galaxy.ansible.com/oracle) using the command:
   ``` bash
@@ -77,7 +97,7 @@ Notes:
 * For more information about collections, please check [Ansible Collections](https://docs.ansible.com/ansible/latest/user_guide/collections_using.html)
 * To update the modules to latest version, use the install --force flag.
 
-#### 2) Install OCI Python SDK
+#### Install OCI Python SDK
 
 The Oracle Cloud Ansible modules are built using the [Oracle Cloud Infrastructure Python SDK](https://docs.us-phoenix-1.oraclecloud.com/Content/API/SDKDocs/pythonsdk.htm).
 
@@ -100,7 +120,8 @@ with Oracle Cloud Infrastructure services under [the samples directory on GitHub
 Begin by reviewing the Readme.md file that you will find in each sample's root directory.
 
 ## Documentation
-Module documentation is found [here](https://github.com/oracle/oci-ansible-collection/tree/master/docs)<br/>
+Module documentation is found [here](https://github.com/oracle/oci-ansible-collection/tree/master/docs). The HTML version is available on [readthedocs.io](https://oci-ansible-collection.readthedocs.io/en/latest/).
+
 To view the module documentation, use this command:
   ``` bash
 ansible-doc oracle.oci.[module_name]

THIRD_PARTY_LICENSES.txt

@@ -35,6 +35,13 @@ Helps in checking if the create operation will create the resource or not. It wi
     check_mode: yes
 ```
 
+### Identity Home Region Redirect
+By default, Identity requests are redirected to the user home region even if you specify a different region. 
+If you need to use Identity service with a region other than your home region, you can override this behavior by setting this variable to any value:
+- Environment variable: OCI_IDENTITY_DO_NOT_REDIRECT_TO_HOME_REGION
+
+
+
 ### Avoiding reliance on server side default values
 Before our modules execute any operation, they check with the service to determine if that operation is necessary or if the state is already such that the operation would be a no-op. For create operations, this means checking if a resource already exists that matches the parameters a user supplied. The modules will attempt to find a matching resource *only* based on the parameters you supply. This means that if you omit an optional parameter and rely on the server side default value, future invocations of the same playbook can potentially match a resource that has a different value for that parameter.
 

UserGuide.md

@@ -24,8 +24,6 @@
 
 __metaclass__ = type
 
-from recommonmark.parser import CommonMarkParser
-
 # sys.path.insert(0, os.path.abspath('.'))
 
 import sphinx_rtd_theme
@@ -192,7 +190,3 @@
 
 # The suffix of source filenames.
 source_suffix = [".rst", ".md"]
-
-# source_parsers = {
-#     ".md": CommonMarkParser,
-# }

docs/conf.py

@@ -9,7 +9,7 @@ namespace: oracle
 name: oci
 
 # The version of the collection. Must be compatible with semantic versioning
-version: 2.6.0
+version: 2.7.0
 
 # The path to the Markdown (.md) readme file. This path is relative to the root of the collection
 readme: README.md

galaxy.yml

@@ -108,6 +108,7 @@
     "data_safe_private_endpoint": "datasafeprivateendpoints",
     "bds_instance": "bds",
     "stack": "ormstack",
+    "workspace": "disworkspace",
 }
 
 CREATE_OPERATION_KEY = "CREATE"

plugins/module_utils/oci_common_utils.py

@@ -66,6 +66,7 @@ def get_custom_class_mapping(modules):
     oci_mysql_custom_helpers,
     oci_bigdata_custom_helpers,
     oci_usage_api_custom_helpers,
+    oci_ocvp_custom_helpers,
 )  # noqa
 
 custom_helper_mapping = get_custom_class_mapping(
@@ -106,5 +107,6 @@ def get_custom_class_mapping(modules):
         oci_mysql_custom_helpers,
         oci_bigdata_custom_helpers,
         oci_usage_api_custom_helpers,
+        oci_ocvp_custom_helpers,
     ]
 )

plugins/module_utils/oci_custom_helpers_utils.py

@@ -392,12 +392,54 @@ class AutonomousContainerDatabaseHelperCustom:
     # the quarterly maintenance window. However object `UpdateAutonomousContainerDatabase` represents it with different
     # name 'maintenance_window_details'.
     def is_update_necessary(self, existing_resource_dict):
+        resource_dict = dict(existing_resource_dict)
+        resource_dict["maintenance_window_details"] = resource_dict.pop(
+            "maintenance_window", None
+        )
+        return super(AutonomousContainerDatabaseHelperCustom, self).is_update_necessary(
+            resource_dict
+        )
+
+    def get_existing_resource_dict_for_idempotence_check(self, existing_resource):
+        existing_resource_dict = super(
+            AutonomousContainerDatabaseHelperCustom, self
+        ).get_existing_resource_dict_for_idempotence_check(existing_resource)
+
         existing_resource_dict[
             "maintenance_window_details"
         ] = existing_resource_dict.pop("maintenance_window", None)
-        return super(AutonomousContainerDatabaseHelperCustom, self).is_update_necessary(
-            existing_resource_dict
-        )
+        return existing_resource_dict
+
+    def list_resources(self):
+        # Method `ListAutonomousContainerDatabases` has filer `infrastructureType` which returns resources that
+        # match the given Infrastructure Type. If not passed API sets its value to `CLOUD`. In order to return ExaCC
+        # resources it's necessary to pass `infrastructureType` = `CLOUD_AT_CUSTOMER` and `infrastructureType` = `CLOUD`
+        # for non ExaCC resources.
+        if not (
+            self.module.params.get("autonomous_exadata_infrastructure_id")
+            and self.module.params.get("autonomous_vm_cluster_id")
+        ):
+            optional_kwargs = super(
+                AutonomousContainerDatabaseHelperCustom, self
+            ).get_optional_kwargs_for_list()
+            required_kwargs = super(
+                AutonomousContainerDatabaseHelperCustom, self
+            ).get_required_kwargs_for_list()
+            kwargs = oci_common_utils.merge_dicts(required_kwargs, optional_kwargs)
+
+            autonomous_container_database_at_cloud = oci_common_utils.list_all_resources(
+                self.client.list_autonomous_container_databases, **kwargs
+            )
+
+            kwargs["infrastructure_type"] = "CLOUD_AT_CUSTOMER"
+            autonomous_container_database_cloud_at_customer = oci_common_utils.list_all_resources(
+                self.client.list_autonomous_container_databases, **kwargs
+            )
+            return (
+                autonomous_container_database_at_cloud
+                + autonomous_container_database_cloud_at_customer
+            )
+        return super(AutonomousContainerDatabaseHelperCustom, self).list_resources()
 
 
 class VmClusterNetworkHelperCustom:
@@ -544,3 +586,50 @@ def update_resource(self):
             operation_response=operation_response,
             wait_for_states=oci_common_utils.get_work_request_completed_states(),
         ).wait()
+
+
+class BackupDestinationHelperCustom:
+    def __init__(self, *args, **kwargs):
+        super(BackupDestinationHelperCustom, self).__init__(*args, **kwargs)
+        self.delete_vpc_users_from_update_model_dict = False
+
+    # resource returned from server doesn't have an attribute `mount_type_details` Thus we add this attribute in
+    # existing resource dict by using values returned for parameters `nfs_mount_type` , `local_mount_point_path`,
+    # `nfs_server` & `nfs_server_export`.
+    def get_existing_resource_dict_for_idempotence_check(self, resource):
+        resource_dict = super(
+            BackupDestinationHelperCustom, self
+        ).get_existing_resource_dict_for_idempotence_check(resource)
+        resource_dict["mount_type_details"] = {
+            "mount_type": resource_dict.get("nfs_mount_type", None),
+            "local_mount_point_path": resource_dict.get("local_mount_point_path", None),
+            "nfs_server": resource_dict.get("nfs_server", None),
+            "nfs_server_export": resource_dict.get("nfs_server_export", None),
+        }
+        return resource_dict
+
+    def get_update_model_dict_for_idempotence_check(self, update_model):
+        update_model_dict = super(
+            BackupDestinationHelperCustom, self
+        ).get_update_model_dict_for_idempotence_check(update_model)
+        if "vpc_users" in update_model_dict:
+            del update_model_dict["vpc_users"]
+        return update_model_dict
+
+    def is_update_necessary(self, existing_resource_dict):
+        vpc_users_source_list = self.module.params.get("vpc_users")
+        vpc_users_target_list = existing_resource_dict["vpc_users"]
+
+        if vpc_users_source_list is not None and not all(
+            [
+                oci_common_utils.is_in_list(
+                    vpc_users_target_list, element, ignore_attr_if_not_in_target=False,
+                )
+                for element in vpc_users_source_list
+            ]
+        ):
+            return True
+
+        return super(BackupDestinationHelperCustom, self).is_update_necessary(
+            existing_resource_dict
+        )

plugins/module_utils/oci_database_custom_helpers.py

@@ -13,9 +13,7 @@
 from ansible_collections.oracle.oci.plugins.module_utils import oci_common_utils
 
 try:
-    from oci.exceptions import ServiceError
-
-    # from oci.exceptions import ServiceError, MaximumWaitTimeExceeded
+    from oci.exceptions import ServiceError, MaximumWaitTimeExceeded
 
     HAS_OCI_PY_SDK = True
 except ImportError:
@@ -341,6 +339,8 @@ def prepare_result(self, *args, **kwargs):
 
 
 # class TagActionsHelperCustom:
+#     # overriding the perform_action method as bulk_delete tags operation does not support
+#     # get_resource method which is an integral part of the main perform_action method
 #     def perform_action(self, action):
 #         action_fn = self.get_action_fn(action)
 #         if not action_fn:
@@ -354,7 +354,7 @@ def prepare_result(self, *args, **kwargs):
 #         # if sent list is empty or None, return back without performing the action with
 #         # status of resource as not changed
 #         tag_ids = self.module.params.get("tag_definition_ids")
-#         if tag_ids is None or tag_ids == []:
+#         if not tag_ids:
 #             return self.prepare_result(
 #                 changed=False, resource_type=self.resource_type, resource=None
 #             )
@@ -371,3 +371,53 @@ def prepare_result(self, *args, **kwargs):
 #             return self.prepare_result(
 #                 changed=True, resource_type=self.resource_type, resource=None,
 #             )
+
+
+class CompartmentActionsHelperCustom:
+    # overriding the perform_action method as bulk_move and bulk_delete actions do not support
+    # get_resource method which is an integral part of the main perform_action method
+    def perform_action(self, action):
+        if action in ["move", "recover"]:
+            return super(CompartmentActionsHelperCustom, self).perform_action(action)
+
+        action_fn = self.get_action_fn(action)
+        if not action_fn:
+            self.module.fail_json(msg="{0} not supported by the module.".format(action))
+
+        if self.check_mode:
+            return self.prepare_result(
+                changed=True, resource_type=self.resource_type, resource=None
+            )
+
+        # if resource list is empty or None, return back without performing the action with
+        # status of resource as not changed
+        resources_list = self.module.params.get("resources")
+        if not resources_list:
+            return self.prepare_result(
+                changed=False, resource_type=self.resource_type, resource=None
+            )
+
+        try:
+            action_fn()
+        except MaximumWaitTimeExceeded as mwtex:
+            self.module.fail_json(msg=str(mwtex))
+        except ServiceError as se:
+            self.module.fail_json(
+                msg="Performing action failed with exception: {0}".format(se.message)
+            )
+        else:
+            return self.prepare_result(
+                changed=True, resource_type=self.resource_type, resource=None,
+            )
+
+    # this method is overridden to ensure idempotency for the move and recover actions
+    def is_action_necessary(self, action, resource_data):
+        if action == "move":
+            return resource_data.compartment_id != self.module.params.get(
+                "target_compartment_id"
+            )
+        if action == "recover":
+            return resource_data.lifecycle_state == "DELETED"
+        return super(CompartmentActionsHelperCustom, self).is_action_necessary(
+            action, resource_data
+        )