blob: 44b02cb8bf753bbb4158781f383a70ba0a63466d [file] [log] [blame]
martin f. krafft8acd49d2013-08-26 21:22:25 +02001================================================
2reclass Recursive external node classification
3================================================
4.. include:: intro.inc
5
martin f. krafft0b157d62013-08-27 18:52:47 +02006Community
7---------
8There is a `mailing list`_, where you can bring up anything related to
9|reclass|.
10
11.. _mailing list: http://lists.pantsfullofunix.net/listinfo/reclass
12
13For real-time communication, please join the ``#reclass`` IRC channel on
14``irc.oftc.net``.
15
16If you're using `Salt`_, you can also ask your |reclass|-and-Salt-related
17questions on the mailing list, ideally specifying "reclass" in the subject of
18your message.
19
20Source code
21-----------
22For now, |reclass| is hosted `on Github`_, and you may clone it with the
23following command::
24
25 git clone https://github.com/madduck/reclass.git
26
27.. _on Github: https://github.com/madduck/reclass
28
29If you want a tarball, please `obtain it from the Debian archive`_.
30
31.. _obtain it from the Debian archive: http://http.debian.net/debian/pool/main/r/reclass/
32
33Licence
34-------
35|reclass| is © 2007–2013 by martin f. krafft and released under the terms of
36the `Artistic Licence 2.0`_.
37
martin f. krafft8acd49d2013-08-26 21:22:25 +020038Contents
39--------
40These documents aim to get you started with |reclass|:
41
42.. toctree::
43 :maxdepth: 2
44
45 install
46 concepts
47 operations
48 usage
49 manpage
50 configfile
51 salt
52 ansible
53 puppet
54 hacking
martin f. krafftcc8851d2013-08-27 13:43:16 +020055 todo
martin f. krafft069f53c2013-08-27 17:50:03 +020056 changelog
martin f. krafft8acd49d2013-08-26 21:22:25 +020057
martin f. krafft8acd49d2013-08-26 21:22:25 +020058About the name
59--------------
60"reclass" stands for **r**\ ecursive **e**\ xternal node **class**\ ifier,
61which is somewhat of a misnomer. I chose the name very early on, based on the
62recursive nature of the data merging. However, to the user, a better paradigm
63would be "hierarchical", as s/he does not and should not care too much about
64the implementation internals. By the time that I realised this, unfortunately,
65`Hiera`_ (Puppet-specific) had already occupied this prefix. Oh well. Once you
66start using |reclass|, you'll think recursively as well as hierarchically at
67the same time. It's really quite simple.
68
69..
70 Indices and tables
71 ==================
72
73 * :ref:`genindex`
74 * :ref:`modindex`
75 * :ref:`search`
76
77.. include:: extrefs.inc
78.. include:: substs.inc