summaryrefslogtreecommitdiffstats
path: root/cookbooks/user/README.md
diff options
context:
space:
mode:
authorSteve Smokowski <ss835w@att.com>2017-02-09 15:38:13 -0500
committerSteve Smokowski <ss835w@att.com>2017-02-09 15:39:00 -0500
commitb160c3cc1e58e85502ccaa7358cd38ff210ed34a (patch)
tree210cc985eff4dc146e3ea431cdc7d1e792594314 /cookbooks/user/README.md
parent7a3f850cf5c4aad118edaaf0b6981352daecb2a8 (diff)
Initial OpenECOMP A&AI commitrelease-1.0.0
Change-Id: Ic953856ef5e44eebf05bd00fe26cb5901fb49289 Signed-off-by: Steve Smokowski <ss835w@att.com>
Diffstat (limited to 'cookbooks/user/README.md')
-rw-r--r--cookbooks/user/README.md42
1 files changed, 42 insertions, 0 deletions
diff --git a/cookbooks/user/README.md b/cookbooks/user/README.md
new file mode 100644
index 0000000..7d85a9f
--- /dev/null
+++ b/cookbooks/user/README.md
@@ -0,0 +1,42 @@
+user Cookbook
+=============
+Configures users and mechids
+
+Requirements
+------------
+
+Attributes
+----------
+#### user::mech_users
+<table>
+ <tr>
+ <th>Key</th>
+ <th>Type</th>
+ <th>Description</th>
+ <th>Default</th>
+ </tr>
+ <tr>
+ <td><tt>['aai-app-config']['mech-ids']</tt></td>
+ <td>Hash</td>
+ <td>Mech ID, is the mech ID enabled?, shoud the cookbook update the key?</td>
+ <td><tt>true</tt></td>
+ </tr>
+</table>
+
+Usage
+-----
+#### user::default
+Just include `user` in your node's `run_list`:
+
+```json
+{
+ "name":"my_node",
+ "run_list": [
+ "recipe[user]"
+ ]
+}
+```
+
+License and Authors
+-------------------
+Authors: AT&T A&AI