diff --git a/docs/about.rst b/docs/about.rst new file mode 100644 index 0000000000000000000000000000000000000000..0bfbcf79d4a5cdfcb42055d0b5daa490ab78e1e9 --- /dev/null +++ b/docs/about.rst @@ -0,0 +1,43 @@ +About Majic Ansible Roles +========================= + +Majic Ansible Roles is a collection of Ansible roles that are used on regular +basis for deployment and maintenance of Majic infrastructure. + +The roles are kept as a separate project in hope of making them potentially +useful to wider audience, and for reference purposes. + +Roles cover different aspects of infrastructure, such as mail servers, web +servers, web applications etc. The roles are mainly well-suited for smaller +installations. + + +Why were these roles created? +----------------------------- + +For a long time I have had a couple of Internet-facing servers where I hosted +all the IT infrastructure I needed for my day-to-day life. + +This started off with some basic services, like mail and XMPP server, and in +time extended to include a web server, code repository etc. + +As the number of services I used grew, I found it more difficult to track +updates and upgrades, let alone test them in reliable way. The biggest problem +in particular was lack of time to properly document all the different things +I've set-up. + +Being familiar with some Puppet-based deployments, I've started looking into the +possibility of using a configuration management system. Ansible emerged as +something that I thought would be easy to use, due to its agent-less nature. + +Once I passed some basic tutorials and got to know the system a bit, I decided +to start my journey on implementing the different roles, in the way I want them, +that would let me easily set-up my servers (and reinstall them, amongst other +things). + +The roles you see within this repository are the fruit of this labour. I hope +you find them useful. + + +Features +-------- diff --git a/docs/index.rst b/docs/index.rst index 083df5509ddf1c44f4640ef6981baeac6f4698af..d8d555bb17d287bbb7060f1099689c98162ca4e5 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,17 +1,65 @@ -.. Majic Ansible Roles documentation master file, created by - sphinx-quickstart on Sat Nov 8 14:03:39 2014. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. +Majic Ansible Roles documentation +================================= -Welcome to Majic Ansible Roles's documentation! -=============================================== +Majic Ansible Roles is a collection of Ansible roles that are used on regular +basis for deployment and maintenance of Majic infrastructure. -Contents: + +Support +------- + +In case of problems with the roles or provided code, please do not hestitate to +contact the author at **majic-ansible-roles (at) majic.rs**. The project can be +found at: + +* https://code.majic.rs/majic-ansible-roles +* https://projects.majic.rs/majic-ansible-roles + + +License +------- + +Majic Ansible Roles is released under terms of *BSD (3-Clause) License*:: + + Copyright (c) 2014, Branko Majic + All rights reserved. + + Redistribution and use in source and binary forms, with or without modification, + are permitted provided that the following conditions are met: + + Redistributions of source code must retain the above copyright notice, this + list of conditions and the following disclaimer. + + Redistributions in binary form must reproduce the above copyright notice, this + list of conditions and the following disclaimer in the documentation and/or + other materials provided with the distribution. + + Neither the name of Branko Majic nor the names of any other + contributors may be used to endorse or promote products derived from + this software without specific prior written permission. + + THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND + ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED + WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE + DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR + ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES + (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; + LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON + ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS + SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + + +Contents +======== .. toctree:: :maxdepth: 2 - + about + usage + rolereference + releasenotes Indices and tables ================== diff --git a/docs/releasenotes.rst b/docs/releasenotes.rst new file mode 100644 index 0000000000000000000000000000000000000000..352cc6a88ef0ce896cb64b94ad86582d8453bbd7 --- /dev/null +++ b/docs/releasenotes.rst @@ -0,0 +1,2 @@ +Release notes +============= diff --git a/docs/rolereference.rst b/docs/rolereference.rst new file mode 100644 index 0000000000000000000000000000000000000000..44ac1c6f963ff4aa65da50d233f0db9b7c31f915 --- /dev/null +++ b/docs/rolereference.rst @@ -0,0 +1,2 @@ +Role Reference +============== diff --git a/docs/usage.rst b/docs/usage.rst new file mode 100644 index 0000000000000000000000000000000000000000..65b7cfff4e0885aa816463806fd8976cda875ab4 --- /dev/null +++ b/docs/usage.rst @@ -0,0 +1,8 @@ +.. _usage: + +Usage +===== + +Majic Ansible Roles is targeted at sysadmins who wish to deploy services for +their own, small-scale use. This chapter covers some basic steps on how to get +going using them for your own infrastructure.