Chef Cookbook: Sudo Rules
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Eric Renfro df09afab32 Added issues_url and source_url 6 years ago
attributes Initial release 0.1.0 7 years ago
recipes Added Pieter Vogelaar's merge request in manually. Thank you, great idea. Added attribute to do custom search queries instead of just hosts:fqdn, updated documentation 7 years ago
test Added framework for kitchen test-suite but no tests, yet 7 years ago
.gitignore Added gitignore and Gemfile 7 years ago
.kitchen.yml Added framework for kitchen test-suite but no tests, yet 7 years ago
Berksfile Initial release 0.1.0 7 years ago
CHANGELOG.md Updated Changelog 7 years ago
Gemfile Added framework for kitchen test-suite but no tests, yet 7 years ago
LICENSE Added LGPLv3 license 7 years ago
README.md Adjusted formatteding for contributors 7 years ago
metadata.rb Added issues_url and source_url 6 years ago

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

sudo_rules::default

Key Type Description Default
['sudo_rules']['data_bag'] String Name of data bag to use for entries. sudo_rules
['sudo_rules']['search_query'] String Custom search query for matching instead of just host:fqdn None

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

Include sudo_rules in your node's run_list:

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

And provide properly formatted data bag:

{
    "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"
    ]
}

Contributing

  1. Fork the repository on Github.
  2. Switch to the develop branch.
  3. Create a named feature branch off develop (like githubusername/feature/add_component_x).
  4. Write your change.
  5. Update documentation if appropriate.
  6. Write tests for your change (if applicable).
  7. Run the tests, ensuring they all pass.
  8. Submit a Pull Request using Github to develop branch.

or

  1. Report issue on Github

License and Authors