Prep 2.2.0 release, Run add_docs, generate changelog (#727)

Prep 2.2.0 release, Run add_docs, generate changelog SUMMARY Prep 2.2.0 release, Run add_docs, Generate changelog ISSUE TYPE Feature Pull Request Reviewed-by: Alina Buzachis <None> Reviewed-by: Mark Chappell <None>
ansible-collections · Mar 24, 2022 · 8d35ae4 · 8d35ae4
1 parent fe5cfae
commit 8d35ae4
Show file tree

Hide file tree

Showing 14 changed files with 295 additions and 71 deletions.
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -5,6 +5,24 @@ community.aws Release Notes
 .. contents:: Topics
 
 
+v2.2.0
+======
+
+Minor Changes
+-------------
+
+- ec2_instance - add count parameter support (https://github.com/ansible-collections/amazon.aws/pull/539).
+
+Bugfixes
+--------
+
+- aws_ec2 inventory - use the iam_role_arn configuration parameter to assume the role before trying to call DescribeRegions if the regions configuration is not set and AWS credentials provided without enough privilege to perform the DescribeRegions action. (https://github.com/ansible-collections/amazon.aws/issues/566).
+- ec2_vol - Sets the Iops value in req_obj even if the iops value has not changed, to allow modifying volume types that require passing an iops value to boto. (https://github.com/ansible-collections/amazon.aws/pull/606)
+- ec2_vol - changing a volume from a type that does not support IOPS (like ``standard``) to a type that does (like ``gp3``) fails (https://github.com/ansible-collections/amazon.aws/issues/626).
+- ec2_vpc_igw - fix 'NoneType' object is not subscriptable error (https://github.com/ansible-collections/amazon.aws/pull/691).
+- ec2_vpc_igw - use paginator for describe internet gateways and add retry to fix NoneType object is not subscriptable error (https://github.com/ansible-collections/amazon.aws/pull/695).
+- elb_classic_lb - handle security_group_ids when providing security_group_names and fix broken tasks in integration test (https://github.com/ansible-collections/amazon.aws/pull/592).
+
 v2.1.0
 ======
 

diff --git a/README.md b/README.md
diff --git a/changelogs/changelog.yaml b/changelogs/changelog.yaml
@@ -594,3 +594,31 @@ releases:
     - 552-elb_classic_lb-fact.yml
     - 557-action_group-missing-entry.yml
     release_date: '2021-11-11'
+  2.2.0:
+    changes:
+      bugfixes:
+      - aws_ec2 inventory - use the iam_role_arn configuration parameter to assume
+        the role before trying to call DescribeRegions if the regions configuration
+        is not set and AWS credentials provided without enough privilege to perform
+        the DescribeRegions action. (https://github.com/ansible-collections/amazon.aws/issues/566).
+      - ec2_vol - Sets the Iops value in req_obj even if the iops value has not changed,
+        to allow modifying volume types that require passing an iops value to boto.
+        (https://github.com/ansible-collections/amazon.aws/pull/606)
+      - ec2_vol - changing a volume from a type that does not support IOPS (like ``standard``)
+        to a type that does (like ``gp3``) fails (https://github.com/ansible-collections/amazon.aws/issues/626).
+      - ec2_vpc_igw - fix 'NoneType' object is not subscriptable error (https://github.com/ansible-collections/amazon.aws/pull/691).
+      - ec2_vpc_igw - use paginator for describe internet gateways and add retry to
+        fix NoneType object is not subscriptable error (https://github.com/ansible-collections/amazon.aws/pull/695).
+      - elb_classic_lb - handle security_group_ids when providing security_group_names
+        and fix broken tasks in integration test (https://github.com/ansible-collections/amazon.aws/pull/592).
+      minor_changes:
+      - ec2_instance - add count parameter support (https://github.com/ansible-collections/amazon.aws/pull/539).
+    fragments:
+    - 539-ec2_instance_add_count_param.yml
+    - 592-elb_classic_lb-handle-sg-ids-fix-tests.yml
+    - 606-ec2_vol-set-iops-even-if-unchanged-for-boto-req.yml
+    - 619-inventory-aws_ec2-assume-arn-role-when-listing-regions.yml
+    - 626-ec2_vol-iops-when-source-does-not-have-iops.yml
+    - 691-ec2_vpc_igw-fix-null-igw-error.yml
+    - 695-ec2_vpc_igw-fix-nonetype-with-paginator.yml
+    release_date: '2022-03-22'
diff --git a/changelogs/fragments/539-ec2_instance_add_count_param.yml b/changelogs/fragments/539-ec2_instance_add_count_param.yml
diff --git a/changelogs/fragments/592-elb_classic_lb-handle-sg-ids-fix-tests.yml b/changelogs/fragments/592-elb_classic_lb-handle-sg-ids-fix-tests.yml
diff --git a/changelogs/fragments/606-ec2_vol-set-iops-even-if-unchanged-for-boto-req.yml b/changelogs/fragments/606-ec2_vol-set-iops-even-if-unchanged-for-boto-req.yml
diff --git a/changelogs/fragments/619-inventory-aws_ec2-assume-arn-role-when-listing-regions.yml b/changelogs/fragments/619-inventory-aws_ec2-assume-arn-role-when-listing-regions.yml
diff --git a/changelogs/fragments/626-ec2_vol-iops-when-source-does-not-have-iops.yml b/changelogs/fragments/626-ec2_vol-iops-when-source-does-not-have-iops.yml
diff --git a/changelogs/fragments/691-ec2_vpc_igw-fix-null-igw-error.yml b/changelogs/fragments/691-ec2_vpc_igw-fix-null-igw-error.yml
diff --git a/changelogs/fragments/695-ec2_vpc_igw-fix-nonetype-with-paginator.yml b/changelogs/fragments/695-ec2_vpc_igw-fix-nonetype-with-paginator.yml
diff --git a/docs/amazon.aws.aws_ec2_inventory.rst b/docs/amazon.aws.aws_ec2_inventory.rst
@@ -17,7 +17,7 @@ amazon.aws.aws_ec2
 Synopsis
 --------
 - Get inventory hosts from Amazon Web Services EC2.
-- Uses a YAML configuration file that ends with ``aws_ec2.(yml|yaml``).
+- Uses a YAML configuration file that ends with ``aws_ec2.{yml|yaml}``.
 
 
 

diff --git a/docs/amazon.aws.ec2_instance_module.rst b/docs/amazon.aws.ec2_instance_module.rst
@@ -129,6 +129,24 @@ Parameters
                         <div style="font-size: small; color: darkgreen"><br/>aliases: ec2_secret_key, secret_key</div>
                 </td>
             </tr>
+            <tr>
+                <td colspan="2">
+                    <div class="ansibleOptionAnchor" id="parameter-"></div>
+                    <b>count</b>
+                    <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
+                    <div style="font-size: small">
+                        <span style="color: purple">integer</span>
+                    </div>
+                    <div style="font-style: italic; font-size: small; color: darkgreen">added in 2.2.0</div>
+                </td>
+                <td>
+                </td>
+                <td>
+                        <div>Number of instances to launch.</div>
+                        <div>Setting this value will result in always launching new instances.</div>
+                        <div>Mutually exclusive with <em>exact_count</em>.</div>
+                </td>
+            </tr>
             <tr>
                 <td colspan="2">
                     <div class="ansibleOptionAnchor" id="parameter-"></div>
@@ -278,6 +296,25 @@ Parameters
                         <div style="font-size: small; color: darkgreen"><br/>aliases: aws_endpoint_url, endpoint_url</div>
                 </td>
             </tr>
+            <tr>
+                <td colspan="2">
+                    <div class="ansibleOptionAnchor" id="parameter-"></div>
+                    <b>exact_count</b>
+                    <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
+                    <div style="font-size: small">
+                        <span style="color: purple">integer</span>
+                    </div>
+                    <div style="font-style: italic; font-size: small; color: darkgreen">added in 2.2.0</div>
+                </td>
+                <td>
+                </td>
+                <td>
+                        <div>An integer value which indicates how many instances that match the <em>filters</em> parameter should be running.</div>
+                        <div>Instances are either created or terminated based on this value.</div>
+                        <div>If termination takes place, least recently created instances will be terminated based on Launch Time.</div>
+                        <div>Mutually exclusive with <em>count</em>, <em>instance_ids</em>.</div>
+                </td>
+            </tr>
             <tr>
                 <td colspan="2">
                     <div class="ansibleOptionAnchor" id="parameter-"></div>
@@ -388,6 +425,7 @@ Parameters
                 </td>
                 <td>
                         <div>If you specify one or more instance IDs, only instances that have the specified IDs are returned.</div>
+                        <div>Mutually exclusive with <em>exact_count</em>.</div>
                 </td>
             </tr>
             <tr>
@@ -1295,6 +1333,7 @@ Examples
         tags:
           Env: "eni_on"
         instance_type: t2.micro
+
     - name: start an instance with metadata options
       amazon.aws.ec2_instance:
         name: "public-metadataoptions-instance"
@@ -1307,6 +1346,35 @@ Examples
           http_endpoint: enabled
           http_tokens: optional
 
+    # ensure number of instances running with a tag matches exact_count
+    - name: start multiple instances
+      amazon.aws.ec2_instance:
+        instance_type: t3.small
+        image_id: ami-123456
+        exact_count: 5
+        region: us-east-2
+        vpc_subnet_id: subnet-0123456
+        network:
+          assign_public_ip: yes
+          security_group: default
+        tags:
+          foo: bar
+
+    # launches multiple instances - specific number of instances
+    - name: start specific number of multiple instances
+      amazon.aws.ec2_instance:
+        instance_type: t3.small
+        image_id: ami-123456
+        count: 3
+        region: us-east-2
+        network:
+          assign_public_ip: yes
+          security_group: default
+          vpc_subnet_id: subnet-0123456
+        state: present
+        tags:
+          foo: bar
+
 
 
 Return Values

diff --git a/docs/amazon.aws.s3_bucket_module.rst b/docs/amazon.aws.s3_bucket_module.rst
@@ -705,6 +705,136 @@ Examples
 
 
 
+Return Values
+-------------
+Common return values are documented `here <https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values>`_, the following are the fields unique to this module:
+
+.. raw:: html
+
+    <table border=0 cellpadding=0 class="documentation-table">
+        <tr>
+            <th colspan="1">Key</th>
+            <th>Returned</th>
+            <th width="100%">Description</th>
+        </tr>
+            <tr>
+                <td colspan="1">
+                    <div class="ansibleOptionAnchor" id="return-"></div>
+                    <b>encryption</b>
+                    <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a>
+                    <div style="font-size: small">
+                      <span style="color: purple">string</span>
+                    </div>
+                </td>
+                <td><em>state=present</em></td>
+                <td>
+                            <div>Server-side encryption of the objects in the S3 bucket.</div>
+                    <br/>
+                </td>
+            </tr>
+            <tr>
+                <td colspan="1">
+                    <div class="ansibleOptionAnchor" id="return-"></div>
+                    <b>name</b>
+                    <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a>
+                    <div style="font-size: small">
+                      <span style="color: purple">string</span>
+                    </div>
+                </td>
+                <td><em>state=present</em></td>
+                <td>
+                            <div>Name of the S3 bucket.</div>
+                    <br/>
+                        <div style="font-size: smaller"><b>Sample:</b></div>
+                        <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">2d3ce10a8210d36d6b4d23b822892074complex</div>
+                </td>
+            </tr>
+            <tr>
+                <td colspan="1">
+                    <div class="ansibleOptionAnchor" id="return-"></div>
+                    <b>object_ownership</b>
+                    <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a>
+                    <div style="font-size: small">
+                      <span style="color: purple">string</span>
+                    </div>
+                </td>
+                <td><em>state=present</em></td>
+                <td>
+                            <div>S3 bucket&#x27;s ownership controls.</div>
+                    <br/>
+                        <div style="font-size: smaller"><b>Sample:</b></div>
+                        <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">BucketOwnerPreferred</div>
+                </td>
+            </tr>
+            <tr>
+                <td colspan="1">
+                    <div class="ansibleOptionAnchor" id="return-"></div>
+                    <b>policy</b>
+                    <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a>
+                    <div style="font-size: small">
+                      <span style="color: purple">dictionary</span>
+                    </div>
+                </td>
+                <td><em>state=present</em></td>
+                <td>
+                            <div>S3 bucket&#x27;s policy.</div>
+                    <br/>
+                        <div style="font-size: smaller"><b>Sample:</b></div>
+                        <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">{&#x27;Statement&#x27;: [{&#x27;Action&#x27;: &#x27;s3:GetObject&#x27;, &#x27;Effect&#x27;: &#x27;Allow&#x27;, &#x27;Principal&#x27;: &#x27;*&#x27;, &#x27;Resource&#x27;: &#x27;arn:aws:s3:::2d3ce10a8210d36d6b4d23b822892074complex/*&#x27;, &#x27;Sid&#x27;: &#x27;AddPerm&#x27;}], &#x27;Version&#x27;: &#x27;2012-10-17&#x27;}</div>
+                </td>
+            </tr>
+            <tr>
+                <td colspan="1">
+                    <div class="ansibleOptionAnchor" id="return-"></div>
+                    <b>requester_pays</b>
+                    <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a>
+                    <div style="font-size: small">
+                      <span style="color: purple">string</span>
+                    </div>
+                </td>
+                <td><em>state=present</em></td>
+                <td>
+                            <div>Indicates that the requester was successfully charged for the request.</div>
+                    <br/>
+                </td>
+            </tr>
+            <tr>
+                <td colspan="1">
+                    <div class="ansibleOptionAnchor" id="return-"></div>
+                    <b>tags</b>
+                    <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a>
+                    <div style="font-size: small">
+                      <span style="color: purple">dictionary</span>
+                    </div>
+                </td>
+                <td><em>state=present</em></td>
+                <td>
+                            <div>S3 bucket&#x27;s tags.</div>
+                    <br/>
+                        <div style="font-size: smaller"><b>Sample:</b></div>
+                        <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">{&#x27;Tag1&#x27;: &#x27;tag1&#x27;, &#x27;Tag2&#x27;: &#x27;tag2&#x27;}</div>
+                </td>
+            </tr>
+            <tr>
+                <td colspan="1">
+                    <div class="ansibleOptionAnchor" id="return-"></div>
+                    <b>versioning</b>
+                    <a class="ansibleOptionLink" href="#return-" title="Permalink to this return value"></a>
+                    <div style="font-size: small">
+                      <span style="color: purple">dictionary</span>
+                    </div>
+                </td>
+                <td><em>state=present</em></td>
+                <td>
+                            <div>S3 bucket&#x27;s versioning configuration.</div>
+                    <br/>
+                        <div style="font-size: smaller"><b>Sample:</b></div>
+                        <div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">{&#x27;MfaDelete&#x27;: &#x27;Disabled&#x27;, &#x27;Versioning&#x27;: &#x27;Enabled&#x27;}</div>
+                </td>
+            </tr>
+    </table>
+    <br/><br/>
+
 
 Status
 ------

diff --git a/galaxy.yml b/galaxy.yml
@@ -1,6 +1,6 @@
 namespace: amazon
 name: aws
-version: 2.1.0
+version: 2.2.0
 readme: README.md
 authors:
   - Ansible (https://github.com/ansible)