Prepare 1.4.0 release (ansible-collections#254)

* Prepare 1.4.0 release
alinabuzachis · Feb 5, 2021 · 8bbf81b · 8bbf81b
1 parent d9e591f
commit 8bbf81b
Show file tree

Hide file tree

Showing 19 changed files with 213 additions and 39 deletions.
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -5,6 +5,26 @@ community.aws Release Notes
 .. contents:: Topics
 
 
+v1.4.0
+======
+
+Minor Changes
+-------------
+
+- aws_ec2 - Add hostname options concatenation
+- aws_ec2 inventory plugin - avoid a superfluous import of ``ansible.utils.display.Display`` (https://github.com/ansible-collections/amazon.aws/pull/226).
+- aws_ec2 module - Replace inverse aws instance-state-name filters !terminated, !shutting-down in favor of postive filters pending, running, stopping, stopped. Issue 235. (https://github.com/ansible-collections/amazon.aws/pull/237)
+- aws_secret - add ``bypath`` functionality (https://github.com/ansible-collections/amazon.aws/pull/192).
+- ec2_key - add AWSRetry decorator to automatically retry on common temporary failures (https://github.com/ansible-collections/amazon.aws/pull/213).
+- ec2_vol - Add support for gp3 volumes and support for modifying existing volumes (https://github.com/ansible-collections/amazon.aws/issues/55).
+- module_utils/elbv2 - add logic to compare_rules to suit Values list nested within dicts unique to each field type. Fixes issue (https://github.com/ansible-collections/amazon.aws/issues/187)
+- various AWS plugins and module_utils - Cleanup unused imports (https://github.com/ansible-collections/amazon.aws/pull/217).
+
+Bugfixes
+--------
+
+- ec2_vol - a creation or update now returns a structure with an up to date list of tags (https://github.com/ansible-collections/amazon.aws/pull/241).
+
 v1.3.0
 ======
 

diff --git a/changelogs/changelog.yaml b/changelogs/changelog.yaml
@@ -197,3 +197,34 @@ releases:
     - 211-fix-error-handling-during-tagging-failure.yaml
     - 53-ec2_vol-boto3-port.yml
     release_date: '2020-12-10'
+  1.4.0:
+    changes:
+      bugfixes:
+      - ec2_vol - a creation or update now returns a structure with an up to date
+        list of tags (https://github.com/ansible-collections/amazon.aws/pull/241).
+      minor_changes:
+      - aws_ec2 - Add hostname options concatenation
+      - aws_ec2 inventory plugin - avoid a superfluous import of ``ansible.utils.display.Display``
+        (https://github.com/ansible-collections/amazon.aws/pull/226).
+      - aws_ec2 module - Replace inverse aws instance-state-name filters !terminated,
+        !shutting-down in favor of postive filters pending, running, stopping, stopped.
+        Issue 235. (https://github.com/ansible-collections/amazon.aws/pull/237)
+      - aws_secret - add ``bypath`` functionality (https://github.com/ansible-collections/amazon.aws/pull/192).
+      - ec2_key - add AWSRetry decorator to automatically retry on common temporary
+        failures (https://github.com/ansible-collections/amazon.aws/pull/213).
+      - ec2_vol - Add support for gp3 volumes and support for modifying existing volumes
+        (https://github.com/ansible-collections/amazon.aws/issues/55).
+      - module_utils/elbv2 - add logic to compare_rules to suit Values list nested
+        within dicts unique to each field type. Fixes issue (https://github.com/ansible-collections/amazon.aws/issues/187)
+      - various AWS plugins and module_utils - Cleanup unused imports (https://github.com/ansible-collections/amazon.aws/pull/217).
+    fragments:
+    - 188-httprequestmethodconfig-keyerror.yaml
+    - 192-aws_secret-bypath-option.yaml
+    - 213-ec2_key-retries.yml
+    - 215-gp3-and-change-support-for-ec2_vol.yaml
+    - 217-duplicate-imports.yml
+    - 226_avoid_extra_Display_import.yaml
+    - 237_replace_inverse_ec2_aws_filter.yaml
+    - 241_ec2_vol-returns-an-up-to-date-tag-dict-of-the-volume.yaml
+    - 25-aws_ec2-hostname-options-concatenation.yaml
+    release_date: '2021-02-05'
diff --git a/changelogs/fragments/188-httprequestmethodconfig-keyerror.yaml b/changelogs/fragments/188-httprequestmethodconfig-keyerror.yaml
diff --git a/changelogs/fragments/192-aws_secret-bypath-option.yaml b/changelogs/fragments/192-aws_secret-bypath-option.yaml
diff --git a/changelogs/fragments/213-ec2_key-retries.yml b/changelogs/fragments/213-ec2_key-retries.yml
diff --git a/changelogs/fragments/215-gp3-and-change-support-for-ec2_vol.yaml b/changelogs/fragments/215-gp3-and-change-support-for-ec2_vol.yaml
diff --git a/changelogs/fragments/217-duplicate-imports.yml b/changelogs/fragments/217-duplicate-imports.yml
diff --git a/changelogs/fragments/226_avoid_extra_Display_import.yaml b/changelogs/fragments/226_avoid_extra_Display_import.yaml
diff --git a/changelogs/fragments/237_replace_inverse_ec2_aws_filter.yaml b/changelogs/fragments/237_replace_inverse_ec2_aws_filter.yaml
diff --git a/changelogs/fragments/241_ec2_vol-returns-an-up-to-date-tag-dict-of-the-volume.yaml b/changelogs/fragments/241_ec2_vol-returns-an-up-to-date-tag-dict-of-the-volume.yaml
diff --git a/changelogs/fragments/25-aws_ec2-hostname-options-concatenation.yaml b/changelogs/fragments/25-aws_ec2-hostname-options-concatenation.yaml
diff --git a/docs/amazon.aws.aws_ec2_inventory.rst b/docs/amazon.aws.aws_ec2_inventory.rst
@@ -412,6 +412,7 @@ Parameters
                 <td>
                         <ul style="margin: 0; padding: 0"><b>Choices:</b>
                                     <li>aws_ec2</li>
+                                    <li>amazon.aws.aws_ec2</li>
                         </ul>
                 </td>
                     <td>
@@ -578,7 +579,10 @@ Examples
       - tag:Name=Tag1,Name=Tag2  # Return specific hosts only
       - tag:CustomDNSName
       - dns-name
-      - private-ip-address
+      - name: 'tag:Name=Tag1,Name=Tag2'
+      - name: 'private-ip-address'
+        separator: '_'
+        prefix: 'tag:Name'
 
     # Example using constructed features to create groups and set ansible_host
     plugin: aws_ec2

diff --git a/docs/amazon.aws.aws_s3_module.rst b/docs/amazon.aws.aws_s3_module.rst
@@ -660,7 +660,7 @@ Examples
         mode: put
 
     - name: PUT operation from a rendered template
-      aws_s3:
+      amazon.aws.aws_s3:
         bucket: mybucket
         object: /object.yaml
         content: "{{ lookup('template', 'templates/object.yaml.j2') }}"

diff --git a/docs/amazon.aws.aws_secret_lookup.rst b/docs/amazon.aws.aws_secret_lookup.rst
@@ -17,8 +17,8 @@ amazon.aws.aws_secret
 Synopsis
 --------
 - Look up secrets stored in AWS Secrets Manager provided the caller has the appropriate permissions to read the secret.
-- Lookup is based on the secret's `Name` value.
-- Optional parameters can be passed into this lookup; `version_id` and `version_stage`
+- Lookup is based on the secret's *Name* value.
+- Optional parameters can be passed into this lookup; *version_id* and *version_stage*
 
 
 
@@ -142,6 +142,25 @@ Parameters
                         <div>The AWS security token if using temporary access and secret keys.</div>
                 </td>
             </tr>
+            <tr>
+                <td colspan="1">
+                    <div class="ansibleOptionAnchor" id="parameter-"></div>
+                    <b>bypath</b>
+                    <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
+                    <div style="font-size: small">
+                        <span style="color: purple">boolean</span>
+                    </div>
+                    <div style="font-style: italic; font-size: small; color: darkgreen">added in 1.4.0</div>
+                </td>
+                <td>
+                        <b>Default:</b><br/><div style="color: blue">"no"</div>
+                </td>
+                    <td>
+                    </td>
+                <td>
+                        <div>A boolean to indicate whether the parameter is provided as a hierarchy.</div>
+                </td>
+            </tr>
             <tr>
                 <td colspan="1">
                     <div class="ansibleOptionAnchor" id="parameter-"></div>
@@ -159,6 +178,26 @@ Parameters
                 <td>
                         <div>Join two or more entries to form an extended secret.</div>
                         <div>This is useful for overcoming the 4096 character limit imposed by AWS.</div>
+                        <div>No effect when used with <em>bypath</em>.</div>
+                </td>
+            </tr>
+            <tr>
+                <td colspan="1">
+                    <div class="ansibleOptionAnchor" id="parameter-"></div>
+                    <b>nested</b>
+                    <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
+                    <div style="font-size: small">
+                        <span style="color: purple">boolean</span>
+                    </div>
+                    <div style="font-style: italic; font-size: small; color: darkgreen">added in 1.4.0</div>
+                </td>
+                <td>
+                        <b>Default:</b><br/><div style="color: blue">"no"</div>
+                </td>
+                    <td>
+                    </td>
+                <td>
+                        <div>A boolean to indicate the secret contains nested values.</div>
                 </td>
             </tr>
             <tr>
@@ -275,23 +314,31 @@ Examples
 
 .. code-block:: yaml
 
-    - name: Create RDS instance with aws_secret lookup for password param
+    - name: lookup secretsmanager secret in the current region
+       debug: msg="{{ lookup('amazon.aws.aws_secret', '/path/to/secrets', bypath=true) }}"
+
+     - name: Create RDS instance with aws_secret lookup for password param
        rds:
          command: create
          instance_name: app-db
          db_engine: MySQL
          size: 10
          instance_type: db.m1.small
          username: dbadmin
-         password: "{{ lookup('aws_secret', 'DbSecret') }}"
+         password: "{{ lookup('amazon.aws.aws_secret', 'DbSecret') }}"
          tags:
            Environment: staging
 
      - name: skip if secret does not exist
-       debug: msg="{{ lookup('aws_secret', 'secret-not-exist', on_missing='skip')}}"
+       debug: msg="{{ lookup('amazon.aws.aws_secret', 'secret-not-exist', on_missing='skip')}}"
 
      - name: warn if access to the secret is denied
-       debug: msg="{{ lookup('aws_secret', 'secret-denied', on_denied='warn')}}"
+       debug: msg="{{ lookup('amazon.aws.aws_secret', 'secret-denied', on_denied='warn')}}"
+
+     - name: lookup secretsmanager secret in the current region using the nested feature
+       debug: msg="{{ lookup('amazon.aws.aws_secret', 'secrets.environments.production.password', nested=true) }}"
+       # The secret can be queried using the following syntax: `aws_secret_object_name.key1.key2.key3`.
+       # If an object is of the form `{"key1":{"key2":{"key3":1}}}` the query would return the value `1`.
 
 
 

diff --git a/docs/amazon.aws.cloudformation_info_module.rst b/docs/amazon.aws.cloudformation_info_module.rst
@@ -532,7 +532,7 @@ Common return values are documented `here <https://docs.ansible.com/ansible/late
                       <span style="color: purple">list</span>
                     </div>
                 </td>
-                <td>only if all_facts or stack_resourses is true and the stack exists</td>
+                <td>only if all_facts or stack_resources is true and the stack exists</td>
                 <td>
                             <div>Describes stack resources for the stack</div>
                     <br/>
@@ -547,7 +547,7 @@ Common return values are documented `here <https://docs.ansible.com/ansible/late
                       <span style="color: purple">dictionary</span>
                     </div>
                 </td>
-                <td>only if all_facts or stack_resourses is true and the stack exists</td>
+                <td>only if all_facts or stack_resources is true and the stack exists</td>
                 <td>
                             <div>Dictionary of stack resources keyed by the value of each resource &#x27;LogicalResourceId&#x27; parameter and corresponding value of each resource &#x27;PhysicalResourceId&#x27; parameter</div>
                     <br/>

diff --git a/docs/amazon.aws.ec2_vol_module.rst b/docs/amazon.aws.ec2_vol_module.rst
@@ -27,8 +27,9 @@ Requirements
 ------------
 The below requirements are needed on the host that executes this module.
 
-- python >= 2.6
 - boto
+- boto3>=1.16.33
+- python >= 2.6
 
 
 Parameters
@@ -261,6 +262,26 @@ Parameters
                         <div>Specify the id of the KMS key to use.</div>
                 </td>
             </tr>
+            <tr>
+                <td colspan="1">
+                    <div class="ansibleOptionAnchor" id="parameter-"></div>
+                    <b>modify_volume</b>
+                    <a class="ansibleOptionLink" href="#parameter-" title="Permalink to this option"></a>
+                    <div style="font-size: small">
+                        <span style="color: purple">boolean</span>
+                    </div>
+                    <div style="font-style: italic; font-size: small; color: darkgreen">added in 1.4.0</div>
+                </td>
+                <td>
+                        <ul style="margin: 0; padding: 0"><b>Choices:</b>
+                                    <li><div style="color: blue"><b>no</b>&nbsp;&larr;</div></li>
+                                    <li>yes</li>
+                        </ul>
+                </td>
+                <td>
+                        <div>The volume won&#x27;t be modify unless this key is <code>true</code>.</div>
+                </td>
+            </tr>
             <tr>
                 <td colspan="1">
                     <div class="ansibleOptionAnchor" id="parameter-"></div>
@@ -380,6 +401,24 @@ Parameters
                         <div>tag:value pairs to add to the volume after creation.</div>
                 </td>
             </tr>
+            <tr>
+                <td colspan="1">
+                    <div class="ansibleOptionAnchor" id="parameter-"></div>
+                    <b>throughput</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 1.4.0</div>
+                </td>
+                <td>
+                </td>
+                <td>
+                        <div>Volume throughput in MB/s.</div>
+                        <div>This parameter is only valid for gp3 volumes.</div>
+                        <div>Valid range is from 125 to 1000.</div>
+                </td>
+            </tr>
             <tr>
                 <td colspan="1">
                     <div class="ansibleOptionAnchor" id="parameter-"></div>
@@ -430,10 +469,12 @@ Parameters
                                     <li>io1</li>
                                     <li>st1</li>
                                     <li>sc1</li>
+                                    <li>gp3</li>
+                                    <li>io2</li>
                         </ul>
                 </td>
                 <td>
-                        <div>Type of EBS volume; standard (magnetic), gp2 (SSD), io1 (Provisioned IOPS), st1 (Throughput Optimized HDD), sc1 (Cold HDD). &quot;Standard&quot; is the old EBS default and continues to remain the Ansible default for backwards compatibility.</div>
+                        <div>Type of EBS volume; standard (magnetic), gp2 (SSD), gp3 (SSD), io1 (Provisioned IOPS), io2 (Provisioned IOPS), st1 (Throughput Optimized HDD), sc1 (Cold HDD). &quot;Standard&quot; is the old EBS default and continues to remain the Ansible default for backwards compatibility.</div>
                 </td>
             </tr>
             <tr>

diff --git a/docs/amazon.aws.ec2_vpc_net_info_module.rst b/docs/amazon.aws.ec2_vpc_net_info_module.rst
@@ -447,6 +447,24 @@ Common return values are documented `here <https://docs.ansible.com/ansible/late
                     <br/>
                 </td>
             </tr>
+            <tr>
+                    <td class="elbow-placeholder">&nbsp;</td>
+                <td colspan="3">
+                    <div class="ansibleOptionAnchor" id="return-"></div>
+                    <b>dhcp_options_id</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>always</td>
+                <td>
+                            <div>The ID of the DHCP options associated with this VPC.</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;">dopt-12345678</div>
+                </td>
+            </tr>
             <tr>
                     <td class="elbow-placeholder">&nbsp;</td>
                 <td colspan="3">
@@ -614,6 +632,24 @@ Common return values are documented `here <https://docs.ansible.com/ansible/late
                     <br/>
                 </td>
             </tr>
+            <tr>
+                    <td class="elbow-placeholder">&nbsp;</td>
+                <td colspan="3">
+                    <div class="ansibleOptionAnchor" id="return-"></div>
+                    <b>owner_id</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>always</td>
+                <td>
+                            <div>The AWS account which owns the VPC.</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;">123456789012</div>
+                </td>
+            </tr>
             <tr>
                     <td class="elbow-placeholder">&nbsp;</td>
                 <td colspan="3">