doc_fragments: Clean up parameter types (cloud) (#52177)

* module_utils: Clean up parameter types (cloud)

This PR includes:

- Parameter types added
- Copyright format fixes
- Short license statement
- Description fixes (only for a few files, then I stopped :-))

* More cloud stuff

* Fix reported issue

* Fix quotes

* Use correct type

* Fix quotes

* Fix quotes

* Fix quotes

* Fix typo

* Fix boolean
This commit is contained in:
Dag Wieers 2019-02-15 13:21:20 +01:00 committed by John R Barker
parent 203caf2570
commit 25323155d2
28 changed files with 337 additions and 412 deletions

View file

@ -1,55 +1,47 @@
# (c) 2014, Matt Martz <matt@sivel.net>
#
# 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/>.
# -*- coding: utf-8 -*-
# Copyright: (c) 2014, Matt Martz <matt@sivel.net>
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
class ModuleDocFragment(object):
# Standard Rackspace only documentation fragment
DOCUMENTATION = """
DOCUMENTATION = r'''
options:
api_key:
description:
- Rackspace API key, overrides I(credentials).
aliases:
- password
type: str
aliases: [ password ]
credentials:
description:
- File to find the Rackspace credentials in. Ignored if I(api_key) and
I(username) are provided.
aliases:
- creds_file
type: path
aliases: [ creds_file ]
env:
description:
- Environment as configured in I(~/.pyrax.cfg),
see U(https://github.com/rackspace/pyrax/blob/master/docs/getting_started.md#pyrax-configuration).
version_added: 1.5
type: str
version_added: '1.5'
region:
description:
- Region to create an instance in.
type: str
default: DFW
username:
description:
- Rackspace username, overrides I(credentials).
type: str
verify_ssl:
description:
- Whether or not to require SSL validation of API endpoints.
version_added: 1.5
type: bool
version_added: '1.5'
requirements:
- "python >= 2.6"
- python >= 2.6
- pyrax
notes:
- The following environment variables can be used, C(RAX_USERNAME),
@ -58,38 +50,36 @@ notes:
appropriate for pyrax. See U(https://github.com/rackspace/pyrax/blob/master/docs/getting_started.md#authenticating)
- C(RAX_USERNAME) and C(RAX_API_KEY) obviate the use of a credentials file
- C(RAX_REGION) defines a Rackspace Public Cloud region (DFW, ORD, LON, ...)
"""
'''
# Documentation fragment including attributes to enable communication
# of other OpenStack clouds. Not all rax modules support this.
OPENSTACK = """
OPENSTACK = r'''
options:
api_key:
description:
- Rackspace API key, overrides I(credentials).
aliases:
- password
aliases: [ password ]
auth_endpoint:
description:
- The URI of the authentication service.
default: https://identity.api.rackspacecloud.com/v2.0/
version_added: 1.5
version_added: '1.5'
credentials:
description:
- File to find the Rackspace credentials in. Ignored if I(api_key) and
I(username) are provided.
aliases:
- creds_file
aliases: [ creds_file ]
env:
description:
- Environment as configured in I(~/.pyrax.cfg),
see U(https://github.com/rackspace/pyrax/blob/master/docs/getting_started.md#pyrax-configuration).
version_added: 1.5
version_added: '1.5'
identity_type:
description:
- Authentication mechanism to use, such as rackspace or keystone.
default: rackspace
version_added: 1.5
version_added: '1.5'
region:
description:
- Region to create an instance in.
@ -97,21 +87,21 @@ options:
tenant_id:
description:
- The tenant ID used for authentication.
version_added: 1.5
version_added: '1.5'
tenant_name:
description:
- The tenant name used for authentication.
version_added: 1.5
version_added: '1.5'
username:
description:
- Rackspace username, overrides I(credentials).
verify_ssl:
description:
- Whether or not to require SSL validation of API endpoints.
version_added: 1.5
version_added: '1.5'
type: bool
requirements:
- "python >= 2.6"
- python >= 2.6
- pyrax
notes:
- The following environment variables can be used, C(RAX_USERNAME),
@ -120,4 +110,4 @@ notes:
appropriate for pyrax. See U(https://github.com/rackspace/pyrax/blob/master/docs/getting_started.md#authenticating)
- C(RAX_USERNAME) and C(RAX_API_KEY) obviate the use of a credentials file
- C(RAX_REGION) defines a Rackspace Public Cloud region (DFW, ORD, LON, ...)
"""
'''