Giter Club home page Giter Club logo

puppet-account's Introduction

Puppet Account Module

A puppet module designed to ease the management of user accounts.

Currently supports:

  • Creation/Removal of accounts (via the "ensure" parameter)
  • Account creation w/UID control
  • Setting the login shell
  • Dedicated Group creation w/GID control (optional)
  • Home directory creation ( and optionally management via /etc/skel )
  • Support for system users/groups
  • SSH key management (optional)

Build Status

master branch status

Documentation

A brief usage summary with examples follows. For full documentation of all parameters, see the inline puppet docs:

$ puppet doc /etc/puppet/modules/account/manifests/init.pp

Usage

account

Standard usage of this defined type would probably look something like this:

account { 
  'sysadmin':
    home_dir => '/opt/sysadmin',
    groups   => [ 'sudo', 'users' ],
    ssh_key  => 'AAAAB3NzaC1yc2EAAAABIwAAAQEArfQmMkvtWRnwas3DIti9qAuSFQXKcE0kdp5f42PP8l2kTytJPPWp5T/q8PXDQ2d2X5KplMCMDiUQkchqhmDp840jsqBQ9iZPejAjv3w2kITgScFNymAcErtzX52iw4lnUyjZzomCW8G3YthQMaRm2NkI4wcVcjzq+SKyTfzrBoH21RgZlfcx+/50AFRrarpYqel9W5DuLmmShHxD8clPS532Z/1X+1jCW2KikUhdo98lxYTIgFno05lwFOS9Ry89UyBarn1Ecp1zXpIBE7dMQif3UyLUTU9zCVIoZiJj4iO5lemSSV0v8GL97qclBUVJpaCpc4ebR7bhi0nQ28RcxQ==',
    comment   => 'SysAdmin user',
}

The type can also be virtualized and realized later (see the official documentation for more information on this pattern):

@account { 'sysadmin': groups  => [ 'sudo', 'users' ] }

For use with hiera, one could define a nested hash of account resources in a hiera data file (this example assumes you use YAML):

---
accounts:
  sysadmin:
    home_dir: /opt/sysadmin
    ssh_key: AAAAB3NzaC1yc2EAAAABIwAAAQEArfQmMkvtWRnwas3DIti9qAuSFQXKcE0kdp5f42PP8l2kTytJPPWp5T/q8PXDQ2d2X5KplMCMDiUQkchqhmDp840jsqBQ9iZPejAjv3w2kITgScFNymAcErtzX52iw4lnUyjZzomCW8G3YthQMaRm2NkI4wcVcjz    q+SKyTfzrBoH21RgZlfcx+/50AFRrarpYqel9W5DuLmmShHxD8clPS532Z/1X+1jCW2KikUhdo98lxYTIgFno05lwFOS9Ry89UyBarn1Ecp1zXpIBE7dMQif3UyLUTU9zCVIoZiJj4iO5lemSSV0v8GL97qclBUVJpaCpc4ebR7bhi0nQ28RcxQ==
    groups:
      - sudo
      - users
  appadmin:
    home_dir: /opt/appadmin
    groups:
      - users

And then use the create_resources function in a puppet manifest:

$accounts = hiera('accounts')
create_resources('account', $accounts)

Feedback

Please use the github issues functionality to report any bugs or requests for new features.

Contribution

Feel free to fork and submit pull requests (or use git's own functionality to mail me patches) for potential contributions.

ToDo

  • Unit Tests
  • Submit module to PuppetForge
  • Support for removing accounts

Contributors

  • Tray Torrance (torrancew) - Author
  • Facundo Guerrero (guerremdq) - Support for 'comment' parameter
  • YuviPanda (yuvipanda) - Bugfix
  • Justin Lambert (jlambert121) - Support for configurable home directory permissions, puppet-lint

puppet-account's People

Contributors

guerremdq avatar jlambert121 avatar yuvipanda avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.