README.md 3.72 KB
Newer Older
Charles Chan committed
1 2
[![PyPI version](https://img.shields.io/pypi/v/ansible.svg)](https://pypi.python.org/pypi/ansible)
[![PyPI downloads](https://img.shields.io/pypi/dm/ansible.svg)](https://pypi.python.org/pypi/ansible)
3
[![Build Status](https://travis-ci.org/ansible/ansible.svg?branch=devel)](https://travis-ci.org/ansible/ansible)
Michael DeHaan committed
4

Michael DeHaan committed
5

Michael DeHaan committed
6 7 8
Ansible
=======

Michael DeHaan committed
9
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.
Michael DeHaan committed
10

Michael DeHaan committed
11
Read the documentation and more at http://ansible.com/
12

Michael DeHaan committed
13 14
Many users run straight from the development branch (it's generally fine to do so), but you might also wish to consume a release.  

Charles Chan committed
15
You can find instructions [here](http://docs.ansible.com/intro_getting_started.html) for a variety of platforms.  If you decide to go with the development branch, be sure to run `git submodule update --init --recursive` after doing a checkout. 
Michael DeHaan committed
16

Charles Chan committed
17
If you want to download a tarball of a release, go to [releases.ansible.com](http://releases.ansible.com/ansible), though most users use `yum` (using the EPEL instructions linked above), `apt` (using the PPA instructions linked above), or `pip install ansible`.
Michael DeHaan committed
18

19 20
Design Principles
=================
Michael DeHaan committed
21

Michael DeHaan committed
22
   * Have a dead simple setup process and a minimal learning curve
Michael DeHaan committed
23 24 25
   * 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
Michael DeHaan committed
26
   * Focus on security and easy auditability/review/rewriting of content
Michael DeHaan committed
27
   * Manage new remote machines instantly, without bootstrapping any software
Michael DeHaan committed
28
   * Allow module development in any dynamic language, not just Python
Michael DeHaan committed
29
   * Be usable as non-root
Michael DeHaan committed
30 31
   * Be the easiest IT automation system to use, ever.
  
Michael DeHaan committed
32
Get Involved
Michael DeHaan committed
33 34
============

Michael DeHaan committed
35
   * Read [Community Information](http://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.  
Charles Chan committed
36
   * 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 and 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.
Michael DeHaan committed
37 38 39
   * Users list: [ansible-project](http://groups.google.com/group/ansible-project)
   * Development list: [ansible-devel](http://groups.google.com/group/ansible-devel)
   * Announcement list: [ansible-announce](http://groups.google.com/group/ansible-announce) - read only
40
   * irc.freenode.net: #ansible
Michael DeHaan committed
41

Michael DeHaan committed
42 43 44
Branch Info
===========

45
   * Releases are named after Led Zeppelin songs.
46
   * The devel branch corresponds to the release actively under development.
Michael DeHaan committed
47
   * As of 1.8, modules are kept in different repos, you'll want to follow [core](https://github.com/ansible/ansible-modules-core) and [extras](https://github.com/ansible/ansible-modules-extras)
48
   * Various release-X.Y branches exist for previous releases.
Michael DeHaan committed
49
   * We'd love to have your contributions, read [Community Information](http://docs.ansible.com/community.html) for notes on how to get started.
50

Michael DeHaan committed
51 52
Authors
=======
Michael DeHaan committed
53

Artur Cygan committed
54
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!
Michael DeHaan committed
55

Michael DeHaan committed
56
Ansible is sponsored by [Ansible, Inc](http://ansible.com)
Akihiro YAMAZAKI committed
57