1|PyPI version| |Docs badge| |Chat badge| |Build Status| |Code Of Conduct| |Mailing Lists| |License|
2
3*******
4Ansible
5*******
6
7Ansible is a radically simple IT automation system. It handles
8configuration management, application deployment, cloud provisioning,
9ad-hoc task execution, network automation, and multi-node orchestration. Ansible makes complex
10changes like zero-downtime rolling updates with load balancers easy. More information on `the Ansible website <https://ansible.com/>`_.
11
12Design Principles
13=================
14
15*  Have a dead simple setup process and a minimal learning curve.
16*  Manage machines very quickly and in parallel.
17*  Avoid custom-agents and additional open ports, be agentless by
18   leveraging the existing SSH daemon.
19*  Describe infrastructure in a language that is both machine and human
20   friendly.
21*  Focus on security and easy auditability/review/rewriting of content.
22*  Manage new remote machines instantly, without bootstrapping any
23   software.
24*  Allow module development in any dynamic language, not just Python.
25*  Be usable as non-root.
26*  Be the easiest IT automation system to use, ever.
27
28Use Ansible
29===========
30
31You can install a released version of Ansible via ``pip``, a package manager, or
32our `release repository <https://releases.ansible.com/ansible/>`_. See our
33`installation guide <https://docs.ansible.com/ansible/latest/installation_guide/intro_installation.html>`_ for details on installing Ansible
34on a variety of platforms.
35
36Red Hat offers supported builds of `Ansible Engine <https://www.ansible.com/ansible-engine>`_.
37
38Power users and developers can run the ``devel`` branch, which has the latest
39features and fixes, directly. Although it is reasonably stable, you are more likely to encounter
40breaking changes when running the ``devel`` branch. We recommend getting involved
41in the Ansible community if you want to run the ``devel`` branch.
42
43Get Involved
44============
45
46*  Read `Community
47   Information <https://docs.ansible.com/ansible/latest/community>`_ for all
48   kinds of ways to contribute to and interact with the project,
49   including mailing list information and how to submit bug reports and
50   code to Ansible.
51*  Join a `Working Group
52   <https://github.com/ansible/community/wiki>`_, an organized community devoted to a specific technology domain or platform.
53*  Submit a proposed code update through a pull request to the ``devel`` branch.
54*  Talk to us before making larger changes
55   to avoid duplicate efforts. This not only helps everyone
56   know what is going on, it also helps save time and effort if we decide
57   some changes are needed.
58*  For a list of email lists, IRC channels and Working Groups, see the
59   `Communication page <https://docs.ansible.com/ansible/latest/community/communication.html>`_
60
61Branch Info
62===========
63
64*  The ``devel`` branch corresponds to the release actively under development.
65*  The ``stable-2.X`` branches correspond to stable releases.
66*  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.
67*  See the `Ansible release and maintenance <https://docs.ansible.com/ansible/latest/reference_appendices/release_and_maintenance.html>`_ page for information about active branches.
68
69Roadmap
70=======
71
72Based on team and community feedback, an initial roadmap will be published for a major or minor version (ex: 2.7, 2.8).
73The `Ansible Roadmap page <https://docs.ansible.com/ansible/devel/roadmap/>`_ details what is planned and how to influence the roadmap.
74
75Authors
76=======
77
78Ansible was created by `Michael DeHaan <https://github.com/mpdehaan>`_
79and has contributions from over 4000 users (and growing). Thanks everyone!
80
81`Ansible <https://www.ansible.com>`_ is sponsored by `Red Hat, Inc.
82<https://www.redhat.com>`_
83
84License
85=======
86
87GNU General Public License v3.0 or later
88
89See `COPYING <COPYING>`_ to see the full text.
90
91.. |PyPI version| image:: https://img.shields.io/pypi/v/ansible.svg
92   :target: https://pypi.org/project/ansible
93.. |Docs badge| image:: https://img.shields.io/badge/docs-latest-brightgreen.svg
94   :target: https://docs.ansible.com/ansible/latest/
95.. |Build Status| image:: https://dev.azure.com/ansible/ansible/_apis/build/status/CI?branchName=stable-2.9
96   :target: https://dev.azure.com/ansible/ansible/_build/latest?definitionId=20&branchName=stable-2.9
97.. |Chat badge| image:: https://img.shields.io/badge/chat-IRC-brightgreen.svg
98   :target: https://docs.ansible.com/ansible/latest/community/communication.html
99.. |Code Of Conduct| image:: https://img.shields.io/badge/code%20of%20conduct-Ansible-silver.svg
100   :target: https://docs.ansible.com/ansible/latest/community/code_of_conduct.html
101   :alt: Ansible Code of Conduct
102.. |Mailing Lists| image:: https://img.shields.io/badge/mailing%20lists-Ansible-orange.svg
103   :target: https://docs.ansible.com/ansible/latest/community/communication.html#mailing-list-information
104   :alt: Ansible mailing lists
105.. |License| image:: https://img.shields.io/badge/license-GPL%20v3.0-brightgreen.svg
106   :target: COPYING
107   :alt: Repository License
108