Forge Home

Modules

Puppet

Resources

PuppetEcosystemPuppet CommunityUpdates

clustershell

clustershell Puppet module
Project URLRSS FeedReport issues

13,624 downloads

2,366 latest version

4.7 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

  • 3.0.0 (latest)
  • 2.0.0
  • 1.1.0
  • 1.0.1
  • 1.0.0
  • 0.3.1
  • 0.3.0
  • 0.2.1
  • 0.2.0
  • 0.1.0
released Aug 23rd 2023
This version is compatible with:
  • Puppet Enterprise 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
  • Puppet >= 7.0.0 < 9.0.0
  • , , , , ,

Start using this module

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

Add this module to your Puppetfile:

mod 'treydock-clustershell', '3.0.0'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add treydock-clustershell
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install treydock-clustershell --version 3.0.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
Tags: hpc, nodeset, clush

Documentation

treydock/clustershell — version 3.0.0 Aug 23rd 2023

puppet-module-clustershell

Puppet Forge Build Status

Table of Contents

  1. Description
  2. Setup - The basics of getting started with clustershell
  3. Usage - Configuration options and additional functionality
  4. Reference - Module reference

Description

This module will manage ClusterShell

Setup

What clustershell affects

This module will install the clustershell packages and manage the clustershell configs.

Setup Requirements

For systems with yum package manager there is a dependency on puppetlabs/yumrepo_core.

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

Usage

Install clustershell and define groups in local.cfg:

class { '::clustershell':
  groupmembers => {
    compute => {
      group  => 'compute',
      member => 'node[00-99]',
    }
    login => {
      group  => 'login',
      member => 'login[01-02]',
    }
  },
}

The equivalent in hiera would be:

clustershell::groupmembers:
  compute:
    group: 'compute'
    member: 'node[00-99]'
  login:
    group: 'login'
    member: 'login[01-02]'

Enable SLURM groups and make them the default:

class { '::clustershell':
  default_group_source => 'slurm',
  include_slurm_groups => true,
}

Enable genders groups and make them the default:

class { '::clustershell':
  default_group_source   => 'genders',
  include_genders_groups => true,
}

Define groups via YAML group files:

class { '::clustershell':
  group_yaml => {
    'cluster' => {
      'data'  => {
        'local' => {
          'compute' => 'node[00-99]',
          'login'   => 'login[01-02]',
        }
      }
    }
  }
}

Defining group YAML files via defined type:

::clustershell::group_yaml { 'cluster':
  data => {
    'local' => {
      'compute' => 'node[00-99]',
      'login'   => 'login[01-02]',
    }
  }
}

Can also supply custom templates to clustershell::group_yaml

::clustershell::group_yaml { 'cluster':
  content => template('profile/clustershell/cluster.yaml.erb'),
}

Example of defining custom group source:

::clustershell::group_source { 'batch':
  ensure  => 'present',
  section => 'job,moabrsv',
  map     => 'clustershell-batch-mapper.py $SOURCE map $GROUP',
  list    => 'clustershell-batch-mapper.py $SOURCE list',
}

Reference

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