blob: ed5effc8a9d06a4de4bc7887f265c10ce3537691 [file] [log] [blame]
Filip Pytloun49768a42015-10-06 16:28:32 +02001
Aleš Komárek586daae2017-02-06 19:47:06 +01002===============
3reclass formula
4===============
Filip Pytloun49768a42015-10-06 16:28:32 +02005
Ales Komarek51e459c2017-02-19 08:47:46 +01006reclass is an external node classifier (ENC) as can be used with automation
7tools, such as Puppet, Salt, and Ansible. It is also a stand-alone tool for
8merging data sources recursively.
9
Filip Pytloun49768a42015-10-06 16:28:32 +020010
11Sample pillars
12==============
13
14Reclass storage with data fetched from git
15
Ales Komarek51e459c2017-02-19 08:47:46 +010016.. literalinclude:: tests/pillar/storage_git.sls
17 :language: yaml
Filip Pytloun49768a42015-10-06 16:28:32 +020018
19Reclass storage with local data source
20
Ales Komarek51e459c2017-02-19 08:47:46 +010021.. literalinclude:: tests/pillar/storage_local.sls
22 :language: yaml
Filip Pytloun49768a42015-10-06 16:28:32 +020023
Ales Komareka4a9f572016-12-03 20:15:50 +010024Reclass model with single node definition
25
Ales Komarek51e459c2017-02-19 08:47:46 +010026.. literalinclude:: tests/pillar/generate_single.sls
27 :language: yaml
Ales Komareka4a9f572016-12-03 20:15:50 +010028
29Reclass model with multiple node defined
30
Ales Komarek51e459c2017-02-19 08:47:46 +010031.. literalinclude:: tests/pillar/generate_multi.sls
32 :language: yaml
Ales Komareka4a9f572016-12-03 20:15:50 +010033
Filip Pytloun49768a42015-10-06 16:28:32 +020034Reclass storage with arbitrary class mappings
35
Ales Komarek51e459c2017-02-19 08:47:46 +010036.. literalinclude:: tests/pillar/class_mapping.sls
37 :language: yaml
Filip Pytloun49768a42015-10-06 16:28:32 +020038
Filip Pytloun49768a42015-10-06 16:28:32 +020039
Aleš Komárek586daae2017-02-06 19:47:06 +010040External links
41==============
Filip Pytloun49768a42015-10-06 16:28:32 +020042
43* http://reclass.pantsfullofunix.net/index.html
44* http://reclass.pantsfullofunix.net/operations.html
Ales Komarek51e459c2017-02-19 08:47:46 +010045
Filip Pytloun2ea4e6a2017-02-02 13:02:03 +010046
47Documentation and Bugs
48======================
49
50To learn how to install and update salt-formulas, consult the documentation
51available online at:
52
53 http://salt-formulas.readthedocs.io/
54
55In the unfortunate event that bugs are discovered, they should be reported to
56the appropriate issue tracker. Use Github issue tracker for specific salt
57formula:
58
59 https://github.com/salt-formulas/salt-formula-reclass/issues
60
61For feature requests, bug reports or blueprints affecting entire ecosystem,
62use Launchpad salt-formulas project:
63
64 https://launchpad.net/salt-formulas
65
66You can also join salt-formulas-users team and subscribe to mailing list:
67
68 https://launchpad.net/~salt-formulas-users
69
70Developers wishing to work on the salt-formulas projects should always base
71their work on master branch and submit pull request against specific formula.
72
73 https://github.com/salt-formulas/salt-formula-reclass
74
75Any questions or feedback is always welcome so feel free to join our IRC
76channel:
77
78 #salt-formulas @ irc.freenode.net