Skip to content
Projects
Groups
Snippets
Help
This project
Loading...
Sign in / Register
Toggle navigation
A
ansible
Overview
Overview
Details
Activity
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Board
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
OpenEdx
ansible
Commits
bb6f7a26
Commit
bb6f7a26
authored
Feb 24, 2014
by
Matt Martz
Committed by
Michael DeHaan
Apr 03, 2014
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Add support for shared module documentation fragments
parent
ee0a0b49
Hide whitespace changes
Inline
Side-by-side
Showing
13 changed files
with
253 additions
and
375 deletions
+253
-375
lib/ansible/utils/module_docs.py
+20
-0
lib/ansible/utils/module_docs_fragments.py
+116
-0
library/cloud/rax
+15
-59
library/cloud/rax_clb
+35
-29
library/cloud/rax_clb_nodes
+14
-31
library/cloud/rax_dns
+4
-21
library/cloud/rax_dns_record
+12
-22
library/cloud/rax_facts
+1
-54
library/cloud/rax_files
+8
-23
library/cloud/rax_files_objects
+16
-31
library/cloud/rax_keypair
+4
-54
library/cloud/rax_network
+4
-25
library/cloud/rax_queue
+4
-26
No files found.
lib/ansible/utils/module_docs.py
View file @
bb6f7a26
...
@@ -23,6 +23,9 @@ import ast
...
@@ -23,6 +23,9 @@ import ast
import
yaml
import
yaml
import
traceback
import
traceback
from
ansible.utils
import
module_docs_fragments
as
fragments
# modules that are ok that they do not have documentation strings
# modules that are ok that they do not have documentation strings
BLACKLIST_MODULES
=
[
BLACKLIST_MODULES
=
[
'async_wrapper'
,
'accelerate'
,
'async_status'
'async_wrapper'
,
'accelerate'
,
'async_status'
...
@@ -46,6 +49,23 @@ def get_docstring(filename, verbose=False):
...
@@ -46,6 +49,23 @@ def get_docstring(filename, verbose=False):
if
isinstance
(
child
,
ast
.
Assign
):
if
isinstance
(
child
,
ast
.
Assign
):
if
'DOCUMENTATION'
in
(
t
.
id
for
t
in
child
.
targets
):
if
'DOCUMENTATION'
in
(
t
.
id
for
t
in
child
.
targets
):
doc
=
yaml
.
safe_load
(
child
.
value
.
s
)
doc
=
yaml
.
safe_load
(
child
.
value
.
s
)
fragment_name
=
doc
.
get
(
'extends_documentation_fragment'
,
'DOESNOTEXIST'
)
.
upper
()
fragment_yaml
=
getattr
(
fragments
,
fragment_name
,
None
)
if
fragment_yaml
:
fragment
=
yaml
.
safe_load
(
fragment_yaml
)
if
fragment
.
has_key
(
'notes'
):
notes
=
fragment
.
pop
(
'notes'
)
if
notes
:
if
not
doc
.
has_key
(
'notes'
):
doc
[
'notes'
]
=
[]
doc
[
'notes'
]
.
extend
(
notes
)
for
key
,
value
in
fragment
.
items
():
if
not
doc
.
has_key
(
key
):
doc
[
key
]
=
value
else
:
doc
[
key
]
.
update
(
value
)
if
'EXAMPLES'
in
(
t
.
id
for
t
in
child
.
targets
):
if
'EXAMPLES'
in
(
t
.
id
for
t
in
child
.
targets
):
plainexamples
=
child
.
value
.
s
[
1
:]
# Skip first empty line
plainexamples
=
child
.
value
.
s
[
1
:]
# Skip first empty line
except
:
except
:
...
...
lib/ansible/utils/module_docs_fragments.py
0 → 100644
View file @
bb6f7a26
# (c) 2012, 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/>.
RACKSPACE_AND_OPENSTACK
=
"""
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/
version_added: 1.5
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)
version_added: 1.5
identity_type:
description:
- Authentication machanism to use, such as rackspace or keystone
default: rackspace
version_added: 1.5
region:
description:
- Region to create an instance in
default: DFW
tenant_id:
description:
- The tenant ID used for authentication
version_added: 1.5
tenant_name:
description:
- The tenant name used for authentication
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
requirements:
- pyrax
notes:
- 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, ...)
"""
RACKSPACE
=
"""
options:
api_key:
description:
- Rackspace API key (overrides I(credentials))
aliases:
- password
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)
version_added: 1.5
region:
description:
- Region to create an instance in
default: DFW
username:
description:
- Rackspace username (overrides I(credentials))
verify_ssl:
description:
- Whether or not to require SSL validation of API endpoints
version_added: 1.5
requirements:
- pyrax
notes:
- 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, ...)
"""
library/cloud/rax
View file @
bb6f7a26
...
@@ -23,52 +23,6 @@ description:
...
@@ -23,52 +23,6 @@ description:
waits for it to be 'running'.
waits for it to be 'running'.
version_added: "1.2"
version_added: "1.2"
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/
version_added: 1.5
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)
version_added: 1.5
identity_type:
description:
- Authentication machanism to use, such as rackspace or keystone
default: rackspace
version_added: 1.5
region:
description:
- Region to create an instance in
default: DFW
tenant_id:
description:
- The tenant ID used for authentication
version_added: 1.5
tenant_name:
description:
- The tenant name used for authentication
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
auto_increment:
auto_increment:
description:
description:
- Whether or not to increment a single number with the name of the
- Whether or not to increment a single number with the name of the
...
@@ -89,7 +43,9 @@ options:
...
@@ -89,7 +43,9 @@ options:
disk_config:
disk_config:
description:
description:
- Disk partitioning strategy
- Disk partitioning strategy
choices: ['auto', 'manual']
choices:
- auto
- manual
version_added: '1.4'
version_added: '1.4'
default: auto
default: auto
exact_count:
exact_count:
...
@@ -135,7 +91,8 @@ options:
...
@@ -135,7 +91,8 @@ options:
description:
description:
- key pair to use on the instance
- key pair to use on the instance
default: null
default: null
aliases: ['keypair']
aliases:
- keypair
meta:
meta:
description:
description:
- A hash of metadata to associate with the instance
- A hash of metadata to associate with the instance
...
@@ -149,31 +106,30 @@ options:
...
@@ -149,31 +106,30 @@ options:
- The network to attach to the instances. If specified, you must include
- The network to attach to the instances. If specified, you must include
ALL networks including the public and private interfaces. Can be C(id)
ALL networks including the public and private interfaces. Can be C(id)
or C(label).
or C(label).
default: ['public', 'private']
default:
- public
- private
version_added: 1.4
version_added: 1.4
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
wait:
wait:
description:
description:
- wait for the instance to be in state 'running' before returning
- wait for the instance to be in state 'running' before returning
default: "no"
default: "no"
choices: [ "yes", "no" ]
choices:
- "yes"
- "no"
wait_timeout:
wait_timeout:
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: Jesse Keating, Matt Martz
author: Jesse Keating, Matt Martz
notes:
extends_documentation_fragment: RACKSPACE_AND_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
=
'''
...
...
library/cloud/rax_clb
View file @
bb6f7a26
...
@@ -25,17 +25,13 @@ options:
...
@@ -25,17 +25,13 @@ options:
algorithm:
algorithm:
description:
description:
- algorithm for the balancer being created
- algorithm for the balancer being created
choices: ['RANDOM', 'LEAST_CONNECTIONS', 'ROUND_ROBIN', 'WEIGHTED_LEAST_CONNECTIONS', 'WEIGHTED_ROUND_ROBIN']
choices:
- RANDOM
- LEAST_CONNECTIONS
- ROUND_ROBIN
- WEIGHTED_LEAST_CONNECTIONS
- WEIGHTED_ROUND_ROBIN
default: LEAST_CONNECTIONS
default: LEAST_CONNECTIONS
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']
meta:
meta:
description:
description:
- A hash of metadata to associate with the instance
- A hash of metadata to associate with the instance
...
@@ -51,16 +47,32 @@ options:
...
@@ -51,16 +47,32 @@ options:
protocol:
protocol:
description:
description:
- Protocol for the balancer being created
- Protocol for the balancer being created
choices: ['DNS_TCP', 'DNS_UDP' ,'FTP', 'HTTP', 'HTTPS', 'IMAPS', 'IMAPv4', 'LDAP', 'LDAPS', 'MYSQL', 'POP3', 'POP3S', 'SMTP', 'TCP', 'TCP_CLIENT_FIRST', 'UDP', 'UDP_STREAM', 'SFTP']
choices:
- DNS_TCP
- DNS_UDP
- FTP
- HTTP
- HTTPS
- IMAPS
- IMAPv4
- LDAP
- LDAPS
- MYSQL
- POP3
- POP3S
- SMTP
- TCP
- TCP_CLIENT_FIRST
- UDP
- UDP_STREAM
- SFTP
default: HTTP
default: HTTP
region:
description:
- Region to create the load balancer in
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
timeout:
timeout:
description:
description:
...
@@ -69,11 +81,10 @@ options:
...
@@ -69,11 +81,10 @@ options:
type:
type:
description:
description:
- type of interface for the balancer being created
- type of interface for the balancer being created
choices: ['PUBLIC', 'SERVICENET']
choices:
- PUBLIC
- SERVICENET
default: PUBLIC
default: PUBLIC
username:
description:
- Rackspace username (overrides C(credentials))
vip_id:
vip_id:
description:
description:
- Virtual IP ID to use when creating the load balancer for purposes of
- Virtual IP ID to use when creating the load balancer for purposes of
...
@@ -83,20 +94,15 @@ options:
...
@@ -83,20 +94,15 @@ options:
description:
description:
- wait for the balancer to be in state 'running' before returning
- wait for the balancer to be in state 'running' before returning
default: "no"
default: "no"
choices: [ "yes", "no" ]
choices:
- "yes"
- "no"
wait_timeout:
wait_timeout:
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
- 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
=
'''
...
...
library/cloud/rax_clb_nodes
View file @
bb6f7a26
...
@@ -26,21 +26,15 @@ options:
...
@@ -26,21 +26,15 @@ options:
required: false
required: false
description:
description:
- IP address or domain name of the node
- IP address or domain name of the node
api_key:
required: false
description:
- Rackspace API key (overrides C(credentials))
condition:
condition:
required: false
required: false
choices: [ "enabled", "disabled", "draining" ]
choices:
- enabled
- disabled
- draining
description:
description:
- Condition for the node, which determines its role within the load
- Condition for the node, which determines its role within the load
balancer
balancer
credentials:
required: false
description:
- File to find the Rackspace credentials in (ignored if C(api_key) and
C(username) are provided)
load_balancer_id:
load_balancer_id:
required: true
required: true
type: integer
type: integer
...
@@ -56,35 +50,27 @@ options:
...
@@ -56,35 +50,27 @@ options:
type: integer
type: integer
description:
description:
- Port number of the load balanced service on the node
- Port number of the load balanced service on the node
region:
required: false
description:
- Region to authenticate in
state:
state:
required: false
required: false
default: "present"
default: "present"
choices: [ "present", "absent" ]
choices:
- present
- absent
description:
description:
- Indicate desired state of the node
- Indicate desired state of the node
type:
type:
required: false
required: false
choices: [ "primary", "secondary" ]
choices:
- primary
- secondary
description:
description:
- Type of node
- Type of node
username:
required: false
description:
- Rackspace username (overrides C(credentials))
virtualenv:
required: false
description:
- Path to a virtualenv that should be activated before doing anything.
The virtualenv has to already exist. Useful if installing pyrax
globally is not an option.
wait:
wait:
required: false
required: false
default: "no"
default: "no"
choices: [ "yes", "no" ]
choices:
- "yes"
- "no"
description:
description:
- Wait for the load balancer to become active before returning
- Wait for the load balancer to become active before returning
wait_timeout:
wait_timeout:
...
@@ -97,11 +83,8 @@ options:
...
@@ -97,11 +83,8 @@ options:
required: false
required: false
description:
description:
- Weight of node
- Weight of node
requirements: [ "pyrax" ]
author: Lukasz Kawczynski
author: Lukasz Kawczynski
notes:
extends_documentation_fragment: RACKSPACE
- "The following environment variables can be used: C(RAX_USERNAME),
C(RAX_API_KEY), C(RAX_CREDENTIALS) and C(RAX_REGION)."
'''
'''
EXAMPLES
=
'''
EXAMPLES
=
'''
...
...
library/cloud/rax_dns
View file @
bb6f7a26
...
@@ -22,18 +22,9 @@ description:
...
@@ -22,18 +22,9 @@ description:
- Manage domains on Rackspace Cloud DNS
- Manage domains on Rackspace Cloud DNS
version_added: 1.5
version_added: 1.5
options:
options:
api_key:
description:
- Rackspace API key (overrides C(credentials))
comment:
comment:
description:
description:
- Brief description of the domain. Maximum length of 160 characters
- Brief description of the domain. Maximum length of 160 characters
credentials:
description:
- File to find the Rackspace credentials in (ignored if C(api_key) and
C(username) are provided)
default: null
aliases: ['creds_file']
email:
email:
desctiption:
desctiption:
- Email address of the domain administrator
- Email address of the domain administrator
...
@@ -43,24 +34,16 @@ options:
...
@@ -43,24 +34,16 @@ options:
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
ttl:
ttl:
description:
description:
- Time to live of domain in seconds
- Time to live of domain in seconds
default: 3600
default: 3600
username:
description:
- Rackspace username (overrides C(credentials))
requirements: [ "pyrax" ]
author: Matt Martz
author: Matt Martz
notes:
extends_documentation_fragment: RACKSPACE
- 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
=
'''
...
...
library/cloud/rax_dns_record
View file @
bb6f7a26
...
@@ -22,18 +22,9 @@ description:
...
@@ -22,18 +22,9 @@ description:
- Manage DNS records on Rackspace Cloud DNS
- Manage DNS records on Rackspace Cloud DNS
version_added: 1.5
version_added: 1.5
options:
options:
api_key:
description:
- Rackspace API key (overrides C(credentials))
comment:
comment:
description:
description:
- Brief description of the domain. Maximum length of 160 characters
- Brief description of the domain. Maximum length of 160 characters
credentials:
description:
- File to find the Rackspace credentials in (ignored if C(api_key) and
C(username) are provided)
default: null
aliases: ['creds_file']
data:
data:
description:
description:
- IP address for A/AAAA record, FQDN for CNAME/MX/NS, or text data for
- IP address for A/AAAA record, FQDN for CNAME/MX/NS, or text data for
...
@@ -54,7 +45,9 @@ options:
...
@@ -54,7 +45,9 @@ options:
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
ttl:
ttl:
description:
description:
...
@@ -63,20 +56,17 @@ options:
...
@@ -63,20 +56,17 @@ options:
type:
type:
description:
description:
- DNS record type
- DNS record type
choices: ['A', 'AAAA', 'CNAME', 'MX', 'NS', 'SRV', 'TXT']
choices:
- A
- AAAA
- CNAME
- MX
- NS
- SRV
- TXT
default: A
default: A
username:
description:
- Rackspace username (overrides C(credentials))
requirements: [ "pyrax" ]
author: Matt Martz
author: Matt Martz
notes:
extends_documentation_fragment: RACKSPACE
- 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
=
'''
...
...
library/cloud/rax_facts
View file @
bb6f7a26
...
@@ -22,52 +22,6 @@ description:
...
@@ -22,52 +22,6 @@ description:
- Gather facts for Rackspace Cloud Servers.
- Gather facts for Rackspace Cloud Servers.
version_added: "1.4"
version_added: "1.4"
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/
version_added: 1.5
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 https://github.com/rackspace/pyrax/blob/master/docs/getting_started.md#pyrax-configuration
version_added: 1.5
identity_type:
description:
- Authentication machanism to use, such as rackspace or keystone
default: rackspace
version_added: 1.5
region:
description:
- Region to create an instance in
default: DFW
tenant_id:
description:
- The tenant ID used for authentication
version_added: 1.5
tenant_name:
description:
- The tenant name used for authentication
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
address:
address:
description:
description:
- Server IP address to retrieve facts for, will match any IP assigned to
- Server IP address to retrieve facts for, will match any IP assigned to
...
@@ -79,15 +33,8 @@ options:
...
@@ -79,15 +33,8 @@ options:
description:
description:
- Server name to retrieve facts for
- Server name to retrieve facts for
default: null
default: null
requirements: [ "pyrax" ]
author: Matt Martz
author: Matt Martz
notes:
extends_documentation_fragment: RACKSPACE_AND_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
=
'''
...
...
library/cloud/rax_files
View file @
bb6f7a26
...
@@ -25,25 +25,18 @@ description:
...
@@ -25,25 +25,18 @@ description:
- Manipulate Rackspace Cloud Files Containers
- Manipulate Rackspace Cloud Files Containers
version_added: "1.5"
version_added: "1.5"
options:
options:
api_key:
description:
- Rackspace API key (overrides I(credentials))
clear_meta:
clear_meta:
description:
description:
- Optionally clear existing metadata when applying metadata to existing containers.
- Optionally clear existing metadata when applying metadata to existing containers.
Selecting this option is only appropriate when setting type=meta
Selecting this option is only appropriate when setting type=meta
choices: ["yes", "no"]
choices:
- "yes"
- "no"
default: "no"
default: "no"
container:
container:
description:
description:
- The container to use for container or metadata operations.
- The container to use for container or metadata operations.
required: true
required: true
credentials:
description:
- File to find the Rackspace credentials in (ignored if I(api_key) and
I(username) are provided)
default: null
aliases: ['creds_file']
meta:
meta:
description:
description:
- A hash of items to set as metadata values on a container
- A hash of items to set as metadata values on a container
...
@@ -71,26 +64,18 @@ options:
...
@@ -71,26 +64,18 @@ options:
type:
type:
description:
description:
- Type of object to do work on, i.e. metadata object or a container object
- Type of object to do work on, i.e. metadata object or a container object
choices: ["file", "meta"]
choices:
default: "file"
- file
username:
- meta
description:
default: file
- Rackspace username (overrides I(credentials))
web_error:
web_error:
description:
description:
- Sets an object to be presented as the HTTP error page when accessed by the CDN URL
- Sets an object to be presented as the HTTP error page when accessed by the CDN URL
web_index:
web_index:
description:
description:
- Sets an object to be presented as the HTTP index page when accessed by the CDN URL
- Sets an object to be presented as the HTTP index page when accessed by the CDN URL
requirements: [ "pyrax" ]
author: Paul Durivage
author: Paul Durivage
notes:
extends_documentation_fragment: RACKSPACE
- 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
=
'''
...
...
library/cloud/rax_files_objects
View file @
bb6f7a26
...
@@ -25,26 +25,19 @@ description:
...
@@ -25,26 +25,19 @@ description:
- Upload, download, and delete objects in Rackspace Cloud Files
- Upload, download, and delete objects in Rackspace Cloud Files
version_added: "1.5"
version_added: "1.5"
options:
options:
api_key:
description:
- Rackspace API key (overrides I(credentials))
default: null
clear_meta:
clear_meta:
description:
description:
- Optionally clear existing metadata when applying metadata to existing objects.
- Optionally clear existing metadata when applying metadata to existing objects.
Selecting this option is only appropriate when setting type=meta
Selecting this option is only appropriate when setting type=meta
choices: ["yes", "no"]
choices:
- "yes"
- "no"
default: "no"
default: "no"
container:
container:
description:
description:
- The container to use for file object operations.
- The container to use for file object operations.
required: true
required: true
default: null
default: null
credentials:
description:
- File to find the Rackspace credentials in (ignored if I(api_key) and I(username) are provided)
default: null
aliases: ['creds_file']
dest:
dest:
description:
description:
- The destination of a "get" operation; i.e. a local directory, "/home/user/myfolder".
- The destination of a "get" operation; i.e. a local directory, "/home/user/myfolder".
...
@@ -64,12 +57,11 @@ options:
...
@@ -64,12 +57,11 @@ options:
- The method of operation to be performed. For example, put to upload files
- The method of operation to be performed. For example, put to upload files
to Cloud Files, get to download files from Cloud Files or delete to delete
to Cloud Files, get to download files from Cloud Files or delete to delete
remote objects in Cloud Files
remote objects in Cloud Files
choices: ["get", "put", "delete"]
choices:
default: "get"
- get
region:
- put
description:
- delete
- Region in which to work. Maps to a Rackspace Cloud region, i.e. DFW, ORD, IAD, SYD, LON
default: get
default: DFW
src:
src:
description:
description:
- Source from which to upload files. Used to specify a remote object as a source for
- Source from which to upload files. Used to specify a remote object as a source for
...
@@ -81,7 +73,9 @@ options:
...
@@ -81,7 +73,9 @@ options:
- Used to specify whether to maintain nested directory structure when downloading objects
- Used to specify whether to maintain nested directory structure when downloading objects
from Cloud Files. Setting to false downloads the contents of a container to a single,
from Cloud Files. Setting to false downloads the contents of a container to a single,
flat directory
flat directory
choices: ["yes", "no"]
choices:
- yes
- "no"
default: "yes"
default: "yes"
state:
state:
description:
description:
...
@@ -92,21 +86,12 @@ options:
...
@@ -92,21 +86,12 @@ options:
description:
description:
- Type of object to do work on
- Type of object to do work on
- Metadata object or a file object
- Metadata object or a file object
choices: ["file", "meta"]
choices:
default: "file"
- file
username:
- meta
description:
default: file
- Rackspace username (overrides I(credentials))
default: null
requirements: [ "pyrax" ]
author: Paul Durivage
author: Paul Durivage
notes:
extends_documentation_fragment: RACKSPACE
- 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
=
'''
...
...
library/cloud/rax_keypair
View file @
bb6f7a26
...
@@ -22,52 +22,6 @@ description:
...
@@ -22,52 +22,6 @@ description:
- Create a keypair for use with Rackspace Cloud Servers
- Create a keypair for use with Rackspace Cloud Servers
version_added: 1.5
version_added: 1.5
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/
version_added: 1.5
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 https://github.com/rackspace/pyrax/blob/master/docs/getting_started.md#pyrax-configuration
version_added: 1.5
identity_type:
description:
- Authentication machanism to use, such as rackspace or keystone
default: rackspace
version_added: 1.5
region:
description:
- Region to create an instance in
default: DFW
tenant_id:
description:
- The tenant ID used for authentication
version_added: 1.5
tenant_name:
description:
- The tenant name used for authentication
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
name:
name:
description:
description:
- Name of keypair
- Name of keypair
...
@@ -79,19 +33,15 @@ options:
...
@@ -79,19 +33,15 @@ options:
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
requirements: [ "pyrax" ]
author: Matt Martz
author: Matt Martz
notes:
notes:
- 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, ...)
- Keypairs cannot be manipulated, only created and deleted. To "update" a
- Keypairs cannot be manipulated, only created and deleted. To "update" a
keypair you must first delete and then recreate.
keypair you must first delete and then recreate.
extends_documentation_fragment: RACKSPACE_AND_OPENSTACK
'''
'''
EXAMPLES
=
'''
EXAMPLES
=
'''
...
...
library/cloud/rax_network
View file @
bb6f7a26
...
@@ -25,20 +25,10 @@ options:
...
@@ -25,20 +25,10 @@ options:
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
credentials:
description:
- File to find the Rackspace credentials in (ignored if C(api_key) and
C(username) are provided)
default: null
aliases: ['creds_file']
api_key:
description:
- Rackspace API key (overrides C(credentials))
username:
description:
- Rackspace username (overrides C(credentials))
label:
label:
description:
description:
- Label (name) to give the network
- Label (name) to give the network
...
@@ -47,19 +37,8 @@ options:
...
@@ -47,19 +37,8 @@ options:
description:
description:
- cidr of the network being created
- cidr of the network being created
default: null
default: null
region:
description:
- Region to create the network in
default: DFW
requirements: [ "pyrax" ]
author: Christopher H. Laco, Jesse Keating
author: Christopher H. Laco, Jesse Keating
notes:
extends_documentation_fragment: RACKSPACE_AND_OPENSTACK
- The following environment variables can be used, C(RAX_USERNAME),
C(RAX_API_KEY), C(RAX_CREDS), C(RAX_CREDENTIALS), C(RAX_REGION).
- C(RAX_CREDENTIALS) and C(RAX_CREDS) points to a credentials file
appropriate for pyrax
- 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
=
'''
...
...
library/cloud/rax_queue
View file @
bb6f7a26
...
@@ -22,40 +22,19 @@ description:
...
@@ -22,40 +22,19 @@ description:
- creates / deletes a Rackspace Public Cloud queue.
- creates / deletes a Rackspace Public Cloud queue.
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']
name:
name:
description:
description:
- Name to give the queue
- Name to give the queue
default: null
default: null
region:
description:
- Region to create the load balancer in
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
- 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
=
'''
...
@@ -68,7 +47,6 @@ EXAMPLES = '''
...
@@ -68,7 +47,6 @@ EXAMPLES = '''
local_action:
local_action:
module: rax_queue
module: rax_queue
credentials: ~/.raxpub
credentials: ~/.raxpub
client_id: unique-client-name
name: my-queue
name: my-queue
region: DFW
region: DFW
state: present
state: present
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment