blob: c57a0a45ab0b023f08bcf82d30146fded8417d0f [file] [log] [blame]
Filip Pytloun49768a42015-10-06 16:28:32 +02001
Aleš Komárek586daae2017-02-06 19:47:06 +01002===============
Ales Komareka4f836f2017-05-17 13:12:51 +02003Reclass Formula
Aleš Komárek586daae2017-02-06 19:47:06 +01004===============
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
Ales Komareka4f836f2017-05-17 13:12:51 +020011Sample Metadata
12===============
Filip Pytloun49768a42015-10-06 16:28:32 +020013
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
Ales Komareka4f836f2017-05-17 13:12:51 +020034Reclass storage with simple class mappings
Filip Pytloun49768a42015-10-06 16:28:32 +020035
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
Ales Komareka4f836f2017-05-17 13:12:51 +020039Reclass models with dynamic node classification
Filip Pytloun49768a42015-10-06 16:28:32 +020040
Ales Komareka4f836f2017-05-17 13:12:51 +020041.. literalinclude:: tests/pillar/node_classify.sls
42 :language: yaml
43
44
45More Information
46================
Filip Pytloun49768a42015-10-06 16:28:32 +020047
48* http://reclass.pantsfullofunix.net/index.html
49* http://reclass.pantsfullofunix.net/operations.html
Ales Komarek51e459c2017-02-19 08:47:46 +010050
Filip Pytloun2ea4e6a2017-02-02 13:02:03 +010051
52Documentation and Bugs
53======================
54
55To learn how to install and update salt-formulas, consult the documentation
56available online at:
57
58 http://salt-formulas.readthedocs.io/
59
60In the unfortunate event that bugs are discovered, they should be reported to
61the appropriate issue tracker. Use Github issue tracker for specific salt
62formula:
63
64 https://github.com/salt-formulas/salt-formula-reclass/issues
65
66For feature requests, bug reports or blueprints affecting entire ecosystem,
67use Launchpad salt-formulas project:
68
69 https://launchpad.net/salt-formulas
70
71You can also join salt-formulas-users team and subscribe to mailing list:
72
73 https://launchpad.net/~salt-formulas-users
74
75Developers wishing to work on the salt-formulas projects should always base
76their work on master branch and submit pull request against specific formula.
77
78 https://github.com/salt-formulas/salt-formula-reclass
79
80Any questions or feedback is always welcome so feel free to join our IRC
81channel:
82
83 #salt-formulas @ irc.freenode.net