puppet-module-singularity

Table of Contents

1. Overview
2. Usage - Configuration options
3. Reference - Parameter and detailed reference to all options

Overview

This module manages the singularity installation and configuration of singularity.conf.

RedHat based systems will by default install from EPEL package

Debian based systems will by default install from source

Usage

singularity

Install and configure singularity.

include singularity

The following Hiera example of building from source (default for Debian based systems) with several additional options passed.

singularity::install_method: source
singularity::build_flags:
  without-suid: true
  mandir: /some/other/path
singularity::build_env:
  GOPATH=/some/other/path
singularity::prefix: /opt/singularity
singularity::sysconfdir: /opt/singularity/etc
singularity::localstatedir: /opt/singularity/var

Compile and install a Singularity plugin from the Singularity source:

singularity::plugins:
  github.com/sylabs/singularity/log-plugin:
    source_dir: examples/plugins/log-plugin

Reference

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

Reference

Table of Contents

Classes

Public Classes

• singularity: Manage Singularity

Private Classes

• singularity::config: Private class
• singularity::install::package: Private class
• singularity::install::source: Private class

Defined types

• singularity::plugin: Manage Singularity plugin

Classes

singularity

Manage Singularity

Examples

include ::singularity

Parameters

The following parameters are available in the singularity class:

• install_method
• package_ensure
• package_name
• manage_epel
• version
• source_dependencies
• manage_go
• rebuild_on_go
• source_base_dir
• source_mconfig_path
• build_flags
• build_env
• prefix
• localstatedir
• sysconfdir
• source_exec_path
• plugins
• config_path
• config_template
• allow_setuid
• max_loop_devices
• allow_pid_ns
• config_passwd
• config_group
• config_resolv_conf
• mount_proc
• mount_sys
• mount_dev
• mount_devpts
• mount_home
• mount_tmp
• mount_hostfs
• bind_paths
• user_bind_control
• enable_fusemount
• enable_overlay
• enable_underlay
• mount_slave
• sessiondir_max_size
• limit_container_owners
• limit_container_groups
• limit_container_paths
• allow_containers
• allow_net_users
• allow_net_groups
• allow_net_networks
• always_use_nv
• always_use_rocm
• root_default_capabilities
• memory_fs_type
• cni_configuration_path
• cni_plugin_path
• mksquashfs_path
• mksquashfs_procs
• mksquashfs_mem
• cryptsetup_path
• shared_loop_devices
• image_driver
• namespace_users
• namespace_begin_id
• namespace_id_range
• subid_template

install_method

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

Sets how Singularity will be installed

Default value: 'package'

package_ensure

Data type: String

Package ensure property Only used when install_method=package

Default value: 'present'

package_name

Data type: String

Singularity package name Only used when install_method=package

Default value: 'singularity'

manage_epel

Data type: Boolean

Determines if EPEL repo should be managed Only used when install_method=package on RedHat based systems

Default value: true

version

Data type: String

Version of Singularity to install Only used when install_method=source

Default value: '3.7.4'

source_dependencies

Data type: Array

Packages needed to build from source Only used when install_method=source

Default value: []

manage_go

Data type: Boolean

Sets if golang module should be included Only used when install_method=source

Default value: true

rebuild_on_go

Data type: Boolean

Sets if Singularity should be rebuilt on updates to Go via golang module Only used when install_method=source and manage_go=true

Default value: true

source_base_dir

Data type: Stdlib::Absolutepath

Base directory of where Singularity source will be extracted Only used when install_method=source

Default value: '/opt'

source_mconfig_path

Data type: Stdlib::Absolutepath

Path to source install mconfig script

Default value: '/usr/local/sbin/singularity-mconfig.sh'

build_flags

Data type: Hash

Build flags to pass to mconfig when building Singularity Only used when install_method=source

Default value: {}

build_env

Data type: Hash

Environment variables to use when building from source Only used when install_method=source

Default value: {}

prefix

Data type: Stdlib::Absolutepath

The --prefix value when building from source Only used when install_method=source

Default value: '/usr'

localstatedir

Data type: Stdlib::Absolutepath

The --localstatedir value when building from source Only used when install_method=source

Default value: '/var'

sysconfdir

Data type: Stdlib::Absolutepath

The --sysconfdir value when building from source Only used when install_method=source

Default value: '/etc'

source_exec_path

Data type: String

Set PATH when building from source Only used when install_method=source

Default value: '/usr/local/bin:/bin:/usr/bin:/usr/local/sbin:/usr/sbin:/sbin'

plugins

Data type: Hash

Hash to define singularity::plugin resources

Default value: {}

config_path

Data type: Stdlib::Absolutepath

Path to singularity.conf

Default value: '/etc/singularity/singularity.conf'

config_template

Data type: String

Template used for singularity.conf

Default value: 'singularity/singularity.conf.erb'

allow_setuid

Data type: Enum['yes','no']

See singularity.conf: allow setuid

Default value: 'yes'

max_loop_devices

Data type: Integer

See singularity.conf: max loop devices

Default value: 256

allow_pid_ns

Data type: Enum['yes','no']

See singularity.conf: allow pid ns

Default value: 'yes'

config_passwd

Data type: Enum['yes','no']

See singularity.conf: config passwd

Default value: 'yes'

config_group

Data type: Enum['yes','no']

See singularity.conf: config group

Default value: 'yes'

config_resolv_conf

Data type: Enum['yes','no']

See singularity.conf: config resolv conf

Default value: 'yes'

mount_proc

Data type: Enum['yes','no']

See singularity.conf: mount proc

Default value: 'yes'

mount_sys

Data type: Enum['yes','no']

See singularity.conf: mount sys

Default value: 'yes'

mount_dev

Data type: Enum['yes','no']

See singularity.conf: mount dev

Default value: 'yes'

mount_devpts

Data type: Enum['yes','no']

See singularity.conf: mount devpts

Default value: 'yes'

mount_home

Data type: Enum['yes','no']

See singularity.conf: mount home

Default value: 'yes'

mount_tmp

Data type: Enum['yes','no']

See singularity.conf: mount tmp

Default value: 'yes'

mount_hostfs

Data type: Enum['yes','no']

See singularity.conf: mount hostfs

Default value: 'no'

bind_paths

Data type: Array[Stdlib::Absolutepath]

See singularity.conf: bind paths

Default value: ['/etc/localtime', '/etc/hosts']

user_bind_control

Data type: Enum['yes','no']

See singularity.conf: user bind control

Default value: 'yes'

enable_fusemount

Data type: Enum['yes','no']

See singularity.conf: enable fusemount

Default value: 'yes'

enable_overlay

Data type: Enum['yes','no','try']

See singularity.conf: enable overlay

Default value: 'try'

enable_underlay

Data type: Enum['yes','no','try','driver']

See singularity.conf: enable underlay

Default value: 'yes'

mount_slave

Data type: Enum['yes','no']

See singularity.conf: mount slave

Default value: 'yes'

sessiondir_max_size

Data type: Integer

See singularity.conf: sessiondir max size

Default value: 16

limit_container_owners

Data type: Optional[Array]

See singularity.conf: limit container owners

Default value: undef

limit_container_groups

Data type: Optional[Array]

See singularity.conf: limit container groups

Default value: undef

limit_container_paths

Data type: Optional[Array]

See singularity.conf: limit container paths

Default value: undef

allow_containers

Data type: Hash[String,Enum['yes','no']]

See singularity.conf: allow containers

Default value: { 'squashfs' => 'yes', 'extfs' => 'yes', 'dir' => 'yes', 'encrypted' => 'yes', }

allow_net_users

Data type: Array

See singularity.conf: allow net users

Default value: []

allow_net_groups

Data type: Array

See singularity.conf: allow net groups

Default value: []

allow_net_networks

Data type: Array

See singularity.conf: allow net networks

Default value: []

always_use_nv

Data type: Enum['yes','no']

See singularity.conf: always use nv

Default value: 'no'

always_use_rocm

Data type: Enum['yes','no']

See singularity.conf: always use rocm

Default value: 'no'

root_default_capabilities

Data type: Enum['full','file','default','no']

See singularity.conf: root default capabilities

Default value: 'full'

memory_fs_type

Data type: Enum['tmpfs','ramfs']

See singularity.conf: memory fs type

Default value: 'tmpfs'

cni_configuration_path

Data type: Optional[Stdlib::Absolutepath]

See singularity.conf: cni configuration path

Default value: undef

cni_plugin_path

Data type: Optional[Stdlib::Absolutepath]

See singularity.conf: cni plugin path

Default value: undef

mksquashfs_path

Data type: Optional[Stdlib::Absolutepath]

See singularity.conf: mksquashfs path

Default value: undef

mksquashfs_procs

Data type: Integer[0,default]

See singularity.conf: mksquashfs procs

Default value: 0

mksquashfs_mem

Data type: Optional[String[1]]

See singularity.conf: mksquashfs mem

Default value: undef

cryptsetup_path

Data type: Optional[Stdlib::Absolutepath]

See singularity.conf: cryptsetup path

Default value: undef

shared_loop_devices

Data type: Enum['yes','no']

See singularity.conf: shared loop devices

Default value: 'no'

image_driver

Data type: Optional[String]

See singularity.conf: image driver

Default value: undef

namespace_users

Data type: Array

List of uses to add to /etc/subuid and /etc/subgid to support user namespaces

Default value: []

namespace_begin_id

Data type: Integer

The beginning ID for /etc/subuid and /etc/subgid. The value is incremented For each user by start + namespace_id_range + 1

Default value: 65537

namespace_id_range

Data type: Integer

The range of UIDs/GIDs usable by a user in namespaces

Default value: 65536

subid_template

Data type: String

The template to use for /etc/subuid and /etc/subgid

Default value: 'singularity/subid.erb'

Defined types

singularity::plugin

Manage Singularity plugin

Examples

install log plugin

singularity::plugin { 'github.com/sylabs/singularity/log-plugin':
  source_dir => 'examples/plugins/log-plugin',
}

Parameters

The following parameters are available in the singularity::plugin defined type:

• source_dir
• ensure
• sif_name

source_dir

Data type: Optional[String]

The plugin source directory This path must be relative to Singularity source directory $singularity::install::source::source_dir

Default value: undef

ensure

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

Whether to install (present) or uninstall (absent) the plugin

Default value: 'present'

sif_name

Data type: Optional[String]

The name of the SIF image to use for install after the plugin is compiled. The default is to use part after last / in the plugin name so plugin examples/plugins/log-plugin will have SIF name of log-plugin.sif.

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.4.0 (2021-09-22)

Full Changelog

Added

• Bump upper version limit for the stdlib dependency #32 (mrolli)

v5.3.1 (2021-06-30)

Full Changelog

Fixed

• Avoid dependency package conflicts with source installs #30 (treydock)

v5.3.0 (2021-06-17)

Full Changelog

Added

• Rebuild source on golang update or new source download #29 (treydock)

v5.2.1 (2021-06-17)

Full Changelog

Fixed

• Make source archive resource name generic #28 (treydock)

v5.2.0 (2021-06-17)

Full Changelog

Added

• Support Singularity 3.8.0, update default version to 3.7.4 #27 (treydock)

v5.1.0 (2021-06-14)

Full Changelog

Added

• Improve source install method to support better upgrade/downgrade #26 (treydock)
• Support Singularity plugin compile and install #25 (treydock)
• Update module dependency ranges #24 (treydock)

v5.0.0 (2021-03-19)

Full Changelog

Changed

• Drop Puppet 5, add Puppet 7, drop EL6, update dependencies #22 (treydock)

Added

• Support build from source and Debian and Ubuntu #23 (treydock)

v4.0.0 (2020-10-28)

Full Changelog

Changed

• BREAKING: Support Singularity 3.6 #20 (treydock)

v3.5.0 (2019-12-18)

Full Changelog

Added

• Add 'allow container encrypted' default #18 (treydock)

v3.4.0 (2019-11-14)

Full Changelog

Added

• Add parameters to support Singularity 3.5.0 #17 (treydock)

v3.3.0 (2019-10-11)

Full Changelog

Added

• Support EL8 #16 (treydock)

v3.2.0 (2019-10-10)

Full Changelog

Added

• Add support for managing /etc/subuid and /etc/subgid #15 (treydock)

v3.1.0 (2019-05-09)

Full Changelog

Added

• Use Hiera v5 module data #14 (treydock)
• Use PDK #13 (treydock)

3.0.0 (2019-03-20)

Full Changelog

Added

• README updates and use puppet strings for docs #12 (treydock)
• BREAKING: Update singularity.conf to support Singularity 3.1.0 #11 (treydock)

2.0.1 (2018-10-16)

Full Changelog

Fixed

• Make underlay default match documented default #10 (treydock)

2.0.0 (2018-10-15)

Full Changelog

Added

• Add support for Puppet 6 and drop support for Puppet 4 #9 (treydock)
• Update singularity.conf to match 3.0.0 #8 (treydock)

1.2.0 (2018-09-14)

Full Changelog

Added

• Use beaker 4.x #7 (treydock)
• Support new options of Singularity-2.6.0 #6 (mrolli)

1.1.0 (2018-05-01)

Full Changelog

Added

• Add limit_container_groups parameter which was added in Singularity 2.5.0 #5 (treydock)

1.0.1 (2018-05-01)

Full Changelog

Fixed

• Fixed boolean error when using provided hiera parameters #4 (kreczko)

1.0.0 (2018-03-19)

Full Changelog

Added

• BREAKING: Drop Puppet 3 support #3 (treydock)
• BREAKING: Change default for enable_overlay to 'try' #2 (treydock)

0.1.0 (2017-10-12)

Full Changelog

Added

• Add support for Singularity 2.4 #1 (treydock)

0.0.2 (2017-08-15)

Full Changelog

0.0.1 (2017-08-07)

Full Changelog

* This Changelog was automatically generated by github_changelog_generator