blob: 8441365e899561275c38cb492000836144a8f063 [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. krafft069f53c2013-08-27 17:50:03 +020024 changelog
martin f. krafft8acd49d2013-08-26 21:22:25 +020025
26Community
27---------
28Currently, there exists only an IRC channel, ``#reclass`` on ``irc.oftc.net``,
29where you may stop by to ask questions. When usage grows, I'll set up
30a mailing list. If you're using `Salt`_, you can also ask your
31|reclass|-related questions on the mailing list, ideally specifying
32"reclass" in the subject of your message.
33
martin f. krafft72dc9cd2013-08-27 15:51:25 +020034Source code
35-----------
36For now, |reclass| is hosted `on Github`_, and you may clone it with the
37following command::
38
39 git clone https://github.com/madduck/reclass.git
40
41.. _on Github: https://github.com/madduck/reclass
42
martin f. krafft8acd49d2013-08-26 21:22:25 +020043Licence
44-------
45|reclass| is © 20072013 by martin f. krafft and released under the terms of
46the `Artistic Licence 2.0`_.
47
48About the name
49--------------
50"reclass" stands for **r**\ ecursive **e**\ xternal node **class**\ ifier,
51which is somewhat of a misnomer. I chose the name very early on, based on the
52recursive nature of the data merging. However, to the user, a better paradigm
53would be "hierarchical", as s/he does not and should not care too much about
54the implementation internals. By the time that I realised this, unfortunately,
55`Hiera`_ (Puppet-specific) had already occupied this prefix. Oh well. Once you
56start using |reclass|, you'll think recursively as well as hierarchically at
57the same time. It's really quite simple.
58
59..
60 Indices and tables
61 ==================
62
63 * :ref:`genindex`
64 * :ref:`modindex`
65 * :ref:`search`
66
67.. include:: extrefs.inc
68.. include:: substs.inc