From f7c3975f21a0ac1fa33005c3834eb919c70775ff Mon Sep 17 00:00:00 2001 From: Michael DeHaan Date: Mon, 18 Nov 2013 18:55:49 -0500 Subject: [PATCH] Add version_added to all modules missing version_added information, the docs formatter will now raise errors when omitted, updated changelog with new modules. --- CHANGELOG.md | 9 +++++--- docs/man/man1/ansible-playbook.1 | 16 +++++++++---- docs/man/man1/ansible-pull.1 | 23 ++++++++++++++----- docs/man/man1/ansible.1 | 16 +++++++++---- hacking/module_formatter.py | 7 ++++++ library/cloud/docker | 1 + library/cloud/ec2_ami | 1 + library/cloud/ec2_group | 1 + library/cloud/gce | 1 + library/cloud/gce_lb | 1 + library/cloud/gce_net | 1 + library/cloud/gce_pd | 1 + library/cloud/glance_image | 1 + library/cloud/keystone_user | 1 + library/cloud/nova_compute | 1 + library/cloud/nova_keypair | 1 + library/cloud/quantum_floating_ip | 1 + library/cloud/quantum_floating_ip_associate | 1 + library/cloud/quantum_network | 1 + library/cloud/quantum_router | 1 + library/cloud/quantum_router_gateway | 1 + library/cloud/quantum_router_interface | 1 + library/cloud/quantum_subnet | 1 + library/commands/command | 1 + library/commands/raw | 1 + library/commands/script | 1 + library/database/postgresql_privs | 1 + library/files/copy | 1 + library/files/file | 1 + library/files/template | 1 + library/files/unarchive | 1 + library/net_infrastructure/arista_interface | 1 + library/net_infrastructure/arista_l2interface | 1 + library/net_infrastructure/arista_lag | 1 + library/net_infrastructure/arista_vlan | 1 + library/net_infrastructure/openvswitch_bridge | 1 + library/net_infrastructure/openvswitch_port | 1 + library/network/slurp | 1 + library/notification/{notify_grove => grove} | 15 ++++++------ library/notification/irc | 1 + library/packaging/yum | 1 + library/system/ping | 1 + library/system/setup | 1 + library/web_infrastructure/ejabberd_user | 1 + library/web_infrastructure/htpasswd | 1 + library/web_infrastructure/jboss | 2 +- 46 files changed, 99 insertions(+), 28 deletions(-) rename library/notification/{notify_grove => grove} (88%) diff --git a/CHANGELOG.md b/CHANGELOG.md index 472abddf8fe..a23d5c81e43 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -35,6 +35,7 @@ New modules and plugins. * cloud: docker - instantiates/removes/manages docker containers * cloud: ovirt -- VM lifecycle controls for ovirt * files: acl -- set or get acls on a file +* files: unarchive: pushes and extracts tarballs * system: firewalld -- manage the firewalld configuration * system: host -- manage `/etc/hosts` file entries * system: modprobe -- manage kernel modules on systems that support modprobe/rmmod @@ -49,9 +50,11 @@ New modules and plugins. * web_infrastructure: ejabberd_user: add and remove users to ejabberd * web_infrastructure: jboss: deploys or undeploys apps to jboss * source_control: github_hooks: manages GitHub service hooks -* network: bigip_monitor_tcp: manages F5 BIG-IP LTM TCP monitors -* network: bigip_pool_member: manages F5 BIG-IP LTM pool members -* network: bigip_node: manages F5 BIG-IP LTM nodes +* net_infrastructure: bigip_monitor_tcp: manages F5 BIG-IP LTM TCP monitors +* net_infrastructure: bigip_pool_member: manages F5 BIG-IP LTM pool members +* net_infrastructure: bigip_node: manages F5 BIG-IP LTM nodes +* net_infrastructure: openvswitch_port +* net_infrastructure: openvswitch_bridge Plugins: diff --git a/docs/man/man1/ansible-playbook.1 b/docs/man/man1/ansible-playbook.1 index 996d1c94487..c545ea4f9c2 100644 --- a/docs/man/man1/ansible-playbook.1 +++ b/docs/man/man1/ansible-playbook.1 @@ -1,13 +1,13 @@ '\" t .\" Title: ansible-playbook -.\" Author: [see the "AUTHOR" section] -.\" Generator: DocBook XSL Stylesheets v1.78.1 -.\" Date: 09/13/2013 +.\" Author: :doctype:manpage +.\" Generator: DocBook XSL Stylesheets v1.76.1 +.\" Date: 11/18/2013 .\" Manual: System administration commands .\" Source: Ansible 1.4 .\" Language: English .\" -.TH "ANSIBLE\-PLAYBOOK" "1" "09/13/2013" "Ansible 1\&.4" "System administration commands" +.TH "ANSIBLE\-PLAYBOOK" "1" "11/18/2013" "Ansible 1\&.4" "System administration commands" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -122,7 +122,7 @@ Connection timeout to use when trying to talk to hosts, in Force all plays to use sudo, even if not marked as such\&. .RE .PP -\fB\-u\fR \fIUSERNAME\fR, \fB\-\-remote\-user=\fR\fIUSERNAME\fR +\fB\-u\fR \fIUSERNAME\fR, \fB\-\-user=\fR\fIUSERNAME\fR .RS 4 Use this remote user name on playbook steps that do not indicate a user name to run as\&. .RE @@ -171,3 +171,9 @@ Ansible is released under the terms of the GPLv3 License\&. \fBansible\fR(1), \fBansible\-pull\fR(1), \fBansible\-doc\fR(1) .sp Extensive documentation as well as IRC and mailing list info is available on the ansible home page: https://ansible\&.github\&.com/ +.SH "AUTHOR" +.PP +\fB:doctype:manpage\fR +.RS 4 +Author. +.RE diff --git a/docs/man/man1/ansible-pull.1 b/docs/man/man1/ansible-pull.1 index 10e9fd40f2e..6ef143a8df3 100644 --- a/docs/man/man1/ansible-pull.1 +++ b/docs/man/man1/ansible-pull.1 @@ -1,13 +1,13 @@ '\" t .\" Title: ansible -.\" Author: [see the "AUTHOR" section] -.\" Generator: DocBook XSL Stylesheets v1.78.1 -.\" Date: 09/13/2013 +.\" Author: :doctype:manpage +.\" Generator: DocBook XSL Stylesheets v1.76.1 +.\" Date: 11/18/2013 .\" Manual: System administration commands .\" Source: Ansible 1.4 .\" Language: English .\" -.TH "ANSIBLE" "1" "09/13/2013" "Ansible 1\&.4" "System administration commands" +.TH "ANSIBLE" "1" "11/18/2013" "Ansible 1\&.4" "System administration commands" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -45,14 +45,14 @@ This is useful both for extreme scale\-out as well as periodic remediation\&. Us .PP \fBfilename\&.yml\fR .RS 4 -The name of one the YAML format files to run as an ansible playbook\&. This can be a relative path within the checkout\&. If not provided, ansible\-pull will look for a playbook based on the host\(cqs fully\-qualified domain name and finally a playbook named +The name of one the YAML format files to run as an ansible playbook\&. This can be a relative path within the checkout\&. If not provided, ansible\-pull will look for a playbook based on the host\(cqs fully\-qualified domain name, on the host hostname and finally a playbook named \fBlocal\&.yml\fR\&. .RE .SH "OPTIONS" .PP \fB\-d\fR \fIDEST\fR, \fB\-\-directory=\fR\fIDEST\fR .RS 4 -Directory to checkout repository into\&. +Directory to checkout repository into\&. If not provided, a subdirectory of ~/\&.ansible/pull/ will be used\&. .RE .PP \fB\-U\fR \fIURL\fR, \fB\-\-url=\fR\fIURL\fR @@ -65,6 +65,11 @@ URL of the playbook repository to checkout\&. Branch/Tag/Commit to checkout\&. If not provided, uses default behavior of module used to check out playbook repository\&. .RE .PP +\fB\-f\fR, \fB\-\-force\fR +.RS 4 +Force running of playbook even if unable to update playbook repository\&. This can be useful, for example, to enforce run\-time state when a network connection may not always be up or possible\&. +.RE +.PP \fB\-i\fR \fIPATH\fR, \fB\-\-inventory=\fR\fIPATH\fR .RS 4 The @@ -94,3 +99,9 @@ Ansible is released under the terms of the GPLv3 License\&. \fBansible\fR(1), \fBansible\-playbook\fR(1), \fBansible\-doc\fR(1) .sp Extensive documentation as well as IRC and mailing list info is available on the ansible home page: https://ansible\&.github\&.com/ +.SH "AUTHOR" +.PP +\fB:doctype:manpage\fR +.RS 4 +Author. +.RE diff --git a/docs/man/man1/ansible.1 b/docs/man/man1/ansible.1 index 5ca174e7f64..bf8d2701e4a 100644 --- a/docs/man/man1/ansible.1 +++ b/docs/man/man1/ansible.1 @@ -1,13 +1,13 @@ '\" t .\" Title: ansible -.\" Author: [see the "AUTHOR" section] -.\" Generator: DocBook XSL Stylesheets v1.78.1 -.\" Date: 09/13/2013 +.\" Author: :doctype:manpage +.\" Generator: DocBook XSL Stylesheets v1.76.1 +.\" Date: 11/18/2013 .\" Manual: System administration commands .\" Source: Ansible 1.4 .\" Language: English .\" -.TH "ANSIBLE" "1" "09/13/2013" "Ansible 1\&.4" "System administration commands" +.TH "ANSIBLE" "1" "11/18/2013" "Ansible 1\&.4" "System administration commands" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -136,7 +136,7 @@ seconds\&. Requires \fB\-B\fR\&. .RE .PP -\fB\-u\fR \fIUSERNAME\fR, \fB\-\-remote\-user=\fR\fIUSERNAME\fR +\fB\-u\fR \fIUSERNAME\fR, \fB\-\-user=\fR\fIUSERNAME\fR .RS 4 Use this remote \fIUSERNAME\fR @@ -206,3 +206,9 @@ Ansible is released under the terms of the GPLv3 License\&. \fBansible\-playbook\fR(1), \fBansible\-pull\fR(1), \fBansible\-doc\fR(1) .sp Extensive documentation as well as IRC and mailing list info is available on the ansible home page: https://ansible\&.github\&.com/ +.SH "AUTHOR" +.PP +\fB:doctype:manpage\fR +.RS 4 +Author. +.RE diff --git a/hacking/module_formatter.py b/hacking/module_formatter.py index 608b0f776e4..4e5f93fb812 100755 --- a/hacking/module_formatter.py +++ b/hacking/module_formatter.py @@ -362,6 +362,13 @@ def main(): if not doc is None: all_keys = [] + + if not 'version_added' in doc: + sys.stderr.write("*** ERROR: missing version_added in: %s ***\n" % module) + sys.exit(1) + if doc['version_added'] == 'historical': + del doc['version_added'] + for (k,v) in doc['options'].iteritems(): all_keys.append(k) all_keys = sorted(all_keys) diff --git a/library/cloud/docker b/library/cloud/docker index 286e6f1afe6..a7e635f79e1 100644 --- a/library/cloud/docker +++ b/library/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/library/cloud/ec2_ami b/library/cloud/ec2_ami index a4d8dbf6814..f849a2d38fd 100644 --- a/library/cloud/ec2_ami +++ b/library/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/library/cloud/ec2_group b/library/cloud/ec2_group index 0ece9647525..c325c1ce301 100644 --- a/library/cloud/ec2_group +++ b/library/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/library/cloud/gce b/library/cloud/gce index 90052e5bf43..d0eb474f8c7 100644 --- a/library/cloud/gce +++ b/library/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/library/cloud/gce_lb b/library/cloud/gce_lb index bc444a44f0e..21e142be185 100644 --- a/library/cloud/gce_lb +++ b/library/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/library/cloud/gce_net b/library/cloud/gce_net index 4728584dab5..b0954a2f8d5 100644 --- a/library/cloud/gce_net +++ b/library/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/library/cloud/gce_pd b/library/cloud/gce_pd index 245d1bb6644..0e125d260d2 100644 --- a/library/cloud/gce_pd +++ b/library/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/library/cloud/glance_image b/library/cloud/glance_image index 1060ffacbaa..d6ab5538473 100644 --- a/library/cloud/glance_image +++ b/library/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/library/cloud/keystone_user b/library/cloud/keystone_user index aa9ac100b29..4efe72ddc0c 100644 --- a/library/cloud/keystone_user +++ b/library/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/library/cloud/nova_compute b/library/cloud/nova_compute index 2a8437fa1a1..e6b550cd184 100644 --- a/library/cloud/nova_compute +++ b/library/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/library/cloud/nova_keypair b/library/cloud/nova_keypair index f9c449af529..3d332a03fc3 100644 --- a/library/cloud/nova_keypair +++ b/library/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/library/cloud/quantum_floating_ip b/library/cloud/quantum_floating_ip index 8b89a405a34..093787572c6 100644 --- a/library/cloud/quantum_floating_ip +++ b/library/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/library/cloud/quantum_floating_ip_associate b/library/cloud/quantum_floating_ip_associate index 7ea40c15da2..30b6224d947 100644 --- a/library/cloud/quantum_floating_ip_associate +++ b/library/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/library/cloud/quantum_network b/library/cloud/quantum_network index c0e901197ff..7d7504075d6 100644 --- a/library/cloud/quantum_network +++ b/library/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/library/cloud/quantum_router b/library/cloud/quantum_router index 3e7409009be..f1655ea8a04 100644 --- a/library/cloud/quantum_router +++ b/library/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/library/cloud/quantum_router_gateway b/library/cloud/quantum_router_gateway index 10cfe2a03c9..6238c6c1868 100644 --- a/library/cloud/quantum_router_gateway +++ b/library/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/library/cloud/quantum_router_interface b/library/cloud/quantum_router_interface index f85ac1a311b..4fa1f030313 100644 --- a/library/cloud/quantum_router_interface +++ b/library/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/library/cloud/quantum_subnet b/library/cloud/quantum_subnet index 941e21bdb43..24f89203815 100644 --- a/library/cloud/quantum_subnet +++ b/library/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/library/commands/command b/library/commands/command index 49c0155658e..707ec325a6b 100644 --- a/library/commands/command +++ b/library/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/library/commands/raw b/library/commands/raw index dc4c09d4258..87f2b5c4bdc 100644 --- a/library/commands/raw +++ b/library/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/library/commands/script b/library/commands/script index 00a1bced30a..143b2b25665 100644 --- a/library/commands/script +++ b/library/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/library/database/postgresql_privs b/library/database/postgresql_privs index adbad0209a0..bea203dd663 100644 --- a/library/database/postgresql_privs +++ b/library/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/library/files/copy b/library/files/copy index 99c3391083b..1146c95a53f 100644 --- a/library/files/copy +++ b/library/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/library/files/file b/library/files/file index cb81bf1ce11..d30e3716bf1 100644 --- a/library/files/file +++ b/library/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/library/files/template b/library/files/template index 2b1b4641310..35ac831e181 100644 --- a/library/files/template +++ b/library/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/library/files/unarchive b/library/files/unarchive index 5fb7de13425..17999d30ce5 100644 --- a/library/files/unarchive +++ b/library/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/library/net_infrastructure/arista_interface b/library/net_infrastructure/arista_interface index c5ab653bb85..56807cb0c41 100644 --- a/library/net_infrastructure/arista_interface +++ b/library/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/library/net_infrastructure/arista_l2interface b/library/net_infrastructure/arista_l2interface index 1f36925c485..5c26e47c0b6 100644 --- a/library/net_infrastructure/arista_l2interface +++ b/library/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/library/net_infrastructure/arista_lag b/library/net_infrastructure/arista_lag index d3995bd8ac6..a07caa423c4 100644 --- a/library/net_infrastructure/arista_lag +++ b/library/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/library/net_infrastructure/arista_vlan b/library/net_infrastructure/arista_vlan index a9a1627f41e..b6346984f45 100644 --- a/library/net_infrastructure/arista_vlan +++ b/library/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/library/net_infrastructure/openvswitch_bridge b/library/net_infrastructure/openvswitch_bridge index 7d9824c54bb..82a2d3fef82 100644 --- a/library/net_infrastructure/openvswitch_bridge +++ b/library/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/library/net_infrastructure/openvswitch_port b/library/net_infrastructure/openvswitch_port index bfa7a9caa45..3fe0c4e397c 100644 --- a/library/net_infrastructure/openvswitch_port +++ b/library/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/library/network/slurp b/library/network/slurp index 1f9975fda05..6661f9db326 100644 --- a/library/network/slurp +++ b/library/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/library/notification/notify_grove b/library/notification/grove similarity index 88% rename from library/notification/notify_grove rename to library/notification/grove index 8e0e6fe70c2..5b08852314b 100644 --- a/library/notification/notify_grove +++ b/library/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 ''' 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/library/notification/irc b/library/notification/irc index 6d209bf2d27..039b627499b 100644 --- a/library/notification/irc +++ b/library/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/library/packaging/yum b/library/packaging/yum index cc801564cfc..536c7e50405 100644 --- a/library/packaging/yum +++ b/library/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/library/system/ping b/library/system/ping index ef76d39da2c..4bda3971504 100644 --- a/library/system/ping +++ b/library/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/library/system/setup b/library/system/setup index 3f8250fa742..7b0fd70e80b 100755 --- a/library/system/setup +++ b/library/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/library/web_infrastructure/ejabberd_user b/library/web_infrastructure/ejabberd_user index d74ad57bb73..1fe15c7a454 100644 --- a/library/web_infrastructure/ejabberd_user +++ b/library/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/library/web_infrastructure/htpasswd b/library/web_infrastructure/htpasswd index 3de636d376f..0080c49fafa 100644 --- a/library/web_infrastructure/htpasswd +++ b/library/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/library/web_infrastructure/jboss b/library/web_infrastructure/jboss index 94dc4bcd85e..c3d4becf7b5 100644 --- a/library/web_infrastructure/jboss +++ b/library/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