mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-24 19:31:26 -07:00
97 lines
3.3 KiB
Python
97 lines
3.3 KiB
Python
# 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 to operate against. Provides default values for I(auth) and I(auth_plugin)
|
|
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.
|
|
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
|
|
default: password
|
|
region_name:
|
|
description:
|
|
- Name of the region.
|
|
required: false
|
|
availability_zone:
|
|
description:
|
|
- Name of the availability zone.
|
|
required: false
|
|
wait:
|
|
description:
|
|
- Should ansible wait until the requested resource is complete.
|
|
required: false
|
|
default: "yes"
|
|
choices: ["yes", "no"]
|
|
timeout:
|
|
description:
|
|
- How long should ansible wait for the requested resource.
|
|
required: false
|
|
default: 180
|
|
verify:
|
|
description:
|
|
- Whether or not SSL API requests should be verified.
|
|
required: false
|
|
default: True
|
|
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
|
|
endpoint_type:
|
|
description:
|
|
- Endpoint URL type to fetch from the service catalog.
|
|
choices: [public, internal, admin]
|
|
required: false
|
|
default: public
|
|
requirements:
|
|
- shade
|
|
notes:
|
|
- The standard OpenStack environment variables, such as C(OS_USERNAME)
|
|
may be user instead of providing explicit values.
|
|
- Auth information is driven by os-client-config, 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.
|
|
'''
|