Forge Home


apptainer Puppet module


240 latest version

5.0 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

  • 0.1.1 (latest)
  • 0.1.0
released May 12th 2022
This version is compatible with:
  • Puppet Enterprise 2021.7.x, 2021.6.x, 2021.5.x, 2021.4.x, 2021.3.x, 2021.2.x, 2021.1.x, 2021.0.x, 2019.8.x, 2019.7.x, 2019.5.x, 2019.4.x, 2019.3.x, 2019.2.x, 2019.1.x, 2019.0.x
  • Puppet >= 6.0.0 < 8.0.0
  • , , , ,

Start using this module

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

Add this module to your Puppetfile:

mod 'treydock-apptainer', '0.1.1'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

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

Manually install this module globally with Puppet module tool:

puppet module install treydock-apptainer --version 0.1.1

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.



treydock/apptainer — version 0.1.1 May 12th 2022


Puppet Forge CI Status

Table of Contents

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


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

RedHat based systems will by default install from apptainer package

Debian based systems will by default install from source



Install and configure apptainer.

include apptainer

For both package and source installs, it's best to define the desired version. This Puppet module supports both upgrades and downgrades of Apptainer.

apptainer::version: '1.0.1'

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

apptainer::version: '1.0.1'
apptainer::install_method: source
  without-suid: true
  mandir: /some/other/path
apptainer::prefix: /opt/apptainer
apptainer::sysconfdir: /opt/apptainer/etc
apptainer::localstatedir: /opt/apptainer/var

Compile and install a Apptainer plugin from the Apptainer source:

    source_dir: examples/plugins/log-plugin

If replacing Singularity with Apptainer, it's possible to have this module cleanup Singularity to avoid conflicts:

apptainer::remove_singularity: true

Enabling Singularity removal will result in the following actions:

  • Remove /etc/singularity
  • Remove /usr/local/sbin/
  • Remove /opt/singularity
  • Remove /opt/singularity-3*