Merge pull request #6864 from sivel/rax-add-shared-mod-docs
Shared module docs for remaining rax modules
This commit is contained in:
commit
4d2b7d6341
3 changed files with 9 additions and 122 deletions
|
@ -14,6 +14,8 @@
|
||||||
# You should have received a copy of the GNU General Public License
|
# You should have received a copy of the GNU General Public License
|
||||||
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
|
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
# This is a DOCUMENTATION stub specific to this module, it extends
|
||||||
|
# a documentation fragment located in ansible.utils.module_docs_fragments
|
||||||
DOCUMENTATION = '''
|
DOCUMENTATION = '''
|
||||||
---
|
---
|
||||||
module: rax_cbs
|
module: rax_cbs
|
||||||
|
@ -22,46 +24,6 @@ description:
|
||||||
- Manipulate Rackspace Cloud Block Storage Volumes
|
- Manipulate Rackspace Cloud Block Storage Volumes
|
||||||
version_added: 1.6
|
version_added: 1.6
|
||||||
options:
|
options:
|
||||||
api_key:
|
|
||||||
description:
|
|
||||||
- Rackspace API key (overrides I(credentials))
|
|
||||||
aliases:
|
|
||||||
- password
|
|
||||||
auth_endpoint:
|
|
||||||
description:
|
|
||||||
- The URI of the authentication service
|
|
||||||
default: https://identity.api.rackspacecloud.com/v2.0/
|
|
||||||
credentials:
|
|
||||||
description:
|
|
||||||
- File to find the Rackspace credentials in (ignored if I(api_key) and
|
|
||||||
I(username) are provided)
|
|
||||||
default: null
|
|
||||||
aliases:
|
|
||||||
- creds_file
|
|
||||||
env:
|
|
||||||
description:
|
|
||||||
- Environment as configured in ~/.pyrax.cfg,
|
|
||||||
see U(https://github.com/rackspace/pyrax/blob/master/docs/getting_started.md#pyrax-configuration)
|
|
||||||
identity_type:
|
|
||||||
description:
|
|
||||||
- Authentication machanism to use, such as rackspace or keystone
|
|
||||||
default: rackspace
|
|
||||||
region:
|
|
||||||
description:
|
|
||||||
- Region to create an instance in
|
|
||||||
default: DFW
|
|
||||||
tenant_id:
|
|
||||||
description:
|
|
||||||
- The tenant ID used for authentication
|
|
||||||
tenant_name:
|
|
||||||
description:
|
|
||||||
- The tenant name used for authentication
|
|
||||||
username:
|
|
||||||
description:
|
|
||||||
- Rackspace username (overrides I(credentials))
|
|
||||||
verify_ssl:
|
|
||||||
description:
|
|
||||||
- Whether or not to require SSL validation of API endpoints
|
|
||||||
description:
|
description:
|
||||||
description:
|
description:
|
||||||
- Description to give the volume being created
|
- Description to give the volume being created
|
||||||
|
@ -111,16 +73,8 @@ options:
|
||||||
description:
|
description:
|
||||||
- how long before wait gives up, in seconds
|
- how long before wait gives up, in seconds
|
||||||
default: 300
|
default: 300
|
||||||
requirements:
|
|
||||||
- pyrax
|
|
||||||
author: Christopher H. Laco, Matt Martz
|
author: Christopher H. Laco, Matt Martz
|
||||||
notes:
|
extends_documentation_fragment: rackspace.openstack
|
||||||
- The following environment variables can be used, C(RAX_USERNAME),
|
|
||||||
C(RAX_API_KEY), C(RAX_CREDS_FILE), C(RAX_CREDENTIALS), C(RAX_REGION).
|
|
||||||
- C(RAX_CREDENTIALS) and C(RAX_CREDS_FILE) points to a credentials file
|
|
||||||
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, ...)
|
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
|
|
|
@ -14,6 +14,8 @@
|
||||||
# You should have received a copy of the GNU General Public License
|
# You should have received a copy of the GNU General Public License
|
||||||
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
|
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
# This is a DOCUMENTATION stub specific to this module, it extends
|
||||||
|
# a documentation fragment located in ansible.utils.module_docs_fragments
|
||||||
DOCUMENTATION = '''
|
DOCUMENTATION = '''
|
||||||
---
|
---
|
||||||
module: rax_cbs_attachments
|
module: rax_cbs_attachments
|
||||||
|
@ -22,46 +24,6 @@ description:
|
||||||
- Manipulate Rackspace Cloud Block Storage Volume Attachments
|
- Manipulate Rackspace Cloud Block Storage Volume Attachments
|
||||||
version_added: 1.6
|
version_added: 1.6
|
||||||
options:
|
options:
|
||||||
api_key:
|
|
||||||
description:
|
|
||||||
- Rackspace API key (overrides I(credentials))
|
|
||||||
aliases:
|
|
||||||
- password
|
|
||||||
auth_endpoint:
|
|
||||||
description:
|
|
||||||
- The URI of the authentication service
|
|
||||||
default: https://identity.api.rackspacecloud.com/v2.0/
|
|
||||||
credentials:
|
|
||||||
description:
|
|
||||||
- File to find the Rackspace credentials in (ignored if I(api_key) and
|
|
||||||
I(username) are provided)
|
|
||||||
default: null
|
|
||||||
aliases:
|
|
||||||
- creds_file
|
|
||||||
env:
|
|
||||||
description:
|
|
||||||
- Environment as configured in ~/.pyrax.cfg,
|
|
||||||
see U(https://github.com/rackspace/pyrax/blob/master/docs/getting_started.md#pyrax-configuration)
|
|
||||||
identity_type:
|
|
||||||
description:
|
|
||||||
- Authentication machanism to use, such as rackspace or keystone
|
|
||||||
default: rackspace
|
|
||||||
region:
|
|
||||||
description:
|
|
||||||
- Region to create an instance in
|
|
||||||
default: DFW
|
|
||||||
tenant_id:
|
|
||||||
description:
|
|
||||||
- The tenant ID used for authentication
|
|
||||||
tenant_name:
|
|
||||||
description:
|
|
||||||
- The tenant name used for authentication
|
|
||||||
username:
|
|
||||||
description:
|
|
||||||
- Rackspace username (overrides I(credentials))
|
|
||||||
verify_ssl:
|
|
||||||
description:
|
|
||||||
- Whether or not to require SSL validation of API endpoints
|
|
||||||
device:
|
device:
|
||||||
description:
|
description:
|
||||||
- The device path to attach the volume to, e.g. /dev/xvde
|
- The device path to attach the volume to, e.g. /dev/xvde
|
||||||
|
@ -96,16 +58,8 @@ options:
|
||||||
description:
|
description:
|
||||||
- how long before wait gives up, in seconds
|
- how long before wait gives up, in seconds
|
||||||
default: 300
|
default: 300
|
||||||
requirements:
|
|
||||||
- pyrax
|
|
||||||
author: Christopher H. Laco, Matt Martz
|
author: Christopher H. Laco, Matt Martz
|
||||||
notes:
|
extends_documentation_fragment: rackspace.openstack
|
||||||
- The following environment variables can be used, C(RAX_USERNAME),
|
|
||||||
C(RAX_API_KEY), C(RAX_CREDS_FILE), C(RAX_CREDENTIALS), C(RAX_REGION).
|
|
||||||
- C(RAX_CREDENTIALS) and C(RAX_CREDS_FILE) points to a credentials file
|
|
||||||
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, ...)
|
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
|
|
|
@ -14,6 +14,8 @@
|
||||||
# You should have received a copy of the GNU General Public License
|
# You should have received a copy of the GNU General Public License
|
||||||
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
|
# along with Ansible. If not, see <http://www.gnu.org/licenses/>.
|
||||||
|
|
||||||
|
# This is a DOCUMENTATION stub specific to this module, it extends
|
||||||
|
# a documentation fragment located in ansible.utils.module_docs_fragments
|
||||||
DOCUMENTATION = '''
|
DOCUMENTATION = '''
|
||||||
---
|
---
|
||||||
module: rax_identity
|
module: rax_identity
|
||||||
|
@ -22,36 +24,13 @@ description:
|
||||||
- Verifies Rackspace Cloud credentials and returns identity information
|
- Verifies Rackspace Cloud credentials and returns identity information
|
||||||
version_added: "1.5"
|
version_added: "1.5"
|
||||||
options:
|
options:
|
||||||
api_key:
|
|
||||||
description:
|
|
||||||
- Rackspace API key (overrides C(credentials))
|
|
||||||
credentials:
|
|
||||||
description:
|
|
||||||
- File to find the Rackspace credentials in (ignored if C(api_key) and
|
|
||||||
C(username) are provided)
|
|
||||||
default: null
|
|
||||||
aliases: ['creds_file']
|
|
||||||
region:
|
|
||||||
description:
|
|
||||||
- Region to authenticate against
|
|
||||||
default: DFW
|
|
||||||
state:
|
state:
|
||||||
description:
|
description:
|
||||||
- Indicate desired state of the resource
|
- Indicate desired state of the resource
|
||||||
choices: ['present', 'absent']
|
choices: ['present', 'absent']
|
||||||
default: present
|
default: present
|
||||||
username:
|
|
||||||
description:
|
|
||||||
- Rackspace username (overrides C(credentials))
|
|
||||||
requirements: [ "pyrax" ]
|
|
||||||
author: Christopher H. Laco, Matt Martz
|
author: Christopher H. Laco, Matt Martz
|
||||||
notes:
|
extends_documentation_fragment: rackspace.openstack
|
||||||
- The following environment variables can be used, C(RAX_USERNAME),
|
|
||||||
C(RAX_API_KEY), C(RAX_CREDS_FILE), C(RAX_CREDENTIALS), C(RAX_REGION).
|
|
||||||
- C(RAX_CREDENTIALS) and C(RAX_CREDS_FILE) points to a credentials file
|
|
||||||
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, ...)
|
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
|
|
Loading…
Reference in a new issue