blob: 1f8b51fbb2c36253f9e97d06e84eea8f513680c7 [file] [log] [blame]
martin f. krafft8acd49d2013-08-26 21:22:25 +02001================================================
2reclass Recursive external node classification
3================================================
4.. include:: intro.inc
5
6Contents
7--------
8These documents aim to get you started with |reclass|:
9
10.. toctree::
11 :maxdepth: 2
12
13 install
14 concepts
15 operations
16 usage
17 manpage
18 configfile
19 salt
20 ansible
21 puppet
22 hacking
martin f. krafftcc8851d2013-08-27 13:43:16 +020023 todo
martin f. krafft8acd49d2013-08-26 21:22:25 +020024
25Community
26---------
27Currently, there exists only an IRC channel, ``#reclass`` on ``irc.oftc.net``,
28where you may stop by to ask questions. When usage grows, I'll set up
29a mailing list. If you're using `Salt`_, you can also ask your
30|reclass|-related questions on the mailing list, ideally specifying
31"reclass" in the subject of your message.
32
martin f. krafft72dc9cd2013-08-27 15:51:25 +020033Source code
34-----------
35For now, |reclass| is hosted `on Github`_, and you may clone it with the
36following command::
37
38 git clone https://github.com/madduck/reclass.git
39
40.. _on Github: https://github.com/madduck/reclass
41
martin f. krafft8acd49d2013-08-26 21:22:25 +020042Licence
43-------
44|reclass| is © 20072013 by martin f. krafft and released under the terms of
45the `Artistic Licence 2.0`_.
46
47About the name
48--------------
49"reclass" stands for **r**\ ecursive **e**\ xternal node **class**\ ifier,
50which is somewhat of a misnomer. I chose the name very early on, based on the
51recursive nature of the data merging. However, to the user, a better paradigm
52would be "hierarchical", as s/he does not and should not care too much about
53the implementation internals. By the time that I realised this, unfortunately,
54`Hiera`_ (Puppet-specific) had already occupied this prefix. Oh well. Once you
55start using |reclass|, you'll think recursively as well as hierarchically at
56the same time. It's really quite simple.
57
58..
59 Indices and tables
60 ==================
61
62 * :ref:`genindex`
63 * :ref:`modindex`
64 * :ref:`search`
65
66.. include:: extrefs.inc
67.. include:: substs.inc