From f9121c1d29e527483e117057e780754f1401ece3 Mon Sep 17 00:00:00 2001 From: Eric Renfro Date: Wed, 13 May 2015 12:35:27 -0400 Subject: [PATCH] Moved data bag attribute table under attributes. --- README.md | 24 +++++++++++++----------- 1 file changed, 13 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index 52d9473..d20e453 100644 --- a/README.md +++ b/README.md @@ -16,6 +16,19 @@ Key | Type | Description | Default ---------------- | ------ | ------------------------------------ | ---------- `['sudo_rules']` | String | Name of data bag to use for entries. | sudo_rules +#### data bag + +Key | Type | Description | Default | Required? +-------- | ------ | ------------------------------------------------------------------------------------ | ---------- | --------- +Id | String | Name of Data Bag item, and sudoers.d/Id filename. | None | Yes +Name | String | Instead of using Id, you can choose the name of the file for sudoers.d/Name instead. | Same as Id | No +Hosts | Array | List of hosts to apply this rule to by fqdn, can be wildcard matched. | [] | Yes +Action | String | `create` or `remove` Sets whether to create or remove the entry. | `create` | No +User | String | Username or %Groupname to use for the sudo rule. | None | Yes +Runas | String | Allowed colon-separated list of users for sudoers runas. | `ALL` | No +Commands | Array | List of commands (and arguments) this rule adds for the user/group. | [] | Yes +Defaults | Array | List of defaults this user has. | [] | No + Usage ----- #### sudo_rules::default @@ -56,17 +69,6 @@ And provide properly formatted data bag: } ``` -Key | Type | Description | Default | Required? --------- | ------ | ------------------------------------------------------------------------------------ | ---------- | --------- -Id | String | Name of Data Bag item, and sudoers.d/Id filename. | None | Yes -Name | String | Instead of using Id, you can choose the name of the file for sudoers.d/Name instead. | Same as Id | No -Hosts | Array | List of hosts to apply this rule to by fqdn, can be wildcard matched. | [] | Yes -Action | String | `create` or `remove` Sets whether to create or remove the entry. | `create` | No -User | String | Username or %Groupname to use for the sudo rule. | None | Yes -Runas | String | Allowed colon-separated list of users for sudoers runas. | `ALL` | No -Commands | Array | List of commands (and arguments) this rule adds for the user/group. | [] | Yes -Defaults | Array | List of defaults this user has. | [] | No - Contributing ------------ 1. Fork the repository on Github