Go to file
Sandra McCann 8726e64080
Batch docs fixes for 2.7 (#71926)
* remove Edit on Github from EOL branches

* try again

* replace porting guides with stub pages - issue 71687

(cherry picked from commit 3528a98a3811e8d2ca7cc8870ab9b5a13f4c35f5)
2020-12-01 09:42:39 -08:00
.github (Backport) ec2_instance, ebs_optimized not sub-option of network (#48467) 2018-11-12 19:23:31 -08:00
bin [2.7] Don't fail if a remote_addr with a '/' hits ansible_connection (#49781) (#50037) 2019-01-07 09:32:55 -08:00
changelogs New release v2.7.18 2020-05-11 16:33:55 -07:00
contrib Misc typo fixes (#45969) (#45978) 2018-09-21 13:56:35 -05:00
docs Batch docs fixes for 2.7 (#71926) 2020-12-01 09:42:39 -08:00
examples Add 'auto' to documented default enabled inventory plugins (#46621) (#46637) 2018-10-08 15:22:03 -05:00
hacking Make ansible-test available in the bin directory. (#45876) 2018-10-09 18:25:24 -07:00
lib/ansible Update Ansible release version to v2.7.18.post0. 2020-05-12 08:32:21 -07:00
licenses Create a short license for PSF and MIT. (#32212) 2017-11-06 10:25:30 -08:00
packaging [stable-2.7] Fix unicode error in changelog generation 2019-07-05 11:47:32 -07:00
test Fix up host used in win_get_url tests - 2.7 (#69817) 2020-06-01 16:33:16 -07:00
.cherry_picker.toml 🚸 🐍 🍒 ⛏ Integrate cherry picker (#41403) 2018-07-12 19:34:02 +03:00
.coveragerc AnsiballZ improvements 2018-07-26 20:07:25 -07:00
.gitattributes 2.6 changelog gen/version/root dir cleanup (#40421) 2018-05-21 16:14:53 -07:00
.gitignore added build artifact to .gitignore (#47518) 2019-01-28 10:13:05 -08:00
.mailmap Fix syntax typo 2017-12-24 12:16:17 +01:00
CODING_GUIDELINES.md [stable-2.7] bulk docs update (#47828) 2018-10-30 14:45:41 -05:00
COPYING license file should be in source tree 2012-03-15 20:24:22 -04:00
MANIFEST.in powershell - add bootstrap wrapper to packaging manifest 2018-11-30 08:48:24 -08:00
MODULE_GUIDELINES.md [stable-2.7] bulk docs update (#47828) 2018-10-30 14:45:41 -05:00
Makefile [stable-2.7] Fix nightly rpm release 2019-07-24 09:49:48 -07:00
README.rst [stable-2.7] Add or later to the license expressed in the README (#65289) 2019-12-03 10:50:58 -08:00
docsite_requirements.txt Fixes the build issue pertaining to sphinx-build which is required to build ansible (#22480) 2017-03-14 14:19:46 -07:00
requirements.txt Cyptography pr 20566 rebase (#25560) 2017-06-27 06:00:15 -07:00
setup.py powershell - add bootstrap wrapper to packaging manifest 2018-11-30 08:48:24 -08:00
shippable.yml [stable-2.7] Update tests to use RHEL 7.8. (#68787) 2020-04-09 01:53:42 -07:00
tox.ini Fix ansible-test unit test execution. (#45772) 2018-10-09 18:25:24 -07:00

README.rst

|PyPI version| |Docs badge| |Chat badge| |Build Status|

*******
Ansible
*******

Ansible is a radically simple IT automation system. It handles
configuration-management, application deployment, cloud provisioning,
ad-hoc task-execution, and multinode orchestration -- including
trivializing things like zero-downtime rolling updates with load
balancers.

Read the documentation and more at https://ansible.com/

You can find installation instructions
`here <https://docs.ansible.com/ansible/latest/installation_guide/intro_installation.html>`_ for a
variety of platforms.

Most users should probably install a released version of Ansible from ``pip``, a package manager or
our `release repository <https://releases.ansible.com/ansible/>`_. `Officially supported
<https://www.ansible.com/ansible-engine>`_ builds of Ansible are also available. Some power users
run directly from the development branch - while significant efforts are made to ensure that
``devel`` is reasonably stable, you're more likely to encounter breaking changes when running
Ansible this way.

Design Principles
=================

*  Have a dead simple setup process and a minimal learning curve.
*  Manage machines very quickly and in parallel.
*  Avoid custom-agents and additional open ports, be agentless by
   leveraging the existing SSH daemon.
*  Describe infrastructure in a language that is both machine and human
   friendly.
*  Focus on security and easy auditability/review/rewriting of content.
*  Manage new remote machines instantly, without bootstrapping any
   software.
*  Allow module development in any dynamic language, not just Python.
*  Be usable as non-root.
*  Be the easiest IT automation system to use, ever.

Get Involved
============

*  Read `Community
   Information <https://docs.ansible.com/ansible/latest/community>`_ for all
   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.
*  All code submissions are done through pull requests to the ``devel`` branch.
*  Feel free to talk to us before making larger changes
   to avoid duplicate efforts. This not only helps everyone
   know what's going on, it also helps save time and effort if we decide
   some changes are needed.
*  Users list:
   `ansible-project <https://groups.google.com/group/ansible-project>`_
*  Development list:
   `ansible-devel <https://groups.google.com/group/ansible-devel>`_
*  Announcement list:
   `ansible-announce <https://groups.google.com/group/ansible-announce>`_
   -- read only
*  irc.freenode.net: #ansible
*  For the full list of Email Lists, IRC channels see the
   `Communication page <https://docs.ansible.com/ansible/latest/community/communication.html>`_

Branch Info
===========

*  Releases are named after Led Zeppelin songs. (Releases prior to 2.0
   were named after Van Halen songs.)
*  The ``devel`` branch corresponds to the release actively under
   development.
*  The ``stable-2.x`` branches exist for current releases.
*  Various release-X.Y branches exist for previous releases.
*  For information about the active branches see the
   `Ansible release and maintenance <https://docs.ansible.com/ansible/latest/reference_appendices/release_and_maintenance.html>`_ page.
*  We'd love to have your contributions, read the `Community
   Guide <https://docs.ansible.com/ansible/latest/community>`_ for notes on
   how to get started.

Roadmap
=======

Based on team and community feedback, an initial roadmap will be published for a major or minor version (ex: 2.0, 2.1).
Subminor versions will generally not have roadmaps published.

The `Ansible Roadmap page <https://docs.ansible.com/ansible/devel/roadmap/>`_ details what is planned and how to influence the roadmap.

Authors
=======

Ansible was created by `Michael DeHaan <https://github.com/mpdehaan>`_
(michael.dehaan/gmail/com) and has contributions from over 3700 users
(and growing). Thanks everyone!

`Ansible <https://www.ansible.com>`_ is sponsored by `Red Hat, Inc.
<https://www.redhat.com>`_

License
=======

GNU General Public License v3.0 or later

See `COPYING <COPYING>`_ to see the full text.

.. |PyPI version| image:: https://img.shields.io/pypi/v/ansible.svg
   :target: https://pypi.org/project/ansible
.. |Docs badge| image:: https://img.shields.io/badge/docs-latest-brightgreen.svg
   :target: https://docs.ansible.com/ansible/latest/
.. |Build Status| image:: https://api.shippable.com/projects/573f79d02a8192902e20e34b/badge?branch=devel
   :target: https://app.shippable.com/projects/573f79d02a8192902e20e34b
.. |Chat badge| image:: https://img.shields.io/badge/chat-IRC-brightgreen.svg
   :target: https://docs.ansible.com/ansible/latest/community/communication.html