ccbfdec334
* excludes scenario guides from core docs, splits porting guides and roadmaps, symlinks indices to create index.html pages, and adds .gitignore entries for conf.py and the toplevel index.rst files generated by the docs build This solution builds three types of docs: * ansible-2.10 and earlier: all the docs. Handle this via `make webdocs ANSIBLE_VERSION=2.10` * ansible-3 and later: a subset of the docs for the ansible package. Handle this via `make webdocs ANSIBLE_VERSION=3` (change the ANSIBLE_VERSION to match the version being built for. * ansible-core: a subset of the docs for the ansible-core package. Handle this via `make coredocs`. * `make webdocs` now always builds all the collection docs * Use `make coredocs` to limit it to core plugins only * The user specifies the desired version. If no ANSIBLE_VERSION is specified, build plugins for the latest release of ansible Co-authored-by: Toshio Kuratomi <a.badger@gmail.com> Co-authored-by: Matt Clay <matt@mystile.com>
84 lines
3.7 KiB
ReStructuredText
84 lines
3.7 KiB
ReStructuredText
.. _ansible_core_documentation:
|
|
|
|
..
|
|
This is the index file for ansible-core. It gets symlinked to index.rst by the Makefile
|
|
|
|
**************************
|
|
Ansible Core Documentation
|
|
**************************
|
|
|
|
About ansible-core
|
|
===================
|
|
|
|
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.
|
|
|
|
You can learn more at `AnsibleFest <https://www.ansible.com/ansiblefest>`_, the annual event for all Ansible contributors, users, and customers hosted by Red Hat. AnsibleFest is the place to connect with others, learn new skills, and find a new friend to automate with.
|
|
|
|
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-core`` releases a new major release approximately twice a year. The core application evolves somewhat conservatively, valuing simplicity in language design and setup. Contributors develop and change modules and plugins, hosted in collections since version 2.10, much more quickly.
|
|
|
|
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
:caption: Installation, Upgrade & Configuration
|
|
|
|
installation_guide/index
|
|
porting_guides/core_porting_guides
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
:caption: Using Ansible Core
|
|
|
|
user_guide/index
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
:caption: Contributing to Ansible Core
|
|
|
|
community/index
|
|
|
|
.. toctree::
|
|
:maxdepth: 2
|
|
:caption: Extending Ansible
|
|
|
|
dev_guide/index
|
|
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
:caption: Reference & Appendices
|
|
|
|
collections/index
|
|
collections/all_plugins
|
|
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: Roadmaps
|
|
|
|
roadmap/ansible_base_roadmap_index.rst
|