diff --git a/contrib/README.md b/contrib/README.md deleted file mode 100644 index 686535e1507..00000000000 --- a/contrib/README.md +++ /dev/null @@ -1,84 +0,0 @@ -Ansible Resources -================= - -User contributed playbooks, modules, and articles. This is a small curated list, but growing. Everyone is encouraged to add to this document, -just send in a pull request! - -Ansible Modules -=============== - -Ansible modules are a way of adding new client-side logic to ansible. They can be written in any language. - -* [Official "core" ansible modules](http://ansible.cc/docs/modules.html) - various -* [mercurial](https://github.com/bradobro/ansible-module-mercurial) - bradobro -* [zypper (bash module example)](https://github.com/jpmens/ansible-zypp) - jp_mens -* [homebrew](https://gist.github.com/3170079) - swehack -* [network_facts](https://github.com/dagwieers/ansible-network-facts) - dagwieers -* [vsphere_boot](https://github.com/dagwieers/ansible-vsphere-boot) - dagwieers - -Python modules using 0.6 and later can use the common "AnsibleModule" class to dramatically reduce -the amount of boilerplate code required. Not all modules above yet take advantage of this feature. -See the official documentation for more details. - -Selected Playbooks -================== - -[Playbooks](http://ansible.cc/docs/playbooks.html) are Ansible's configuration management language. It should -be easy to write your own from scratch for most applications, but it's always helpful to look at what others have -done for reference. - -* [Hadoop](https://github.com/jkleint/ansible-hadoop) - jkleint -* [LAMP](https://github.com/fourkitchens/server-playbooks) - [Four Kitchens](http://fourkitchens.com) -* [Ganglia (demo)](https://github.com/mpdehaan/ansible-examples) - mpdehaan -* [Nginx](http://www.capsunlock.net/2012/04/ansible-nginx-playbook.html) - cocoy -* [OpenStack](http://github.com/lorin/openstack-ansible) - lorin -* [Systems Configuration](https://github.com/cegeddin/ansible-contrib) - cegeddin -* [Fedora Infrastructure](http://infrastructure.fedoraproject.org/cgit/ansible.git/tree/) - [Fedora](http://fedoraproject.org) - -Callbacks and Plugins -===================== - -The Ansible project has a whole repo devoted to extending ansible with new connection types, logging/event callbacks, and -inventory data storage. Talk to Cobbler and EC2, tweak the way things are logged, or even add sound effects. - -* [Ansible-Plugins](https://github.com/ansible/ansible/tree/devel/plugins) - -Scripts And Misc -================ - -Ansible isn't just a program, it's also an API. Here's some examples of some clever integrations with the "Runner" and -also Playbook APIs, and integrations with other interesting pieces of software. - -* [Ansible Vagrant plugin](https://github.com/dsander/vagrant-ansible) - dsander -* [Ansible+Vagrant Tutorial](https://github.com/mattupstate/vagrant-ansible-tutorial) - mattupstate - -* [virt-install](http://fedorapeople.org/cgit/skvidal/public_git/scripts.git/tree/ansible/start-prov-boot.py) - skvidal -* [rebooting hosts](http://fedorapeople.org/cgit/skvidal/public_git/scripts.git/tree/ansible/host-reboot) - skvidal -* [uptime (API demo)](https://github.com/ansible/ansible/blob/devel/examples/scripts/uptime.py) - mpdehaan - -Blogs & Articles -================ - -* [HighScalability.com](http://highscalability.com/blog/2012/4/18/ansible-a-simple-model-driven-configuration-management-and-c.html) - mpdehaan -* [ColoAndCloud.com interview](http://www.coloandcloud.com/editorial/an-interview-with-ansible-author-michael-dehaan/) - mpdehaan -* [dzone](http://server.dzone.com/articles/ansible-cm-deployment-and-ad) - Mitch Pronschinske -* [Configuration Management With Ansible](http://jpmens.net/2012/06/06/configuration-management-with-ansible/) - jp_mens -* [Shell Scripts As Ansible Modules](http://jpmens.net/2012/07/05/shell-scripts-as-ansible-modules/) - jp_mens -* [Ansible Facts](http://jpmens.net/2012/07/15/ansible-it-s-a-fact/) - jp_mens -* [Infrastructure as Data](http://www.capsunlock.net/2012/04/ansible-infrastructure-as-data-not-infrastructure-as-code.html) - cocoy -* [Ansible Pull Mode](http://www.capsunlock.net/2012/05/using-ansible-pull-and-user-data-to-setup-ec2-or-openstack-servers.html) - cocoy -* [Exploring Configuration Management With Ansible](http://palominodb.com/blog/2012/08/01/exploring-configuration-management-ansible) - Palamino DB -* [You Should Consider Using SSH Based Configuration Management](http://www.lshift.net/blog/2012/07/30/you-should-consider-using-ssh-based-configuration-management) - LShift Ltd -* [Deploying Flask/uWSGI, Nginx, and Supervisorctl](http://mattupstate.github.com/python/devops/2012/08/07/flask-wsgi-application-deployment-with-ubuntu-ansible-nginx-supervisor-and-uwsgi.html) - mattupstate -* [Infracoders Presentation](http://www.danielhall.me/2012/10/ansible-talk-infra-coders/) - Daniel Hall - -Disclaimer -========== - -Modules and playbooks here may not be using the latest in Ansible features. When in doubt to the features of -a particular version of Ansbile, always consult [ansible.cc](http://ansible.cc) and in particular -see [Best Practices](http://ansible.cc/docs/bestpractices.html) for some tips and tricks that may be useful. - -Ansible is (C) 2012, [Michael DeHaan](http://twitter.com/laserllama) and others and is available under the GPLv3 license. Content here is as specified -by individual contributors. - - diff --git a/docsite/rst/contrib.rst b/docsite/rst/contrib.rst new file mode 100644 index 00000000000..5cef2c0a681 --- /dev/null +++ b/docsite/rst/contrib.rst @@ -0,0 +1,134 @@ +Ansible Resources +================= + +User contributed playbooks, modules, and articles. This is a small +curated list, but growing. Everyone is encouraged to add to this +document, just send in a pull request! + +Ansible Modules +=============== + +Ansible modules are a way of adding new client-side logic to ansible. +They can be written in any language. + +- `Official "core" ansible + modules `_ - various +- `mercurial `_ - + bradobro +- `zypper (bash module + example) `_ - jp\_mens +- `homebrew `_ - swehack +- `network\_facts `_ + - dagwieers +- `vsphere\_boot `_ + - dagwieers + +Python modules using 0.6 and later can use the common "AnsibleModule" +class to dramatically reduce the amount of boilerplate code required. +Not all modules above yet take advantage of this feature. See the +official documentation for more details. + +Selected Playbooks +================== + +`Playbooks `_ are Ansible's +configuration management language. It should be easy to write your own +from scratch for most applications, but it's always helpful to look at +what others have done for reference. + +- `Hadoop `_ - jkleint +- `LAMP `_ - `Four + Kitchens `_ +- `Ganglia (demo) `_ - + mpdehaan +- `Nginx `_ + - cocoy +- `OpenStack `_ - lorin +- `Systems + Configuration `_ - + cegeddin +- `Fedora + Infrastructure `_ + - `Fedora `_ + +Callbacks and Plugins +===================== + +The Ansible project has a whole repo devoted to extending ansible with +new connection types, logging/event callbacks, and inventory data +storage. Talk to Cobbler and EC2, tweak the way things are logged, or +even add sound effects. + +- `Ansible-Plugins `_ + +Scripts And Misc +================ + +Ansible isn't just a program, it's also an API. Here's some examples of +some clever integrations with the "Runner" and also Playbook APIs, and +integrations with other interesting pieces of software. + +- `Ansible Vagrant + plugin `_ - dsander +- `Ansible+Vagrant + Tutorial `_ + - mattupstate - +- `virt-install `_ + - skvidal +- `rebooting + hosts `_ + - skvidal +- `uptime (API + demo) `_ + - mpdehaan + +Blogs & Articles +================ + +- `HighScalability.com `_ + - mpdehaan +- `ColoAndCloud.com + interview `_ + - mpdehaan +- `dzone `_ + - Mitch Pronschinske +- `Configuration Management With + Ansible `_ + - jp\_mens +- `Shell Scripts As Ansible + Modules `_ + - jp\_mens +- `Ansible Facts `_ + - jp\_mens +- `Infrastructure as + Data `_ + - cocoy +- `Ansible Pull + Mode `_ + - cocoy +- `Exploring Configuration Management With + Ansible `_ + - Palamino DB +- `You Should Consider Using SSH Based Configuration + Management `_ + - LShift Ltd +- `Deploying Flask/uWSGI, Nginx, and + Supervisorctl `_ + - mattupstate +- `Infracoders + Presentation `_ + - Daniel Hall + +Disclaimer +========== + +Modules and playbooks here may not be using the latest in Ansible +features. When in doubt to the features of a particular version of +Ansbile, always consult `ansible.cc `_ and in +particular see `Best +Practices `_ for some tips +and tricks that may be useful. + +Ansible is (C) 2012, `Michael DeHaan `_ +and others and is available under the GPLv3 license. Content here is as +specified by individual contributors. diff --git a/docsite/rst/index.rst b/docsite/rst/index.rst index 5482923a09a..4ca73a5e33c 100644 --- a/docsite/rst/index.rst +++ b/docsite/rst/index.rst @@ -56,6 +56,14 @@ with other solutions in your environment. api moduledev +Ansible Resources +````````````````` + +.. toctree:: + :maxdepth: 0 + + contrib + Miscellaneous `````````````