Add INFO.yaml file
[so/so-config.git] / README.md
1 mso-config Cookbook
2 ===================
3 This cookbook will deploy the MSO configuration files.
4
5 Requirements
6 ------------
7 n/a
8
9 Attributes
10 ----------
11 <table>
12   <tr>
13     <th>Key</th>
14     <th>Type</th>
15     <th>Description</th>
16     <th>Default</th>
17   </tr>
18 </table>
19
20 Usage
21 -----
22 #### mso-config::default
23 This recipe does nothing.
24
25 #### mso-config::apih
26 #### mso-config::bpmn
27 #### mso-config::jra
28 Those are used as "roles" or "profiles" to manage the configuration elements (mostly files) related to each of them. Each of these profiles will call other recipes specific to the profile.
29
30 None of other recipes should be called directly, unless you **REALLY** know what you're doing.
31
32 e.g.
33 Just include `mso-config` in your node's `run_list`:
34
35 ```json
36 {
37   "name":"my_node",
38   "run_list": [
39     "recipe[mso-config::apih]",
40     "recipe[mso-config::bpmn]",
41     "recipe[mso-config::jra]"
42   ]
43 }
44 ```
45
46 License and Authors
47 -------------------
48 Authors: pete/eddie/kevin
49 License: Apache License, version 2.0