Forge Home

account_management

Creates users/groups and installs user's shell.

7,073 downloads

1,530 latest version

5.0 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.

Version information

  • 0.3.0 (latest)
  • 0.2.2
  • 0.2.1
  • 0.1.3
  • 0.1.2
  • 0.1.1 (deleted)
  • 0.1.1-r1
  • 0.1.0
released Jun 17th 2020
This version is compatible with:
  • Puppet Enterprise 2019.8.x, 2019.7.x, 2019.5.x, 2019.4.x, 2019.3.x, 2019.2.x, 2019.1.x, 2019.0.x, 2018.1.x, 2017.3.x, 2017.2.x, 2017.1.x, 2016.5.x, 2016.4.x
  • Puppet >= 4.7.0 < 7.0.0
  • , , , Gentoo

Start using this module

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

Add this module to your Puppetfile:

mod 'arden-account_management', '0.3.0'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add arden-account_management
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install arden-account_management --version 0.3.0

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: accounts

Documentation

arden/account_management — version 0.3.0 Jun 17th 2020

account_management

Build Status Puppet Forge

Table of Contents

  1. Description
  2. Setup - The basics of getting started with account_management
  3. Usage - Configuration options and additional functionality
  4. Limitations - OS compatibility, etc.
  5. Development - Guide for contributing to the module

Description

Creates users/groups and installs a users preferred shell in the correct order.

Setup

What account_management affects

It creates users/groups and installs a users preferred shell. It makes sure that groups are created and preferred shells are installed before the user is created.

Usage

The example below will create a group named bridge and a user named wriker. The bridge group will be created first, then wriker's preferred shell will be installed and finally the wriker user will be created with the requested parameters.


profile::account_management::required_groups:
  bridge:
    name: 'bridge'
    gid: '1701'
profile::account_management::required_users:
  wriker:
    comment: 'beard'
    groups:
      - 'wheel'
      - 'bridge'
    uid: '1200'
    gid: '1200'
    shell: '/bin/zsh'

Cron & Exec-Once

This module also supports providing a list of cron entries and run-once executables specified on a per user basis. This can be useful if some kind of initialization is desired when a user is first created. For example, cloning a set of dotfiles from a git repository.

profile::account_management::exec_map:
  wriker:
    - command: 'chezmoi init --apply https://github.com/wriker/dotfiles.git'
      path: '/usr/local/bin:/usr/bin'
      environment: [ 'HOME=/home/wriker' ]
      creates: '/home/wriker/.local/share/chezmoi'
profile::account_management::cron_map:
  wriker:
    - command: '/usr/local/bin/chezmoi update -a'
      hour: '0'
      minute: '30'

Note that each entry in a user array provided within exec_map must include one of the following three attributes:

  • refreshonly
  • creates
  • onlyif

In the example above wriker's chezmoi configuration is installed when his user is first created. Additionally, a cron entry to refresh that configuration is scheduled to run every day at 00:30.

Limitations

OS Support

Tested on:

  • CentOS 7
  • RHEL 7
  • Gentoo
  • Debian 10

Shell Support

  • Currently only supports bash, zsh, and ksh.

Development

See the contributing guide.

Release Notes/Contributors/Etc.

Check out the contributor list