community.general/docsite/rst/playbooks.rst

Playbooks
`````````

Playbooks are Ansible's configuration, deployment, and orchestration language.  They can describe a policy you want your remote systems to enforce, or a set of steps in a general IT process.

If Ansible modules are the tools in your workshop, playbooks are your instruction manuals, and your inventory of hosts are your raw material.

At a basic level, playbooks can be used to manage configurations of and deployments to remote machines.  At a more advanced level, they can sequence multi-tier rollouts involving rolling updates, and can delegate actions to other hosts, interacting with monitoring servers and load balancers along the way.  

While there's a lot of information here, there's no need to learn everything at once.  You can start small and pick up more features
over time as you need them.  

Playbooks are designed to be human-readable and are developed in a basic text language.  There are multiple
ways to organize playbooks and the files they include, and we'll offer up some suggestions on that and making the most out of Ansible.

It is recommended to look at `Example Playbooks <https://github.com/ansible/ansible-examples>`_ while reading along with the playbook documentation.  These illustrate best practices as well as how to put many of the various concepts together.

.. toctree::
   :maxdepth: 1

   playbooks_intro
   playbooks_roles
   playbooks_variables
   playbooks_filters
   playbooks_tests
   playbooks_conditionals
   playbooks_loops
   playbooks_blocks
   playbooks_strategies
   playbooks_best_practices
Reorg of the documentation tree such that the sidebar will be more correct. Some work yet to do on module docs. 2013-12-24 23:51:16 +01:00			`Playbooks`
			`````````
Add some 1.1 feature documentation 2013-02-23 20:34:29 +01:00
Reorg of the documentation tree such that the sidebar will be more correct. Some work yet to do on module docs. 2013-12-24 23:51:16 +01:00			`Playbooks are Ansible's configuration, deployment, and orchestration language. They can describe a policy you want your remote systems to enforce, or a set of steps in a general IT process.`
More anchors! 2013-10-05 00:41:14 +02:00
I think that is a better analogy. 2016-08-17 11:20:13 +02:00			`If Ansible modules are the tools in your workshop, playbooks are your instruction manuals, and your inventory of hosts are your raw material.`
Update docs 2012-03-09 13:42:53 +01:00
Reorg of the documentation tree such that the sidebar will be more correct. Some work yet to do on module docs. 2013-12-24 23:51:16 +01:00			`At a basic level, playbooks can be used to manage configurations of and deployments to remote machines. At a more advanced level, they can sequence multi-tier rollouts involving rolling updates, and can delegate actions to other hosts, interacting with monitoring servers and load balancers along the way.`
Minor playbooks doc tweaks. 2013-10-03 03:56:55 +02:00
Reorg of the documentation tree such that the sidebar will be more correct. Some work yet to do on module docs. 2013-12-24 23:51:16 +01:00			`While there's a lot of information here, there's no need to learn everything at once. You can start small and pick up more features`
			`over time as you need them.`
Updating docs, added extensive info on playbook async + external vars_files for keeping variables outside of the playbook file. 2012-03-13 04:12:21 +01:00
Reorg of the documentation tree such that the sidebar will be more correct. Some work yet to do on module docs. 2013-12-24 23:51:16 +01:00			`Playbooks are designed to be human-readable and are developed in a basic text language. There are multiple`
			`ways to organize playbooks and the files they include, and we'll offer up some suggestions on that and making the most out of Ansible.`
Updating docs, added extensive info on playbook async + external vars_files for keeping variables outside of the playbook file. 2012-03-13 04:12:21 +01:00
Reorg of the documentation tree such that the sidebar will be more correct. Some work yet to do on module docs. 2013-12-24 23:51:16 +01:00			It is recommended to look at `Example Playbooks <https://github.com/ansible/ansible-examples>`_ while reading along with the playbook documentation. These illustrate best practices as well as how to put many of the various concepts together.
Updating docs, added extensive info on playbook async + external vars_files for keeping variables outside of the playbook file. 2012-03-13 04:12:21 +01:00
Reorg of the documentation tree such that the sidebar will be more correct. Some work yet to do on module docs. 2013-12-24 23:51:16 +01:00			`.. toctree::`
			`:maxdepth: 1`
Update docs 2012-03-09 13:42:53 +01:00
Re-add the playbook introduction which was replaced earlier. 2013-12-25 00:51:46 +01:00			`playbooks_intro`
Reorg of the documentation tree such that the sidebar will be more correct. Some work yet to do on module docs. 2013-12-24 23:51:16 +01:00			`playbooks_roles`
			`playbooks_variables`
Add the playbook filters to a toctree 2015-03-07 06:02:10 +01:00			`playbooks_filters`
J2 test docs (#16646) * moved tests from filters to actual jinja2 tests also removed some unused declarations and imports * split tests into their own docs removed isnan as existing jinja2's 'number' already covers same added missing docs for several tests * updated as per feedback 2016-07-12 16:13:00 +02:00			`playbooks_tests`
Reorg of the documentation tree such that the sidebar will be more correct. Some work yet to do on module docs. 2013-12-24 23:51:16 +01:00			`playbooks_conditionals`
			`playbooks_loops`
moar docs added docs for new v2 features restructures modules bar and core/extras info into their own pages changed templates to refer to the new pages added some missing ansible.cfg options more info on gathering setting 2015-07-17 19:53:13 +02:00			`playbooks_blocks`
			`playbooks_strategies`
Reorg of the documentation tree such that the sidebar will be more correct. Some work yet to do on module docs. 2013-12-24 23:51:16 +01:00			`playbooks_best_practices`
Added docs on conditional import usage 2012-03-20 04:43:03 +01:00
Docs updates 2012-03-08 19:36:47 +01:00