mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-10-10 18:34:03 -07:00
Doc fragments to plugins (#50172)
* promote doc_fragments into actual plugins change tests hardcoded path to doc fragments avoid sanity in fragments avoid improper testing of doc_fragments also change runner paths fix botmeta updated comment for fragments updated docs
This commit is contained in:
parent
4041f02389
commit
96b3ef5553
106 changed files with 51 additions and 31 deletions
109
lib/ansible/plugins/doc_fragments/openstack.py
Normal file
109
lib/ansible/plugins/doc_fragments/openstack.py
Normal file
|
@ -0,0 +1,109 @@
|
|||
# Copyright (c) 2014 Hewlett-Packard Development Company, L.P.
|
||||
#
|
||||
# This file is part of Ansible
|
||||
#
|
||||
# Ansible is free software: you can redistribute it and/or modify
|
||||
# it under the terms of the GNU General Public License as published by
|
||||
# the Free Software Foundation, either version 3 of the License, or
|
||||
# (at your option) any later version.
|
||||
#
|
||||
# Ansible is distributed in the hope that it will be useful,
|
||||
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
# GNU General Public License for more details.
|
||||
#
|
||||
# You should have received a copy of the GNU General Public License
|
||||
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
|
||||
class ModuleDocFragment(object):
|
||||
|
||||
# Standard openstack documentation fragment
|
||||
DOCUMENTATION = '''
|
||||
options:
|
||||
cloud:
|
||||
description:
|
||||
- Named cloud or cloud config to operate against.
|
||||
If I(cloud) is a string, it references a named cloud config as defined
|
||||
in an OpenStack clouds.yaml file. Provides default values for I(auth)
|
||||
and I(auth_type). This parameter is not needed if I(auth) is provided
|
||||
or if OpenStack OS_* environment variables are present.
|
||||
If I(cloud) is a dict, it contains a complete cloud configuration like
|
||||
would be in a section of clouds.yaml.
|
||||
required: false
|
||||
auth:
|
||||
description:
|
||||
- Dictionary containing auth information as needed by the cloud's auth
|
||||
plugin strategy. For the default I(password) plugin, this would contain
|
||||
I(auth_url), I(username), I(password), I(project_name) and any
|
||||
information about domains if the cloud supports them. For other plugins,
|
||||
this param will need to contain whatever parameters that auth plugin
|
||||
requires. This parameter is not needed if a named cloud is provided or
|
||||
OpenStack OS_* environment variables are present.
|
||||
required: false
|
||||
auth_type:
|
||||
description:
|
||||
- Name of the auth plugin to use. If the cloud uses something other than
|
||||
password authentication, the name of the plugin should be indicated here
|
||||
and the contents of the I(auth) parameter should be updated accordingly.
|
||||
required: false
|
||||
region_name:
|
||||
description:
|
||||
- Name of the region.
|
||||
required: false
|
||||
wait:
|
||||
description:
|
||||
- Should ansible wait until the requested resource is complete.
|
||||
type: bool
|
||||
required: false
|
||||
default: true
|
||||
timeout:
|
||||
description:
|
||||
- How long should ansible wait for the requested resource.
|
||||
required: false
|
||||
default: 180
|
||||
api_timeout:
|
||||
description:
|
||||
- How long should the socket layer wait before timing out for API calls.
|
||||
If this is omitted, nothing will be passed to the requests library.
|
||||
required: false
|
||||
verify:
|
||||
description:
|
||||
- Whether or not SSL API requests should be verified. Before 2.3 this defaulted to True.
|
||||
type: bool
|
||||
required: false
|
||||
aliases: ['validate_certs']
|
||||
cacert:
|
||||
description:
|
||||
- A path to a CA Cert bundle that can be used as part of verifying
|
||||
SSL API requests.
|
||||
required: false
|
||||
cert:
|
||||
description:
|
||||
- A path to a client certificate to use as part of the SSL transaction.
|
||||
required: false
|
||||
key:
|
||||
description:
|
||||
- A path to a client key to use as part of the SSL transaction.
|
||||
required: false
|
||||
interface:
|
||||
description:
|
||||
- Endpoint URL type to fetch from the service catalog.
|
||||
choices: [public, internal, admin]
|
||||
required: false
|
||||
default: public
|
||||
aliases: ['endpoint_type']
|
||||
version_added: "2.3"
|
||||
requirements:
|
||||
- python >= 2.7
|
||||
- openstacksdk
|
||||
notes:
|
||||
- The standard OpenStack environment variables, such as C(OS_USERNAME)
|
||||
may be used instead of providing explicit values.
|
||||
- Auth information is driven by openstacksdk, which means that values
|
||||
can come from a yaml config file in /etc/ansible/openstack.yaml,
|
||||
/etc/openstack/clouds.yaml or ~/.config/openstack/clouds.yaml, then from
|
||||
standard environment variables, then finally by explicit parameters in
|
||||
plays. More information can be found at
|
||||
U(https://docs.openstack.org/openstacksdk/)
|
||||
'''
|
Loading…
Add table
Add a link
Reference in a new issue