You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
ansible/docs/docsite/rst/index.rst

103 lines
3.7 KiB
ReStructuredText

.. _ansible_documentation:
Ansible Documentation
=====================
About Ansible
`````````````
Ansible is an IT automation tool. It can configure systems, deploy software, and orchestrate more advanced IT tasks such as continuous deployments or zero downtime rolling updates.
12 years ago
7 years ago
Ansible's main goals are simplicity and ease-of-use. It also has a strong focus on security and reliability, featuring a minimum of moving parts, usage of OpenSSH for transport (with other transports and pull modes as alternatives), and a language that is designed around auditability by humans--even those not familiar with the program.
10 years ago
We believe simplicity is relevant to all sizes of environments, so we design for busy users of all types: developers, sysadmins, release engineers, IT managers, and everyone in between. Ansible is appropriate for managing all environments, from small setups with a handful of instances to enterprise environments with many thousands of instances.
10 years ago
Ansible manages machines in an agent-less manner. There is never a question of how to
upgrade remote daemons or the problem of not being able to manage systems because daemons are uninstalled. Because OpenSSH is one of the most peer-reviewed open source components, security exposure is greatly reduced. Ansible is decentralized--it relies on your existing OS credentials to control access to remote machines. If needed, Ansible can easily connect with Kerberos, LDAP, and other centralized authentication management systems.
12 years ago
This documentation covers the version of Ansible noted in the upper left corner of this page. We maintain multiple versions of Ansible and of the documentation, so please be sure you are using the version of the documentation that covers the version of Ansible you're using. For recent features, we note the version of Ansible where the feature was added.
Ansible releases a new major release of Ansible approximately three to four times per year. The core application evolves somewhat conservatively, valuing simplicity in language design and setup. However, the community around new modules and plugins being developed and contributed moves very quickly, adding many new modules in each release.
.. toctree::
:maxdepth: 2
:caption: Installation, Upgrade & Configuration
installation_guide/index
porting_guides/porting_guides
.. toctree::
:maxdepth: 2
:caption: Using Ansible
user_guide/index
.. toctree::
:maxdepth: 2
:caption: Contributing to Ansible
12 years ago
community/index
.. toctree::
:maxdepth: 2
:caption: Extending Ansible
dev_guide/index
.. toctree::
:glob:
:maxdepth: 1
:caption: Common Ansible Scenarios
scenario_guides/cloud_guides
scenario_guides/network_guides
scenario_guides/virt_guides
.. toctree::
:maxdepth: 2
:caption: Ansible for Network Automation
network/index
Backport/2.9/docs2 (#63524) * Update sros_config.py (#63132) (cherry picked from commit b3deab4319fe1e793d36307093e1639a49c28175) * add note about collection links (#63346) (cherry picked from commit bdd0fac606265f92e6521540106accf19a1ae4d0) * Nosh module documentation update (#63303) * detail the 'status' dictionary * did not add individual descriptions, see nosh documentation for those * sample: False not being rendered unless 'False' is quoted (cherry picked from commit df283788e562470741ebed15dc4374190316c352) * Move galaxy appendix info to a new Galaxy section (#63356) * start galaxy docs restructure * shared snippets in txt files * moved all content to galaxy section (cherry picked from commit ae265bc5464a89935bfe1be6af050b94e09b6eb9) * Enter should be Italics as it is a menu option (#63441) (cherry picked from commit 7a8c9098763a2b6a30d54d69aa94b2ecf1ee516d) * ini_file: remove incorrect documentation (#63394) (cherry picked from commit ab249a469eaa9cb27c3f17813a60fe23ee2d7315) * Changed with_items to loop in VMware example (#63022) (cherry picked from commit 876a2d57be5683ab5cfa90268a4712187c092fdb) * ovirt update fetch_nested param doc (#63191) (cherry picked from commit 0beab6bf699fc014aeb7bb74af7a692b2e7d462f) * Update 'delete' parameter description in synchronize module (#63450) Co-Authored-By: Abhijeet Kasurde <akasurde@redhat.com> (cherry picked from commit da46800f1b0576a4a2cc5d6ca20b24efe58ea3d7) * Update unarchive.py - Further clarify extra_opts (#58102) Update the description in the options to help assist with what the module is looking for in the extra_opts. #31873 alone is not enough since if you are not familiar with the option given in the example it may not be obvious that both elements are part of the same option instead of being two different options. Co-Authored-By: Alicia Cozine <879121+acozine@users.noreply.github.com> (cherry picked from commit e967060b9f64dffdf4b7febb27f64dd3a411f59b) * ovirt_vm add warning about next run configuration (#63458) (cherry picked from commit 16e49fdd44134356323d10207715f7943ef0f44f) * Fix doc - porting_guide_2.8 value example (#63493) (cherry picked from commit e0f67b58ce85b3fbb5930e19ad76d27834cf6c34) * Fix warnings for ufw examples (#63505) (cherry picked from commit e4eea0510cd89124c3a20f4d9937e7c015a46597)
5 years ago
.. toctree::
:maxdepth: 2
:caption: Ansible Galaxy
Backport/2.9/docs (#64073) * clarify no subfolders and md only for collections /docs folder (#63808) (cherry picked from commit 6a2902c8d55f366bd577436effa2426b04ce65ee) * Fixed example error in windows_winrm user guide (#63922) The example code to configure TLS 1.2 Support using Ansible had an indention error. The register variable 'enable_tls12' was not indented. This caused the subsequent task to fail since the variable was not registered. (cherry picked from commit c562e17659abefce44a5e64fd798e6000b84a6f7) * Fix doc errors in AWS modules (#63851) * Fix register/debug in aws_batch_compute_environment * Fix aws_batch_job_queue doc errors * Fix module naming: `batch_job_queue` > `aws_batch_job_queue` * Fix missing register * Update debug task to use modern YAML format * Fix missing register + debug for lambda_policy * Fix YAML syntax for elb_application_lb_info module (cherry picked from commit e4f16368ed8060dd7a15a0078b4a21fb86d85baf) * Update documentation for package module (#63909) It is not clear from the documentation that list can be used (cherry picked from commit 7f2c367d78c1773e5e908e31196fd07a698db9ee) * [ec2_launch_template] Update description of state param (#63147) Currently, it is not possible to delete specific versions of an ec2 launch template. The module docs incorrectly suggest that there is a `version` param to the module that can be used to do that. This patch aims to correct that error. (cherry picked from commit 7ea72607534ce996c311c17ee4c6aaf83989ae9e) * template: Add a space in example block (#63930) (cherry picked from commit f279715c29530c9148616a5c3fa5af846586cb18) * revisions to docsite README (#63957) (cherry picked from commit 5c962ef859b37ac3a9707a3e1ac88f4b34b78038) * combine galaxy.com install roles details (#63486) (cherry picked from commit ee8a0882054b7f633cd8bc075ffc61b8eb136d4b) * Correct a typo (#64020) (cherry picked from commit 18f4f0549faabefbd0457cde0dd86b0d0fed406b) * Update password.py (#63965) Update the examples of the password lookup plugin to show how multiple options are joined together. (cherry picked from commit 92daec5d0bce5dfbb73fda52910de2a74d59fa7e) * Fix indentation of example (#63789) Remove no_log since module_defaults aren't displayed like set_fact was (cherry picked from commit 1e52782d6ba6e3e2c9d140ec47558c034f0d394f) * add newline to render table correctly (#63769) (cherry picked from commit 1aee11c86026e8493ce9acba30175fadcd6dc70f) * clarified some points on environment keyword usage (#64065) (cherry picked from commit 885ee62b53247bc0985bfb12a39149d7ab9d3f2d)
5 years ago
galaxy/user_guide.rst
galaxy/dev_guide.rst
Backport/2.9/docs2 (#63524) * Update sros_config.py (#63132) (cherry picked from commit b3deab4319fe1e793d36307093e1639a49c28175) * add note about collection links (#63346) (cherry picked from commit bdd0fac606265f92e6521540106accf19a1ae4d0) * Nosh module documentation update (#63303) * detail the 'status' dictionary * did not add individual descriptions, see nosh documentation for those * sample: False not being rendered unless 'False' is quoted (cherry picked from commit df283788e562470741ebed15dc4374190316c352) * Move galaxy appendix info to a new Galaxy section (#63356) * start galaxy docs restructure * shared snippets in txt files * moved all content to galaxy section (cherry picked from commit ae265bc5464a89935bfe1be6af050b94e09b6eb9) * Enter should be Italics as it is a menu option (#63441) (cherry picked from commit 7a8c9098763a2b6a30d54d69aa94b2ecf1ee516d) * ini_file: remove incorrect documentation (#63394) (cherry picked from commit ab249a469eaa9cb27c3f17813a60fe23ee2d7315) * Changed with_items to loop in VMware example (#63022) (cherry picked from commit 876a2d57be5683ab5cfa90268a4712187c092fdb) * ovirt update fetch_nested param doc (#63191) (cherry picked from commit 0beab6bf699fc014aeb7bb74af7a692b2e7d462f) * Update 'delete' parameter description in synchronize module (#63450) Co-Authored-By: Abhijeet Kasurde <akasurde@redhat.com> (cherry picked from commit da46800f1b0576a4a2cc5d6ca20b24efe58ea3d7) * Update unarchive.py - Further clarify extra_opts (#58102) Update the description in the options to help assist with what the module is looking for in the extra_opts. #31873 alone is not enough since if you are not familiar with the option given in the example it may not be obvious that both elements are part of the same option instead of being two different options. Co-Authored-By: Alicia Cozine <879121+acozine@users.noreply.github.com> (cherry picked from commit e967060b9f64dffdf4b7febb27f64dd3a411f59b) * ovirt_vm add warning about next run configuration (#63458) (cherry picked from commit 16e49fdd44134356323d10207715f7943ef0f44f) * Fix doc - porting_guide_2.8 value example (#63493) (cherry picked from commit e0f67b58ce85b3fbb5930e19ad76d27834cf6c34) * Fix warnings for ufw examples (#63505) (cherry picked from commit e4eea0510cd89124c3a20f4d9937e7c015a46597)
5 years ago
.. toctree::
:maxdepth: 1
:caption: Reference & Appendices
../modules/modules_by_category
reference_appendices/playbooks_keywords
reference_appendices/common_return_values
reference_appendices/config
reference_appendices/general_precedence
reference_appendices/YAMLSyntax
reference_appendices/python_3_support
reference_appendices/interpreter_discovery
reference_appendices/release_and_maintenance
reference_appendices/test_strategies
dev_guide/testing/sanity/index
reference_appendices/faq
reference_appendices/glossary
reference_appendices/module_utils
reference_appendices/special_variables
reference_appendices/tower
Backport/2.9/docs3 (#63251) * Fixing typo mistake in testbed with section. Deploy template from content library is supported from 67U3 (cherry picked from commit c6c13b56260565dd0ae6cfdbfad3c4191e2a0a5d) * Typo fix in mssql_db (#63184) Changed from 'then' to 'than' (cherry picked from commit b5cc0872e713826c85bdde04e5443be6dca94ebf) * VMware: Update maintenance notes on vmware_cfg_backup (#62853) Maintenance mode seems only to be required for load or restet, not for save_configuration. (cherry picked from commit e977e0af741f55520e3671addcdc433a7792be67) * Misc typo in nxos_config documentation (#62629) * Changed 'exit' to 'exist' * Removed unnecessary word 'first' (cherry picked from commit 0554b50eedae4e8a70fcc2e69d0297c4f5439b7f) * postgresql: add elements for list params to the module's documentation (#63186) (cherry picked from commit 8a37a2440ecbf8407b28b19db2d3c987a367051b) * mysql: add elements for list params to the modules' documentation (#63187) (cherry picked from commit 30c2d21f17832266bb2ba140c6ea530167845098) * Add spaces around {{ indicators. (#63125) The example looked a little less readable by not having spaces after `{{` and before `}}`. This commit should make the examples match [ansible-lint rule 206](https://github.com/ansible/ansible-lint/blob/master/lib/ansiblelint/rules/VariableHasSpacesRule.py) (cherry picked from commit b7a9d99cefe15b248ebc11162529d16babd28d7f) * fix typo in collection/plugins/readme (#63162) (cherry picked from commit da1a9450885bc51b0268b7ec7c0830e35e71583e) * Docs: User guide overhaul, part 1 (#63056) (cherry picked from commit 941a9b68fc262182172e081533e43ccbf60c453f)
5 years ago
reference_appendices/logging
.. toctree::
:maxdepth: 2
:caption: Release Notes
.. toctree::
:maxdepth: 2
:caption: Roadmaps
roadmap/index.rst