da15cf1f54
Generate rst docs for plugins Based on rst generated for modules. But generated plugin docs go into docs/docsite/rst/plugins/$PLUGIN_TYPE/plugin_name.rst ( docs/docsite/rst/plugins/connection/ssh.py for ex) * move plugins docs to rst/*_plugins/ subdirs for namespace * Only gen support pages for modules for now. * Add generated plugin docs to gitignore* add list_*_plugins templates * support MODULES/PLUGINS filters for make htmldocs Add a 'PLUGINS=ssh' filter env var like MODULES to filter plugins to build docs for. * fixup 'historical' version_added, skip plugins/loader.py * Fix plugins_by_support ref link to new plugins/*/ location * use :ref: for common_return_values, allow empty version_added * warnings on missing doc info * add a prefix to _random_choice It was colliding with the target for random_choice plugin
49 lines
2.4 KiB
ReStructuredText
49 lines
2.4 KiB
ReStructuredText
Ansible Documentation
|
|
=====================
|
|
|
|
About Ansible
|
|
`````````````
|
|
|
|
Welcome to the Ansible documentation!
|
|
|
|
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.
|
|
|
|
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 an accelerated socket mode and pull modes as alternatives), and a language that is designed around auditability by humans--even those not familiar with the program.
|
|
|
|
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.
|
|
|
|
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.
|
|
|
|
This documentation covers the current released version of Ansible (2.3) and also some development version features (2.4). For recent features, we note in each section the version of Ansible where the feature was added.
|
|
|
|
Ansible, Inc. releases a new major release of Ansible approximately every two months. 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, typically adding 20 or so new modules in each release.
|
|
|
|
.. _an_introduction:
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
intro
|
|
quickstart
|
|
playbooks
|
|
playbooks_special_topics
|
|
modules
|
|
modules_by_category
|
|
vault
|
|
command_line_tools
|
|
plugins_by_category
|
|
guides
|
|
dev_guide/index
|
|
tower
|
|
community
|
|
galaxy
|
|
test_strategies
|
|
faq
|
|
config
|
|
glossary
|
|
YAMLSyntax
|
|
porting_guides
|
|
python_3_support
|
|
release_and_maintenance
|