README.md 2.38 KB
Newer Older
Michael DeHaan committed
1 2
[![PyPI version](https://badge.fury.io/py/ansible.png)](http://badge.fury.io/py/ansible)

Michael DeHaan committed
3 4 5
Ansible
=======

Michael DeHaan committed
6 7
Ansible is a radically simple configuration-management, deployment, task-execution, and
multinode orchestration framework.
Michael DeHaan committed
8

9
Read the documentation and more at http://ansibleworks.com/
10

Michael DeHaan committed
11
Many users run straight from the development branch (it's generally fine to do so), but you might also wish to consume a release.  You can find 
Will Green committed
12
instructions [here](http://ansibleworks.com/docs/intro_getting_started.html) for a variety of platforms.  If you want a tarball of the last release, go to 
Michael DeHaan committed
13
http://ansibleworks.com/releases/ and you can also install with pip.
Michael DeHaan committed
14

15 16
Design Principles
=================
Michael DeHaan committed
17

Michael DeHaan committed
18 19 20 21 22 23 24
   * Dead simple setup
   * Super fast & parallel by default
   * No server or client daemons; use existing SSHd
   * No additional software required on client boxes
   * Modules can be written in ANY language
   * Awesome API for creating very powerful distributed scripts
   * Be usable as non-root
Michael DeHaan committed
25
   * The easiest config management system to use, ever.
Michael DeHaan committed
26

Michael DeHaan committed
27
Get Involved
Michael DeHaan committed
28 29
============

Michael DeHaan committed
30 31 32
   * Read [Contributing.md](https://github.com/ansible/ansible/blob/devel/CONTRIBUTING.md) 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.  
   * When submitting a bug report, include 1) the output of 'ansible --version', 2) what you expected to happen, 3) what actually happened, and 4) any relevant commands and output.
   * 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.
33
   * irc.freenode.net: #ansible
Michael DeHaan committed
34

Michael DeHaan committed
35 36 37
Branch Info
===========

38
   * Releases are named after Van Halen songs.
39
   * The devel branch corresponds to the release actively under development.
Michael DeHaan committed
40
   * Various release-X.Y branches exist for previous releases
41
   * We'd love to have your contributions, read "CONTRIBUTING.md" for process notes.
42

Michael DeHaan committed
43 44 45
Author
======

Michael DeHaan committed
46
Michael DeHaan -- michael@ansibleworks.com
Michael DeHaan committed
47

Michael DeHaan committed
48
[AnsibleWorks](http://ansibleworks.com)
Akihiro YAMAZAKI committed
49