puppet-lmod

Overview

The lmod module handles the configuration of a system to use Lmod. Additional details regarding Lmod can be found at http://lmod.readthedocs.io/en/latest/index.html.

Usage

lmod

Install Lmod through package repositories:

class { 'lmod': }

This is an example install Lmod from source.

class { 'lmod':
  prefix            => '/apps',
  modulepath_root   => '/apps/modulefiles',
  version           => '8.4.26',
  install_method    => 'source',
  source_with_flags => {
    'spiderCacheDir' => '/apps/lmodcache/cacheDir',
    'updateSystemFn' => '/apps/lmodcache/system.txt',
  },
}

If you wish to manage the Lmod install outside Puppet:

class { 'lmod':
  prefix            => '/apps',
  modulepath_root   => '/apps/modulefiles',
  install_method    => 'none',
}

To customize the avail layout (since Lmod 5.7.5)

class { 'lmod':
  avail_styles => ['grouped', 'system'],
}

Below is an example that adds several paths to default MODULEPATH, sets a default module, sets LMOD_PACKAGE_PATH and sets LMOD_SYSTEM_NAME.

class { 'lmod':
  modulepaths            => ['$LMOD_sys', 'Core'],
  set_lmod_package_path  => true,
  set_default_module     => true,
  default_module         => 'mycluster',
}

Reference

http://treydock.github.io/puppet-lmod/

Reference

Table of Contents

Classes

Public Classes

• lmod: Manage Lmod

Private Classes

• lmod::install: Install Lmod package and dependencies
• lmod::install::source: Install Lmod from source
• lmod::load: Manage Lmod load config files

Classes

lmod

Manage Lmod

Examples

To install Lmod from existing package repositories

class { 'lmod':
   install_method => 'package',
 }

Parameters

The following parameters are available in the lmod class:

• ensure
• version
• package_ensure
• prefix
• install_method
• manage_epel
• source_dir
• source_with_flags
• package_name
• runtime_packages
• build_packages
• manage_alternatives
• modulepath_root
• modulepaths
• set_lmod_package_path
• lmod_package_path
• set_default_module
• default_module
• avail_styles
• lmod_admin_file
• system_name
• site_name
• cached_loads
• modules_bash_path
• modules_bash_template
• modules_bash_source
• modules_csh_path
• modules_csh_template
• modules_csh_source
• stdenv_bash_path
• stdenv_bash_template
• stdenv_bash_source
• stdenv_csh_path
• stdenv_csh_template
• stdenv_csh_source
• with_fish
• modules_fish_path
• modules_fish_template
• modules_fish_source
• stdenv_fish_path
• stdenv_fish_template
• stdenv_fish_source

ensure

Data type: Enum['present','absent']

The ensure parameter for this module. If set to 'absent', managed files are removed. If lmod_package_from_repo is true and ensure is 'absent', then the lmod package is also removed.

Default value: 'present'

version

Data type: String

Version of Lmod to install when installing from source

Default value: '8.4.26'

package_ensure

Data type: String

The ensure value for Lmod package. Only applies when lmod_package_from_repo is true.

Default value: 'present'

prefix

Data type: Stdlib::Absolutepath

The prefix used when lmod was compiled.

Default value: '/usr/share'

install_method

Data type: Enum['package','source','none']

How Lmod should be installed

Default value: 'package'

manage_epel

Data type: Boolean

Boolean that determines if EPEL should be mananged by this module for systems installing Lmod via yum.

Default value: true

source_dir

Data type: Stdlib::Absolutepath

Directory to store Lmod source

Default value: '/usr/src'

source_with_flags

Data type: Hash

Key/value pair of flags to turn into --with-= passed to configure when installing from source

Default value: {}

package_name

Data type: String

Lmod package name if lmod_package_from_repo is true.

Default value: 'Lmod'

runtime_packages

Data type: Array

Lmod runtime package dependencies, only installed if lmod_package_from_repo is false

Default value: []

build_packages

Data type: Array

Lmod runtime devel package dependencies, only installed if manage_build_packages is true

Default value: []

manage_alternatives

Data type: Boolean

Sets whether alternatives are managed by this module Only used for Debian and Ubuntu systems

Default value: true

modulepath_root

Data type: Optional[Stdlib::Absolutepath]

The modulepath for your lmod installation. Default is 'UNSET'. If the value is 'UNSET' then the path $prefix/modulefiles is used.

Default value: undef

modulepaths

Data type: Array

An Array of modulepaths to be defined in the module.sh and module.csh.

Default value: ['$LMOD_sys', 'Core']

set_lmod_package_path

Data type: Boolean

Boolean that determines if the LMOD_PACKAGE_PATH environment variable should be set in modules.sh and modules.csh.

Default value: false

lmod_package_path

Data type: String

Value given to the LMOD_PACKAGE_PATH environment variable in modules.sh and modules.csh.

Default value: '$MODULEPATH_ROOT/Site'

set_default_module

Data type: Boolean

Boolean will disable the management of the files that define the default module.

Default value: false

default_module

Data type: String

The name of the default module to be loaded when users login. This will not be set if set_default_module is false.

Default value: 'StdEnv'

avail_styles

Data type: Array

An Array used to set the LMOD_AVAIL_STYLES environment variable. An empty Array prevents this environment variable from being set.

Default value: ['system']

lmod_admin_file

Data type: Optional[Stdlib::Absolutepath]

Defines path used for LMOD_ADMIN_FILE.

Default value: undef

system_name

Data type: Optional[String]

Value used for LMOD_SYSTEM_NAME.

Default value: undef

site_name

Data type: Optional[String]

Value used for LMOD_SITE_NAME.

Default value: undef

cached_loads

Data type: Optional[Boolean]

Value used for LMOD_CACHED_LOADS.

Default value: undef

modules_bash_path

Data type: Stdlib::Absolutepath

Path to script to load bash modules environment

Default value: '/etc/profile.d/modules.sh'

modules_bash_template

Data type: String

Module bash load template

Default value: 'lmod/modules.sh.erb'

modules_bash_source

Data type: Optional[String]

Module bash load source

Default value: undef

modules_csh_path

Data type: Stdlib::Absolutepath

Path to script to load csh modules environment

Default value: '/etc/profile.d/modules.csh'

modules_csh_template

Data type: String

Module csh load template

Default value: 'lmod/modules.csh.erb'

modules_csh_source

Data type: Optional[String]

Module csh load source

Default value: undef

stdenv_bash_path

Data type: Stdlib::Absolutepath

Path to bash script that loads default modules

Default value: '/etc/profile.d/z00_StdEnv.sh'

stdenv_bash_template

Data type: String

Default module bash load template

Default value: 'lmod/z00_StdEnv.sh.erb'

stdenv_bash_source

Data type: Optional[String]

Default module bash load source

Default value: undef

stdenv_csh_path

Data type: Stdlib::Absolutepath

Path to csh script that loads default modules

Default value: '/etc/profile.d/z00_StdEnv.csh'

stdenv_csh_template

Data type: String

Default module csh load template

Default value: 'lmod/z00_StdEnv.csh.erb'

stdenv_csh_source

Data type: Optional[String]

Default module bash load source

Default value: undef

with_fish

Data type: Boolean

Enable fish support

Default value: false

modules_fish_path

Data type: Stdlib::Absolutepath

Path to script to load fish modules environment

Default value: '/etc/fish/conf.d/modules.fish'

modules_fish_template

Data type: String

Module fish load template

Default value: 'lmod/modules.fish.erb'

modules_fish_source

Data type: Optional[String]

Module fish load source

Default value: undef

stdenv_fish_path

Data type: Stdlib::Absolutepath

Path to fish script that loads default modules

Default value: '/etc/fish/conf.d/z00_StdEnv.fish'

stdenv_fish_template

Data type: String

Default module fish load template

Default value: 'lmod/z00_StdEnv.fish.erb'

stdenv_fish_source

Data type: Optional[String]

Default module bash load source

Default value: undef

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.

v5.0.0 (2024-10-22)

Full Changelog

Changed

• Major updates - see description #45 (treydock)

v4.0.0 (2023-12-14)

Full Changelog

Changed

• Major updates - read description #43 (treydock)

Added

• Add fish support #44 (treydock)

v3.3.2 (2022-09-02)

Full Changelog

Fixed

• Remove extra newlines #42 (treydock)

v3.3.1 (2022-09-02)

Full Changelog

Fixed

• Also allow absolute path for csh load file #41 (treydock)

v3.3.0 (2022-09-02)

Full Changelog

Added

• Support adding absolute path modulepaths to MODULEPATH #40 (treydock)

v3.2.0 (2022-04-21)

Full Changelog

Added

• Replace CentOS 8 with Rocky 8 and fix package installs on Debian and Ubuntu #39 (treydock)

v3.1.0 (2021-09-23)

Full Changelog

Added

• Use Lua 5.3 for Debian 10 and Ubuntu #37 (treydock)

v3.0.1 (2021-09-16)

Full Changelog

Fixed

• Ensure csh is installed for Debian and Ubuntu #34 (treydock)

v3.0.0 (2021-09-08)

Full Changelog

Changed

• Remove support for Ubuntu 16.04 #30 (treydock)

Added

• Update module dependency ranges #31 (treydock)

v2.0.0 (2021-03-10)

Full Changelog

Changed

• BREAKING Major refactor (read pull request description) #28 (treydock)
• Drop Puppet 5 support #27 (treydock)
• Drop support for EL6, Debian 8, Ubuntu 14.04 #24 (treydock)

Added

• Support stdlib 6.x #26 (treydock)
• Support EL8, Debian 10, Ubuntu 20.04, Puppet 7 #25 (treydock)

v1.3.0 (2019-05-10)

Full Changelog

Added

• Use puppet strings #22 (treydock)
• Use Hiera v5 data #21 (treydock)
• Support Debian 8 and 9 and Ubuntu 18.04 #20 (treydock)
• Use PDK #19 (treydock)
• Support Puppet 5 and 6 and use Beaker 4 #18 (treydock)
• Make EPEL optional #17 (treydock)

1.2.0 (2018-06-25)

Full Changelog

Added

• Allow LMOD_SITE_NAME to be set #16 (treydock)

1.1.0 (2018-04-18)

Full Changelog

Added

• Support setting LMOD_CACHED_LOADS via cached_loads parameter #15 (treydock)

1.0.2 (2017-11-09)

Full Changelog

Fixed

• Fix bash module load file syntax error #14 (treydock)

1.0.1 (2017-10-28)

Full Changelog

1.0.0 (2017-10-28)

Full Changelog

Added

• Add package_ensure parameter. Only used when lmod_package_from_repo=true #11 (treydock)
• Remove EL5 package list #10 (treydock)
• Update bash init script to check for various commands in multiple locations #9 (treydock)
• BREAKING: Drop support for Puppet 3 and use Puppet datatypes #8 (treydock)

0.0.1 (2017-10-19)

Full Changelog

Added

• Drop puppet 2.7 testing, sync test matrix #6 (jabl)
• Support Ubuntu 16.04 LTS #3 (jabl)
• Support Ubuntu, and allow lmod package to be installed from repo #1 (jabl)

Fixed

• Use correct default tcsh paths on Ubuntu #5 (jabl)

* This Changelog was automatically generated by github_changelog_generator