Properly documented openstacksdk version requirements

With "extends_documentation_fragment: ['openstack.cloud.openstack']"
it is not necessary to list required Python libraries in section
'requirements' of DOCUMENTATION docstring in modules. Ansible will
merge requirements from doc fragments and DOCUMENTATION docstring
which previously resulted in duplicates such as in server module [0]:

* openstacksdk
* openstacksdk >= 0.36, < 0.99.0
* python >= 3.6

When removing the 'requirements' section from server module, then
Ansible will list openstacksdk once only:

* openstacksdk >= 0.36, < 0.99.0
* python >= 3.6

To see what documentation Ansible will produce for server module run:

  ansible-doc --type module openstack.cloud.server

[0] https://docs.ansible.com/ansible/latest/collections/openstack/\
    cloud/server_module.html

Change-Id: Ia53c2c34436c7a72080602f5699e82d20f677b8b
This commit is contained in:
Jakob Meng 2023-01-16 13:15:26 +01:00
parent bc16f70e1d
commit e4be201f20
84 changed files with 11 additions and 300 deletions

View File

@ -99,8 +99,8 @@ options:
default: INFO
choices: [INFO, DEBUG]
requirements:
- python >= 3.6
- openstacksdk >= 0.36, < 0.99.0
- "python >= 3.6"
- "openstacksdk >= 0.36, < 0.99.0"
notes:
- The standard OpenStack environment variables, such as C(OS_USERNAME)
may be used instead of providing explicit values.

View File

@ -111,11 +111,10 @@ options:
default: true
requirements:
- "python >= 3.6"
- "openstacksdk >= 0.28, < 0.99.0"
- "openstacksdk >= 0.36, < 0.99.0"
extends_documentation_fragment:
- inventory_cache
- constructed
'''
EXAMPLES = '''

View File

@ -44,10 +44,6 @@ options:
required: false
default: {}
type: dict
requirements:
- "python >= 3.6"
- "openstacksdk"
extends_documentation_fragment:
- openstack.cloud.openstack
'''

View File

@ -10,9 +10,6 @@ short_description: Retrieve an auth token
author: OpenStack Ansible SIG
description:
- Retrieve an auth token from an OpenStack Cloud
requirements:
- "python >= 3.6"
- "openstacksdk"
extends_documentation_fragment:
- openstack.cloud.openstack
'''

View File

@ -36,11 +36,6 @@ options:
- A timeout in seconds to tell the role to wait for the node to complete introspection if wait is set to True.
default: 1200
type: int
requirements:
- "python >= 3.6"
- "openstacksdk"
extends_documentation_fragment:
- openstack.cloud.openstack
'''

View File

@ -165,10 +165,7 @@ options:
aliases:
- skip_update_of_driver_password
requirements:
- "python >= 3.6"
- "openstacksdk"
- "jsonpatch"
extends_documentation_fragment:
- openstack.cloud.openstack
'''

View File

@ -91,10 +91,6 @@ options:
wait for the node activation or deactivation to complete.
default: 1800
type: int
requirements:
- "python >= 3.6"
- "openstacksdk"
extends_documentation_fragment:
- openstack.cloud.openstack
'''

View File

@ -26,10 +26,6 @@ options:
endpoint URL for the Ironic API. Use with "auth" and "auth_type"
settings set to None.
type: str
requirements:
- "python >= 3.6"
- "openstacksdk"
extends_documentation_fragment:
- openstack.cloud.openstack
'''

View File

@ -71,10 +71,6 @@ options:
endpoint URL for the Ironic API. Use with "auth" and "auth_type"
settings set to None.
type: str
requirements:
- "python >= 3.6"
- "openstacksdk"
extends_documentation_fragment:
- openstack.cloud.openstack
'''

View File

@ -30,9 +30,6 @@ options:
endpoint URL for the Ironic API. Use with "auth" and "auth_type"
settings set to None.
type: str
requirements:
- "python >= 3.6"
- "openstacksdk"
extends_documentation_fragment:
- openstack.cloud.openstack
'''

View File

@ -39,10 +39,6 @@ options:
choices: [present, absent]
default: present
type: str
requirements:
- "python >= 3.6"
- "openstacksdk"
extends_documentation_fragment:
- openstack.cloud.openstack
'''

View File

@ -77,9 +77,6 @@ notes:
- Return values of this module are preliminary and will most likely change
when openstacksdk has finished its transition of cloud layer functions to
resource proxies.
requirements:
- "python >= 3.6"
- "openstacksdk"
extends_documentation_fragment:
- openstack.cloud.openstack
'''

View File

@ -143,9 +143,6 @@ notes:
- Return values of this module are preliminary and will most likely change
when openstacksdk has finished its transition of cloud layer functions to
resource proxies.
requirements:
- "python >= 3.6"
- "openstacksdk"
extends_documentation_fragment:
- openstack.cloud.openstack
'''

View File

@ -67,10 +67,6 @@ options:
description:
- Metadata dictionary
type: dict
requirements:
- "python >= 3.6"
- "openstacksdk"
extends_documentation_fragment:
- openstack.cloud.openstack
'''

View File

@ -55,10 +55,6 @@ options:
- A string used for filtering flavors based on the amount of ephemeral
storage. Format is the same as the I(ram) parameter
type: str
requirements:
- "python >= 3.6"
- "openstacksdk"
extends_documentation_fragment:
- openstack.cloud.openstack
'''

View File

@ -18,10 +18,6 @@ options:
description:
- Filter by service host. Requires openstacksdk>=0.53.
type: str
requirements:
- "python >= 3.6"
- "openstacksdk"
extends_documentation_fragment:
- openstack.cloud.openstack
'''

View File

@ -21,8 +21,8 @@ options:
type: list
elements: str
requirements:
- "python >= 3.6"
- "openstacksdk"
- "python >= 3.6"
- "openstacksdk >= 0.36, < 0.99.0"
author: OpenStack Ansible SIG
'''

View File

@ -45,10 +45,6 @@ options:
choices: [present, absent]
default: present
type: str
requirements:
- "python >= 3.6"
- "openstacksdk"
extends_documentation_fragment:
- openstack.cloud.openstack
'''

View File

@ -34,11 +34,6 @@ options:
description:
- TTL (Time To Live) value in seconds.
type: int
requirements:
- "python >= 3.6"
- "openstacksdk"
extends_documentation_fragment:
- openstack.cloud.openstack
'''

View File

@ -44,10 +44,6 @@ options:
choices: [present, absent]
default: present
type: str
requirements:
- "python >= 3.6"
- "openstacksdk >= 0.13.0"
extends_documentation_fragment:
- openstack.cloud.openstack
'''

View File

@ -46,8 +46,7 @@ options:
type: list
elements: str
requirements:
- "python >= 3.6"
- "openstacksdk >= 0.44"
- "openstacksdk >= 0.44, < 0.99.0"
extends_documentation_fragment:
- openstack.cloud.openstack
'''

View File

@ -19,8 +19,7 @@ options:
type: str
aliases: ['id']
requirements:
- "python >= 3.6"
- "openstacksdk >= 0.44"
- "openstacksdk >= 0.44, < 0.99.0"
extends_documentation_fragment:
- openstack.cloud.openstack
'''

View File

@ -45,8 +45,7 @@ options:
type: list
elements: dict
requirements:
- "python >= 3.6"
- "openstacksdk >= 0.44"
- "openstacksdk >= 0.44, < 0.99.0"
extends_documentation_fragment:
- openstack.cloud.openstack
'''

View File

@ -18,8 +18,7 @@ options:
type: str
aliases: ['id']
requirements:
- "python >= 3.6"
- "openstacksdk >= 0.44"
- "openstacksdk >= 0.44, < 0.99.0"
extends_documentation_fragment:
- openstack.cloud.openstack
'''

View File

@ -71,10 +71,6 @@ options:
IP completely, or only detach it from the server. Default is to detach only.
type: bool
default: 'no'
requirements:
- "python >= 3.6"
- "openstacksdk"
extends_documentation_fragment:
- openstack.cloud.openstack
'''

View File

@ -45,10 +45,6 @@ options:
- The status of a floating IP, which can be ``ACTIVE``or ``DOWN``.
choices: ['active', 'down']
type: str
requirements:
- "python >= 3.6"
- "openstacksdk"
extends_documentation_fragment:
- openstack.cloud.openstack
'''

View File

@ -26,10 +26,6 @@ options:
choices: [present, absent]
default: present
type: str
requirements:
- "python >= 3.6"
- "openstacksdk"
extends_documentation_fragment:
- openstack.cloud.openstack
'''

View File

@ -35,10 +35,6 @@ options:
choices: [present, absent]
default: present
type: str
requirements:
- "python >= 3.6"
- "openstacksdk"
extends_documentation_fragment:
- openstack.cloud.openstack
'''

View File

@ -32,10 +32,6 @@ options:
choices: [present, absent]
default: present
type: str
requirements:
- "python >= 3.6"
- "openstacksdk"
extends_documentation_fragment:
- openstack.cloud.openstack
'''

View File

@ -21,10 +21,6 @@ options:
- A dictionary of meta data to use for filtering. Elements of
this dictionary may be additional dictionaries.
type: dict
requirements:
- "python >= 3.6"
- "openstacksdk"
extends_documentation_fragment:
- openstack.cloud.openstack
'''

View File

@ -30,10 +30,6 @@ options:
choices: [present, absent]
default: present
type: str
requirements:
- "python >= 3.6"
- "openstacksdk"
extends_documentation_fragment:
- openstack.cloud.openstack
'''

View File

@ -24,10 +24,6 @@ options:
- A dictionary of meta data to use for further filtering. Elements of
this dictionary may be additional dictionaries.
type: dict
requirements:
- "python >= 3.6"
- "openstacksdk"
extends_documentation_fragment:
- openstack.cloud.openstack
'''

View File

@ -21,10 +21,6 @@ options:
choices: [present, absent]
default: present
type: str
requirements:
- "python >= 3.6"
- "openstacksdk"
extends_documentation_fragment:
- openstack.cloud.openstack
'''

View File

@ -22,11 +22,6 @@ options:
- Name or ID of the role
type: str
required: false
requirements:
- "python >= 3.6"
- "openstacksdk"
extends_documentation_fragment:
- openstack.cloud.openstack
'''

View File

@ -58,10 +58,6 @@ options:
choices: [present, absent]
default: present
type: str
requirements:
- "python >= 3.6"
- "openstacksdk"
extends_documentation_fragment:
- openstack.cloud.openstack
'''

View File

@ -25,10 +25,6 @@ options:
- A dictionary of meta data to use for further filtering. Elements of
this dictionary may be additional dictionaries.
type: dict
requirements:
- "python >= 3.6"
- "openstacksdk"
extends_documentation_fragment:
- openstack.cloud.openstack
'''

View File

@ -102,10 +102,6 @@ options:
- ID of a volume to create an image from.
- The volume must be in AVAILABLE state.
type: str
requirements:
- "python >= 3.6"
- "openstacksdk"
extends_documentation_fragment:
- openstack.cloud.openstack
'''

View File

@ -24,10 +24,6 @@ options:
type: dict
required: false
aliases: ['properties']
requirements:
- "python >= 3.6"
- "openstacksdk"
extends_documentation_fragment:
- openstack.cloud.openstack
'''

View File

@ -36,10 +36,6 @@ options:
choices: [present, absent, replace]
default: present
type: str
requirements:
- "python >= 3.6"
- "openstacksdk"
extends_documentation_fragment:
- openstack.cloud.openstack
'''

View File

@ -28,10 +28,6 @@ options:
description:
- The last-seen item.
type: str
requirements:
- "python >= 3.6"
- "openstacksdk"
extends_documentation_fragment:
- openstack.cloud.openstack
'''

View File

@ -35,8 +35,7 @@ options:
type: str
aliases: ['mapping_name']
requirements:
- "python >= 3.6"
- "openstacksdk >= 0.44"
- "openstacksdk >= 0.44, < 0.99.0"
extends_documentation_fragment:
- openstack.cloud.openstack
'''

View File

@ -22,8 +22,7 @@ options:
required: true
type: str
requirements:
- "python >= 3.6"
- "openstacksdk >= 0.44"
- "openstacksdk >= 0.44, < 0.99.0"
extends_documentation_fragment:
- openstack.cloud.openstack
'''

View File

@ -78,7 +78,6 @@ options:
description:
- The HTTP URL path of the request sent by the monitor to test the health of a backend member.
Must be a string that begins with a forward slash (/). The default URL path is /.
requirements: ["openstacksdk"]
extends_documentation_fragment:
- openstack.cloud.openstack
'''

View File

@ -59,10 +59,6 @@ options:
into ACTIVE state.
default: 180
type: int
requirements:
- "python >= 3.6"
- "openstacksdk"
extends_documentation_fragment:
- openstack.cloud.openstack
'''

View File

@ -59,10 +59,6 @@ options:
description:
- Port used to monitor this member
type: int
requirements:
- "python >= 3.6"
- "openstacksdk"
extends_documentation_fragment:
- openstack.cloud.openstack
'''

View File

@ -55,10 +55,6 @@ options:
into ACTIVE state.
default: 180
type: int
requirements:
- "python >= 3.6"
- "openstacksdk"
extends_documentation_fragment:
- openstack.cloud.openstack
'''

View File

@ -135,10 +135,6 @@ options:
- The amount of time the module should wait.
default: 180
type: int
requirements:
- "python >= 3.6"
- "openstacksdk"
extends_documentation_fragment:
- openstack.cloud.openstack
'''

View File

@ -76,10 +76,6 @@ options:
Network will use Openstack defaults if this option is
not provided.
type: str
requirements:
- "python >= 3.6"
- "openstacksdk"
extends_documentation_fragment:
- openstack.cloud.openstack
'''

View File

@ -24,10 +24,6 @@ options:
this dictionary may be additional dictionaries.
required: false
type: dict
requirements:
- "python >= 3.6"
- "openstacksdk"
extends_documentation_fragment:
- openstack.cloud.openstack
'''

View File

@ -61,7 +61,6 @@ options:
- Logically AND'ed with other filters
choices: ['access_as_shared', 'access_as_external']
type: str
extends_documentation_fragment:
- openstack.cloud.openstack
'''

View File

@ -58,7 +58,6 @@ options:
choices: ['present', 'absent']
default: present
type: str
extends_documentation_fragment:
- openstack.cloud.openstack
'''

View File

@ -41,10 +41,6 @@ options:
choices: [present, absent]
default: present
type: str
requirements:
- "python >= 3.6"
- "openstacksdk"
extends_documentation_fragment:
- openstack.cloud.openstack
'''

View File

@ -43,10 +43,6 @@ options:
default: 'present'
choices: ['present', 'absent']
type: str
requirements:
- "python >= 3.6"
- "openstacksdk"
extends_documentation_fragment:
- openstack.cloud.openstack
'''

View File

@ -131,10 +131,6 @@ options:
description:
- The dns domain of the port ( only with dns-integration enabled )
type: str
requirements:
- "python >= 3.6"
- "openstacksdk"
extends_documentation_fragment:
- openstack.cloud.openstack
'''

View File

@ -23,10 +23,6 @@ options:
dictionaries. Matching is currently limited to strings within
the port dictionary, or strings within nested dictionaries.
type: dict
requirements:
- "python >= 3.6"
- "openstacksdk"
extends_documentation_fragment:
- openstack.cloud.openstack
'''

View File

@ -45,10 +45,6 @@ options:
choices: [present, absent]
default: present
type: str
requirements:
- "python >= 3.6"
- "openstacksdk"
extends_documentation_fragment:
- openstack.cloud.openstack
'''

View File

@ -44,11 +44,6 @@ options:
- The resource name (eg. tiny).
required: true
type: str
requirements:
- "python >= 3.6"
- "openstacksdk"
extends_documentation_fragment:
- openstack.cloud.openstack
'''

View File

@ -25,10 +25,6 @@ options:
- A dictionary of meta data to use for further filtering. Elements of
this dictionary may be additional dictionaries.
type: dict
requirements:
- "python >= 3.6"
- "openstacksdk"
extends_documentation_fragment:
- openstack.cloud.openstack
'''

View File

@ -133,12 +133,8 @@ options:
project:
description: Unused, kept for compatability
type: int
requirements:
- "python >= 3.6"
- "openstacksdk >= 0.13.0"
- "keystoneauth1 >= 3.4.0"
extends_documentation_fragment:
- openstack.cloud.openstack
'''

View File

@ -48,10 +48,6 @@ options:
- Name or ID of the zone which manages the recordset
required: true
type: str
requirements:
- "python >= 3.6"
- "openstacksdk"
extends_documentation_fragment:
- openstack.cloud.openstack
'''

View File

@ -43,10 +43,6 @@ options:
choices: [present, absent]
default: present
type: str
requirements:
- "python >= 3.6"
- "openstacksdk"
extends_documentation_fragment:
- openstack.cloud.openstack
'''

View File

@ -72,10 +72,6 @@ options:
been already used.
type: list
elements: raw
requirements:
- "python >= 3.6"
- "openstacksdk"
extends_documentation_fragment:
- openstack.cloud.openstack
'''

View File

@ -50,9 +50,6 @@ options:
- A list of tags to filter the list result by. Resources that match all tags in this list will be returned.
type: list
elements: str
requirements:
- "python >= 3.6"
- "openstacksdk"
extends_documentation_fragment:
- openstack.cloud.openstack
'''

View File

@ -33,10 +33,6 @@ options:
- Unique name or ID of the project.
required: false
type: str
requirements:
- "python >= 3.6"
- "openstacksdk"
extends_documentation_fragment:
- openstack.cloud.openstack
'''

View File

@ -54,8 +54,6 @@ options:
- Resources that match any tag in this list will be excluded.
type: list
elements: str
requirements: ["openstacksdk"]
'''
RETURN = '''

View File

@ -68,10 +68,6 @@ options:
description:
- Description of the rule.
type: str
requirements:
- "python >= 3.6"
- "openstacksdk"
extends_documentation_fragment:
- openstack.cloud.openstack
'''

View File

@ -68,11 +68,6 @@ options:
description:
- Name or ID of the security group
type: str
requirements:
- "python >= 3.6"
- "openstacksdk"
extends_documentation_fragment:
- openstack.cloud.openstack
'''

View File

@ -193,10 +193,6 @@ options:
description:
- Description of the server.
type: str
requirements:
- "python >= 3.6"
- "openstacksdk"
extends_documentation_fragment:
- openstack.cloud.openstack
'''

View File

@ -52,11 +52,6 @@ options:
auth scoped project.
type: bool
default: 'no'
requirements:
- "python >= 3.6"
- "openstacksdk"
extends_documentation_fragment:
- openstack.cloud.openstack
'''

View File

@ -33,10 +33,6 @@ options:
required: false
type: list
elements: str
requirements:
- "python >= 3.6"
- "openstacksdk"
extends_documentation_fragment:
- openstack.cloud.openstack
'''

View File

@ -37,10 +37,6 @@ options:
scoped project.
type: bool
default: 'no'
requirements:
- "python >= 3.6"
- "openstacksdk"
extends_documentation_fragment:
- openstack.cloud.openstack
'''

View File

@ -36,10 +36,6 @@ options:
- Availability zone in which to create the snapshot.
required: false
type: str
requirements:
- "python >= 3.6"
- "openstacksdk"
extends_documentation_fragment:
- openstack.cloud.openstack
'''

View File

@ -33,10 +33,6 @@ options:
description:
- Device you want to attach. Defaults to auto finding a device name.
type: str
requirements:
- "python >= 3.6"
- "openstacksdk"
extends_documentation_fragment:
- openstack.cloud.openstack
'''

View File

@ -51,10 +51,6 @@ options:
- Maximum number of seconds to wait for the stack creation
default: 3600
type: int
requirements:
- "python >= 3.6"
- "openstacksdk"
extends_documentation_fragment:
- openstack.cloud.openstack
'''

View File

@ -32,11 +32,6 @@ options:
- Owner (parent) of the stack to be used as a filter
type: str
required: false
requirements:
- "python >= 3.6"
- "openstacksdk"
extends_documentation_fragment:
- openstack.cloud.openstack
'''

View File

@ -110,10 +110,6 @@ options:
required: false
default: {}
type: dict
requirements:
- "python >= 3.6"
- "openstacksdk"
extends_documentation_fragment:
- openstack.cloud.openstack
'''

View File

@ -79,10 +79,6 @@ options:
required: false
default: {}
type: dict
requirements:
- "python >= 3.6"
- "openstacksdk"
extends_documentation_fragment:
- openstack.cloud.openstack
'''

View File

@ -26,10 +26,6 @@ options:
this dictionary may be additional dictionaries.
required: false
type: dict
requirements:
- "python >= 3.6"
- "openstacksdk"
extends_documentation_fragment:
- openstack.cloud.openstack
'''

View File

@ -62,10 +62,6 @@ options:
description:
- Metadata for the volume
type: dict
requirements:
- "python >= 3.6"
- "openstacksdk"
extends_documentation_fragment:
- openstack.cloud.openstack
'''

View File

@ -52,7 +52,6 @@ options:
description: The backup mode
type: bool
default: False
requirements: ["openstacksdk"]
'''
RETURN = '''

View File

@ -21,7 +21,6 @@ options:
description:
- Name of the volume.
type: str
requirements: ["openstacksdk"]
extends_documentation_fragment:
- openstack.cloud.openstack
'''

View File

@ -30,11 +30,6 @@ options:
- Value of the status of the volume so that you can filter on "available" for example
type: str
required: false
requirements:
- "python >= 3.6"
- "openstacksdk"
extends_documentation_fragment:
- openstack.cloud.openstack
'''

View File

@ -40,10 +40,6 @@ options:
choices: [present, absent]
default: present
type: str
requirements:
- "python >= 3.6"
- "openstacksdk"
extends_documentation_fragment:
- openstack.cloud.openstack
'''

View File

@ -31,7 +31,6 @@ options:
choices: [creating, available, error, deleting,
error_deleting, rollbacking, backing-up]
type: str
requirements: ["openstacksdk"]
extends_documentation_fragment:
- openstack.cloud.openstack
'''