From e737191f97caf24c906449e7a0939c5831536835 Mon Sep 17 00:00:00 2001 From: Mark Chappell Date: Tue, 19 Jul 2022 17:04:52 +0200 Subject: [PATCH] Attempt to sync README.md docs with amazon.aws where possible (#1359) Attempt to sync README.md docs with amazon.aws where possible SUMMARY Minor drift has occurred between the amazon.aws and community.aws docs. Attempt to re-synchronise where appropriate ISSUE TYPE Docs Pull Request COMPONENT NAME README.md ADDITIONAL INFORMATION See also : https://github.com/ansible-collections/amazon.aws/pull/937 Reviewed-by: Joseph Torcasso Reviewed-by: Alina Buzachis (cherry picked from commit d83eb4beb7de9d43bb748b7c9fa66a7522fa1d16) --- README.md | 20 ++++++++++++++++++-- 1 file changed, 18 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 4620b69285c..75f4a831461 100644 --- a/README.md +++ b/README.md @@ -18,10 +18,14 @@ PEP440 is the schema used to describe the versions of Ansible. As the AWS SDK for Python (Boto3 and Botocore) has [ceased supporting Python 2.7](https://aws.amazon.com/blogs/developer/announcing-end-of-support-for-python-2-7-in-aws-sdk-for-python-and-aws-cli-v1/), this collection requires Python 3.6 or greater. +## AWS SDK version compatibility + Starting with the 2.0.0 releases of amazon.aws and community.aws, it is generally the collection's policy to support the versions of `botocore` and `boto3` that were released 12 months prior to the most recent major collection release, following semantic versioning (for example, 2.0.0, 3.0.0). Version 4.0.0 of this collection supports `boto3 >= 1.17.0` and `botocore >= 1.20.0` +All support for the original AWS SDK `boto` was removed in release 4.0.0. + ## Included content ### Connection plugins @@ -249,9 +253,20 @@ A specific version of the collection can be installed by using the `version` key --- collections: - name: community.aws - version: 0.1.1 + version: 3.1.1 ``` +The python module dependencies are not installed by `ansible-galaxy`. They can +be manually installed using pip: + + pip install requirements.txt + +or: + + pip install boto3 botocore + +## Using this collection + You can either call modules by their Fully Qualified Collection Namespace (FQCN), such as `community.aws.ec2_instance`, or you can call modules by their short name if you list the `community.aws` collection in the playbook's `collections` keyword: ```yaml @@ -278,6 +293,7 @@ You can either call modules by their Fully Qualified Collection Namespace (FQCN) ## Contributing to this collection We welcome community contributions to this collection. If you find problems, please open an issue or create a PR against the [Community AWS collection repository](https://github.com/ansible-collections/community.aws). +See [Contributing to Ansible-maintained collections](https://docs.ansible.com/ansible/devel/community/contributing_maintained_collections.html#contributing-maintained-collections) for more details. You can also join us on: @@ -309,4 +325,4 @@ You can also join us on: GNU General Public License v3.0 or later. -See [LICENSE](https://www.gnu.org/licenses/gpl-3.0.txt) to see the full text. +See [COPYING](https://www.gnu.org/licenses/gpl-3.0.txt) to see the full text.