ansible/README.md

66 lines
2 KiB
Markdown
Raw Normal View History

2012-02-23 19:17:24 +00:00
Ansible
=======
2012-08-07 01:00:21 +00:00
Ansible is a radically simple configuration-management, deployment, task-execution, and
multinode orchestration framework.
2012-02-23 19:17:24 +00:00
2012-08-01 12:16:21 +00:00
Read the documentation at http://ansible.github.com
2012-02-24 02:47:31 +00:00
Design Principles
=================
2012-02-23 19:17:24 +00:00
2012-02-28 02:26:23 +00:00
* 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
2012-03-08 18:59:12 +00:00
* The easiest config management system to use, ever.
2012-02-23 19:17:24 +00:00
2012-03-08 18:59:12 +00:00
Get Involved
2012-02-23 19:17:24 +00:00
============
* [ansible-project mailing list](http://groups.google.com/group/ansible-project)
* irc.freenode.net: #ansible
2012-02-29 18:58:46 +00:00
2012-04-26 01:23:50 +00:00
Branch Info
===========
2012-07-04 22:06:38 +00:00
* Releases are named after Van Halen songs.
2012-08-07 01:15:39 +00:00
* The devel branch corresponds to release 0.7, "Panama".
* Various release-X.Y branches exist for previous releases
2012-08-07 01:00:21 +00:00
* All feature work happens on the development branch.
2012-08-07 01:15:39 +00:00
* Major bug fixes will be made to the last release branch only
2012-04-26 01:23:50 +00:00
* See CHANGELOG.md for release notes to track each release.
2012-03-31 15:38:06 +00:00
Patch Instructions
==================
Contributions to the core and modules are greatly welcome.
* Required Process:
* Submit github pull requests to the "ansible/devel" branch for features
2012-08-07 01:15:39 +00:00
* Fixes for bugs may also be submitted to "ansible/release-X.Y" for the last release
2012-03-31 15:38:06 +00:00
* Make sure "make tests" passes before submitting any requests.
* Bonus points:
* Joining the mailing list
* Fixing bugs instead of sending bug reports.
2012-03-31 15:38:06 +00:00
* Using squash merges
* Updating the "rst/*" files in the docs project and "docs/" manpage content
2012-08-07 01:00:21 +00:00
* Adding more unit tests
2012-03-31 15:38:06 +00:00
* Avoid:
* Sending patches to the mailing list directly.
2012-08-07 01:15:39 +00:00
* Sending feature pull requests to the 'release' branch instead of the devel branch
2012-03-31 15:38:06 +00:00
* Sending pull requests to mpdehaan's personal ansible fork.
2012-02-23 19:17:24 +00:00
Author
======
2012-02-24 02:47:31 +00:00
Michael DeHaan -- michael.dehaan@gmail.com
2012-02-23 19:28:39 +00:00
2012-02-24 02:47:31 +00:00
[http://michaeldehaan.net](http://michaeldehaan.net/)
2012-02-23 19:28:39 +00:00