7b91d298 |
|PyPI version| |Docs badge| |Chat badge| |Build Status| |Code Of Conduct| |Mailing Lists| |License| |
7afa34ae |
*******
Ansible
*******
Ansible is a radically simple IT automation system. It handles |
e6aff4dc |
configuration management, application deployment, cloud provisioning,
ad-hoc task execution, network automation, and multi-node orchestration. Ansible makes complex
changes like zero-downtime rolling updates with load balancers easy. More information on `the Ansible website <https://ansible.com/>`_. |
7afa34ae |
Design Principles
=================
|
72359a10 |
* Have a dead simple setup process and a minimal learning curve.
* Manage machines very quickly and in parallel. |
7afa34ae |
* Avoid custom-agents and additional open ports, be agentless by |
72359a10 |
leveraging the existing SSH daemon. |
7afa34ae |
* Describe infrastructure in a language that is both machine and human |
72359a10 |
friendly.
* Focus on security and easy auditability/review/rewriting of content. |
7afa34ae |
* Manage new remote machines instantly, without bootstrapping any |
72359a10 |
software.
* Allow module development in any dynamic language, not just Python.
* Be usable as non-root. |
7afa34ae |
* Be the easiest IT automation system to use, ever.
|
e6aff4dc |
Use Ansible
===========
You can install a released version of Ansible via ``pip``, a package manager, or
our `release repository <https://releases.ansible.com/ansible/>`_. See our
`installation guide <https://docs.ansible.com/ansible/latest/installation_guide/intro_installation.html>`_ for details on installing Ansible
on a variety of platforms.
Red Hat offers supported builds of `Ansible Engine <https://www.ansible.com/ansible-engine>`_.
Power users and developers can run the ``devel`` branch, which has the latest
features and fixes, directly. Although it is reasonably stable, you are more likely to encounter
breaking changes when running the ``devel`` branch. We recommend getting involved
in the Ansible community if you want to run the ``devel`` branch.
|
7afa34ae |
Get Involved
============
* Read `Community |
72359a10 |
Information <https://docs.ansible.com/ansible/latest/community>`_ for all |
7afa34ae |
kinds of ways to contribute to and interact with the project,
including mailing list information and how to submit bug reports and
code to Ansible. |
e6aff4dc |
* Join a `Working Group
<https://github.com/ansible/community/wiki>`_, an organized community devoted to a specific technology domain or platform. |
281cfcdd |
* Submit a proposed code update through a pull request to the ``devel`` branch. |
e6aff4dc |
* Talk to us before making larger changes |
72359a10 |
to avoid duplicate efforts. This not only helps everyone |
e6aff4dc |
know what is going on, it also helps save time and effort if we decide |
7afa34ae |
some changes are needed. |
e6aff4dc |
* For a list of email lists, IRC channels and Working Groups, see the |
72359a10 |
`Communication page <https://docs.ansible.com/ansible/latest/community/communication.html>`_ |
7afa34ae |
Branch Info
===========
|
e6aff4dc |
* The ``devel`` branch corresponds to the release actively under development.
* The ``stable-2.X`` branches correspond to stable releases. |
281cfcdd |
* Create a branch based on ``devel`` and set up a `dev environment <https://docs.ansible.com/ansible/latest/dev_guide/developing_modules_general.html#common-environment-setup>`_ if you want to open a PR.
* See the `Ansible release and maintenance <https://docs.ansible.com/ansible/latest/reference_appendices/release_and_maintenance.html>`_ page for information about active branches. |
7afa34ae |
|
e4edb284 |
Roadmap
=======
|
e6aff4dc |
Based on team and community feedback, an initial roadmap will be published for a major or minor version (ex: 2.7, 2.8). |
72359a10 |
The `Ansible Roadmap page <https://docs.ansible.com/ansible/devel/roadmap/>`_ details what is planned and how to influence the roadmap. |
e4edb284 |
|
7afa34ae |
Authors
=======
Ansible was created by `Michael DeHaan <https://github.com/mpdehaan>`_ |
e6aff4dc |
and has contributions from over 4000 users (and growing). Thanks everyone! |
7afa34ae |
|
4632ae4b |
`Ansible <https://www.ansible.com>`_ is sponsored by `Red Hat, Inc.
<https://www.redhat.com>`_ |
7afa34ae |
|
98a6827b |
License |
7afa34ae |
=======
GNU General Public License v3.0
See `COPYING <COPYING>`_ to see the full text.
.. |PyPI version| image:: https://img.shields.io/pypi/v/ansible.svg |
1d972f51 |
:target: https://pypi.org/project/ansible |
2a55c64d |
.. |Docs badge| image:: https://img.shields.io/badge/docs-latest-brightgreen.svg |
72359a10 |
:target: https://docs.ansible.com/ansible/latest/ |
7afa34ae |
.. |Build Status| image:: https://api.shippable.com/projects/573f79d02a8192902e20e34b/badge?branch=devel
:target: https://app.shippable.com/projects/573f79d02a8192902e20e34b |
72359a10 |
.. |Chat badge| image:: https://img.shields.io/badge/chat-IRC-brightgreen.svg
:target: https://docs.ansible.com/ansible/latest/community/communication.html |
7b91d298 |
.. |Code Of Conduct| image:: https://img.shields.io/badge/code%20of%20conduct-Ansible-silver.svg
:target: https://docs.ansible.com/ansible/latest/community/code_of_conduct.html
:alt: Ansible Code of Conduct
.. |Mailing Lists| image:: https://img.shields.io/badge/mailing%20lists-Ansible-orange.svg
:target: https://docs.ansible.com/ansible/latest/community/communication.html#mailing-list-information
:alt: Ansible mailing lists
.. |License| image:: https://img.shields.io/badge/license-GPL%20v3.0-brightgreen.svg |
c66e1609 |
:target: COPYING |
7b91d298 |
:alt: Repository License |