Skip to content

Latest commit

 

History

History
422 lines (237 loc) · 10 KB

REFERENCE.md

File metadata and controls

422 lines (237 loc) · 10 KB
Raw

Reference

Table of Contents

Classes

Public Classes

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

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