root

Root user account configuration module

26,618 downloads

248 latest version

5.0 quality score

Version information

  • 1.0.2 (latest)
  • 1.0.1
  • 1.0.0
  • 0.1.0
released Feb 4th 2025
This version is compatible with:
  • Puppet Enterprise 2025.3.x, 2025.2.x, 2025.1.x, 2023.8.x, 2023.7.x, 2023.6.x, 2023.5.x, 2023.4.x, 2023.3.x, 2023.2.x, 2023.1.x, 2023.0.x, 2021.7.x, 2021.6.x, 2021.5.x, 2021.4.x, 2021.3.x, 2021.2.x, 2021.1.x, 2021.0.x, 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 >=2.7.20 <9.0.0
  • RedHat
    ,
    CentOS
    ,
    Debian
    ,
    Ubuntu
    , 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.2'
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.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: root

Documentation

thias/root — version 1.0.2 Feb 4th 2025

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: '*'