ansible/README.md

50 lines
2.6 KiB
Markdown
Raw Normal View History

2014-04-03 12:25:26 +00:00
[![PyPI version](https://badge.fury.io/py/ansible.png)](http://badge.fury.io/py/ansible) [![PyPI downloads](https://pypip.in/d/ansible/badge.png)](https://pypi.python.org/pypi/ansible)
2014-04-03 12:25:01 +00:00
2012-02-23 19:17:24 +00:00
Ansible
=======
Ansible is a radically simple configuration-management, application deployment, task-execution, and multinode orchestration engine.
2012-02-23 19:17:24 +00:00
2014-01-28 16:38:52 +00:00
Read the documentation and more at http://ansible.com/
2012-02-24 02:47:31 +00:00
2013-02-04 03:17:13 +00:00
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
2014-01-28 16:38:52 +00:00
instructions [here](http://docs.ansible.com/intro_getting_started.html) for a variety of platforms. If you want a tarball of the last release, go to [releases.ansible.com](http://releases.ansible.com/ansible) and you can also install with pip.
2013-02-04 03:17:13 +00:00
2012-02-24 02:47:31 +00:00
Design Principles
=================
2012-02-23 19:17:24 +00:00
2014-02-21 17:58:09 +00:00
* Have a dead simple setup process and a minimal learning curve
* Be super fast & parallel by default
* Require no server or client daemons; use existing SSHd
2014-02-21 17:58:09 +00:00
* Use a language that is both machine and human friendly
* Focus on security and easy auditability/review/rewriting of content
* Manage remote machines instantly, without bootstrapping
* Allow module development in any dynamic language, not just Python
2012-02-28 02:26:23 +00:00
* Be usable as non-root
* Be the easiest IT automation system to use, ever.
2012-03-08 18:59:12 +00:00
Get Involved
2012-02-23 19:17:24 +00:00
============
2013-12-15 16:50:18 +00:00
* 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.
* 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.
* 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-09-18 03:03:11 +00:00
* The devel branch corresponds to the release actively under development.
* Various release-X.Y branches exist for previous releases.
2012-09-18 03:03:11 +00:00
* We'd love to have your contributions, read "CONTRIBUTING.md" for process notes.
2012-02-23 19:17:24 +00:00
Author
======
2014-06-06 13:24:33 +00:00
Ansible was created by Michael DeHaan (michael@ansible.com) and has contributions from over
800 users (and growing). Thanks everyone!
2012-02-23 19:28:39 +00:00
2014-01-28 16:38:52 +00:00
[Ansible, Inc](http://ansible.com)
2013-11-22 07:22:48 +00:00