Forge Home

Modules

Puppet

Resources

PuppetEcosystemPuppet CommunityUpdates

root

Root user account configuration module
Project URLRSS FeedReport issues

26,037 downloads

6,743 latest version

4.3 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

  • 1.0.1 (latest)
  • 1.0.0
  • 0.1.0
released May 31st 2018
This version is compatible with:
  • Puppet Enterprise 3.x
  • Puppet >=2.7.20 <5.4.0
  • , , , , Gentoo

Start using this module

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

Add this module to your Puppetfile:

mod 'thias-root', '1.0.1'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add thias-root
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install thias-root --version 1.0.1

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

Documentation

thias/root — version 1.0.1 May 31st 2018

puppet-root

Overview

This is a very simple module to configure the local root user account, typically to lock it down and keep it that way.

  • ::root : Class to configure the local root user account.

Including the main class without specifying any parameters shouldn't change anything, since it will just ensure that the root account exists with its default attributes (uid 0, gid 0, /root home, 'root' name).

Main class parameters (all default to undef unless otherwise specificed) :

  • $password : Account password hash.
  • $comment : Account passwd comment. Default : OS specific original value
  • $shell : Account passwd shell. Default : OS specific original value
  • $ssh_authorized_keys_ensure : $ensure for /root/.ssh/authorized_keys
  • $ssh_authorized_keys_content : $content for /root/.ssh/authorized_keys
  • $ssh_authorized_keys_source : $source for /root/.ssh/authorized_keys
  • $email_recipient : Email forward recipient.

Examples

From hiera, enforcing a specific password, denying /root/.ssh/authorized_keys presence and forwarding local email to an external address :

---
classes:
  '::root'
root::password: '$6$0V82Ibo2$TRTehe1A1d9WFl1a3e3qgEfXBotOZSZRn5egcyMtl1a3q/EkzWPClaIaXn5egcyMtL83ga.NpNAzO4dlaIaX51'
root::ssh_authorized_keys_ensure: 'absent'
root::email_recipient: 'root@example.com'

Note that you can use the following to disable password-based access to the account (typically when using only sudo) :

root::password: '*'