Add version_added to all modules missing version_added information, the docs formatter will now
raise errors when omitted, updated changelog with new modules.
This commit is contained in:
parent
55a48aacc3
commit
08996d78d6
41 changed files with 47 additions and 9 deletions
|
@ -23,6 +23,7 @@
|
||||||
DOCUMENTATION = '''
|
DOCUMENTATION = '''
|
||||||
---
|
---
|
||||||
module: docker
|
module: docker
|
||||||
|
version_added: "1.4"
|
||||||
short_description: manage docker containers
|
short_description: manage docker containers
|
||||||
description:
|
description:
|
||||||
- Manage the life cycle of docker containers.
|
- Manage the life cycle of docker containers.
|
||||||
|
|
|
@ -17,6 +17,7 @@
|
||||||
DOCUMENTATION = '''
|
DOCUMENTATION = '''
|
||||||
---
|
---
|
||||||
module: ec2_ami
|
module: ec2_ami
|
||||||
|
version_added: "1.3"
|
||||||
short_description: create or destroy an image in ec2, return imageid
|
short_description: create or destroy an image in ec2, return imageid
|
||||||
description:
|
description:
|
||||||
- Creates or deletes ec2 images. This module has a dependency on python-boto >= 2.5
|
- Creates or deletes ec2 images. This module has a dependency on python-boto >= 2.5
|
||||||
|
|
|
@ -5,6 +5,7 @@
|
||||||
DOCUMENTATION = '''
|
DOCUMENTATION = '''
|
||||||
---
|
---
|
||||||
module: ec2_group
|
module: ec2_group
|
||||||
|
version_added: "1.3"
|
||||||
short_description: maintain an ec2 VPC security group.
|
short_description: maintain an ec2 VPC security group.
|
||||||
description:
|
description:
|
||||||
- maintains ec2 security groups. This module has a dependency on python-boto >= 2.5
|
- maintains ec2 security groups. This module has a dependency on python-boto >= 2.5
|
||||||
|
|
|
@ -19,6 +19,7 @@
|
||||||
DOCUMENTATION = '''
|
DOCUMENTATION = '''
|
||||||
---
|
---
|
||||||
module: gce
|
module: gce
|
||||||
|
version_added: "1.4"
|
||||||
short_description: create or terminate GCE instances
|
short_description: create or terminate GCE instances
|
||||||
description:
|
description:
|
||||||
- Creates or terminates Google Compute Engine (GCE) instances. See
|
- Creates or terminates Google Compute Engine (GCE) instances. See
|
||||||
|
|
|
@ -19,6 +19,7 @@
|
||||||
DOCUMENTATION = '''
|
DOCUMENTATION = '''
|
||||||
---
|
---
|
||||||
module: gce_lb
|
module: gce_lb
|
||||||
|
version_added: "1.5"
|
||||||
short_description: create/destroy GCE load-balancer resources
|
short_description: create/destroy GCE load-balancer resources
|
||||||
description:
|
description:
|
||||||
- This module can create and destroy Google Compute Engine C(loadbalancer)
|
- This module can create and destroy Google Compute Engine C(loadbalancer)
|
||||||
|
|
|
@ -19,6 +19,7 @@
|
||||||
DOCUMENTATION = '''
|
DOCUMENTATION = '''
|
||||||
---
|
---
|
||||||
module: gce_net
|
module: gce_net
|
||||||
|
version_added: "1.5"
|
||||||
short_description: create/destroy GCE networks and firewall rules
|
short_description: create/destroy GCE networks and firewall rules
|
||||||
description:
|
description:
|
||||||
- This module can create and destroy Google Compue Engine networks and
|
- This module can create and destroy Google Compue Engine networks and
|
||||||
|
|
|
@ -19,6 +19,7 @@
|
||||||
DOCUMENTATION = '''
|
DOCUMENTATION = '''
|
||||||
---
|
---
|
||||||
module: gce_pd
|
module: gce_pd
|
||||||
|
version_added: "1.4"
|
||||||
short_description: utilize GCE persistent disk resources
|
short_description: utilize GCE persistent disk resources
|
||||||
description:
|
description:
|
||||||
- This module can create and destroy unformatted GCE persistent disks
|
- This module can create and destroy unformatted GCE persistent disks
|
||||||
|
|
|
@ -19,6 +19,7 @@
|
||||||
DOCUMENTATION = '''
|
DOCUMENTATION = '''
|
||||||
---
|
---
|
||||||
module: glance_image
|
module: glance_image
|
||||||
|
version_added: "1.2"
|
||||||
short_description: Add/Delete images from glance
|
short_description: Add/Delete images from glance
|
||||||
description:
|
description:
|
||||||
- Add or Remove images from the glance repository.
|
- Add or Remove images from the glance repository.
|
||||||
|
|
|
@ -6,6 +6,7 @@
|
||||||
DOCUMENTATION = '''
|
DOCUMENTATION = '''
|
||||||
---
|
---
|
||||||
module: keystone_user
|
module: keystone_user
|
||||||
|
version_added: "1.2"
|
||||||
short_description: Manage OpenStack Identity (keystone) users, tenants and roles
|
short_description: Manage OpenStack Identity (keystone) users, tenants and roles
|
||||||
description:
|
description:
|
||||||
- Manage users,tenants, roles from OpenStack.
|
- Manage users,tenants, roles from OpenStack.
|
||||||
|
|
|
@ -25,6 +25,7 @@ except ImportError:
|
||||||
DOCUMENTATION = '''
|
DOCUMENTATION = '''
|
||||||
---
|
---
|
||||||
module: nova_compute
|
module: nova_compute
|
||||||
|
version_added: "1.2"
|
||||||
short_description: Create/Delete VMs from OpenStack
|
short_description: Create/Delete VMs from OpenStack
|
||||||
description:
|
description:
|
||||||
- Create or Remove virtual machines from Openstack.
|
- Create or Remove virtual machines from Openstack.
|
||||||
|
|
|
@ -25,6 +25,7 @@ except ImportError:
|
||||||
DOCUMENTATION = '''
|
DOCUMENTATION = '''
|
||||||
---
|
---
|
||||||
module: nova_keypair
|
module: nova_keypair
|
||||||
|
version_added: "1.2"
|
||||||
short_description: Add/Delete key pair from nova
|
short_description: Add/Delete key pair from nova
|
||||||
description:
|
description:
|
||||||
- Add or Remove key pair from nova .
|
- Add or Remove key pair from nova .
|
||||||
|
|
|
@ -27,6 +27,7 @@ except ImportError:
|
||||||
DOCUMENTATION = '''
|
DOCUMENTATION = '''
|
||||||
---
|
---
|
||||||
module: quantum_floating_ip
|
module: quantum_floating_ip
|
||||||
|
version_added: "1.2"
|
||||||
short_description: Add/Remove floating IP from an instance
|
short_description: Add/Remove floating IP from an instance
|
||||||
description:
|
description:
|
||||||
- Add or Remove a floating IP to an instance
|
- Add or Remove a floating IP to an instance
|
||||||
|
|
|
@ -27,6 +27,7 @@ except ImportError:
|
||||||
DOCUMENTATION = '''
|
DOCUMENTATION = '''
|
||||||
---
|
---
|
||||||
module: quantum_floating_ip_associate
|
module: quantum_floating_ip_associate
|
||||||
|
version_added: "1.2"
|
||||||
short_description: Associate or disassociate a particular floating IP with an instance
|
short_description: Associate or disassociate a particular floating IP with an instance
|
||||||
description:
|
description:
|
||||||
- Associates or disassociates a specific floating IP with a particular instance
|
- Associates or disassociates a specific floating IP with a particular instance
|
||||||
|
|
|
@ -25,6 +25,7 @@ except ImportError:
|
||||||
DOCUMENTATION = '''
|
DOCUMENTATION = '''
|
||||||
---
|
---
|
||||||
module: quantum_network
|
module: quantum_network
|
||||||
|
version_added: "1.4"
|
||||||
short_description: Creates/Removes networks from OpenStack
|
short_description: Creates/Removes networks from OpenStack
|
||||||
description:
|
description:
|
||||||
- Add or Remove network from OpenStack.
|
- Add or Remove network from OpenStack.
|
||||||
|
|
|
@ -25,6 +25,7 @@ except ImportError:
|
||||||
DOCUMENTATION = '''
|
DOCUMENTATION = '''
|
||||||
---
|
---
|
||||||
module: quantum_router
|
module: quantum_router
|
||||||
|
version_added: "1.2"
|
||||||
short_description: Create or Remove router from openstack
|
short_description: Create or Remove router from openstack
|
||||||
description:
|
description:
|
||||||
- Create or Delete routers from OpenStack
|
- Create or Delete routers from OpenStack
|
||||||
|
|
|
@ -24,6 +24,7 @@ except ImportError:
|
||||||
DOCUMENTATION = '''
|
DOCUMENTATION = '''
|
||||||
---
|
---
|
||||||
module: quantum_router_gateway
|
module: quantum_router_gateway
|
||||||
|
version_added: "1.2"
|
||||||
short_description: set/unset a gateway interface for the router with the specified external network
|
short_description: set/unset a gateway interface for the router with the specified external network
|
||||||
description:
|
description:
|
||||||
- Creates/Removes a gateway interface from the router, used to associate a external network with a router to route external traffic.
|
- Creates/Removes a gateway interface from the router, used to associate a external network with a router to route external traffic.
|
||||||
|
|
|
@ -24,6 +24,7 @@ except ImportError:
|
||||||
DOCUMENTATION = '''
|
DOCUMENTATION = '''
|
||||||
---
|
---
|
||||||
module: quantum_router_interface
|
module: quantum_router_interface
|
||||||
|
version_added: "1.2"
|
||||||
short_description: Attach/Dettach a subnet's interface to a router
|
short_description: Attach/Dettach a subnet's interface to a router
|
||||||
description:
|
description:
|
||||||
- Attach/Dettach a subnet interface to a router, to provide a gateway for the subnet.
|
- Attach/Dettach a subnet interface to a router, to provide a gateway for the subnet.
|
||||||
|
|
|
@ -25,6 +25,7 @@ except ImportError:
|
||||||
DOCUMENTATION = '''
|
DOCUMENTATION = '''
|
||||||
---
|
---
|
||||||
module: quantum_subnet
|
module: quantum_subnet
|
||||||
|
version_added: "1.2"
|
||||||
short_description: Add/Remove floating IP from an instance
|
short_description: Add/Remove floating IP from an instance
|
||||||
description:
|
description:
|
||||||
- Add or Remove a floating IP to an instance
|
- Add or Remove a floating IP to an instance
|
||||||
|
|
|
@ -28,6 +28,7 @@ import os
|
||||||
DOCUMENTATION = '''
|
DOCUMENTATION = '''
|
||||||
---
|
---
|
||||||
module: command
|
module: command
|
||||||
|
version_added: historical
|
||||||
short_description: Executes a command on a remote node
|
short_description: Executes a command on a remote node
|
||||||
description:
|
description:
|
||||||
- The M(command) module takes the command name followed by a list of space-delimited arguments.
|
- The M(command) module takes the command name followed by a list of space-delimited arguments.
|
||||||
|
|
|
@ -3,6 +3,7 @@
|
||||||
DOCUMENTATION = '''
|
DOCUMENTATION = '''
|
||||||
---
|
---
|
||||||
module: raw
|
module: raw
|
||||||
|
version_added: historical
|
||||||
short_description: Executes a low-down and dirty SSH command
|
short_description: Executes a low-down and dirty SSH command
|
||||||
options:
|
options:
|
||||||
free_form:
|
free_form:
|
||||||
|
|
|
@ -2,6 +2,7 @@
|
||||||
DOCUMENTATION = """
|
DOCUMENTATION = """
|
||||||
---
|
---
|
||||||
module: script
|
module: script
|
||||||
|
version_added: "0.9"
|
||||||
short_description: Runs a local script on a remote node after transferring it
|
short_description: Runs a local script on a remote node after transferring it
|
||||||
description:
|
description:
|
||||||
- "The M(script) module takes the script name followed by a list of
|
- "The M(script) module takes the script name followed by a list of
|
||||||
|
|
|
@ -19,6 +19,7 @@
|
||||||
DOCUMENTATION = """
|
DOCUMENTATION = """
|
||||||
---
|
---
|
||||||
module: postgresql_privs
|
module: postgresql_privs
|
||||||
|
version_added: "1.2"
|
||||||
short_description: Grant or revoke privileges on PostgreSQL database objects.
|
short_description: Grant or revoke privileges on PostgreSQL database objects.
|
||||||
description:
|
description:
|
||||||
- Grant or revoke privileges on PostgreSQL database objects.
|
- Grant or revoke privileges on PostgreSQL database objects.
|
||||||
|
|
|
@ -24,6 +24,7 @@ import time
|
||||||
DOCUMENTATION = '''
|
DOCUMENTATION = '''
|
||||||
---
|
---
|
||||||
module: copy
|
module: copy
|
||||||
|
version_added: "historical"
|
||||||
short_description: Copies files to remote locations.
|
short_description: Copies files to remote locations.
|
||||||
description:
|
description:
|
||||||
- The M(copy) module copies a file on the local box to remote locations.
|
- The M(copy) module copies a file on the local box to remote locations.
|
||||||
|
|
|
@ -31,6 +31,7 @@ except ImportError:
|
||||||
DOCUMENTATION = '''
|
DOCUMENTATION = '''
|
||||||
---
|
---
|
||||||
module: file
|
module: file
|
||||||
|
version_added: "historical"
|
||||||
short_description: Sets attributes of files
|
short_description: Sets attributes of files
|
||||||
description:
|
description:
|
||||||
- Sets attributes of files, symlinks, and directories, or removes
|
- Sets attributes of files, symlinks, and directories, or removes
|
||||||
|
|
|
@ -3,6 +3,7 @@
|
||||||
DOCUMENTATION = '''
|
DOCUMENTATION = '''
|
||||||
---
|
---
|
||||||
module: template
|
module: template
|
||||||
|
version_added: historical
|
||||||
short_description: Templates a file out to a remote server.
|
short_description: Templates a file out to a remote server.
|
||||||
description:
|
description:
|
||||||
- Templates are processed by the Jinja2 templating language
|
- Templates are processed by the Jinja2 templating language
|
||||||
|
|
|
@ -22,6 +22,7 @@
|
||||||
DOCUMENTATION = '''
|
DOCUMENTATION = '''
|
||||||
---
|
---
|
||||||
module: unarchive
|
module: unarchive
|
||||||
|
version_added: 1.4
|
||||||
short_description: Copies archive to remote locations and unpacks them
|
short_description: Copies archive to remote locations and unpacks them
|
||||||
description:
|
description:
|
||||||
- The M(unarchive) module copies an archive file on the local box to remote locations and unpacks them.
|
- The M(unarchive) module copies an archive file on the local box to remote locations and unpacks them.
|
||||||
|
|
|
@ -19,6 +19,7 @@
|
||||||
DOCUMENTATION = '''
|
DOCUMENTATION = '''
|
||||||
---
|
---
|
||||||
module: arista_interface
|
module: arista_interface
|
||||||
|
version_added: "1.3"
|
||||||
author: Peter Sprygada
|
author: Peter Sprygada
|
||||||
short_description: Manage physical Ethernet interfaces
|
short_description: Manage physical Ethernet interfaces
|
||||||
requirements:
|
requirements:
|
||||||
|
|
|
@ -19,6 +19,7 @@
|
||||||
DOCUMENTATION = '''
|
DOCUMENTATION = '''
|
||||||
---
|
---
|
||||||
module: arista_l2interface
|
module: arista_l2interface
|
||||||
|
version_added: "1.2"
|
||||||
author: Peter Sprygada
|
author: Peter Sprygada
|
||||||
short_description: Manage layer 2 interfaces
|
short_description: Manage layer 2 interfaces
|
||||||
requirements:
|
requirements:
|
||||||
|
|
|
@ -19,6 +19,7 @@
|
||||||
DOCUMENTATION = '''
|
DOCUMENTATION = '''
|
||||||
---
|
---
|
||||||
module: arista_lag
|
module: arista_lag
|
||||||
|
version_added: "1.3"
|
||||||
author: Peter Sprygada
|
author: Peter Sprygada
|
||||||
short_description: Manage port channel (lag) interfaces
|
short_description: Manage port channel (lag) interfaces
|
||||||
requirements:
|
requirements:
|
||||||
|
|
|
@ -19,6 +19,7 @@
|
||||||
DOCUMENTATION = '''
|
DOCUMENTATION = '''
|
||||||
---
|
---
|
||||||
module: arista_vlan
|
module: arista_vlan
|
||||||
|
version_added: "1.3"
|
||||||
author: Peter Sprygada
|
author: Peter Sprygada
|
||||||
short_description: Manage VLAN resources
|
short_description: Manage VLAN resources
|
||||||
requirements:
|
requirements:
|
||||||
|
|
|
@ -17,6 +17,7 @@
|
||||||
DOCUMENTATION = '''
|
DOCUMENTATION = '''
|
||||||
---
|
---
|
||||||
module: openvswitch_bridge
|
module: openvswitch_bridge
|
||||||
|
version_added: 1.4
|
||||||
short_description: Manage Open vSwitch bridges
|
short_description: Manage Open vSwitch bridges
|
||||||
requirements: [ ovs-vsctl ]
|
requirements: [ ovs-vsctl ]
|
||||||
description:
|
description:
|
||||||
|
|
|
@ -17,6 +17,7 @@
|
||||||
DOCUMENTATION = '''
|
DOCUMENTATION = '''
|
||||||
---
|
---
|
||||||
module: openvswitch_port
|
module: openvswitch_port
|
||||||
|
version_added: 1.4
|
||||||
short_description: Manage Open vSwitch ports
|
short_description: Manage Open vSwitch ports
|
||||||
requirements: [ ovs-vsctl ]
|
requirements: [ ovs-vsctl ]
|
||||||
description:
|
description:
|
||||||
|
|
|
@ -21,6 +21,7 @@
|
||||||
DOCUMENTATION = '''
|
DOCUMENTATION = '''
|
||||||
---
|
---
|
||||||
module: slurp
|
module: slurp
|
||||||
|
version_added: historical
|
||||||
short_description: Slurps a file from remote nodes
|
short_description: Slurps a file from remote nodes
|
||||||
description:
|
description:
|
||||||
- This module works like M(fetch). It is used for fetching a base64-
|
- This module works like M(fetch). It is used for fetching a base64-
|
||||||
|
|
|
@ -3,10 +3,11 @@
|
||||||
|
|
||||||
DOCUMENTATION = '''
|
DOCUMENTATION = '''
|
||||||
---
|
---
|
||||||
module: notify_grove
|
module: grove
|
||||||
|
version_added: 1.4
|
||||||
short_description: Sends a notification to a grove.io channel
|
short_description: Sends a notification to a grove.io channel
|
||||||
description:
|
description:
|
||||||
- The M(notify_grove) modules sends a message for a service to a Grove.io
|
- The M(grove) module sends a message for a service to a Grove.io
|
||||||
channel.
|
channel.
|
||||||
options:
|
options:
|
||||||
channel_token:
|
channel_token:
|
||||||
|
@ -33,12 +34,10 @@ author: Jonas Pfenniger <zimbatm@zimbatm.com>
|
||||||
'''
|
'''
|
||||||
|
|
||||||
EXAMPLES = '''
|
EXAMPLES = '''
|
||||||
# Creates a json file for chef-solo
|
- grove: >
|
||||||
- notify_grove:
|
channel_token=6Ph62VBBJOccmtTPZbubiPzdrhipZXtg
|
||||||
args:
|
service=my-app
|
||||||
channel_token: 6Ph62VBBJOccmtTPZbubiPzdrhipZXtg
|
message=deployed {{ target }}
|
||||||
service: my-app
|
|
||||||
message: deployed {{ target }}
|
|
||||||
'''
|
'''
|
||||||
|
|
||||||
import urllib
|
import urllib
|
|
@ -22,6 +22,7 @@
|
||||||
DOCUMENTATION = '''
|
DOCUMENTATION = '''
|
||||||
---
|
---
|
||||||
module: irc
|
module: irc
|
||||||
|
version_added: "1.2"
|
||||||
short_description: Send a message to an IRC channel
|
short_description: Send a message to an IRC channel
|
||||||
description:
|
description:
|
||||||
- Send a message to an IRC channel. This is a very simplistic implementation.
|
- Send a message to an IRC channel. This is a very simplistic implementation.
|
||||||
|
|
|
@ -28,6 +28,7 @@ import yum
|
||||||
DOCUMENTATION = '''
|
DOCUMENTATION = '''
|
||||||
---
|
---
|
||||||
module: yum
|
module: yum
|
||||||
|
version_added: historical
|
||||||
short_description: Manages packages with the I(yum) package manager
|
short_description: Manages packages with the I(yum) package manager
|
||||||
description:
|
description:
|
||||||
- Will install, upgrade, remove, and list packages with the I(yum) package manager.
|
- Will install, upgrade, remove, and list packages with the I(yum) package manager.
|
||||||
|
|
|
@ -22,6 +22,7 @@
|
||||||
DOCUMENTATION = '''
|
DOCUMENTATION = '''
|
||||||
---
|
---
|
||||||
module: ping
|
module: ping
|
||||||
|
version_added: historical
|
||||||
short_description: Try to connect to host and return C(pong) on success.
|
short_description: Try to connect to host and return C(pong) on success.
|
||||||
description:
|
description:
|
||||||
- A trivial test module, this module always returns C(pong) on successful
|
- A trivial test module, this module always returns C(pong) on successful
|
||||||
|
|
|
@ -37,6 +37,7 @@ import StringIO
|
||||||
DOCUMENTATION = '''
|
DOCUMENTATION = '''
|
||||||
---
|
---
|
||||||
module: setup
|
module: setup
|
||||||
|
version_added: historical
|
||||||
short_description: Gathers facts about remote hosts
|
short_description: Gathers facts about remote hosts
|
||||||
options:
|
options:
|
||||||
filter:
|
filter:
|
||||||
|
|
|
@ -19,6 +19,7 @@
|
||||||
DOCUMENTATION = '''
|
DOCUMENTATION = '''
|
||||||
---
|
---
|
||||||
module: ejabberd_user
|
module: ejabberd_user
|
||||||
|
version_added: "1.5"
|
||||||
author: Peter Sprygada
|
author: Peter Sprygada
|
||||||
short_description: Manages users for ejabberd servers
|
short_description: Manages users for ejabberd servers
|
||||||
requirements:
|
requirements:
|
||||||
|
|
|
@ -20,6 +20,7 @@
|
||||||
#
|
#
|
||||||
DOCUMENTATION = """
|
DOCUMENTATION = """
|
||||||
module: htpasswd
|
module: htpasswd
|
||||||
|
version_added: "1.3"
|
||||||
short_description: manage user files for basic authentication
|
short_description: manage user files for basic authentication
|
||||||
description:
|
description:
|
||||||
- Add and remove username/password entries in a password file using htpasswd.
|
- Add and remove username/password entries in a password file using htpasswd.
|
||||||
|
|
|
@ -20,10 +20,10 @@
|
||||||
|
|
||||||
DOCUMENTATION = """
|
DOCUMENTATION = """
|
||||||
module: jboss
|
module: jboss
|
||||||
|
version_added: "1.4"
|
||||||
short_description: deploy applications to JBoss
|
short_description: deploy applications to JBoss
|
||||||
description:
|
description:
|
||||||
- Deploy applications to JBoss standalone using the filesystem
|
- Deploy applications to JBoss standalone using the filesystem
|
||||||
version_added: "1.4"
|
|
||||||
options:
|
options:
|
||||||
deployment:
|
deployment:
|
||||||
required: true
|
required: true
|
||||||
|
|
Loading…
Reference in a new issue