Version information
released Oct 16th 2018
This version is compatible with:
- Puppet Enterprise 2019.8.x, 2019.7.x, 2019.5.x, 2019.4.x, 2019.3.x, 2019.2.x, 2019.1.x, 2019.0.x, 2018.1.x, 2017.3.x
- Puppet >= 5.0.0 < 7.0.0
- RedHat,CentOS,Scientific
Start using this module
Add this module to your Puppetfile:
mod 'treydock-singularity', '2.0.1'Learn more about managing modules with a PuppetfileDocumentation
treydock/singularity — version 2.0.1 Oct 16th 2018
puppet-module-singularity
Table of Contents
- Overview
- Usage - Configuration options
- Reference - Parameter and detailed reference to all options
- Limitations - OS compatibility, etc.
- Development - Guide for contributing to the module
- TODO
- Additional Information
Overview
This module manages the singularity package installation and configuration of singularity.conf.
NOTE: The puppetlabs/yumrepo_core Puppet module is a soft dependency if using Puppet >= 6.0.0.
Usage
singularity
Install and configure singularity:
class { 'singularity': }
Reference
Classes
Public classes
singularity: Installs and configures singularity.
Private classes
singularity::install: Installs singularity packages.singularity::config: Configures singularity.singularity::params: Sets parameter defaults based on fact values.
Parameters
singularity
Below are parameter defaults in Hiera format:
singularity::package_ensure: present
singularity::package_name: singularity
singularity::manage_epel: true
singularity::config_path: /etc/singularity/singularity.conf
singularity::config_template: singularity/singularity.conf.erb
singularity::allow_setuid: 'yes'
singularity::max_loop_devices: 256
singularity::allow_pid_ns: 'yes'
singularity::config_passwd: 'yes'
singularity::config_group: 'yes'
singularity::config_resolv_conf: 'yes'
singularity::mount_proc: 'yes'
singularity::mount_sys: 'yes'
singularity::mount_dev: 'yes'
singularity::mount_devpts: 'yes'
singularity::mount_home: 'yes'
singularity::mount_tmp: 'yes'
singularity::mount_hostfs: 'no'
singularity::bind_paths:
- /etc/localtime
- /etc/hosts
singularity::user_bind_control: 'yes'
singularity::enable_overlay: 'try'
singularity::enable_underlay: 'yes'
singularity::mount_slave: 'yes'
singularity::sessiondir_max_size: 16
#singularity::limit_container_owners: undef
#singularity::limit_container_groups: undef
#singularity::limit_container_paths: undef
singularity::allow_containers:
squashfs: 'yes'
extfs: 'yes'
dir: 'yes'
#singularity::autofs_bug_paths: undef
singularity::always_use_nv: 'no'
singularity::root_default_capabilities: 'no'
singularity::allow_root_capabilities: 'yes'
singularity::allow_user_capabilities: 'no'
singularity::memory_fs_type: tmpfs
#singularity::cni_configuration_path: undef
#singularity::cni_plugin_path: undef
#singularity::mksquashfs_path: undef
package_ensure
Package ensure parameter, defaults to present
package_name
Package name, defaults to singularity
manage_epel
Determines whether to include EPEL class before installing singularity. Defaults to true
Limitations
This module has been tested on:
- CentOS 6 x86_64
- CentOS 7 x86_64
Development
Testing
Testing requires the following dependencies:
- rake
- bundler
Install gem dependencies
bundle install
Run unit tests
bundle exec rake test
If you have Vagrant >= 1.2.0 installed you can run system tests
bundle exec rake beaker
TODO
Further Information
treydock-singularity changelog
Release notes for the treydock-singularity module.
2.0.1 (2018-10-16)
Fixed bugs:
2.0.0 (2018-10-15)
Implemented enhancements:
- 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)
Implemented enhancements:
1.1.0 (2018-05-01)
Implemented enhancements:
1.0.1 (2018-05-01)
Fixed bugs:
1.0.0 (2018-03-19)
Implemented enhancements:
- BREAKING: Drop Puppet 3 support #3 (treydock)
- BREAKING: Change default for enable_overlay to 'try' #2 (treydock)
0.1.0 (2017-10-12)
Implemented enhancements:
0.0.2 (2017-08-15)
- Fix enable_overlay to default to
noon systems that don't support overlayfs
0.0.1 (2017-08-07)
- Initial release
Dependencies
- puppetlabs/stdlib (>= 4.13.1 <5.0.0)
- stahnma/epel (>= 1.0.0 <2.0.0)
Copyright (C) 2017 Trey Dockendorf <treydock@gmail.com>
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.