1|PyPI version| |Docs badge| |Chat badge| |Build Status| |Code Of Conduct| |Mailing Lists| |License| |CII Best Practices| 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 with 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 with ``pip`` or a package manager. See our 32`installation guide <https://docs.ansible.com/ansible/latest/installation_guide/intro_installation.html>`_ for details on installing Ansible 33on a variety of platforms. 34 35Red Hat offers supported builds of `Ansible Engine <https://www.ansible.com/ansible-engine>`_. 36 37Power users and developers can run the ``devel`` branch, which has the latest 38features and fixes, directly. Although it is reasonably stable, you are more likely to encounter 39breaking changes when running the ``devel`` branch. We recommend getting involved 40in the Ansible community if you want to run the ``devel`` branch. 41 42Get Involved 43============ 44 45* Read `Community 46 Information <https://docs.ansible.com/ansible/latest/community>`_ for all 47 kinds of ways to contribute to and interact with the project, 48 including mailing list information and how to submit bug reports and 49 code to Ansible. 50* Join a `Working Group 51 <https://github.com/ansible/community/wiki>`_, an organized community devoted to a specific technology domain or platform. 52* Submit a proposed code update through a pull request to the ``devel`` branch. 53* Talk to us before making larger changes 54 to avoid duplicate efforts. This not only helps everyone 55 know what is going on, but it also helps save time and effort if we decide 56 some changes are needed. 57* For a list of email lists, IRC channels and Working Groups, see the 58 `Communication page <https://docs.ansible.com/ansible/latest/community/communication.html>`_ 59 60Coding Guidelines 61================= 62 63We document our Coding Guidelines in the `Developer Guide <https://docs.ansible.com/ansible/devel/dev_guide/>`_. We particularly suggest you review: 64 65* `Contributing your module to Ansible <https://docs.ansible.com/ansible/devel/dev_guide/developing_modules_checklist.html>`_ 66* `Conventions, tips, and pitfalls <https://docs.ansible.com/ansible/devel/dev_guide/developing_modules_best_practices.html>`_ 67 68Branch Info 69=========== 70 71* The ``devel`` branch corresponds to the release actively under development. 72* The ``stable-2.X`` branches correspond to stable releases. 73* 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. 74* See the `Ansible release and maintenance <https://docs.ansible.com/ansible/devel/reference_appendices/release_and_maintenance.html>`_ page for information about active branches. 75 76Roadmap 77======= 78 79Based on team and community feedback, an initial roadmap will be published for a major or minor version (ex: 2.7, 2.8). 80The `Ansible Roadmap page <https://docs.ansible.com/ansible/devel/roadmap/>`_ details what is planned and how to influence the roadmap. 81 82Authors 83======= 84 85Ansible was created by `Michael DeHaan <https://github.com/mpdehaan>`_ 86and has contributions from over 5000 users (and growing). Thanks everyone! 87 88`Ansible <https://www.ansible.com>`_ is sponsored by `Red Hat, Inc. 89<https://www.redhat.com>`_ 90 91License 92======= 93 94GNU General Public License v3.0 or later 95 96See `COPYING <COPYING>`_ to see the full text. 97 98.. |PyPI version| image:: https://img.shields.io/pypi/v/ansible-core.svg 99 :target: https://pypi.org/project/ansible-core 100.. |Docs badge| image:: https://img.shields.io/badge/docs-latest-brightgreen.svg 101 :target: https://docs.ansible.com/ansible/latest/ 102.. |Build Status| image:: https://dev.azure.com/ansible/ansible/_apis/build/status/CI?branchName=devel 103 :target: https://dev.azure.com/ansible/ansible/_build/latest?definitionId=20&branchName=devel 104.. |Chat badge| image:: https://img.shields.io/badge/chat-IRC-brightgreen.svg 105 :target: https://docs.ansible.com/ansible/latest/community/communication.html 106.. |Code Of Conduct| image:: https://img.shields.io/badge/code%20of%20conduct-Ansible-silver.svg 107 :target: https://docs.ansible.com/ansible/latest/community/code_of_conduct.html 108 :alt: Ansible Code of Conduct 109.. |Mailing Lists| image:: https://img.shields.io/badge/mailing%20lists-Ansible-orange.svg 110 :target: https://docs.ansible.com/ansible/latest/community/communication.html#mailing-list-information 111 :alt: Ansible mailing lists 112.. |License| image:: https://img.shields.io/badge/license-GPL%20v3.0-brightgreen.svg 113 :target: COPYING 114 :alt: Repository License 115.. |CII Best Practices| image:: https://bestpractices.coreinfrastructure.org/projects/2372/badge 116 :target: https://bestpractices.coreinfrastructure.org/projects/2372 117 :alt: Ansible CII Best Practices certification 118
