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