blob: 9090e65818522be9577fdf364ece73effd071eba [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 Komarekf0942d72017-05-23 10:10:37 +020024Reclass storage with archive data source
25
26.. literalinclude:: tests/pillar/storage_archive.sls
27 :language: yaml
28
29Reclass storage with archive data source with content hash check
30
31.. literalinclude:: tests/pillar/storage_archive_public.sls
32 :language: yaml
33
Ales Komareka4a9f572016-12-03 20:15:50 +010034Reclass model with single node definition
35
Ales Komarek51e459c2017-02-19 08:47:46 +010036.. literalinclude:: tests/pillar/generate_single.sls
37 :language: yaml
Ales Komareka4a9f572016-12-03 20:15:50 +010038
39Reclass model with multiple node defined
40
Ales Komarek51e459c2017-02-19 08:47:46 +010041.. literalinclude:: tests/pillar/generate_multi.sls
42 :language: yaml
Ales Komareka4a9f572016-12-03 20:15:50 +010043
Ales Komareka4f836f2017-05-17 13:12:51 +020044Reclass storage with simple class mappings
Filip Pytloun49768a42015-10-06 16:28:32 +020045
Ales Komarek51e459c2017-02-19 08:47:46 +010046.. literalinclude:: tests/pillar/class_mapping.sls
47 :language: yaml
Filip Pytloun49768a42015-10-06 16:28:32 +020048
Ales Komareka4f836f2017-05-17 13:12:51 +020049Reclass models with dynamic node classification
Filip Pytloun49768a42015-10-06 16:28:32 +020050
Ales Komareka4f836f2017-05-17 13:12:51 +020051.. literalinclude:: tests/pillar/node_classify.sls
52 :language: yaml
53
54
55More Information
56================
Filip Pytloun49768a42015-10-06 16:28:32 +020057
58* http://reclass.pantsfullofunix.net/index.html
59* http://reclass.pantsfullofunix.net/operations.html
Ales Komarek51e459c2017-02-19 08:47:46 +010060
Filip Pytloun2ea4e6a2017-02-02 13:02:03 +010061
62Documentation and Bugs
63======================
64
65To learn how to install and update salt-formulas, consult the documentation
66available online at:
67
68 http://salt-formulas.readthedocs.io/
69
70In the unfortunate event that bugs are discovered, they should be reported to
71the appropriate issue tracker. Use Github issue tracker for specific salt
72formula:
73
74 https://github.com/salt-formulas/salt-formula-reclass/issues
75
76For feature requests, bug reports or blueprints affecting entire ecosystem,
77use Launchpad salt-formulas project:
78
79 https://launchpad.net/salt-formulas
80
81You can also join salt-formulas-users team and subscribe to mailing list:
82
83 https://launchpad.net/~salt-formulas-users
84
85Developers wishing to work on the salt-formulas projects should always base
86their work on master branch and submit pull request against specific formula.
87
88 https://github.com/salt-formulas/salt-formula-reclass
89
90Any questions or feedback is always welcome so feel free to join our IRC
91channel:
92
93 #salt-formulas @ irc.freenode.net