diff --git a/README.md b/README.md index d20e453..5668704 100644 --- a/README.md +++ b/README.md @@ -18,16 +18,16 @@ Key | Type | Description | Default #### 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 +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 -----