Update version_added information for modules which migrate to amazon.…

…aws in 5.0.0 (ansible-collections#1155) Update version_added information for modules which migrate to amazon.aws in 5.0.0 SUMMARY Felix has pointed out in IRC/Matrix that for modules which migrated to amazon.aws it can be a little confusing when you try to look back in logs to find exactly what needs to be installed for a feature (installing amazon.aws.4.3.0 doesn't guarantee that community.aws 4.x is installed) Update the main 'version_added' to match the version that the modules were moved to amazon.aws, and add the version_added_collection for existing new features. ISSUE TYPE Docs Pull Request COMPONENT NAME various modules ADDITIONAL INFORMATION Scope is currently limited to the 5.0.0 migrations, to simplify backports. If accepted I'll cleanup the 4.0.0 and 2.0.0 modules too. Reviewed-by: Felix Fontein <[email protected]>
abikouo · Oct 11, 2022 · 2797554 · 2797554
1 parent a9ad180
commit 2797554
Show file tree

Hide file tree

Showing 40 changed files with 251 additions and 144 deletions.
diff --git a/changelogs/fragments/version_added-5.yml b/changelogs/fragments/version_added-5.yml
@@ -0,0 +1,3 @@
+trivial:
+- various modules - bumped module ``version_added`` to match when they were added to the amazon.aws collection
+- various modules - added ``version_added_collection`` where features were added as part of community.aws
diff --git a/plugins/modules/autoscaling_group.py b/plugins/modules/autoscaling_group.py
@@ -9,13 +9,14 @@
 DOCUMENTATION = r'''
 ---
 module: autoscaling_group
-version_added: 1.0.0
+version_added: 5.0.0
 short_description: Create or delete AWS AutoScaling Groups (ASGs)
 description:
   - Can create or delete AWS AutoScaling Groups.
   - Can be used with the M(community.aws.autoscaling_launch_config) module to manage Launch Configurations.
   - Prior to release 5.0.0 this module was called C(community.aws.ec2_asg).
     The usage did not change.
+  - This module was originally added to C(community.aws) in release 1.0.0.
 author:
   - "Gareth Rushgrove (@garethr)"
 options:
@@ -106,13 +107,15 @@
         required: false
         type: dict
         version_added: 1.5.0
+        version_added_collection: community.aws
         suboptions:
           on_demand_allocation_strategy:
             description:
               - Indicates how to allocate instance types to fulfill On-Demand capacity.
             type: str
             required: false
             version_added: 1.5.0
+            version_added_collection: community.aws
           on_demand_base_capacity:
             description:
               - >-
@@ -124,6 +127,7 @@
             type: int
             required: false
             version_added: 1.5.0
+            version_added_collection: community.aws
           on_demand_percentage_above_base_capacity:
             description:
               - Controls the percentages of On-Demand Instances and Spot Instances for your additional capacity beyond OnDemandBaseCapacity.
@@ -132,12 +136,14 @@
             type: int
             required: false
             version_added: 1.5.0
+            version_added_collection: community.aws
           spot_allocation_strategy:
             description:
               - Indicates how to allocate instances across Spot Instance pools.
             type: str
             required: false
             version_added: 1.5.0
+            version_added_collection: community.aws
           spot_instance_pools:
             description:
               - >-
@@ -148,6 +154,7 @@
             type: int
             required: false
             version_added: 1.5.0
+            version_added_collection: community.aws
           spot_max_price:
             description:
               - The maximum price per unit hour that you are willing to pay for a Spot Instance.
@@ -156,6 +163,7 @@
             type: str
             required: false
             version_added: 1.5.0
+            version_added_collection: community.aws
     type: dict
   placement_group:
     description:
@@ -194,12 +202,14 @@
     type: list
     elements: str
     version_added: 3.2.0
+    version_added_collection: community.aws
   decrement_desired_capacity:
     description:
       - Indicates whether the AutoScalingGroup decrements the desired capacity value by the number of instances detached.
     default: false
     type: bool
     version_added: 3.2.0
+    version_added_collection: community.aws
   lc_check:
     description:
       - Check to make sure instances that are being replaced with I(replace_instances) do not already have the current I(launch_config).
@@ -230,6 +240,7 @@
     default: false
     type: bool
     version_added: 3.2.0
+    version_added_collection: community.aws
   health_check_period:
     description:
       - Length of time in seconds after a new EC2 instance comes into service that Auto Scaling starts checking its health.

diff --git a/plugins/modules/autoscaling_group_info.py b/plugins/modules/autoscaling_group_info.py
@@ -9,12 +9,13 @@
 DOCUMENTATION = '''
 ---
 module: autoscaling_group_info
-version_added: 1.0.0
+version_added: 5.0.0
 short_description: Gather information about EC2 Auto Scaling Groups (ASGs) in AWS
 description:
   - Gather information about EC2 Auto Scaling Groups (ASGs) in AWS.
   - Prior to release 5.0.0 this module was called C(community.aws.ec2_asg_info).
     The usage did not change.
+  - This module was originally added to C(community.aws) in release 1.0.0.
 author:
   - "Rob White (@wimnat)"
 options:

diff --git a/plugins/modules/cloudtrail.py b/plugins/modules/cloudtrail.py
@@ -9,10 +9,11 @@
 DOCUMENTATION = '''
 ---
 module: cloudtrail
-version_added: 1.0.0
+version_added: 5.0.0
 short_description: manage CloudTrail create, delete, update
 description:
   - Creates, deletes, or updates CloudTrail configuration. Ensures logging is also enabled.
+  - This module was originally added to C(community.aws) in release 1.0.0.
 author:
   - Ansible Core Team
   - Ted Timmons (@tedder)

diff --git a/plugins/modules/cloudwatch_metric_alarm.py b/plugins/modules/cloudwatch_metric_alarm.py
@@ -21,12 +21,13 @@
 DOCUMENTATION = r'''
 module: cloudwatch_metric_alarm
 short_description: "Create/update or delete AWS CloudWatch 'metric alarms'"
-version_added: 1.0.0
+version_added: 5.0.0
 description:
  - Can create or delete AWS CloudWatch metric alarms.
  - Metrics you wish to alarm on must already exist.
  - Prior to release 5.0.0 this module was called C(community.aws.ec2_metric_alarm).
    The usage did not change.
+ - This module was originally added to C(community.aws) in release 1.0.0.
 author:
   - "Zacharie Eakin (@Zeekin)"
 options:

diff --git a/plugins/modules/cloudwatchevent_rule.py b/plugins/modules/cloudwatchevent_rule.py
@@ -9,16 +9,18 @@
 DOCUMENTATION = r'''
 ---
 module: cloudwatchevent_rule
-version_added: 1.0.0
+version_added: 5.0.0
 short_description: Manage CloudWatch Event rules and targets
 description:
   - This module creates and manages CloudWatch event rules and targets.
+  - This module was originally added to C(community.aws) in release 1.0.0.
 extends_documentation_fragment:
-- amazon.aws.aws
-- amazon.aws.ec2
-- amazon.aws.boto3
+  - amazon.aws.aws
+  - amazon.aws.ec2
+  - amazon.aws.boto3
 
-author: "Jim Dalton (@jsdalton) <[email protected]>"
+author:
+  - "Jim Dalton (@jsdalton) <[email protected]>"
 notes:
   - A rule must contain at least an I(event_pattern) or I(schedule_expression). A
     rule can have both an I(event_pattern) and a I(schedule_expression), in which
@@ -96,6 +98,7 @@
         description:
           - Settings to support providing custom input to a target based on certain event data.
         version_added: 4.1.0
+        version_added_collection: community.aws
         suboptions:
           input_paths_map:
             type: dict

diff --git a/plugins/modules/cloudwatchlogs_log_group.py b/plugins/modules/cloudwatchlogs_log_group.py
@@ -10,13 +10,14 @@
 DOCUMENTATION = '''
 ---
 module: cloudwatchlogs_log_group
-version_added: 1.0.0
+version_added: 5.0.0
 short_description: create or delete log_group in CloudWatchLogs
+description:
+  - Create or delete log_group in CloudWatchLogs.
+  - This module was originally added to C(community.aws) in release 1.0.0.
 notes:
   - For details of the parameters and returns see U(http://boto3.readthedocs.io/en/latest/reference/services/logs.html).
   - Support for I(purge_tags) was added in release 4.0.0.
-description:
-  - Create or delete log_group in CloudWatchLogs.
 author:
   - Willian Ricardo (@willricardo) <[email protected]>
 options:
@@ -95,6 +96,7 @@
     returned: success
     type: complex
     version_added: 4.0.0
+    version_added_collection: community.aws
     contains:
         log_group_name:
             description: The name of the log group.

diff --git a/plugins/modules/cloudwatchlogs_log_group_info.py b/plugins/modules/cloudwatchlogs_log_group_info.py
@@ -10,10 +10,11 @@
 DOCUMENTATION = '''
 ---
 module: cloudwatchlogs_log_group_info
-version_added: 1.0.0
+version_added: 5.0.0
 short_description: Get information about log_group in CloudWatchLogs
 description:
   - Lists the specified log groups. You can list all your log groups or filter the results by prefix.
+  - This module was originally added to C(community.aws) in release 1.0.0.
 author:
   - Willian Ricardo (@willricardo) <[email protected]>
 options:
@@ -72,6 +73,7 @@
             returned: always
             type: dict
             version_added: 4.0.0
+            version_added_collection: community.aws
 '''
 
 try:

diff --git a/plugins/modules/cloudwatchlogs_log_group_metric_filter.py b/plugins/modules/cloudwatchlogs_log_group_metric_filter.py
@@ -8,13 +8,14 @@
 DOCUMENTATION = '''
 ---
 module: cloudwatchlogs_log_group_metric_filter
-version_added: 1.0.0
+version_added: 5.0.0
 author:
   - "Markus Bergholz (@markuman)"
 short_description: Manage CloudWatch log group metric filter
 description:
   - Create, modify and delete CloudWatch log group metric filter.
   - CloudWatch log group metric filter can be use with M(community.aws.ec2_metric_alarm).
+  - This module was originally added to C(community.aws) in release 1.0.0.
 options:
     state:
       description:
@@ -58,9 +59,9 @@
             - The value to emit when a filter pattern does not match a log event.
           type: float
 extends_documentation_fragment:
-- amazon.aws.aws
-- amazon.aws.ec2
-- amazon.aws.boto3
+  - amazon.aws.aws
+  - amazon.aws.ec2
+  - amazon.aws.boto3
 
 '''
 

diff --git a/plugins/modules/ec2_eip.py b/plugins/modules/ec2_eip.py
@@ -11,11 +11,12 @@
 DOCUMENTATION = '''
 ---
 module: ec2_eip
-version_added: 1.0.0
+version_added: 5.0.0
 short_description: manages EC2 elastic IP (EIP) addresses.
 description:
   - This module can allocate or release an EIP.
   - This module can associate/disassociate an EIP with instances or network interfaces.
+  - This module was originally added to C(community.aws) in release 1.0.0.
 options:
   device_id:
     description:

diff --git a/plugins/modules/ec2_eip_info.py b/plugins/modules/ec2_eip_info.py
@@ -9,11 +9,13 @@
 DOCUMENTATION = '''
 ---
 module: ec2_eip_info
-version_added: 1.0.0
+version_added: 5.0.0
 short_description: List EC2 EIP details
 description:
-    - List details of EC2 Elastic IP addresses.
-author: "Brad Macpherson (@iiibrad)"
+  - List details of EC2 Elastic IP addresses.
+  - This module was originally added to C(community.aws) in release 1.0.0.
+author:
+  - "Brad Macpherson (@iiibrad)"
 options:
   filters:
     description:
@@ -24,9 +26,9 @@
     default: {}
     type: dict
 extends_documentation_fragment:
-- amazon.aws.aws
-- amazon.aws.ec2
-- amazon.aws.boto3
+  - amazon.aws.aws
+  - amazon.aws.ec2
+  - amazon.aws.boto3
 
 '''
 

diff --git a/plugins/modules/elb_application_lb.py b/plugins/modules/elb_application_lb.py
@@ -21,10 +21,11 @@
 DOCUMENTATION = r'''
 ---
 module: elb_application_lb
-version_added: 1.0.0
+version_added: 5.0.0
 short_description: Manage an Application Load Balancer
 description:
   - Manage an AWS Application Elastic Load Balancer. See U(https://aws.amazon.com/blogs/aws/new-aws-application-load-balancer/) for details.
+  - This module was originally added to C(community.aws) in release 1.0.0.
 author:
   - "Rob White (@wimnat)"
 options:
@@ -64,24 +65,28 @@
     type: str
     choices: ['monitor', 'defensive', 'strictest']
     version_added: 3.2.0
+    version_added_collection: community.aws
   http_drop_invalid_header_fields:
     description:
       - Indicates whether HTTP headers with invalid header fields are removed by the load balancer C(True) or routed to targets C(False).
       - Defaults to C(False).
     type: bool
     version_added: 3.2.0
+    version_added_collection: community.aws
   http_x_amzn_tls_version_and_cipher_suite:
     description:
       - Indicates whether the two headers are added to the client request before sending it to the target.
       - Defaults to C(False).
     type: bool
     version_added: 3.2.0
+    version_added_collection: community.aws
   http_xff_client_port:
     description:
       - Indicates whether the X-Forwarded-For header should preserve the source port that the client used to connect to the load balancer.
       - Defaults to C(False).
     type: bool
     version_added: 3.2.0
+    version_added_collection: community.aws
   idle_timeout:
     description:
       - The number of seconds to wait before an idle connection is closed.
@@ -213,6 +218,7 @@
       - Defaults to C(False).
     type: bool
     version_added: 3.2.0
+    version_added_collection: community.aws
 extends_documentation_fragment:
   - amazon.aws.aws
   - amazon.aws.ec2

diff --git a/plugins/modules/elb_application_lb_info.py b/plugins/modules/elb_application_lb_info.py
@@ -9,11 +9,13 @@
 DOCUMENTATION = r'''
 ---
 module: elb_application_lb_info
-version_added: 1.0.0
+version_added: 5.0.0
 short_description: Gather information about Application Load Balancers in AWS
 description:
-    - Gather information about Application Load Balancers in AWS
-author: Rob White (@wimnat)
+  - Gather information about Application Load Balancers in AWS
+  - This module was originally added to C(community.aws) in release 1.0.0.
+author:
+  - Rob White (@wimnat)
 options:
   load_balancer_arns:
     description:
@@ -29,9 +31,9 @@
     elements: str
 
 extends_documentation_fragment:
-- amazon.aws.aws
-- amazon.aws.ec2
-- amazon.aws.boto3
+  - amazon.aws.aws
+  - amazon.aws.ec2
+  - amazon.aws.boto3
 
 '''
 

diff --git a/plugins/modules/iam_policy.py b/plugins/modules/iam_policy.py
@@ -9,12 +9,13 @@
 DOCUMENTATION = '''
 ---
 module: iam_policy
-version_added: 1.0.0
+version_added: 5.0.0
 short_description: Manage inline IAM policies for users, groups, and roles
 description:
   - Allows uploading or removing inline IAM policies for IAM users, groups or roles.
   - To administer managed policies please see M(community.aws.iam_user), M(community.aws.iam_role),
     M(community.aws.iam_group) and M(community.aws.iam_managed_policy)
+  - This module was originally added to C(community.aws) in release 1.0.0.
 options:
   iam_type:
     description: