9dda393d70
* Build documentation for Ansible-2.10 (formerly known as ACD).
Builds plugin docs from collections whose source is on galaxy
The new command downloads collections from galaxy, then finds the
plugins inside of them to get the documentation for those plugins.
* Update the python syntax checks
* docs builds can now require python 3.6+.
* Move plugin formatter code out to an external tool, antsibull-docs.
Collection owners want to be able to extract docs for their own
websites as well.
* The jinja2 filters, tests, and other support code have moved to antsibull
* Remove document_plugins as that has now been integrated into antsibull-docs
* Cleanup and bugfix to other build script code:
* The Commands class needed to have its metaclass set for abstractmethod
to work correctly
* Fix lint issues in some command plugins
* Add the docs/docsite/rst/collections to .gitignore as
everything in that directory will be generated so we don't want any of
it saved in the git repository
* gitignore the build dir and remove edit docs link on module pages
* Add docs/rst/collections as a directory to remove on make clean
* Split the collections docs from the main docs
* remove version and edit on github
* remove version banner for just collections
* clarify examples need collection keyword defined
* Remove references to plugin documentation locations that no longer exist.
* Perhaps the pages in plugins/*.rst should be deprecated
altogether and their content moved?
* If not, perhaps we want to rephrase and link into the collection
documentation?
* Or perhaps we want to link to the plugins which are present in
collections/ansible/builtin?
* Remove PYTHONPATH from the build-ansible calls
One of the design goals of the build-ansible.py script was for it to
automatically set its library path to include the checkout of ansible
and the library of code to implement itself. Because it automatically
includes the checkout of ansible, we don't need to set PYTHONPATH in
the Makefile any longer.
* Create a command to only build ansible-base plugin docs
* When building docs for devel, only build the ansible-base docs for
now. This is because antsibull needs support for building a "devel
tree" of docs. This can be changed once that is implemented
* When building docs for the sanity tests, only build the ansible-base
plugin docs for now. Those are the docs which are in this repo so
that seems appropriate for now.
105 lines
3.8 KiB
ReStructuredText
105 lines
3.8 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.
|
|
|
|
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.
|
|
|
|
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 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
|
|
|
|
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: Network Automation
|
|
|
|
network/getting_started/index
|
|
network/user_guide/index
|
|
network/dev_guide/index
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
:caption: Ansible Galaxy
|
|
|
|
galaxy/user_guide.rst
|
|
galaxy/dev_guide.rst
|
|
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
:caption: Reference & Appendices
|
|
|
|
collections/index
|
|
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
|
|
reference_appendices/automationhub
|
|
reference_appendices/logging
|
|
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
:caption: Release Notes
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
:caption: Roadmaps
|
|
|
|
roadmap/index.rst
|