cookbook-sudo_rules/README.md

sudo_rules Cookbook
===================
Reads through a special data bag of sudo rules to compile a list of sudoers.d rules to create/remove.

Requirements
------------
#### packages
- sudo

Attributes
----------
TODO: List your cookbook attributes here.

e.g.
#### sudo_rules::default
<table>
  <tr>
    <th>Key</th>
    <th>Type</th>
    <th>Description</th>
    <th>Default</th>
  </tr>
  <tr>
    <td><tt>['sudo_rules']['data_bag']</tt></td>
    <td>String</td>
    <td>Name of data bag to use for entries</td>
    <td><tt>sudo_rules</tt></td>
  </tr>
</table>

Usage
-----
#### sudo_rules::default

Include `sudo_rules` in your node's `run_list`:

```json
{
  "name":"my_node",
  "run_list": [
    "recipe[sudo_rules]"
  ]
}
```

And provide properly formatted data bag:

```json
{
    "id": "Data Bag unique name, default value for name below",
    "name": "Name of the sudoers.d file",
    "hosts": [
        "fqdn1",
        "fqdn2",
        ...
    ],
    "action": "create",
    "user": "someuser",
    "runas": "ALL",
    "commands": [
        "/usr/sbin/somecommand args",
        "/usr/sbin/anothercommand",
        ...
    ],
    "defaults": [
        "env_reset"
    ]
}
```

Id: Required: Name of Data Bag item, and sudoers.d/Id filename.
Name: Optional: Instead of using Id, you can choose the name of the file for sudoers.d/Name instead.
Hosts: Required: List of hosts to apply this rule to by fqdn, can be wildcard matched.
Action: `create` or `remove`: Default `create`
User: Required: Username or %Groupname to use for the sudo rule.
Runas: Allowed colon-separated list of users for sudoers runas: Default `ALL`
Commands: Required: List of commands (and arguments) this rule adds for the user/group.
Defaults: List of defaults this user has. 

Contributing
------------
TODO: (optional) If this is a public cookbook, detail the process for contributing. If this is a private cookbook, remove this section.

e.g.
1. Fork the repository on Github
2. Create a named feature branch (like `add_component_x`)
3. Write your change
4. Write tests for your change (if applicable)
5. Run the tests, ensuring they all pass
6. Submit a Pull Request using Github

License and Authors
-------------------
Authors: TODO: List authors