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