README.md 1.92 KB
Newer Older
Michael DeHaan committed
1 2 3
Ansible
=======

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

Michael DeHaan committed
7
Read all about at it at (http://ansible.github.com)
8 9 10

Design Principles
=================
Michael DeHaan committed
11

Michael DeHaan committed
12 13 14 15 16 17 18
   * 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
19
   * The easiest config management system to use, ever.
Michael DeHaan committed
20

Michael DeHaan committed
21
Get Involved
Michael DeHaan committed
22 23
============

24 25
   * [ansible-project mailing list](http://groups.google.com/group/ansible-project)
   * irc.freenode.net: #ansible
Michael DeHaan committed
26

Michael DeHaan committed
27 28 29 30 31 32 33 34 35
Branch Info
===========

   * The master branch corresponds to release 0.3 "Baluchitherium".
   * Bug fixes WILL be periodically made to the master branch.
   * The devel branch corresponds to release 0.4 "Unchained".
   * Note: sudo support works much better in 0.4/devel, consider trying it.
   * See CHANGELOG.md for release notes to track each release.

Michael DeHaan committed
36 37 38 39 40 41
Patch Instructions
==================

Contributions to the core and modules are greatly welcome.

   * Required Process:
42 43
       * Submit github pull requests to the "ansible/devel" branch for features
       * Fixes for bugs may be submitted to "ansible/master"
Michael DeHaan committed
44 45 46 47 48 49 50 51
       * Make sure "make tests" passes before submitting any requests.
   * Bonus points:
       * Joining the mailing list
       * Using squash merges
       * Updating the "rst/*" files in the docs project and "docs/" manpage content
       * Adding more unit tests 
   * Avoid:
       * Sending patches to the mailing list directly.
52
       * Sending feature pull requests to the 'master' branch instead of the devel branch
Michael DeHaan committed
53 54
       * Sending pull requests to mpdehaan's personal ansible fork.

Michael DeHaan committed
55 56 57
Author
======

58
Michael DeHaan -- michael.dehaan@gmail.com
Michael DeHaan committed
59

60
[http://michaeldehaan.net](http://michaeldehaan.net/)
Michael DeHaan committed
61 62