summaryrefslogtreecommitdiffstats
path: root/kubernetes/config/docker/init/src/config/aai/aai-config/cookbooks/user/README.md
diff options
context:
space:
mode:
authorMandeep Khinda <Mandeep.Khinda@amdocs.com>2017-06-24 11:49:37 -0400
committerMandeep Khinda <Mandeep.Khinda@amdocs.com>2017-06-24 11:49:37 -0400
commitd6ea987caed84a9f36030a5a1516df7c6186362d (patch)
tree265dda9cfb43a78542e4b2ccac382a8a5583bc56 /kubernetes/config/docker/init/src/config/aai/aai-config/cookbooks/user/README.md
parent43d96ac929c93d0aa2a55d860e0425a39118f7b4 (diff)
onap on kubernetes source files
Change-Id: I4de34baf90979651223a28323010deb7aef21946 Signed-off-by: Mandeep Khinda <Mandeep.Khinda@amdocs.com>
Diffstat (limited to 'kubernetes/config/docker/init/src/config/aai/aai-config/cookbooks/user/README.md')
-rwxr-xr-xkubernetes/config/docker/init/src/config/aai/aai-config/cookbooks/user/README.md42
1 files changed, 42 insertions, 0 deletions
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
index 0000000000..7d85a9f0ee
--- /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