summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMichael DeHaan <michael@ansibleworks.com>2013-11-18 18:55:49 -0500
committerMichael DeHaan <michael@ansibleworks.com>2013-11-18 18:55:49 -0500
commit08996d78d69052acc03b63462037328b0a1631fa (patch)
tree5c02cba8542dfc0f858601cb9cca4280b5ffdc59
parent55a48aacc3be822f53b628ffc4f7c11f97ca4130 (diff)
downloadansible-modules-extras-08996d78d69052acc03b63462037328b0a1631fa.tar.gz
Add version_added to all modules missing version_added information, the docs formatter will now
raise errors when omitted, updated changelog with new modules.
-rw-r--r--cloud/docker1
-rw-r--r--cloud/ec2_ami1
-rw-r--r--cloud/ec2_group1
-rw-r--r--cloud/gce1
-rw-r--r--cloud/gce_lb1
-rw-r--r--cloud/gce_net1
-rw-r--r--cloud/gce_pd1
-rw-r--r--cloud/glance_image1
-rw-r--r--cloud/keystone_user1
-rw-r--r--cloud/nova_compute1
-rw-r--r--cloud/nova_keypair1
-rw-r--r--cloud/quantum_floating_ip1
-rw-r--r--cloud/quantum_floating_ip_associate1
-rw-r--r--cloud/quantum_network1
-rw-r--r--cloud/quantum_router1
-rw-r--r--cloud/quantum_router_gateway1
-rw-r--r--cloud/quantum_router_interface1
-rw-r--r--cloud/quantum_subnet1
-rw-r--r--commands/command1
-rw-r--r--commands/raw1
-rw-r--r--commands/script1
-rw-r--r--database/postgresql_privs1
-rw-r--r--files/copy1
-rw-r--r--files/file1
-rw-r--r--files/template1
-rw-r--r--files/unarchive1
-rw-r--r--net_infrastructure/arista_interface1
-rw-r--r--net_infrastructure/arista_l2interface1
-rw-r--r--net_infrastructure/arista_lag1
-rw-r--r--net_infrastructure/arista_vlan1
-rw-r--r--net_infrastructure/openvswitch_bridge1
-rw-r--r--net_infrastructure/openvswitch_port1
-rw-r--r--network/slurp1
-rw-r--r--notification/grove (renamed from notification/notify_grove)15
-rw-r--r--notification/irc1
-rw-r--r--packaging/yum1
-rw-r--r--system/ping1
-rwxr-xr-xsystem/setup1
-rw-r--r--web_infrastructure/ejabberd_user1
-rw-r--r--web_infrastructure/htpasswd1
-rw-r--r--web_infrastructure/jboss2
41 files changed, 47 insertions, 9 deletions
diff --git a/cloud/docker b/cloud/docker
index 286e6f1a..a7e635f7 100644
--- a/cloud/docker
+++ b/cloud/docker
@@ -23,6 +23,7 @@
DOCUMENTATION = '''
---
module: docker
+version_added: "1.4"
short_description: manage docker containers
description:
- Manage the life cycle of docker containers.
diff --git a/cloud/ec2_ami b/cloud/ec2_ami
index a4d8dbf6..f849a2d3 100644
--- a/cloud/ec2_ami
+++ b/cloud/ec2_ami
@@ -17,6 +17,7 @@
DOCUMENTATION = '''
---
module: ec2_ami
+version_added: "1.3"
short_description: create or destroy an image in ec2, return imageid
description:
- Creates or deletes ec2 images. This module has a dependency on python-boto >= 2.5
diff --git a/cloud/ec2_group b/cloud/ec2_group
index 0ece9647..c325c1ce 100644
--- a/cloud/ec2_group
+++ b/cloud/ec2_group
@@ -5,6 +5,7 @@
DOCUMENTATION = '''
---
module: ec2_group
+version_added: "1.3"
short_description: maintain an ec2 VPC security group.
description:
- maintains ec2 security groups. This module has a dependency on python-boto >= 2.5
diff --git a/cloud/gce b/cloud/gce
index 90052e5b..d0eb474f 100644
--- a/cloud/gce
+++ b/cloud/gce
@@ -19,6 +19,7 @@
DOCUMENTATION = '''
---
module: gce
+version_added: "1.4"
short_description: create or terminate GCE instances
description:
- Creates or terminates Google Compute Engine (GCE) instances. See
diff --git a/cloud/gce_lb b/cloud/gce_lb
index bc444a44..21e142be 100644
--- a/cloud/gce_lb
+++ b/cloud/gce_lb
@@ -19,6 +19,7 @@
DOCUMENTATION = '''
---
module: gce_lb
+version_added: "1.5"
short_description: create/destroy GCE load-balancer resources
description:
- This module can create and destroy Google Compute Engine C(loadbalancer)
diff --git a/cloud/gce_net b/cloud/gce_net
index 4728584d..b0954a2f 100644
--- a/cloud/gce_net
+++ b/cloud/gce_net
@@ -19,6 +19,7 @@
DOCUMENTATION = '''
---
module: gce_net
+version_added: "1.5"
short_description: create/destroy GCE networks and firewall rules
description:
- This module can create and destroy Google Compue Engine networks and
diff --git a/cloud/gce_pd b/cloud/gce_pd
index 245d1bb6..0e125d26 100644
--- a/cloud/gce_pd
+++ b/cloud/gce_pd
@@ -19,6 +19,7 @@
DOCUMENTATION = '''
---
module: gce_pd
+version_added: "1.4"
short_description: utilize GCE persistent disk resources
description:
- This module can create and destroy unformatted GCE persistent disks
diff --git a/cloud/glance_image b/cloud/glance_image
index 1060ffac..d6ab5538 100644
--- a/cloud/glance_image
+++ b/cloud/glance_image
@@ -19,6 +19,7 @@
DOCUMENTATION = '''
---
module: glance_image
+version_added: "1.2"
short_description: Add/Delete images from glance
description:
- Add or Remove images from the glance repository.
diff --git a/cloud/keystone_user b/cloud/keystone_user
index aa9ac100..4efe72dd 100644
--- a/cloud/keystone_user
+++ b/cloud/keystone_user
@@ -6,6 +6,7 @@
DOCUMENTATION = '''
---
module: keystone_user
+version_added: "1.2"
short_description: Manage OpenStack Identity (keystone) users, tenants and roles
description:
- Manage users,tenants, roles from OpenStack.
diff --git a/cloud/nova_compute b/cloud/nova_compute
index 2a8437fa..e6b550cd 100644
--- a/cloud/nova_compute
+++ b/cloud/nova_compute
@@ -25,6 +25,7 @@ except ImportError:
DOCUMENTATION = '''
---
module: nova_compute
+version_added: "1.2"
short_description: Create/Delete VMs from OpenStack
description:
- Create or Remove virtual machines from Openstack.
diff --git a/cloud/nova_keypair b/cloud/nova_keypair
index f9c449af..3d332a03 100644
--- a/cloud/nova_keypair
+++ b/cloud/nova_keypair
@@ -25,6 +25,7 @@ except ImportError:
DOCUMENTATION = '''
---
module: nova_keypair
+version_added: "1.2"
short_description: Add/Delete key pair from nova
description:
- Add or Remove key pair from nova .
diff --git a/cloud/quantum_floating_ip b/cloud/quantum_floating_ip
index 8b89a405..09378757 100644
--- a/cloud/quantum_floating_ip
+++ b/cloud/quantum_floating_ip
@@ -27,6 +27,7 @@ except ImportError:
DOCUMENTATION = '''
---
module: quantum_floating_ip
+version_added: "1.2"
short_description: Add/Remove floating IP from an instance
description:
- Add or Remove a floating IP to an instance
diff --git a/cloud/quantum_floating_ip_associate b/cloud/quantum_floating_ip_associate
index 7ea40c15..30b6224d 100644
--- a/cloud/quantum_floating_ip_associate
+++ b/cloud/quantum_floating_ip_associate
@@ -27,6 +27,7 @@ except ImportError:
DOCUMENTATION = '''
---
module: quantum_floating_ip_associate
+version_added: "1.2"
short_description: Associate or disassociate a particular floating IP with an instance
description:
- Associates or disassociates a specific floating IP with a particular instance
diff --git a/cloud/quantum_network b/cloud/quantum_network
index c0e90119..7d750407 100644
--- a/cloud/quantum_network
+++ b/cloud/quantum_network
@@ -25,6 +25,7 @@ except ImportError:
DOCUMENTATION = '''
---
module: quantum_network
+version_added: "1.4"
short_description: Creates/Removes networks from OpenStack
description:
- Add or Remove network from OpenStack.
diff --git a/cloud/quantum_router b/cloud/quantum_router
index 3e740900..f1655ea8 100644
--- a/cloud/quantum_router
+++ b/cloud/quantum_router
@@ -25,6 +25,7 @@ except ImportError:
DOCUMENTATION = '''
---
module: quantum_router
+version_added: "1.2"
short_description: Create or Remove router from openstack
description:
- Create or Delete routers from OpenStack
diff --git a/cloud/quantum_router_gateway b/cloud/quantum_router_gateway
index 10cfe2a0..6238c6c1 100644
--- a/cloud/quantum_router_gateway
+++ b/cloud/quantum_router_gateway
@@ -24,6 +24,7 @@ except ImportError:
DOCUMENTATION = '''
---
module: quantum_router_gateway
+version_added: "1.2"
short_description: set/unset a gateway interface for the router with the specified external network
description:
- Creates/Removes a gateway interface from the router, used to associate a external network with a router to route external traffic.
diff --git a/cloud/quantum_router_interface b/cloud/quantum_router_interface
index f85ac1a3..4fa1f030 100644
--- a/cloud/quantum_router_interface
+++ b/cloud/quantum_router_interface
@@ -24,6 +24,7 @@ except ImportError:
DOCUMENTATION = '''
---
module: quantum_router_interface
+version_added: "1.2"
short_description: Attach/Dettach a subnet's interface to a router
description:
- Attach/Dettach a subnet interface to a router, to provide a gateway for the subnet.
diff --git a/cloud/quantum_subnet b/cloud/quantum_subnet
index 941e21bd..24f89203 100644
--- a/cloud/quantum_subnet
+++ b/cloud/quantum_subnet
@@ -25,6 +25,7 @@ except ImportError:
DOCUMENTATION = '''
---
module: quantum_subnet
+version_added: "1.2"
short_description: Add/Remove floating IP from an instance
description:
- Add or Remove a floating IP to an instance
diff --git a/commands/command b/commands/command
index 49c01556..707ec325 100644
--- a/commands/command
+++ b/commands/command
@@ -28,6 +28,7 @@ import os
DOCUMENTATION = '''
---
module: command
+version_added: historical
short_description: Executes a command on a remote node
description:
- The M(command) module takes the command name followed by a list of space-delimited arguments.
diff --git a/commands/raw b/commands/raw
index dc4c09d4..87f2b5c4 100644
--- a/commands/raw
+++ b/commands/raw
@@ -3,6 +3,7 @@
DOCUMENTATION = '''
---
module: raw
+version_added: historical
short_description: Executes a low-down and dirty SSH command
options:
free_form:
diff --git a/commands/script b/commands/script
index 00a1bced..143b2b25 100644
--- a/commands/script
+++ b/commands/script
@@ -2,6 +2,7 @@
DOCUMENTATION = """
---
module: script
+version_added: "0.9"
short_description: Runs a local script on a remote node after transferring it
description:
- "The M(script) module takes the script name followed by a list of
diff --git a/database/postgresql_privs b/database/postgresql_privs
index adbad020..bea203dd 100644
--- a/database/postgresql_privs
+++ b/database/postgresql_privs
@@ -19,6 +19,7 @@
DOCUMENTATION = """
---
module: postgresql_privs
+version_added: "1.2"
short_description: Grant or revoke privileges on PostgreSQL database objects.
description:
- Grant or revoke privileges on PostgreSQL database objects.
diff --git a/files/copy b/files/copy
index 99c33910..1146c95a 100644
--- a/files/copy
+++ b/files/copy
@@ -24,6 +24,7 @@ import time
DOCUMENTATION = '''
---
module: copy
+version_added: "historical"
short_description: Copies files to remote locations.
description:
- The M(copy) module copies a file on the local box to remote locations.
diff --git a/files/file b/files/file
index cb81bf1c..d30e3716 100644
--- a/files/file
+++ b/files/file
@@ -31,6 +31,7 @@ except ImportError:
DOCUMENTATION = '''
---
module: file
+version_added: "historical"
short_description: Sets attributes of files
description:
- Sets attributes of files, symlinks, and directories, or removes
diff --git a/files/template b/files/template
index 2b1b4641..35ac831e 100644
--- a/files/template
+++ b/files/template
@@ -3,6 +3,7 @@
DOCUMENTATION = '''
---
module: template
+version_added: historical
short_description: Templates a file out to a remote server.
description:
- Templates are processed by the Jinja2 templating language
diff --git a/files/unarchive b/files/unarchive
index 5fb7de13..17999d30 100644
--- a/files/unarchive
+++ b/files/unarchive
@@ -22,6 +22,7 @@
DOCUMENTATION = '''
---
module: unarchive
+version_added: 1.4
short_description: Copies archive to remote locations and unpacks them
description:
- The M(unarchive) module copies an archive file on the local box to remote locations and unpacks them.
diff --git a/net_infrastructure/arista_interface b/net_infrastructure/arista_interface
index c5ab653b..56807cb0 100644
--- a/net_infrastructure/arista_interface
+++ b/net_infrastructure/arista_interface
@@ -19,6 +19,7 @@
DOCUMENTATION = '''
---
module: arista_interface
+version_added: "1.3"
author: Peter Sprygada
short_description: Manage physical Ethernet interfaces
requirements:
diff --git a/net_infrastructure/arista_l2interface b/net_infrastructure/arista_l2interface
index 1f36925c..5c26e47c 100644
--- a/net_infrastructure/arista_l2interface
+++ b/net_infrastructure/arista_l2interface
@@ -19,6 +19,7 @@
DOCUMENTATION = '''
---
module: arista_l2interface
+version_added: "1.2"
author: Peter Sprygada
short_description: Manage layer 2 interfaces
requirements:
diff --git a/net_infrastructure/arista_lag b/net_infrastructure/arista_lag
index d3995bd8..a07caa42 100644
--- a/net_infrastructure/arista_lag
+++ b/net_infrastructure/arista_lag
@@ -19,6 +19,7 @@
DOCUMENTATION = '''
---
module: arista_lag
+version_added: "1.3"
author: Peter Sprygada
short_description: Manage port channel (lag) interfaces
requirements:
diff --git a/net_infrastructure/arista_vlan b/net_infrastructure/arista_vlan
index a9a1627f..b6346984 100644
--- a/net_infrastructure/arista_vlan
+++ b/net_infrastructure/arista_vlan
@@ -19,6 +19,7 @@
DOCUMENTATION = '''
---
module: arista_vlan
+version_added: "1.3"
author: Peter Sprygada
short_description: Manage VLAN resources
requirements:
diff --git a/net_infrastructure/openvswitch_bridge b/net_infrastructure/openvswitch_bridge
index 7d9824c5..82a2d3fe 100644
--- a/net_infrastructure/openvswitch_bridge
+++ b/net_infrastructure/openvswitch_bridge
@@ -17,6 +17,7 @@
DOCUMENTATION = '''
---
module: openvswitch_bridge
+version_added: 1.4
short_description: Manage Open vSwitch bridges
requirements: [ ovs-vsctl ]
description:
diff --git a/net_infrastructure/openvswitch_port b/net_infrastructure/openvswitch_port
index bfa7a9ca..3fe0c4e3 100644
--- a/net_infrastructure/openvswitch_port
+++ b/net_infrastructure/openvswitch_port
@@ -17,6 +17,7 @@
DOCUMENTATION = '''
---
module: openvswitch_port
+version_added: 1.4
short_description: Manage Open vSwitch ports
requirements: [ ovs-vsctl ]
description:
diff --git a/network/slurp b/network/slurp
index 1f9975fd..6661f9db 100644
--- a/network/slurp
+++ b/network/slurp
@@ -21,6 +21,7 @@
DOCUMENTATION = '''
---
module: slurp
+version_added: historical
short_description: Slurps a file from remote nodes
description:
- This module works like M(fetch). It is used for fetching a base64-
diff --git a/notification/notify_grove b/notification/grove
index 8e0e6fe7..5b088523 100644
--- a/notification/notify_grove
+++ b/notification/grove
@@ -3,10 +3,11 @@
DOCUMENTATION = '''
---
-module: notify_grove
+module: grove
+version_added: 1.4
short_description: Sends a notification to a grove.io channel
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.
options:
channel_token:
@@ -33,12 +34,10 @@ author: Jonas Pfenniger <zimbatm@zimbatm.com>
'''
EXAMPLES = '''
-# Creates a json file for chef-solo
-- notify_grove:
- args:
- channel_token: 6Ph62VBBJOccmtTPZbubiPzdrhipZXtg
- service: my-app
- message: deployed {{ target }}
+- grove: >
+ channel_token=6Ph62VBBJOccmtTPZbubiPzdrhipZXtg
+ service=my-app
+ message=deployed {{ target }}
'''
import urllib
diff --git a/notification/irc b/notification/irc
index 6d209bf2..039b6274 100644
--- a/notification/irc
+++ b/notification/irc
@@ -22,6 +22,7 @@
DOCUMENTATION = '''
---
module: irc
+version_added: "1.2"
short_description: Send a message to an IRC channel
description:
- Send a message to an IRC channel. This is a very simplistic implementation.
diff --git a/packaging/yum b/packaging/yum
index cc801564..536c7e50 100644
--- a/packaging/yum
+++ b/packaging/yum
@@ -28,6 +28,7 @@ import yum
DOCUMENTATION = '''
---
module: yum
+version_added: historical
short_description: Manages packages with the I(yum) package manager
description:
- Will install, upgrade, remove, and list packages with the I(yum) package manager.
diff --git a/system/ping b/system/ping
index ef76d39d..4bda3971 100644
--- a/system/ping
+++ b/system/ping
@@ -22,6 +22,7 @@
DOCUMENTATION = '''
---
module: ping
+version_added: historical
short_description: Try to connect to host and return C(pong) on success.
description:
- A trivial test module, this module always returns C(pong) on successful
diff --git a/system/setup b/system/setup
index 3f8250fa..7b0fd70e 100755
--- a/system/setup
+++ b/system/setup
@@ -37,6 +37,7 @@ import StringIO
DOCUMENTATION = '''
---
module: setup
+version_added: historical
short_description: Gathers facts about remote hosts
options:
filter:
diff --git a/web_infrastructure/ejabberd_user b/web_infrastructure/ejabberd_user
index d74ad57b..1fe15c7a 100644
--- a/web_infrastructure/ejabberd_user
+++ b/web_infrastructure/ejabberd_user
@@ -19,6 +19,7 @@
DOCUMENTATION = '''
---
module: ejabberd_user
+version_added: "1.5"
author: Peter Sprygada
short_description: Manages users for ejabberd servers
requirements:
diff --git a/web_infrastructure/htpasswd b/web_infrastructure/htpasswd
index 3de636d3..0080c49f 100644
--- a/web_infrastructure/htpasswd
+++ b/web_infrastructure/htpasswd
@@ -20,6 +20,7 @@
#
DOCUMENTATION = """
module: htpasswd
+version_added: "1.3"
short_description: manage user files for basic authentication
description:
- Add and remove username/password entries in a password file using htpasswd.
diff --git a/web_infrastructure/jboss b/web_infrastructure/jboss
index 94dc4bcd..c3d4becf 100644
--- a/web_infrastructure/jboss
+++ b/web_infrastructure/jboss
@@ -20,10 +20,10 @@
DOCUMENTATION = """
module: jboss
+version_added: "1.4"
short_description: deploy applications to JBoss
description:
- Deploy applications to JBoss standalone using the filesystem
-version_added: "1.4"
options:
deployment:
required: true