Forge Home

Modules

Puppet

Resources

PuppetEcosystemPuppet CommunityUpdates

rex

Module used to deploy REX user for Satellite 6/Foreman
Project URLRSS FeedReport issues

6,890 downloads

6,419 latest version

1.9 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.0 (latest)
  • 0.1.2
released Aug 22nd 2017

Start using this module

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

Add this module to your Puppetfile:

mod 'chopskxw-rex', '0.2.0'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add chopskxw-rex
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install chopskxw-rex --version 0.2.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

Documentation

chopskxw/rex — version 0.2.0 Aug 22nd 2017

rex

Table of Contents

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

Description

The purpose of this module is to configure existing Satellite/Foreman systems for remote execution (REX).

Setup

Import module and publish/promote to appropriate CV/LCE. Configure overrides overrides for the rex::params class. The following two are required, any additional can be tweeked to the desired value.

rex_user = <%= @host.params['remote_execution_ssh_user'] %>
resources = 
---
ssh_authorized_key:
  <% for _key in @host.params['remote_execution_ssh_keys'] do -%>
  <% key = _key.split(' ') -%>
  <%= key[2] %>:
    user: <%= @host.params['remote_execution_ssh_user'] %>
    type: <%= key[0] %>
    key: <%= key[1] %>
  <% end -%>

Following this, simply enable the rex and rex::params classes on the host[s] or host group[s] of your choosing.

Note: If you plan to use a user other than root, you must configure the remote_execution_ssh_user found in the Remote Execution portion of the Settings menu.

What rex affects

This module will creat the REX user, if it is not already present and will manage this users password. It will deploy sudo rules to /etc/sudoers.d/rex. Finally, it will deploy the required ssh keys.

Files affected:

  • user's home dir
  • /etc/passwd
  • /etc/shadow
  • /etc/sudoers.d/rex
  • $home_dir/.ssh/authorized_keys

Warnings:

  • this module will not work correctly if using ldap (or other external) user
  • this module will house the users encrypted password in the UI
  • this module could cause unexpected security risks, if not properly configured

Setup Requirements

The hash_resources module must be installed for this module to function correctly. Additionally, if the desired ssh user for REX is not root, this must be configured prior to enableing this module.

Beginning with rex

  • import the module
  • configure override for resources
  • enable module

Usage

Additional user configurable parameters are available via the params class. These paramaters can be used to manage the REX user's password, set password policies, and the user comments field.

Reference

Limitations

This module will not work with external users for REX ssh user.

Development

Contributions welcome!

Release Notes/Contributors/Etc.

Author: Roy Williams (chopskxw)

Releases: 0.1.0 - initial dev release 0.1.1 - syntax fixes, etc. 0.1.2 - syntax fixes 0.2.0 - Removed !requiretty from sudo rule, created manifest to check working dir mount options, and change resources parameter to rex_keys