Skip to content

Commit

Permalink
Update plugin docs to explicitly list python, boto3 and botocore vers…
Browse files Browse the repository at this point in the history
…ion requirements in line with collection requirements (ansible-collections#819)

Update plugin docs to explicitly list python, boto3 and botocore version requirements

SUMMARY
Update plugin docs to explicitly list python, boto3 and botocore version requirements in line with collection requirements.
ISSUE TYPE

Docs Pull Request

COMPONENT NAME
plugins/inventory/aws_ec2.py
plugins/inventory/aws_rds.py
plugins/lookup/aws_account_attribute.py
plugins/lookup/aws_secret.py
plugins/lookup/aws_ssm.py
ADDITIONAL INFORMATION
This is in line with the collection requirements, just trying to make it easier to find.

Reviewed-by: Alina Buzachis <None>
  • Loading branch information
tremble committed May 19, 2022
1 parent 64c4f0a commit b0c24a3
Show file tree
Hide file tree
Showing 6 changed files with 30 additions and 23 deletions.
19 changes: 19 additions & 0 deletions plugins/doc_fragments/aws_boto3.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# -*- coding: utf-8 -*-

# Copyright: (c) 2022, Ansible Project
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)

from __future__ import (absolute_import, division, print_function)
__metaclass__ = type


class ModuleDocFragment(object):

# Minimum requirements for the collection
DOCUMENTATION = r'''
options: {}
requirements:
- python >= 3.6
- boto3 >= 1.15.0
- botocore >= 1.18.0
'''
4 changes: 1 addition & 3 deletions plugins/inventory/aws_ec2.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,10 @@
name: aws_ec2
plugin_type: inventory
short_description: EC2 inventory source
requirements:
- boto3
- botocore
extends_documentation_fragment:
- inventory_cache
- constructed
- amazon.aws.aws_boto3
- amazon.aws.aws_credentials
description:
Expand Down
4 changes: 1 addition & 3 deletions plugins/inventory/aws_rds.py
Original file line number Diff line number Diff line change
Expand Up @@ -44,11 +44,9 @@
extends_documentation_fragment:
- inventory_cache
- constructed
- amazon.aws.aws_boto3
- amazon.aws.aws_credentials
requirements:
- boto3
- botocore
author: Sloane Hertel (@s-hertel)
'''

Expand Down
7 changes: 2 additions & 5 deletions plugins/lookup/aws_account_attribute.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,9 @@
DOCUMENTATION = '''
lookup: aws_account_attribute
author:
- Sloane Hertel <[email protected]>
requirements:
- python >= 3.6
- boto3
- botocore >= 1.18.0
- Sloane Hertel (@s-hertel) <[email protected]>
extends_documentation_fragment:
- amazon.aws.aws_boto3
- amazon.aws.aws_credentials
- amazon.aws.aws_region
Expand Down
7 changes: 2 additions & 5 deletions plugins/lookup/aws_secret.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,9 @@
DOCUMENTATION = r'''
lookup: aws_secret
author:
- Aaron Smith <[email protected]>
requirements:
- python >= 3.6
- boto3
- botocore >= 1.18.0
- Aaron Smith (!UNKNOWN) <[email protected]>
extends_documentation_fragment:
- amazon.aws.aws_boto3
- amazon.aws.aws_credentials
- amazon.aws.aws_region
Expand Down
12 changes: 5 additions & 7 deletions plugins/lookup/aws_ssm.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,9 @@
DOCUMENTATION = '''
lookup: aws_ssm
author:
- Bill Wang <ozbillwang(at)gmail.com>
- Marat Bakeev <hawara(at)gmail.com>
- Michael De La Rue <[email protected]>
requirements:
- python >= 3.6
- boto3
- botocore >= 1.18.0
- Bill Wang (!UNKNOWN) <ozbillwang(at)gmail.com>
- Marat Bakeev (!UNKNOWN) <hawara(at)gmail.com>
- Michael De La Rue (!UNKNOWN) <[email protected]>
short_description: Get the value for a SSM parameter or all parameters under a path.
description:
- Get the value for an Amazon Simple Systems Manager parameter or a hierarchy of parameters.
Expand Down Expand Up @@ -74,6 +70,8 @@
type: string
choices: ['error', 'skip', 'warn']
version_added: 2.0.0
extends_documentation_fragment:
- amazon.aws.aws_boto3
'''

EXAMPLES = '''
Expand Down

0 comments on commit b0c24a3

Please sign in to comment.