Merge pull request #54 from oracle/release_2.17.0_2021-03-11-07-08-35

Releasing version 2.17.0

Author: sagar2938

CHANGELOG.md

@@ -4,6 +4,26 @@ 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.17.0] - 2021-03-11
+
+### Added
+- Support for the OCI Registry Service
+- Support for enabling and disabling database management for external database
+- Support for listing recommendation strategies in the optimizer service
+- Support for providing target tags and target compartments on profiles in the optimizer service
+- Support for custom endpoint feature in the Integration Service
+- Support for change network endpoint for integration instance in Integration Service
+- `primary_vnic_only` option in inventory plugin to process only the primary vnic of a compute instance
+
+### Fixed
+- Return documentation for `oci_object_storage_object_actions` module
+
+### Changed
+- Python 2 reached end of life on 1st January, 2020 and [OCI Python SDK](https://github.com/oracle/oci-python-sdk) stopped support for Python 2 long back. We cannot support Python 2 since we have a hard dependency on [OCI Python SDK](https://github.com/oracle/oci-python-sdk). We strongly recommend you to move to Python 3 if you are still using Python 2
+- `resource_action_ids` parameter is made optional in `oci_optimizer_recommendation_actions` module
+- Parameter `name` is now updatable in `oci_optimizer_profile`
+- Please update to the latest version of [OCI Python SDK](https://github.com/oracle/oci-python-sdk)
+
 ## [2.16.0] - 2021-2-25
 
 ### Added

COMMON_ISSUES.md

@@ -0,0 +1,58 @@
+# Common Issues
+
+## WARNING: "module oracle.oci.xxx not found in path"
+Most likely reason is that the OCI Ansible Collection is not installed.
+
+Please refer the [Installation Guide](https://github.com/oracle/oci-ansible-collection/blob/master/InstallationGuide.md) on different ways to install the OCI Ansible Collection.
+
+If it is already installed, it could be because the version you are using might not have the module. Please upgrade to the latest version using the below command:
+
+`ansible-galaxy collection install -f oracle.oci`
+
+-----------------------------------
+## Error: "oci python sdk required for this module"
+
+Try first upgrading the OCI python SDK:
+`pip install oci --upgrade`
+
+If the python SDK is not installed correctly, check [Ansible Install Troubleshooting Guide](ansible-oci-customer-troubleshooting/ansible-install-troubleshooting-guide.md).
+
+-----------------------------------
+## Error: "Could not find config file at ~/.oci/config"
+
+- Make sure you created a config file under '~/.oci/config' or you are using instance principal.
+- To create config file, check: [Configuration_File](https://docs.cloud.oracle.com/en-us/iaas/Content/API/Concepts/sdkconfig.htm#SDK_and_CLI_Configuration_File)
+- To use instance principal on a compute instance set the environment variable: `OCI_ANSIBLE_AUTH_TYPE=instance_principal`
+
+-----------------------------------
+## Error: "{'code': 'NotAuthenticated', 'message': 'The required information to complete authentication was not provided.', 'status': 401}"
+
+Check if the [Account Keys](https://docs.cloud.oracle.com/en-us/iaas/Content/API/Concepts/apisigningkey.htm#Required_Keys_and_OCIDs)
+ are generated correctly and uploaded to the user account with right permissions.
+
+-----------------------------------
+## Error: "No inventory plugins available to generate inventory, make sure you have at least one whitelisted."
+
+Enable the OCI Collection inventory plugin by adding it to your ansible.cfg file. For example:<br>
+[inventory]<br>
+enable_plugins = oracle.oci.oci<br>
+
+-----------------------------------
+## In a Mac OSX controller node, Error: "ImportError: No module named yaml" when executing a playbook
+ 
+First make sure that ansible and its requirements including PyYAML are installed.
+If you are running on macOS, and you have python installed by brew, you may see a ImportError(for example: `ImportError: No module named yaml`).
+To resolve this, you must override the `ansible_python_interpreter` configuration option. Setting the inventory variable `ansible_python_interpreter` on any host will allow Ansible to auto-replace the interpreter used when executing python modules.
+
+`ansible_python_interpreter` configuration option can be set in inventory file. For example:
+
+```sh
+[control-node]
+localhost ansible_python_interpreter="/usr/local/Cellar/python/2.7.14_3/bin/python2.7"
+```
+
+OR `ansible_python_interpreter` configuration option can be set using `-e` command line option:
+
+```sh
+$ ansible-playbook sample-playbook.yml -e 'ansible_python_interpreter=/usr/local/Cellar/python/2.7.14_3/bin/python2.7'
+```

FAQ.md

@@ -1,66 +1,32 @@
 # Frequently Asked Questions (FAQs)
 
-### Common errors:
+## How to install the OCI Ansible Collection
+Please refer the [Installation Guide](https://github.com/oracle/oci-ansible-collection/blob/master/InstallationGuide.md) on different ways to install the OCI Ansible Collection.
 
-#### WARNING: "module oracle.oci.xxx not found in path"
-Check if the `oracle.oci` collection is installed using this command:
-`ansible-galaxy collection list`
-The collection is installed under the default paths: `~/.ansible/collections` or `/usr/share/ansible/collections`
-
------------------------------------
-#### Error: "oci python sdk required for this module"
-
-Try first upgrading the OCI python SDK:
-`pip install oci --upgrade`
-
-If the python SDK is not installed correctly, check [Ansible Install Troubleshooting Guide](ansible-oci-customer-troubleshooting/ansible-install-troubleshooting-guide.md).
-
------------------------------------
-#### Error: "Could not find config file at ~/.oci/config"
-
-- Make sure you created a config file under '~/.oci/config' or you are using instance principal.
-- To create config file, check: [Configuration_File](https://docs.cloud.oracle.com/en-us/iaas/Content/API/Concepts/sdkconfig.htm#SDK_and_CLI_Configuration_File)
-- To use instance principal on a compute instance set the environment variable: `OCI_ANSIBLE_AUTH_TYPE=instance_principal`
-
------------------------------------
-#### Error: "{'code': 'NotAuthenticated', 'message': 'The required information to complete authentication was not provided.', 'status': 401}"
-
-Check if the [Account Keys](https://docs.cloud.oracle.com/en-us/iaas/Content/API/Concepts/apisigningkey.htm#Required_Keys_and_OCIDs)
- are generated correctly and uploaded to the user account with right permissions.
-
------------------------------------
-#### Error: "No inventory plugins available to generate inventory, make sure you have at least one whitelisted."
-
-Enable the OCI Collection inventory plugin by adding it to your ansible.cfg file. For example:<br>
-[inventory]<br>
-enable_plugins = oracle.oci.oci<br>
-
-For the legacy modules, use enable_plugins = oci
-
------------------------------------
-
-#### In a Mac OSX controller node, Error: "ImportError: No module named yaml" when executing a playbook
- 
-First make sure that ansible and its requirements including PyYAML are installed.
-If you are running on macOS, and you have python installed by brew, you may see a ImportError(for example: `ImportError: No module named yaml`).
-To resolve this, you must override the `ansible_python_interpreter` configuration option. Setting the inventory variable `ansible_python_interpreter` on any host will allow Ansible to auto-replace the interpreter used when executing python modules.
-
-`ansible_python_interpreter` configuration option can be set in inventory file. For example:
-
-```sh
-[control-node]
-localhost ansible_python_interpreter="/usr/local/Cellar/python/2.7.14_3/bin/python2.7"
+## How do I upgrade to the latest version
+```
+ansible-galaxy collection install -f oracle.oci
 ```
 
-OR `ansible_python_interpreter` configuration option can be set using `-e` command line option:
+## How to find the version of the OCI Ansible Collection installed
+The below command lists all the collections installed in your system and their versions. You can check the version for the entry `oracle.oci`
+```
+ansible-galaxy collection list
+```
+*Note: You need ansible >= 2.10 to run the above command*
 
-```sh
-$ ansible-playbook sample-playbook.yml -e 'ansible_python_interpreter=/usr/local/Cellar/python/2.7.14_3/bin/python2.7'
+## How to find the version of oci python sdk installed
+You can run the below command:
+```
+python -c 'import oci; print(oci.__version__)'
 ```
 
+## What are the dependencies for using OCI Ansible Collection
+You need `ansible >= 2.9` and the latest version of `oci`.
+
 -----------------------------------
 
-### Enable `debug` mode for the OCI Ansible Cloud Modules
+## How to enable `debug` mode
 
 -  Set the `log_requests` variable in your ~/.oci/config to `True` to [enable Request logging in the OCI python SDK](https://github.com/oracle/oci-python-sdk/blob/master/docs/logging.rst)
 -  Export an environment variable named `LOG_LEVEL` with the value `DEBUG` to enable DEBUG mode for the OCI Ansible modules

KNOWN_ISSUES.md

@@ -0,0 +1,25 @@
+# Known Issues
+
+## OCI Ansible Modules
+
+### oci_compute_volume_attachment_facts gets Linux iscsi attach commands for both Linux and Windows
+When using the oci_compute_volume_attachment_facts module, it outputs Linux iscsi connect commands for Windows attached Block Volumes.
+
+This issue is fixed in v2.14.0 but only when fetching getting the of a specific volume attachment using volume_attachment_id. Please check [this](https://github.com/oracle/oci-ansible-collection/issues/15) for more details.
+
+## OCI Inventory Plugin
+
+### fetch_db_host does not work with tag filters
+When the tag filters (freeform_tags and defined_tags) are specified in the config, the db hosts are not returned. This happens because the db hosts do not support tags yet so the plugin filters them since they don't have the specified tags.
+
+Workaround: Avoid using tag filters when fetching db hosts and do any filtering as post processing of the inventory
+
+### Instances with valid hostname_format for secondary vnics but not primary vnic are skipped
+The inventory plugin was not processing the secondary VNICs of a compute instance with valid specified hostname_format if the primary VNIC does not have a valid hostname_format.
+
+This issue is fixed in v2.16.0
+
+### Inventory generation fails with JSONDecodeError in ansible tower
+The OCI Inventory Plugin outputs some informational log messages along with the inventory. But ansible tower expects the output from the inventory plugin to only contain the inventory in JSON format which caused the failure.
+
+This issue is fixed in v2.16.0

README.md

@@ -91,7 +91,8 @@ Oracle Cloud Infrastructure Ansible Collection supports Ansible Tower and AWX. F
 To install the Ansible Tower free version (AWX) on an OCI instance, use this [solution](https://github.com/oracle-quickstart/oci-ansible-awx).
 
 ## Help
-- For FAQs and common errors, check the [Frequently Asked Questions](https://github.com/oracle/oci-ansible-collections/blob/master/FAQ.md) page.
+- For FAQs, check the [Frequently Asked Questions](https://github.com/oracle/oci-ansible-collections/blob/master/FAQ.md) page.
+- For commmon issues, check the [Common Issues](https://github.com/oracle/oci-ansible-collections/blob/master/COMMON_ISSUES.md) page.
 - To file bugs or feature requests, use [GitHub issues](https://github.com/oracle/oci-ansible-collections/issues).
 - For other channels, check the ["Questions or Feedback"](https://docs.cloud.oracle.com/en-us/iaas/Content/API/SDKDocs/ansible.htm#questions) section.
 
@@ -107,7 +108,7 @@ Oracle gratefully acknowledges the contributions to `oci-ansible-collections` th
 
 ## Known Issues
 
-You can find information on any known issues on [GitHub issues](https://github.com/oracle/oci-ansible-collections/issues) page.
+You can find information on any known issues on [Known Issues](https://github.com/oracle/oci-ansible-collections/blob/master/KNOWN_ISSUES.md) or [GitHub issues](https://github.com/oracle/oci-ansible-collections/issues) page.
 
 ## License