374d4ecd98
* doc: avoid mix of single and double quotes (#70115) Avoid mix of single and double quotes in the `ternary`, this way we can copy/past the example without any surprise. (cherry picked from commitb491f776b9
) * document FQCN for M() and :seealso: in DOCUMENTATION blocks (#70245) * document FQCN for M() in DOCUMENTATION blocks * add note about c (cherry picked from commit83f6e4850b
) * Fix bullet points in intro_getting_started.rst. (#70365) The layout was jumbled due to issues with whitespace. (cherry picked from commitdc6f4b6502
) * Add steps for how to create changelog.rst for a collection (#70262) * Update docs/docsite/rst/dev_guide/developing_collections.rst * add steps to create changelogs, add sentence about not using the tool * add note for rerunning the command Co-authored-by: Felix Fontein <felix@fontein.de> (cherry picked from commit5a28b2b86c
) * ansible-doc: avoid problems with YAML anchors when formatting man page (#70045) * Avoid problems with YAML anchors when formatting man page. * Add changelog. (cherry picked from commit5e4f708241
) * Minor grammatical fix (#70405) 'you' -> 'your' (cherry picked from commita1ac595d42
) * incorporate minimalism feedback on filters page (#70366) Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com> (cherry picked from commitc89f3cda9e
) * more correct info about role main.yml (#70326) fixes #40496 (cherry picked from commit5d3d097de3
) * Fix a small typo in cache plugin description @ `config/base.yml` PR #70420 (cherry picked from commit626df08d9d
) * with_sequence: example using vars (#69369) Added an example for using vars in with_sequence. Fixes: #68836 Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com> (cherry picked from commit5709173c32
) * Update pull.py (#70393) (cherry picked from commit46ad3c1162
) * Update playbooks.rst (#70317) (cherry picked from commit7c90a2d2a6
) * Add documentation for ipaddr filters (#70343) (cherry picked from commit9eb904ea61
) * update platform table with links to collections (#70373) (cherry picked from commitaa59c23aed
) * Add description of collections and become_exe keywords (#68055) * Add description of collections keyword * Update based on feedback. - Add link to become plugins. - Add note about how the collections keyword works with roles. (cherry picked from commit5833af9e2a
) Co-authored-by: Gonéri Le Bouder <goneri@lebouder.net> Co-authored-by: Mark Sanders <ziplokk.mark.sanders@gmail.com> Co-authored-by: Felix Fontein <felix@fontein.de> Co-authored-by: Sir Mobus Gochfulshigan Dorphin Esquire XXIII <celestialtuba@gmail.com> Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com> Co-authored-by: Brian Coca <bcoca@users.noreply.github.com> Co-authored-by: Michael Scherer <mscherer@users.noreply.github.com> Co-authored-by: Abhijeet Kasurde <akasurde@redhat.com> Co-authored-by: Ethan <smithe2413@gmail.com> Co-authored-by: jafiala <56597272+jafiala@users.noreply.github.com> Co-authored-by: Baptiste Mille-Mathias <baptiste.millemathias@gmail.com> Co-authored-by: Sam Doran <sdoran@redhat.com>
34 lines
1.7 KiB
ReStructuredText
34 lines
1.7 KiB
ReStructuredText
.. _working_with_playbooks:
|
|
|
|
Working with 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.
|
|
|
|
You should 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: 2
|
|
|
|
playbooks_intro
|
|
playbooks_best_practices
|
|
playbooks_reuse
|
|
playbooks_reuse_roles
|
|
playbooks_variables
|
|
playbooks_vars_facts
|
|
playbooks_templating
|
|
playbooks_conditionals
|
|
playbooks_loops
|
|
playbooks_blocks
|
|
playbooks_special_topics
|
|
playbooks_strategies
|
|
guide_rolling_upgrade
|