nagas / puppet-accounts

puppet module to manage user accounts

puppet-accounts

DO NOT USE THIS MODULE. IT IS IN A VERY EARLY DEVELOPMENT STATE AND ITS BEHAVIOUR IS CHANGING CONSTANTLY.

####Table of Contents

0. Changelog
1. Module Description - What does the module do?
2. Setup - The basics of getting started with puppet-accounts
3. Usage - Configuration and customization options
4. Reference - An under-the-hood peek at what the module is doing
5. Limitations - OS compatibility, etc.
6. Development - Guide for contributing to the module
   • Tests - Testing your configuration

##Changelog

##Module Description

The puppet-accounts module lets you manage user accounts with Puppet.

##Setup

The puppet-accounts module requires:

• puppetlabs-stdlib module.
• pluginsync enabled.
• valid yaml file containing user accounts information

##Usage

Both Include- and Resource-like class declarations are supported. This module is rather meant to by used with puppet >= 3.x, where all class parameters can be lookup by hiera by default. Sample hiera configuration file can be found in examples directory.

include accounts
class {'accounts':
}

Available parameters are:

• purge - use its with care. When set to true (default: no), it will remove all users that are not managed by Puppet.
• skip_sys_users - only has effect when used with purge => true (default: yes). It keeps system users from being purged. By default, it does not purge users whose UIDs are less than or equal to 500, but you can specify a different UID as the inclusive limit.
• users - hash of users and their attributes

class {'accounts':
  purge => true,
  skip_sys_users => 1500,
  users => {
    testuser => {
      state => 'present',
      shell => '/bin/bash',
      uid   => '10010',
      gid   => '10010',
      password => '*',
      groups => ['group1','group2'],
      nodes => '!ruby/regexp "/some-node/"'
    }
  }
}

This will add user testuser and remove all users that aren't managed by Puppet and whose UID is greater than 1500 (user managed by puppet won't be remove even if his uid is greater than 1500).

##Reference

coming soon

##Limitations

Please note that the module was tested only on RedHat and Debian family operating systems. It is rather meant to be used with puppet >= 3.x (hiera integration).

##Development

1. Fork it
2. Clone it to your development environment (git clone https://github.com/nagas/puppet-accounts)
3. Create your feature branch (git checkout -b my-new-feature)
4. Commit your changes (git commit -am 'Add some feature')
5. Push to the branch (git push origin my-new-feature)
6. Create a Pull Request

###Testing

coming soon