Forge Home

homes

A nodule for managing local users and ssh keys

27,440 downloads

6,660 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.

Version information

  • 1.0.2 (latest)
  • 1.0.1
  • 1.0.0
  • 0.3.1
  • 0.3.0
  • 0.2.1
  • 0.2.0
  • 0.1.0
released Dec 12th 2017
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 'opentable-homes', '1.0.2'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add opentable-homes
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install opentable-homes --version 1.0.2

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

Documentation

opentable/homes — version 1.0.2 Dec 12th 2017

puppet-homes

####Table of Contents

  1. Overview
  2. Module Description - What is the homes module?
  3. Setup - The basics of getting started with homes
  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

The homes module allows you to create local system users and optionally manage their ssh keys

Build Status

##Module Description

This module provides a simplified way of managing local and system users, their home directory and optionally the distribution of their public and private ssh keys.

##Setup

###What homes affects

  • Create users
  • Populates authorized_keys file for the given user.

###Beginning with homes

To create a new local user:

   $myuser = {
     'testuser' => { 'groups' => ['testgroup1', 'testgroup2'] }
   }

   homes { 'testuser':
     user => $myuser
   }

To create a new local user and manage their public ssh_key:

   homes { 'testuser'
    ssh_key => 'AAAAB3NzaC1yc2EAAAADAQABAAAAgQC4U/G9Idqy1VvYEDCKg3noVChCbIrJAi0D/qMFoG=='
   }

##Usage

###Classes and Defined Types

####Defined Type: homes The homes module primary type, homes, guides the basic setup of local users on your system.

Parameters within homes: #####user A hash giving details of the user that will be managed.

#####ssh_key The ssh_key is the one-line contents of the users public key. This will be used to populate the authorized_keys file in the .ssh directory of the users home directory.

####Defined Type: homes::ssh::private The type for managing the distribution of private keys from an existing key store.

Parameters within homes::ssh::private: #####username The name of the user that is being managed by this module.

#####key_name The name of the private key as found in the existing key store.

#####key_store The full path directory to the keystore where all the public keys and other secrets are located.

####Defined Type: homes::ssh::config The type for managing the ssh config options for the user.

Parameters within homes::ssh::private: #####username The name of the user that is being managed by this module.

#####ssh_config_entries A hash giving configuration details that will be set in the ~/.ssh/config file

##Reference

###Defined Types ####Public Types

####Private Types

##Limitations

This module is tested on the following platforms:

  • CentOS 5
  • CentOS 6
  • Ubuntu 12.04
  • Ubuntu 14.04

It is tested with the OSS version of Puppet only.

###Contributing

Please read CONTRIBUTING.md for full details on contributing to this project.