Skip to content
Chef cookbook for managing users
Ruby
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.
attributes
files/default
libraries
recipes
templates/default
.gitignore
CHANGELOG.md
README.md
metadata.rb

README.md

Description

Sets up and manages users in a variety of different contexts. Based around the original Opscode data-driven user creation by Joshua Timberman and Seth Chisamore.

Requirements

Platforms

Tested on:

  • Solaris 10
  • Ubuntu 10.04

Data bag named users must exist.

Cookbooks

users::default cookbook

If running on Solaris 10, the system needs to have been bootstrapped to use the publically provided EveryCity IPS/pkg(5) repository at http://s10.pkg.ec. In the Atalanta Systems environment this is still done manually, and no cookbook or bootstrap mechanism exists for this.

To use the users cookbook in a Solaris 10 environment as described, you must have the solaris cookbook at the head of your run list.

Attributes

sysadmins

  • node['users']['home_base'] - base directory where user home directories live. Default is /home
  • node['users']['shell'] - name of the shell to be used as a failback in case of an entry in the users databag being absent. Default is bash. Note this is the shell name not the path to the shell.

sharing

  • node['users']['sharing_user'] - the userame which will be used for sharing. Default is atalanta
  • node['users']['sharing_comment'] - the user comment for the sharing user. Default is Atalanta Systems Engineering
  • node['users']['sharing_shell'] - the login shell for the sharing user. Default is /bin/bash
  • node['users']['sharing_tools'] - an array of packages to install for collaborative purposes. Take care, as only primitive checking is done to ensure the package name is correct for the platform.

clean

  • node['users']['token_group'] - group that designates users from users recipe. default is atalanta.

Recipes

default

Add screenrc and profile files to root user homedir.

sharing

Sets up a user for collaborative co-working, with an authorized_keys file containing the keys for all users who wish to collaborate. Also installs some useful tools.

sysadmins

Creates a sysadmin group and users according to the users databag. Drops off ssh public keys for each user in the sysadmin group. Drops off a GNU screen config file with useful defaults, together with a shell profile to improve user experience on Solaris.

clean

  • Create group from node['users']['token_group'] if not exist.
  • All users from users databag added to this group.
  • if there is a users in this group, but not in the databag - those users will be deleted.

Usage

The users::sysadmins recipe relies upon a databag called users. Each data bag item corresponds to a user. The databag can be extended to be used for arbitrary user such as user-specific preferences, or any other data which may logically be connected to a user. An example databag is here:

{
  "id": "konstantin",
  "ssh_keys": "ssh-rsa AAAAB3Nz...yhCw== konstantin",
  "groups": "sysadmin",
  "shell": "bash",
  "comment": "Konstantin Lysenko"
}

The shell should be set to the name of the shell required. The recipe will calculate the correct path dependent on the platform. If a full path is specified, this will take precedence, and no such calculation will be made.

Create the data bag:

knife data bag create users

Create the data bag entry:

cd $CHEF_REPO/databags/users
cat <<EOF > user.json
{
    "id": "user"
    ....
}
EOF

Upload the data bag:

knife data bag from file user.json

Ensure the user's public ssh key is entered into the ssh_keys value. The users::sysadmins recipe will create a sysadmin group with the id of 2300. If the user is set to be in this group, their key will be dropped off, and key-based ssh will be possible.

The home_base attribute may be set on the role using, for example:

default_attributes(
                   "users" => {
                     "home_base" => '/home'
                   }
                   )

TODO

  • Move clean recipe part out of sysadmins recipe. It's there because chef calculates system users array before he adds new users with users::sysadmins recipe. May be I can throw away etc module in favour of ohai with ohai reload? Or use ruby_block to calculate all stuff in execution time.
  • Make sharing authorized_keys dynamic rather than static, probably iterating over a databag with an element indicating if the user should be a sharer.

License and Author

Author:: Atalanta Systems (support@atalanta-systems.com)

Copyright:: 2011, Atalanta Systems Ltd

Something went wrong with that request. Please try again.