puppet-module-pdsh

####Table of Contents

1. Description
2. Setup - The basics of getting started with pdsh
   • What pdsh affects
   • Setup requirements
3. Usage - Configuration options and additional functionality
4. Reference - Module reference

Setup

What pdsh affects

The pdsh module will install and configure pdsh and optionally add groups.

Setup Requirements

For systems with yum package manager using Puppet >= 6.0 there is a dependency on puppetlabs/yumrepo_core.

If genders support is enabled there is a soft dependency on treydock/genders

Usage

Install and configure pdsh

include ::pdsh

Note Groups are only supported on Red Hat based systems.

Define some groups with members an aliases using class (or Hiera)

class { '::pdsh':
  groups => {
    'compute' => {
      'members'  => 'o0[001-824]',
      'aliases'  => ['all'],
    }
  }
}

Groups can be defined through pdsh::group defined type

pdsh::group { 'compute':
  members => 'o0[001-824]',
  aliases => ['all'],
}

Reference

http://treydock.github.io/puppet-module-pdsh/

Reference

Table of Contents

Classes

Public Classes

• pdsh: Manage pdsh

Private Classes

• pdsh::config: Manage pdsh config
• pdsh::install: Install pdsh

Defined types

• pdsh::group: Define pdsh groups

Classes

pdsh

Manage pdsh

Examples

include ::pdsh

Parameters

The following parameters are available in the pdsh class.

with_rsh

Data type: Boolean

Install rsh support

Default value: false

with_ssh

Data type: Boolean

Install ssh support

Default value: true

with_torque

Data type: Boolean

Install Torque support

Default value: false

with_genders

Data type: Boolean

Install genders support

Default value: false

support_dsh

Data type: Boolean

Boolean to set if dsh support is available

Default value: true

manage_epel

Data type: Boolean

Boolean that determines if EPEL repo should be managed

Default value: true

manage_genders

Data type: Boolean

Boolean that determines if genders class should be managed

Default value: true

package_ensure

Data type: String

Packages ensure property

Default value: 'present'

package_name

Data type: String

Main pdsh package name

Default value: 'pdsh'

rsh_package_name

Data type: Optional[String]

rsh support package name

Default value: undef

ssh_package_name

Data type: Optional[String]

ssh support package name

Default value: undef

dshgroup_package_name

Data type: Optional[String]

dshgroup support package name

Default value: undef

torque_package_name

Data type: Optional[String]

Torque support package name

Default value: undef

genders_package_name

Data type: Optional[String]

Genders support package name

Default value: undef

extra_packages

Data type: Array

Additional pdsh packages to install

Default value: []

dsh_config_dir

Data type: Stdlib::Absolutepath

Path to dsh config directory

Default value: '/etc/dsh'

dsh_group_dir

Data type: Stdlib::Absolutepath

Path to dsh group directory

Default value: '/etc/dsh/group'

dsh_group_dir_purge

Data type: Boolean

Sets if dsh group directory should be purged

Default value: true

groups

Data type: Variant[Array, Hash]

Groups that should be defined using pdsh::group

Default value: {}

use_setuid

Data type: Boolean

Should pdsh binaries have setuid

Default value: false

rcmd_type

Data type: Optional[String]

Sets default remote command via PDSH_RCMD_TYPE environment variable

Default value: undef

ssh_args_append

Data type: Optional[String]

Additional SSH arguments set via PDSH_SSH_ARGS_APPEND environment variable

Default value: undef

Defined types

pdsh::group

Define pdsh groups

Examples

pdsh::group { 'nodes':
  members => 'c[01-04]',
  aliases => 'compute',
}

Parameters

The following parameters are available in the pdsh::group defined type.

aliases

Data type: Variant[Array, String]

Group aliases

Default value: []

members

Data type: Variant[Array, String]

Group members

Default value: []

Change log

All notable changes to this project will be documented in this file. The format is based on Keep a Changelog and this project adheres to Semantic Versioning.

v0.2.0 (2019-08-20)

Full Changelog

Added

• Add genders support #8 (treydock)

v0.1.2 (2019-08-20)

Full Changelog

Fixed

• Fix README #7 (treydock)

v0.1.1 (2019-08-15)

Full Changelog

Fixed

• Add missing concat dependency and better acceptance tests #6 (treydock)

v0.1.0 (2019-08-15)

Full Changelog

Changed

• Modernize and simplify module #2 (treydock)

Added

• Support String or Array for group members and aliases #5 (treydock)
• Initial support for Debian and Ubuntu #4 (treydock)
• Use module Hiera data #3 (treydock)
• Convert module to PDK #1 (treydock)

* This Changelog was automatically generated by github_changelog_generator