Forge Home

user_group

Convenience module to create users and groups

14,283 downloads

10,977 latest version

4.6 quality score

We run a couple of automated
scans to help you access a
module's quality. Each module is
given a score based on how well
the author has formatted their
code and documentation and
modules are also checked for
malware using VirusTotal.

Please note, the information below
is for guidance only and neither of
these methods should be considered
an endorsement by Puppet.

Support the Puppet Community by contributing to this module

You are welcome to contribute to this module by suggesting new features, currency updates, or fixes. Every contribution is valuable to help ensure that the module remains compatible with the latest Puppet versions and continues to meet community needs. Complete the following steps:

  1. Review the module’s contribution guidelines and any licenses. Ensure that your planned contribution aligns with the author’s standards and any legal requirements.
  2. Fork the repository on GitHub, make changes on a branch of your fork, and submit a pull request. The pull request must clearly document your proposed change.

For questions about updating the module, contact the module’s author.

Version information

  • 0.2.6 (latest)
  • 0.2.5
  • 0.2.4
  • 0.2.3
  • 0.2.2
  • 0.2.1
  • 0.2.0
  • 0.1.3
  • 0.1.2
  • 0.1.1
  • 0.1.0
released Jul 6th 2015
This version is compatible with:
  • , , , , ,

Start using this module

  • r10k or Code Manager
  • Bolt
  • Manual installation
  • Direct download

Add this module to your Puppetfile:

mod 'yo61-user_group', '0.2.6'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add yo61-user_group
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install yo61-user_group --version 0.2.6

Direct download is not typically how you would use a Puppet module to manage your infrastructure, but you may want to download the module in order to inspect the code.

Download
Tags: user, group

Documentation

yo61/user_group — version 0.2.6 Jul 6th 2015

####Table of Contents

  1. Overview - What is the user_group module?
  2. Module Description - What the module does and why it is useful
  3. Setup - The basics of getting started with user_group
  4. Usage - Configuration options and additional functionality
  5. Reference - An under-the-hood peek at what the module is doing and how
  6. Limitations - OS compatibility, etc.
  7. Development - Guide for contributing to the module

##Overview

A simple wrapper to aid the creation of users/groups.

##Module Description

This module is a convenience wrapper around the native puppet user and group resource types to make it easy to create a user with a group having the same name and id.

##Setup

###What user_group affects

The user_group define creates users/groups.

###Beginning with user_group

To create a new user and a group with the same name:

  user_group{'my_user':}

##Usage

###Classes and Defined Types

####Defined Type: user_group

Creates a user and (by default) a group with the same name.

  user_group{'my_user':}

Parameters within user_group: #####ensure #####create_group #####create_user #####gname #####allowdupe #####comment #####gid #####groups #####home #####managehome #####password #####password_max_age #####purge_ssh_keys #####shell #####system #####uid

##Reference

###Classes

####Public Classes

There are no public classes in this module.

####Private Classes

  • user_group::params: defines OS-specific defaults

###Defined Types

####Public Defined Types

  • user_group: Creates a user and a group with the same name

##Limitations

This module should work on all platforms supported by puppet but has not been tested on anything other than CentOS 7.

##Development

Feel free to improve anything.

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request