No description
Find a file
Toshio Kuratomi a08459a814
Update info on python support (#38855)
* Update the documentation to list Python 3 as official
* Add some reference targets for inventory variables so we can link to docs
* Add a platform FAQ section
  Populate it with

  * virtualenv info (previously on the python3 support page)
  * BSD (Link to the working with BSD page)
  * Solaris (Document how to work around the non-POSIX shell on some
    Solaris hosts)

  Fixes #21594

* Fix some refs in the release_and_maintenance document

* Fix unindent error in module template

Fix for the module/plugin template unintentionally unindented inside of
a raw block, leading to errors like:

ERROR: docs/docsite/rst/modules/redshift_facts_module.rst:289:0: Explicit markup ends without a blank line; unexpected unindent.

* Make wording for Solaris troubleshooting better.
2018-04-18 13:04:47 -07:00
.github Update Issue & PR templates to make them clearer 2018-04-17 09:52:37 -04:00
bin Normalize usage of temp and tmp on tmp (#36221) 2018-02-15 09:01:02 -08:00
changelogs/fragments Add changelog entry for grafana base64 port 2018-04-17 06:51:59 -07:00
contrib VMware: Support for multiple jinja filters in vmware_inventory (#38173) 2018-04-11 15:50:35 -04:00
docs Update info on python support (#38855) 2018-04-18 13:04:47 -07:00
examples Implement plugin filtering 2018-01-22 16:54:53 -08:00
hacking [cloud]Add aws_ses_identity_policy module for managing SES sending policies (#36623) 2018-04-05 15:11:12 -04:00
lib/ansible Fix broken yaml (#38966) 2018-04-18 20:54:14 +01:00
licenses Create a short license for PSF and MIT. (#32212) 2017-11-06 10:25:30 -08:00
packaging README.md was renamed. Fix deb build reference to the README 2018-04-11 11:22:50 -07:00
test Add Yarn module (#19026) 2018-04-18 08:19:38 -05:00
ticket_stubs Update README.md 2018-03-09 13:53:49 +00:00
.coveragerc
.gitattributes
.gitignore Ignore .pytest_cache (#38401) 2018-04-12 09:41:57 -04:00
.gitmodules
.mailmap Fix syntax typo 2017-12-24 12:16:17 +01:00
.yamllint Add module support to yamllint sanity test. (#34964) 2018-01-16 15:08:56 -08:00
ansible-core-sitemap.xml
CHANGELOG.md [cloud]Add aws_ses_identity_policy module for managing SES sending policies (#36623) 2018-04-05 15:11:12 -04:00
CODING_GUIDELINES.md english corrections (#35307) 2018-01-29 21:09:56 -08:00
CONTRIBUTING.md
COPYING
docsite_requirements.txt
Makefile Move man pages generations to rst2man (#37861) 2018-03-26 16:28:28 -07:00
MANIFEST.in Convert README from Markdown to ReStructured Text and use as longdesc (#22330) 2018-04-06 12:38:40 -07:00
MODULE_GUIDELINES.md Moving guidelines to the official docs (#32260) 2017-10-27 11:40:42 -04:00
README.rst Upgrade PYPI badge to point to new Warehouse site 2018-04-16 17:16:34 +02:00
RELEASES.txt Add 2.4.3 to releases.txt 2018-01-31 14:56:54 -08:00
requirements.txt
ROADMAP.rst No hardcoding roadmaps (#32981) 2017-11-16 08:03:10 -08:00
setup.py Suppress a UserWarning about unknown dist option 2018-04-12 23:53:52 +02:00
shippable.yml Rebalance cloud tests into 5 groups. 2018-02-10 00:37:20 -08:00
tox.ini Convert ansible-test compile into a sanity test. 2018-01-25 09:45:36 -08:00
VERSION Update VERSION to match ansible.release (#36212) 2018-02-14 17:59:01 -08:00

|PyPI version| |Docs 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/intro_getting_started.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/community.html>`_ 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. Take care to
   make sure no merge commits are in the submission, and use
   ``git rebase`` vs ``git merge`` for this reason. If submitting a
   large code change (other than modules), it's probably a good idea to
   join ansible-devel and talk about what you would like to do or add
   first 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

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.
*  Various release-X.Y branches exist for previous releases.
*  We'd love to have your contributions, read `Community
   Information <https://docs.ansible.com/community.html>`_ for notes on
   how to get started.

Authors
=======

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

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

License
=======

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
   :target: https://pypi.org/project/ansible
.. |Docs badge| image:: https://img.shields.io/badge/docs-latest-brightgreen.svg
   :target: http://docs.ansible.com/ansible
.. |Build Status| image:: https://api.shippable.com/projects/573f79d02a8192902e20e34b/badge?branch=devel
   :target: https://app.shippable.com/projects/573f79d02a8192902e20e34b