ansible-collections · softwarefactory-project-zuul · Sep 30, 2022 · Aug 30, 2022 · Sep 13, 2022 · Sep 13, 2022
diff --git a/changelogs/fragments/985-cleanup_doc_fragments.yml b/changelogs/fragments/985-cleanup_doc_fragments.yml
@@ -0,0 +1,2 @@
+breaking_changes:
+- doc_fragments - remove minimum collection requirements from doc_fragments/aws.py and allow pulling those from doc_fragments/aws_boto3.py instead (https://github.com/ansible-collections/amazon.aws/pull/985).
diff --git a/docs/docsite/rst/dev_guidelines.rst b/docs/docsite/rst/dev_guidelines.rst
@@ -294,11 +294,12 @@ An example of the older style connection used for modules based on AnsibleModule
 Common Documentation Fragments for Connection Parameters
 --------------------------------------------------------
 
-There are two :ref:`common documentation fragments <module_docs_fragments>`
+There are four :ref:`common documentation fragments <module_docs_fragments>`
 that should be included into almost all AWS modules:
 
 * ``aws`` - contains the common boto3 connection parameters
 * ``ec2`` - contains the common region parameter required for many AWS modules
+* ``boto3`` - contains the minimum requirements for the collection
 * ``tags`` - contains the common tagging parameters used by many AWS modules
 
 These fragments should be used rather than re-documenting these properties to ensure consistency
@@ -312,6 +313,7 @@ and that the more esoteric connection options are documented. For example:
    extends_documentation_fragment:
        - amazon.aws.aws
        - amazon.aws.ec2
+       - amazon.aws.boto3
    '''
 
 .. _ansible_collections.amazon.aws.docsite.dev_exceptions:

diff --git a/plugins/doc_fragments/aws.py b/plugins/doc_fragments/aws.py
@@ -66,10 +66,6 @@ class ModuleDocFragment(object):
       - A dictionary to modify the botocore configuration.
       - Parameters can be found at U(https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config).
     type: dict
-requirements:
-  - python >= 3.6
-  - boto3 >= 1.18.0
-  - botocore >= 1.21.0
 notes:
   - If parameters are not set within the module, the following
     environment variables can be used in decreasing order of precedence

diff --git a/plugins/doc_fragments/aws_boto3.py → plugins/doc_fragments/boto3.py b/plugins/doc_fragments/aws_boto3.py → plugins/doc_fragments/boto3.py
diff --git a/plugins/inventory/aws_ec2.py b/plugins/inventory/aws_ec2.py
@@ -10,7 +10,7 @@
 extends_documentation_fragment:
   - inventory_cache
   - constructed
-  - amazon.aws.aws_boto3
+  - amazon.aws.boto3
   - amazon.aws.aws_credentials
 description:
   - Get inventory hosts from Amazon Web Services EC2.

diff --git a/plugins/inventory/aws_rds.py b/plugins/inventory/aws_rds.py
@@ -58,7 +58,7 @@
 extends_documentation_fragment:
   - inventory_cache
   - constructed
-  - amazon.aws.aws_boto3
+  - amazon.aws.boto3
   - amazon.aws.aws_credentials
 author:
   - Sloane Hertel (@s-hertel)

diff --git a/plugins/lookup/aws_account_attribute.py b/plugins/lookup/aws_account_attribute.py
@@ -8,7 +8,7 @@
 author:
   - Sloane Hertel (@s-hertel) <shertel@redhat.com>
 extends_documentation_fragment:
-  - amazon.aws.aws_boto3
+  - amazon.aws.boto3
   - amazon.aws.aws_credentials
   - amazon.aws.aws_region
 short_description: Look up AWS account attributes

diff --git a/plugins/lookup/aws_secret.py b/plugins/lookup/aws_secret.py
@@ -9,7 +9,7 @@
 author:
   - Aaron Smith (!UNKNOWN) <ajsmith10381@gmail.com>
 extends_documentation_fragment:
-  - amazon.aws.aws_boto3
+  - amazon.aws.boto3
   - amazon.aws.aws_credentials
   - amazon.aws.aws_region
 

diff --git a/plugins/lookup/aws_ssm.py b/plugins/lookup/aws_ssm.py
@@ -72,7 +72,7 @@
     type: string
     version_added: 3.3.0
 extends_documentation_fragment:
-  - amazon.aws.aws_boto3
+  - amazon.aws.boto3
 '''
 
 EXAMPLES = '''

diff --git a/plugins/modules/autoscaling_group.py b/plugins/modules/autoscaling_group.py
@@ -323,6 +323,7 @@
 extends_documentation_fragment:
   - amazon.aws.aws
   - amazon.aws.ec2
+  - amazon.aws.boto3
 '''
 
 EXAMPLES = r'''

diff --git a/plugins/modules/autoscaling_group_info.py b/plugins/modules/autoscaling_group_info.py
@@ -34,6 +34,7 @@
 extends_documentation_fragment:
   - amazon.aws.aws
   - amazon.aws.ec2
+  - amazon.aws.boto3
 '''
 
 EXAMPLES = '''

diff --git a/plugins/modules/aws_az_info.py b/plugins/modules/aws_az_info.py
@@ -28,6 +28,7 @@
 extends_documentation_fragment:
 - amazon.aws.aws
 - amazon.aws.ec2
+- amazon.aws.boto3
 '''
 
 EXAMPLES = '''

diff --git a/plugins/modules/aws_caller_info.py b/plugins/modules/aws_caller_info.py
@@ -22,7 +22,7 @@
 extends_documentation_fragment:
 - amazon.aws.aws
 - amazon.aws.ec2
-
+- amazon.aws.boto3
 '''
 
 EXAMPLES = '''

diff --git a/plugins/modules/cloudformation.py b/plugins/modules/cloudformation.py
@@ -165,6 +165,7 @@
 extends_documentation_fragment:
   - amazon.aws.aws
   - amazon.aws.ec2
+  - amazon.aws.boto3
 '''
 
 EXAMPLES = '''

diff --git a/plugins/modules/cloudformation_info.py b/plugins/modules/cloudformation_info.py
@@ -54,7 +54,7 @@
 extends_documentation_fragment:
 - amazon.aws.aws
 - amazon.aws.ec2
-
+- amazon.aws.boto3
 '''
 
 EXAMPLES = '''

diff --git a/plugins/modules/cloudtrail.py b/plugins/modules/cloudtrail.py
@@ -95,6 +95,7 @@
   - amazon.aws.aws
   - amazon.aws.ec2
   - amazon.aws.tags
+  - amazon.aws.boto3
 
 '''
 

diff --git a/plugins/modules/cloudtrail_info.py b/plugins/modules/cloudtrail_info.py
@@ -28,6 +28,7 @@
 extends_documentation_fragment:
   - amazon.aws.aws
   - amazon.aws.ec2
+  - amazon.aws.boto3
 '''
 
 EXAMPLES = '''

diff --git a/plugins/modules/cloudwatch_metric_alarm.py b/plugins/modules/cloudwatch_metric_alarm.py
@@ -161,6 +161,7 @@
 extends_documentation_fragment:
   - amazon.aws.aws
   - amazon.aws.ec2
+  - amazon.aws.boto3
 '''
 
 EXAMPLES = r'''

diff --git a/plugins/modules/cloudwatch_metric_alarm_info.py b/plugins/modules/cloudwatch_metric_alarm_info.py
@@ -61,6 +61,8 @@
 extends_documentation_fragment:
 - amazon.aws.aws
 - amazon.aws.ec2
+- amazon.aws.boto3
+
 '''
 
 EXAMPLES = '''

diff --git a/plugins/modules/cloudwatchevent_rule.py b/plugins/modules/cloudwatchevent_rule.py
@@ -16,6 +16,7 @@
 extends_documentation_fragment:
 - amazon.aws.aws
 - amazon.aws.ec2
+- amazon.aws.boto3
 
 author: "Jim Dalton (@jsdalton) <jim.dalton@gmail.com>"
 notes:

diff --git a/plugins/modules/cloudwatchlogs_log_group.py b/plugins/modules/cloudwatchlogs_log_group.py
@@ -62,6 +62,7 @@
   - amazon.aws.aws
   - amazon.aws.ec2
   - amazon.aws.tags
+  - amazon.aws.boto3
 
 '''
 

diff --git a/plugins/modules/cloudwatchlogs_log_group_info.py b/plugins/modules/cloudwatchlogs_log_group_info.py
@@ -24,6 +24,7 @@
 extends_documentation_fragment:
   - amazon.aws.aws
   - amazon.aws.ec2
+  - amazon.aws.boto3
 '''
 
 EXAMPLES = '''

diff --git a/plugins/modules/cloudwatchlogs_log_group_metric_filter.py b/plugins/modules/cloudwatchlogs_log_group_metric_filter.py
@@ -60,6 +60,7 @@
 extends_documentation_fragment:
 - amazon.aws.aws
 - amazon.aws.ec2
+- amazon.aws.boto3
 
 '''
 

diff --git a/plugins/modules/ec2_ami.py b/plugins/modules/ec2_ami.py
@@ -152,6 +152,7 @@
   - amazon.aws.aws
   - amazon.aws.ec2
   - amazon.aws.tags
+  - amazon.aws.boto3
 '''
 
 # Thank you to iAcquire for sponsoring development of this module.

diff --git a/plugins/modules/ec2_ami_info.py b/plugins/modules/ec2_ami_info.py
@@ -49,7 +49,7 @@
 extends_documentation_fragment:
 - amazon.aws.aws
 - amazon.aws.ec2
-
+- amazon.aws.boto3
 '''
 
 EXAMPLES = '''

diff --git a/plugins/modules/ec2_eip.py b/plugins/modules/ec2_eip.py
@@ -82,6 +82,7 @@
   - amazon.aws.aws
   - amazon.aws.ec2
   - amazon.aws.tags
+  - amazon.aws.boto3
 
 author:
   - "Rick Mendes (@rickmendes) <rmendes@illumina.com>"

diff --git a/plugins/modules/ec2_eip_info.py b/plugins/modules/ec2_eip_info.py
@@ -26,6 +26,7 @@
 extends_documentation_fragment:
 - amazon.aws.aws
 - amazon.aws.ec2
+- amazon.aws.boto3
 
 '''
 

diff --git a/plugins/modules/ec2_eni.py b/plugins/modules/ec2_eni.py
@@ -118,6 +118,7 @@
   - amazon.aws.aws
   - amazon.aws.ec2
   - amazon.aws.tags
+  - amazon.aws.boto3
 notes:
   - This module identifies and ENI based on either the I(eni_id), a combination of I(private_ip_address) and I(subnet_id),
     or a combination of I(instance_id) and I(device_id). Any of these options will let you specify a particular ENI.

diff --git a/plugins/modules/ec2_eni_info.py b/plugins/modules/ec2_eni_info.py
@@ -31,6 +31,7 @@
 extends_documentation_fragment:
   - amazon.aws.aws
   - amazon.aws.ec2
+  - amazon.aws.boto3
 '''
 
 EXAMPLES = '''

diff --git a/plugins/modules/ec2_instance.py b/plugins/modules/ec2_instance.py
@@ -355,6 +355,7 @@
   - amazon.aws.aws
   - amazon.aws.ec2
   - amazon.aws.tags
+  - amazon.aws.boto3
 '''
 
 EXAMPLES = '''

diff --git a/plugins/modules/ec2_instance_info.py b/plugins/modules/ec2_instance_info.py
@@ -42,7 +42,7 @@
 extends_documentation_fragment:
 - amazon.aws.aws
 - amazon.aws.ec2
-
+- amazon.aws.boto3
 '''
 
 EXAMPLES = r'''

diff --git a/plugins/modules/ec2_key.py b/plugins/modules/ec2_key.py
@@ -57,6 +57,7 @@
   - amazon.aws.aws
   - amazon.aws.ec2
   - amazon.aws.tags
+  - amazon.aws.boto3
 
 author:
   - "Vincent Viallet (@zbal)"

diff --git a/plugins/modules/ec2_security_group.py b/plugins/modules/ec2_security_group.py
@@ -237,7 +237,7 @@
   - amazon.aws.aws
   - amazon.aws.ec2
   - amazon.aws.tags
-
+  - amazon.aws.boto3
 
 notes:
   - If a rule declares a group_name and that group doesn't exist, it will be

diff --git a/plugins/modules/ec2_security_group_info.py b/plugins/modules/ec2_security_group_info.py
@@ -34,6 +34,7 @@
 extends_documentation_fragment:
 - amazon.aws.aws
 - amazon.aws.ec2
+- amazon.aws.boto3
 
 '''
 

diff --git a/plugins/modules/ec2_snapshot.py b/plugins/modules/ec2_snapshot.py
@@ -75,6 +75,7 @@
 extends_documentation_fragment:
 - amazon.aws.aws
 - amazon.aws.ec2
+- amazon.aws.boto3
 '''
 
 EXAMPLES = '''

diff --git a/plugins/modules/ec2_snapshot_info.py b/plugins/modules/ec2_snapshot_info.py
@@ -72,6 +72,7 @@
 extends_documentation_fragment:
   - amazon.aws.ec2
   - amazon.aws.aws
+  - amazon.aws.boto3
 '''
 
 EXAMPLES = r'''

diff --git a/plugins/modules/ec2_spot_instance.py b/plugins/modules/ec2_spot_instance.py
@@ -285,6 +285,7 @@
 extends_documentation_fragment:
 - amazon.aws.aws
 - amazon.aws.ec2
+- amazon.aws.boto3
 '''
 
 EXAMPLES = '''

diff --git a/plugins/modules/ec2_spot_instance_info.py b/plugins/modules/ec2_spot_instance_info.py
@@ -34,6 +34,7 @@
 extends_documentation_fragment:
 - amazon.aws.aws
 - amazon.aws.ec2
+- amazon.aws.boto3
 '''
 
 EXAMPLES = '''

diff --git a/plugins/modules/ec2_tag.py b/plugins/modules/ec2_tag.py
@@ -50,7 +50,7 @@
 extends_documentation_fragment:
 - amazon.aws.aws
 - amazon.aws.ec2
-
+- amazon.aws.boto3
 '''
 
 EXAMPLES = '''

diff --git a/plugins/modules/ec2_tag_info.py b/plugins/modules/ec2_tag_info.py
@@ -27,7 +27,7 @@
 extends_documentation_fragment:
 - amazon.aws.aws
 - amazon.aws.ec2
-
+- amazon.aws.boto3
 '''
 
 EXAMPLES = '''

diff --git a/plugins/modules/ec2_vol.py b/plugins/modules/ec2_vol.py
@@ -115,6 +115,7 @@
   - amazon.aws.aws
   - amazon.aws.ec2
   - amazon.aws.tags
+  - amazon.aws.boto3
 '''
 
 EXAMPLES = '''

diff --git a/plugins/modules/ec2_vol_info.py b/plugins/modules/ec2_vol_info.py
@@ -23,6 +23,7 @@
 extends_documentation_fragment:
   - amazon.aws.aws
   - amazon.aws.ec2
+  - amazon.aws.boto3
 '''
 
 EXAMPLES = '''

diff --git a/plugins/modules/ec2_vpc_dhcp_option.py b/plugins/modules/ec2_vpc_dhcp_option.py
@@ -94,6 +94,7 @@
   - amazon.aws.aws
   - amazon.aws.ec2
   - amazon.aws.tags
+  - amazon.aws.boto3
 '''
 
 RETURN = """

diff --git a/plugins/modules/ec2_vpc_dhcp_option_info.py b/plugins/modules/ec2_vpc_dhcp_option_info.py
@@ -34,6 +34,7 @@
 extends_documentation_fragment:
   - amazon.aws.aws
   - amazon.aws.ec2
+  - amazon.aws.boto3
 '''
 
 EXAMPLES = '''

diff --git a/plugins/modules/ec2_vpc_endpoint.py b/plugins/modules/ec2_vpc_endpoint.py
@@ -126,6 +126,7 @@
   - amazon.aws.aws
   - amazon.aws.ec2
   - amazon.aws.tags
+  - amazon.aws.boto3
 '''
 
 EXAMPLES = r'''

diff --git a/plugins/modules/ec2_vpc_endpoint_info.py b/plugins/modules/ec2_vpc_endpoint_info.py
@@ -40,7 +40,7 @@
 extends_documentation_fragment:
 - amazon.aws.aws
 - amazon.aws.ec2
-
+- amazon.aws.boto3
 '''
 
 EXAMPLES = r'''

diff --git a/plugins/modules/ec2_vpc_endpoint_service_info.py b/plugins/modules/ec2_vpc_endpoint_service_info.py
@@ -29,7 +29,7 @@
 extends_documentation_fragment:
   - amazon.aws.aws
   - amazon.aws.ec2
-
+  - amazon.aws.boto3
 '''
 
 EXAMPLES = r'''
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		breaking_changes:
		- doc_fragments - remove minimum collection requirements from doc_fragments/aws.py and allow pulling those from doc_fragments/aws_boto3.py instead (https://github.com/ansible-collections/amazon.aws/pull/985).