onap on kubernetes source files

[oom.git] / kubernetes / config / docker / init / src / config / aai / aai-config / cookbooks / user / README.md

diff --git a/kubernetes/config/docker/init/src/config/aai/aai-config/cookbooks/user/README.md b/kubernetes/config/docker/init/src/config/aai/aai-config/cookbooks/user/README.md
new file mode 100755 (executable)
index 0000000..7d85a9f
--- /dev/null
+++ b/kubernetes/config/docker/init/src/config/aai/aai-config/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