From 30d641094b10a1a31eac9b52638429a32df530f6 Mon Sep 17 00:00:00 2001 From: Jan-Piet Mens Date: Mon, 17 Jun 2013 08:53:46 +0200 Subject: [PATCH] Docs: consistently format playbook EXAMPLES --- library/cloud/ec2 | 6 +++--- library/cloud/ec2_vol | 6 +++--- library/cloud/quantum_floating_ip_associate | 2 +- library/cloud/quantum_router | 2 +- library/cloud/quantum_router_interface | 7 +++++-- library/cloud/rax | 4 ++-- library/cloud/virt | 5 ++++- library/commands/shell | 3 ++- library/database/postgresql_privs | 18 +++++++++--------- library/files/fetch | 8 ++++---- library/inventory/add_host | 6 ++++-- library/messaging/rabbitmq_parameter | 5 ++++- library/monitoring/airbrake_deployment | 5 ++++- library/monitoring/newrelic_deployment | 5 ++++- library/monitoring/pagerduty | 16 +++++++++++++--- library/monitoring/pingdom | 12 ++++++++++-- library/network/get_url | 2 +- library/network/uri | 10 +++++----- library/notification/campfire | 4 ++-- library/notification/flowdock | 15 ++++++++++++--- library/notification/hipchat | 2 +- library/notification/irc | 12 ++++++------ library/notification/jabber | 17 ++++++++++++++--- library/notification/mail | 2 +- library/notification/mqtt | 2 +- library/notification/osx_say | 2 +- library/packaging/gem | 6 +++--- library/packaging/homebrew | 8 ++++---- library/packaging/rhn_register | 6 +++--- library/utilities/debug | 6 +++--- 30 files changed, 130 insertions(+), 74 deletions(-) diff --git a/library/cloud/ec2 b/library/cloud/ec2 index 90dcd833b39..e8d6b73ea62 100644 --- a/library/cloud/ec2 +++ b/library/cloud/ec2 @@ -162,7 +162,7 @@ author: Seth Vidal, Tim Gerla, Lester Wade EXAMPLES = ''' # Basic provisioning example -local_action: +- local_action: module: ec2 keypair: mykey instance_type: c1.medium @@ -172,7 +172,7 @@ local_action: count: 3 # Advanced example with tagging and CloudWatch -local_action: +- local_action: module: ec2 keypair: mykey group: databases @@ -184,7 +184,7 @@ local_action: instance_tags: '{"db":"postgres"}' monitoring=yes' # VPC example -local_action: +- local_action: module: ec2 keypair: mykey group_id: sg-1dc53f72 diff --git a/library/cloud/ec2_vol b/library/cloud/ec2_vol index 349863ff7dc..bc9b9b94e72 100644 --- a/library/cloud/ec2_vol +++ b/library/cloud/ec2_vol @@ -58,21 +58,21 @@ author: Lester Wade EXAMPLES = ''' # Simple attachment action -local_action: +- local_action: module: ec2_vol instance: XXXXXX volume_size: 5 device_name: sdd # Playbook example combined with instance launch -local_action: +- local_action: module: ec2 keypair: $keypair image: $image wait: yes count: 3 register: ec2 -local_action: +- local_action: module: ec2_vol instance: ${item.id} volume_size: 5 diff --git a/library/cloud/quantum_floating_ip_associate b/library/cloud/quantum_floating_ip_associate index 9884aa725ee..7ea40c15da2 100644 --- a/library/cloud/quantum_floating_ip_associate +++ b/library/cloud/quantum_floating_ip_associate @@ -76,7 +76,7 @@ requirements: ["quantumclient", "keystoneclient"] EXAMPLES = ''' # Associate a specific floating IP with an Instance -quantum_floating_ip_associate: +- quantum_floating_ip_associate: state=present login_username=admin login_password=admin diff --git a/library/cloud/quantum_router b/library/cloud/quantum_router index 74df17d2906..3e7409009be 100644 --- a/library/cloud/quantum_router +++ b/library/cloud/quantum_router @@ -79,7 +79,7 @@ requirements: ["quantumclient", "keystoneclient"] EXAMPLES = ''' # Creates a router for tenant admin -quantum_router: state=present +- quantum_router: state=present login_username=admin login_password=admin login_tenant_name=admin diff --git a/library/cloud/quantum_router_interface b/library/cloud/quantum_router_interface index 7e7a95d91b2..dfc01e2928e 100644 --- a/library/cloud/quantum_router_interface +++ b/library/cloud/quantum_router_interface @@ -79,8 +79,11 @@ requirements: ["quantumclient", "keystoneclient"] EXAMPLES = ''' # Attach tenant1's subnet to the external router - quantum_router_interface: state=present login_username=admin - login_password=admin login_tenant_name=admin - tenant_name=tenant1 router_name=external_route subnet_name=t1subnet + login_password=admin + login_tenant_name=admin + tenant_name=tenant1 + router_name=external_route + subnet_name=t1subnet ''' diff --git a/library/cloud/rax b/library/cloud/rax index 24dd9670330..f2ffec48651 100644 --- a/library/cloud/rax +++ b/library/cloud/rax @@ -83,8 +83,8 @@ notes: ''' EXAMPLES = ''' -- name: Create a server - local_action: +# Create a server +- local_action: module: rax creds_file: ~/.raxpub service: cloudservers diff --git a/library/cloud/virt b/library/cloud/virt index 792be96a2b3..69dcf055366 100644 --- a/library/cloud/virt +++ b/library/cloud/virt @@ -71,7 +71,10 @@ ansible host -m virt -a "name=alpha command=create uri=lxc:///" # a playbook example of defining and launching an LXC guest tasks: - name: define vm - virt: name=foo command=define xml="{{ lookup('template', 'container-template.xml.j2') }}" uri=lxc:/// + virt: name=foo + command=define + xml="{{ lookup('template', 'container-template.xml.j2') }}" + uri=lxc:/// - name: start vm virt: name=foo state=running uri=lxc:/// ''' diff --git a/library/commands/shell b/library/commands/shell index ff57b4d456f..5b3969a1fb1 100644 --- a/library/commands/shell +++ b/library/commands/shell @@ -45,6 +45,7 @@ author: Michael DeHaan ''' EXAMPLES = ''' -# Execute the command in remote shell; stdout goes to the specified file on the remote +# Execute the command in remote shell; stdout goes to the specified +# file on the remote - shell: somescript.sh >> somelog.txt ''' diff --git a/library/database/postgresql_privs b/library/database/postgresql_privs index 6ab7d08cbc4..89648acad8b 100644 --- a/library/database/postgresql_privs +++ b/library/database/postgresql_privs @@ -136,7 +136,7 @@ EXAMPLES = """ # On database "library": # GRANT SELECT, INSERT, UPDATE ON TABLE public.books, public.authors # TO librarian, reader WITH GRANT OPTION -postgresql_privs: > +- postgresql_privs: > database=library state=present privs=SELECT,INSERT,UPDATE @@ -147,7 +147,7 @@ postgresql_privs: > grant_option=yes # Same as above leveraging default values: -postgresql_privs: > +- postgresql_privs: > db=library privs=SELECT,INSERT,UPDATE objs=books,authors @@ -157,7 +157,7 @@ postgresql_privs: > # REVOKE GRANT OPTION FOR INSERT ON TABLE books FROM reader # Note that role "reader" will be *granted* INSERT privilege itself if this # isn't already the case (since state=present). -postgresql_privs: > +- postgresql_privs: > db=library state=present priv=INSERT @@ -167,7 +167,7 @@ postgresql_privs: > # REVOKE INSERT, UPDATE ON ALL TABLES IN SCHEMA public FROM reader # "public" is the default schema. This also works for PostgreSQL 8.x. -postgresql_privs: > +- postgresql_privs: > db=library state=absent privs=INSERT,UPDATE @@ -175,7 +175,7 @@ postgresql_privs: > role=reader # GRANT ALL PRIVILEGES ON SCHEMA public, math TO librarian -postgresql_privs: > +- postgresql_privs: > db=library privs=ALL type=schema @@ -184,7 +184,7 @@ postgresql_privs: > # GRANT ALL PRIVILEGES ON FUNCTION math.add(int, int) TO librarian, reader # Note the separation of arguments with colons. -postgresql_privs: > +- postgresql_privs: > db=library privs=ALL type=function @@ -195,7 +195,7 @@ postgresql_privs: > # GRANT librarian, reader TO alice, bob WITH ADMIN OPTION # Note that group role memberships apply cluster-wide and therefore are not # restricted to database "library" here. -postgresql_privs: > +- postgresql_privs: > db=library type=group objs=librarian,reader @@ -205,7 +205,7 @@ postgresql_privs: > # GRANT ALL PRIVILEGES ON DATABASE library TO librarian # Note that here "db=postgres" specifies the database to connect to, not the # database to grant privileges on (which is specified via the "objs" param) -postgresql_privs: > +- postgresql_privs: > db=postgres privs=ALL type=database @@ -215,7 +215,7 @@ postgresql_privs: > # GRANT ALL PRIVILEGES ON DATABASE library TO librarian # If objs is omitted for type "database", it defaults to the database # to which the connection is established -postgresql_privs: > +- postgresql_privs: > db=library privs=ALL type=database diff --git a/library/files/fetch b/library/files/fetch index 4e0eae51ca3..bc6ab3ab42d 100644 --- a/library/files/fetch +++ b/library/files/fetch @@ -47,14 +47,14 @@ author: Michael DeHaan EXAMPLES = ''' # Store file into /tmp/fetched/host.example.com/tmp/somefile -fetch: src=/tmp/somefile dest=/tmp/fetched +- fetch: src=/tmp/somefile dest=/tmp/fetched # Specifying a path directly -fetch: src=/tmp/somefile dest=/tmp/prefix-{{ ansible_hostname }} flat=yes +- fetch: src=/tmp/somefile dest=/tmp/prefix-{{ ansible_hostname }} flat=yes # Specifying a destination path -fetch: src=/tmp/uniquefile dest=/tmp/special/ flat=yes +- fetch: src=/tmp/uniquefile dest=/tmp/special/ flat=yes # Storing in a path relative to the playbook -fetch: src=/tmp/uniquefile dest=special/prefix-{{ ansible_hostname }} flat=yes +- fetch: src=/tmp/uniquefile dest=special/prefix-{{ ansible_hostname }} flat=yes ''' diff --git a/library/inventory/add_host b/library/inventory/add_host index 997c8b87d6f..c3085fcd31d 100644 --- a/library/inventory/add_host +++ b/library/inventory/add_host @@ -26,8 +26,10 @@ EXAMPLES = ''' - add_host: hostname=${ip_from_ec2} groups=just_created foo=42 # add a host with a non-standard port local to your machines -- add_host: hostname='${new_ip}:${new_port}' +- add_host: hostname='${new_ip}:${new_port}' # add a host alias that we reach through a tunnel -- add_host: hostname=${new_ip} ansible_ssh_host=${inventory_hostname} ansible_ssh_port=${new_port}' +- add_host: hostname=${new_ip} + ansible_ssh_host=${inventory_hostname} + ansible_ssh_port=${new_port}' ''' diff --git a/library/messaging/rabbitmq_parameter b/library/messaging/rabbitmq_parameter index fe0b2a4f685..e7d26d4c2fe 100644 --- a/library/messaging/rabbitmq_parameter +++ b/library/messaging/rabbitmq_parameter @@ -62,7 +62,10 @@ options: EXAMPLES = """ # Set the federation parameter 'local_username' to a value of 'guest' (in quotes) -rabbitmq_parameter: component=federation name=local-username value='"guest"' state=present +- rabbitmq_parameter: component=federation + name=local-username + value='"guest"' + state=present """ class RabbitMqParameter(object): diff --git a/library/monitoring/airbrake_deployment b/library/monitoring/airbrake_deployment index b9b82c2064f..8db1752a83a 100644 --- a/library/monitoring/airbrake_deployment +++ b/library/monitoring/airbrake_deployment @@ -53,7 +53,10 @@ requirements: [ urllib, urllib2 ] ''' EXAMPLES = ''' -action: airbrake_deployment token=AAAAAA environment='staging' user='ansible' revision=4.2 +- airbrake_deployment: token=AAAAAA + environment='staging' + user='ansible' + revision=4.2 ''' HAS_URLLIB = True diff --git a/library/monitoring/newrelic_deployment b/library/monitoring/newrelic_deployment index adfcb4ab259..b530b1f84fe 100644 --- a/library/monitoring/newrelic_deployment +++ b/library/monitoring/newrelic_deployment @@ -69,7 +69,10 @@ requirements: [ urllib, urllib2 ] ''' EXAMPLES = ''' -action: newrelic_deployment token=AAAAAA app_name=myapp user='ansible deployment' revision=1.0 +- newrelic_deployment: token=AAAAAA + app_name=myapp + user='ansible deployment' + revision=1.0 ''' HAS_URLLIB = True diff --git a/library/monitoring/pagerduty b/library/monitoring/pagerduty index 200d45b0491..4f79f65b4c1 100644 --- a/library/monitoring/pagerduty +++ b/library/monitoring/pagerduty @@ -66,13 +66,23 @@ notes: EXAMPLES=''' # List ongoing maintenance windows. -pagerduty: name=companyabc user=example@example.com passwd=password123 state=ongoing +- pagerduty: name=companyabc user=example@example.com passwd=password123 state=ongoing # Create a 1 hour maintenance window for service FOO123. -pagerduty: name=companyabc user=example@example.com passwd=password123 state=running service=FOO123" +- pagerduty: name=companyabc + user=example@example.com + passwd=password123 + state=running + service=FOO123 # Create a 4 hour maintenance window for service FOO123 with the description "deployment". -pagerduty: name=companyabc user=example@example.com passwd=password123 state=running service=FOO123 hours=4 desc=deployment" +- pagerduty: name=companyabc + user=example@example.com + passwd=password123 + state=running + service=FOO123 + hours=4 + desc=deployment ''' import json diff --git a/library/monitoring/pingdom b/library/monitoring/pingdom index 5e566e6dc4d..242304af809 100644 --- a/library/monitoring/pingdom +++ b/library/monitoring/pingdom @@ -52,10 +52,18 @@ notes: EXAMPLES = ''' # Pause the check with the ID of 12345. -pingdom: uid=example@example.com passwd=password123 key=apipassword123 checkid=12345 state=paused +- pingdom: uid=example@example.com + passwd=password123 + key=apipassword123 + checkid=12345 + state=paused # Unpause the check with the ID of 12345. -pingdom: uid=example@example.com passwd=password123 key=apipassword123 checkid=12345 state=running +- pingdom: uid=example@example.com + passwd=password123 + key=apipassword123 + checkid=12345 + state=running ''' import pingdom diff --git a/library/network/get_url b/library/network/get_url index 74e908f2a26..2f13dbec03e 100644 --- a/library/network/get_url +++ b/library/network/get_url @@ -81,7 +81,7 @@ author: Jan-Piet Mens ''' EXAMPLES=''' -get_url: url=http://example.com/path/file.conf dest=/etc/foo.conf mode=0440 +- get_url: url=http://example.com/path/file.conf dest=/etc/foo.conf mode=0440 ''' diff --git a/library/network/uri b/library/network/uri index 9b4477e8f52..5ab0f15d660 100644 --- a/library/network/uri +++ b/library/network/uri @@ -134,26 +134,26 @@ EXAMPLES = ''' - action: uri url=http://www.example.com return_content=yes register: webpage - action: fail +- action: fail when_string: '"AWESOME" not in "${webpage.content}"' # Create a JIRA issue. -action: > +- action: > uri url=https://your.jira.example.com/rest/api/2/issue/ method=POST user=your_username password=your_pass body='$FILE(issue.json)' force_basic_auth=yes status_code=201 HEADER_Content-Type="application/json" -action: > +- action: > uri url=https://your.form.based.auth.examle.com/index.php method=POST body="name=your_username&password=your_password&enter=Sign%20in" status_code=302 HEADER_Content-Type="application/x-www-form-urlencoded" -register: login + register: login # Login to a form based webpage, then use the returned cookie to # access the app in later tasks. -action: uri url=https://your.form.based.auth.example.com/dashboard.php +- action: uri url=https://your.form.based.auth.example.com/dashboard.php method=GET return_content=yes HEADER_Cookie="${login.set_cookie}" ''' diff --git a/library/notification/campfire b/library/notification/campfire index 348d9aa910a..a081a54ec59 100644 --- a/library/notification/campfire +++ b/library/notification/campfire @@ -43,9 +43,9 @@ author: Adam Garside ''' EXAMPLES = ''' -action: campfire subscription=foo token=12345 room=123 msg="Task completed." +- campfire: subscription=foo token=12345 room=123 msg="Task completed." -action: campfire subscription=foo token=12345 room=123 notify=loggins +- campfire: subscription=foo token=12345 room=123 notify=loggins msg="Task completed ... with feeling." ''' diff --git a/library/notification/flowdock b/library/notification/flowdock index 1d09660dd8c..f528e461398 100644 --- a/library/notification/flowdock +++ b/library/notification/flowdock @@ -82,9 +82,18 @@ requirements: [ urllib, urllib2 ] ''' EXAMPLES = ''' -action: flowdock type=inbox token=AAAAAA from_address=user@example.com source='my cool app' msg='test from ansible' subject='test subject' - -action: flowdock type=chat token=AAAAAA external_user_name=testuser msg='test from ansible' tags=tag1,tag2,tag3 +- flowdock: type=inbox + token=AAAAAA + from_address=user@example.com + source='my cool app' + msg='test from ansible' + subject='test subject' + +- flowdock: type=chat + token=AAAAAA + external_user_name=testuser + msg='test from ansible' + tags=tag1,tag2,tag3 ''' HAS_URLLIB = True diff --git a/library/notification/hipchat b/library/notification/hipchat index d19235567e8..79be892df78 100644 --- a/library/notification/hipchat +++ b/library/notification/hipchat @@ -53,7 +53,7 @@ author: WAKAYAMA Shirou ''' EXAMPLES = ''' -action: hipchat token=AAAAAA room=notify msg="Ansible task finished" +- hipchat: token=AAAAAA room=notify msg="Ansible task finished" ''' # =========================================== diff --git a/library/notification/irc b/library/notification/irc index 4dfd9b4fa7c..3e457cf4373 100644 --- a/library/notification/irc +++ b/library/notification/irc @@ -63,13 +63,13 @@ author: Jan-Piet Mens ''' EXAMPLES = ''' -action: irc server=irc.example.net channel="#t1" msg="Hello world" +- irc: server=irc.example.net channel="#t1" msg="Hello world" -local_action: irc port=6669 - channel="#t1" - msg="All finished at {{ ansible_date_time.iso8601 }}" - color=red - nick=ansibleIRC +- local_action: irc port=6669 + channel="#t1" + msg="All finished at {{ ansible_date_time.iso8601 }}" + color=red + nick=ansibleIRC ''' # =========================================== diff --git a/library/notification/jabber b/library/notification/jabber index 9f1552651a1..f0f6d2b5192 100644 --- a/library/notification/jabber +++ b/library/notification/jabber @@ -47,13 +47,24 @@ author: Brian Coca EXAMPLES = ''' # send a message to a user -jabber: user=mybot@chatserver.tld password=secret to=friend@chatserver.tld msg="Ansible task finished" +- jabber: user=mybot@example.net + password=secret + to=friend@example.net + msg="Ansible task finished" # send a message to a room -jabber: user=mybot@chatserver.tld password=secret to=mychaps@conference.chatserver.tld/ansiblebot msg="Ansible task finished" +- jabber: user=mybot@example.net + password=secret + to=mychaps@conference.example.net/ansiblebot + msg="Ansible task finished" # send a message, specifying the host and port -jabber user=mybot@chatserver.tld host=talk.chatserver.tld port=5223 password=secret to=mychaps@chatserver.tld msg="Ansible task finished" +- jabber user=mybot@example.net + host=talk.example.net + port=5223 + password=secret + to=mychaps@example.net + msg="Ansible task finished" ''' import os diff --git a/library/notification/mail b/library/notification/mail index 3fe344aa04d..b3d9dc794fe 100644 --- a/library/notification/mail +++ b/library/notification/mail @@ -103,7 +103,7 @@ options: EXAMPLES = ''' # Example playbook sending mail to root -local_action: mail msg='System ${ansible_hostname} has been sucessfully provisioned.' +- local_action: mail msg='System ${ansible_hostname} has been sucessfully provisioned.' # Send e-mail to a bunch of users, attaching files - local_action: mail diff --git a/library/notification/mqtt b/library/notification/mqtt index e30ed4c59c6..6c460c7bf24 100644 --- a/library/notification/mqtt +++ b/library/notification/mqtt @@ -85,7 +85,7 @@ author: Jan-Piet Mens ''' EXAMPLES = ''' -local_action: mqtt +- local_action: mqtt topic=service/ansible/{{ ansible_hostname }} payload="Hello at {{ ansible_date_time.iso8601 }}" qos=0 diff --git a/library/notification/osx_say b/library/notification/osx_say index 35f2246d455..6976de14db8 100644 --- a/library/notification/osx_say +++ b/library/notification/osx_say @@ -41,7 +41,7 @@ author: Michael DeHaan ''' EXAMPLES = ''' -local_action: osx_say msg="{{inventory_hostname}} is all done" voice=Zarvox +- local_action: osx_say msg="{{inventory_hostname}} is all done" voice=Zarvox ''' import subprocess diff --git a/library/packaging/gem b/library/packaging/gem index 04ea794a42f..b9621578859 100644 --- a/library/packaging/gem +++ b/library/packaging/gem @@ -60,13 +60,13 @@ author: Johan Wiren EXAMPLES = ''' # Installs version 1.0 of vagrant. -gem: name=vagrant version=1.0 state=present +- gem: name=vagrant version=1.0 state=present # Installs latest available version of rake. -gem: name=rake state=latest +- gem: name=rake state=latest # Installs rake version 1.0 from a local gem on disk. -gem: name=rake gem_source=/path/to/gems/rake-1.0.gem state=present +- gem: name=rake gem_source=/path/to/gems/rake-1.0.gem state=present ''' import re diff --git a/library/packaging/homebrew b/library/packaging/homebrew index 0c57064516b..add06d64b65 100644 --- a/library/packaging/homebrew +++ b/library/packaging/homebrew @@ -45,10 +45,10 @@ options: notes: [] ''' EXAMPLES = ''' -homebrew: name=foo state=present -homebrew: name=foo state=present update_homebrew=yes -homebrew: name=foo state=absent -homebrew: name=foo,bar state=absent +- homebrew: name=foo state=present +- homebrew: name=foo state=present update_homebrew=yes +- homebrew: name=foo state=absent +- homebrew: name=foo,bar state=absent ''' diff --git a/library/packaging/rhn_register b/library/packaging/rhn_register index 177f5b7d026..0e391a42664 100644 --- a/library/packaging/rhn_register +++ b/library/packaging/rhn_register @@ -48,13 +48,13 @@ options: EXAMPLES = ''' # Unregister system from RHN. -- code: rhn_register state=absent username=joe_user password=somepass +- rhn_register: state=absent username=joe_user password=somepass # Register as user (joe_user) with password (somepass) and auto-subscribe to available content. -- code: rhn_register state=present username=joe_user password=somepass +- rhn_register: state=present username=joe_user password=somepass # Register with activationkey (1-222333444) and enable extended update support. -- code: rhn_register state=present activationkey=1-222333444 enable_eus=true +- rhn_register: state=present activationkey=1-222333444 enable_eus=true # Register as user (joe_user) with password (somepass) against a satellite # server specified by (server_url). diff --git a/library/utilities/debug b/library/utilities/debug index 9d279d62916..12e930c7e31 100644 --- a/library/utilities/debug +++ b/library/utilities/debug @@ -48,11 +48,11 @@ author: Dag Wieers EXAMPLES = ''' # Example that prints the loopback address and gateway for each host -- action: debug msg="System $inventory_hostname has uuid $ansible_product_uuid" +- debug: msg="System $inventory_hostname has uuid $ansible_product_uuid" -- action: debug msg="System $inventory_hostname lacks a gateway" fail=yes +- debug: msg="System $inventory_hostname lacks a gateway" fail=yes only_if: "is_unset('${ansible_default_ipv4.gateway}')" -- action: debug msg="System $inventory_hostname has gateway ${ansible_default_ipv4.gateway}" +- debug: msg="System $inventory_hostname has gateway ${ansible_default_ipv4.gateway}" only_if: "is_set('${ansible_default_ipv4.gateway}')" '''