ansible/examples/playbooks/intro_example.yml

---
# this is an annotated example of some features available in playbooks
# it shows how to make sure packages are updated, how to make sure
# services are running, and how to template files.  It also demos
# change handlers that can restart things (or trigger other actions)
# when resources change.  For more advanced examples, see example2.yml

# on all hosts, run as the user root...

- name: example play
  hosts: all
  user: root

# could have also have done:
#  user: mdehaan
#  sudo: yes

  # make these variables available inside of templates
  # for when we use the 'template' action/module later on...

  vars:
    http_port: 80
    max_clients: 200

  # define the tasks that are part of this play...

  tasks:

  # task #1 is to run an arbitrary command
  # we'll simulate a long running task, wait for up to 45 seconds, poll every 5
  # obviously this does nothing useful but you get the idea

  - name: longrunner
    action: command /bin/sleep 15
    async: 45
    poll: 5

  # let's demo file operations.
  #
  # We can 'copy' files or 'template' them instead, using jinja2
  # as the templating engine.  This is done using the variables
  # from the vars section above mixed in with variables bubbled up
  # automatically from tools like facter and ohai.  'copy'
  # works just like 'template' but does not do variable subsitution.
  #
  # If and only if the file changes, restart apache at the very
  # end of the playbook run

  - name: write some_random_foo configuration
    action: template src=templates/foo.j2 dest=/etc/some_random_foo.conf
    notify:
    - restart apache

  # make sure httpd is installed at the latest version

  - name: install httpd
    action: yum pkg=httpd state=latest

  # make sure httpd is running

  - name: httpd start
    action: service name=httpd state=running

  # handlers are only run when things change, at the very end of each
  # play.  Let's define some.  The names are significant and must
  # match the 'notify' sections above

  handlers:

    # this particular handler is run when some_random_foo.conf
    # is changed, and only then

    - name: restart apache
      action: service name=httpd state=restarted
Update man pages. Fix formatting in playbook example. Also, YAML documents by definition start with '---', so I have added this to the example and the manpage 2012-02-27 02:09:56 +00:00			`---`
Annotated playbook example 2012-03-13 22:55:04 +00:00			`# this is an annotated example of some features available in playbooks`
			`# it shows how to make sure packages are updated, how to make sure`
			`# services are running, and how to template files. It also demos`
			`# change handlers that can restart things (or trigger other actions)`
			`# when resources change. For more advanced examples, see example2.yml`

			`# on all hosts, run as the user root...`

Playbook can now take a 'name' which it will show when starting the play 2012-04-27 04:08:06 +00:00			`- name: example play`
			`hosts: all`
Add user to playbook example so it's clear that this is available 2012-03-03 16:02:14 +00:00			`user: root`
Annotated playbook example 2012-03-13 22:55:04 +00:00
Sudo support operational in both playbooks and main program. Implementation could use some cleanup. 2012-03-30 02:58:10 +00:00			`# could have also have done:`
			`# user: mdehaan`
Make use of yes/no booleans in playbooks At the moment Ansible prefers yes/no for module booleans, however booleans in playbooks are still using True/False, rather than yes/no. This changes modifies boolean uses in playbooks (and man pages) to favor yes/no rather than True/False. This change includes: - Adaptation of documentation and examples to favor yes/no - Modification to manpage output to favor yes/no (the docsite output already favors yes/no) 2012-12-14 10:56:53 +00:00			`# sudo: yes`
Sudo support operational in both playbooks and main program. Implementation could use some cleanup. 2012-03-30 02:58:10 +00:00
Annotated playbook example 2012-03-13 22:55:04 +00:00			`# make these variables available inside of templates`
			`# for when we use the 'template' action/module later on...`

Factoids and push variables via setup are now available to be templated in command args as well as template files. PLUS, variables are now expressed in playbooks without having to know about the setup task, which means playbooks are simpler to read now. 2012-03-06 01:09:03 +00:00			`vars:`
			`http_port: 80`
			`max_clients: 200`
Annotated playbook example 2012-03-13 22:55:04 +00:00
			`# define the tasks that are part of this play...`

We don't have modules that list when things change just yet. I plan to handle this by having a changed=True/False in the JSON for these modules. Added a note so folks won't think we can only execute shell :) 2012-02-24 04:54:16 +00:00			`tasks:`
Annotated playbook example 2012-03-13 22:55:04 +00:00
			`# task #1 is to run an arbitrary command`
			`# we'll simulate a long running task, wait for up to 45 seconds, poll every 5`
			`# obviously this does nothing useful but you get the idea`

			`- name: longrunner`
This adds async poll support to playbooks. See examples. Some more testing due + docs but this is more or less a mirror of what /bin/ansible does. It also has a 'fire and forget' mode if the poll interval is left off or set to 0. 2012-03-13 00:53:10 +00:00			`action: command /bin/sleep 15`
			`async: 45`
			`poll: 5`
Annotated playbook example 2012-03-13 22:55:04 +00:00
			`# let's demo file operations.`
			`#`
			`# We can 'copy' files or 'template' them instead, using jinja2`
whitespace 2012-08-07 00:00:31 +00:00			`# as the templating engine. This is done using the variables`
			`# from the vars section above mixed in with variables bubbled up`
			`# automatically from tools like facter and ohai. 'copy'`
Annotated playbook example 2012-03-13 22:55:04 +00:00			`# works just like 'template' but does not do variable subsitution.`
			`#`
			`# If and only if the file changes, restart apache at the very`
			`# end of the playbook run`

			`- name: write some_random_foo configuration`
restructure the examples directory 2012-03-13 23:27:13 +00:00			`action: template src=templates/foo.j2 dest=/etc/some_random_foo.conf`
Notifable handlers only run when something is changed. Awesome. 2012-02-25 19:42:41 +00:00			`notify:`
			`- restart apache`
Annotated playbook example 2012-03-13 22:55:04 +00:00
			`# make sure httpd is installed at the latest version`

			`- name: install httpd`
			`action: yum pkg=httpd state=latest`

			`# make sure httpd is running`

			`- name: httpd start`
Update example to use correct service state; minor pep8 indent/spacing fixes 2012-03-16 03:10:03 +00:00			`action: service name=httpd state=running`
Annotated playbook example 2012-03-13 22:55:04 +00:00
			`# handlers are only run when things change, at the very end of each`
			`# play. Let's define some. The names are significant and must`
			`# match the 'notify' sections above`

Notifable handlers only run when something is changed. Awesome. 2012-02-25 19:42:41 +00:00			`handlers:`
Annotated playbook example 2012-03-13 22:55:04 +00:00
			`# this particular handler is run when some_random_foo.conf`
			`# is changed, and only then`

			`- name: restart apache`
restructure the examples directory 2012-03-13 23:27:13 +00:00			`action: service name=httpd state=restarted`
Annotated playbook example 2012-03-13 22:55:04 +00:00