Forge Home


A Bolt plugin that generates local Targets from GitLab group repositories


143 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.2.1 (latest)
  • 0.1.1
  • 0.1.0
released Apr 26th 2023
This version is compatible with:
  • Puppet Enterprise 2023.2.x, 2023.1.x, 2023.0.x, 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, 2018.1.x, 2017.3.x, 2017.2.x, 2016.4.x
  • Puppet >= 4.10.0 < 8.0.0
  • , , , , , , ,
  • resolve_reference
  • clone_git_repos
  • count

Start using this module

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

Add this module to your Puppetfile:

mod 'bolterrific-gitlab_inventory', '0.2.1'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add bolterrific-gitlab_inventory
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install bolterrific-gitlab_inventory --version 0.2.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.



bolterrific/gitlab_inventory — version 0.2.1 Apr 26th 2023


Table of Contents


gitlab_inventory is an inventory reference plugin for Puppet Bolt. It uses the GitLab API to dynamically provide a list of local transport Targets that represent each project under a GitLab group.

This module also contains an example Bolt project with a working inventory.yaml and several Bolt plans.


Setup Requirements

  • Puppet Bolt
    • Preferred version: Bolt 3.17+
    • Strict minimum is Bolt 2.15+ (untested)
    • Bolt must be installed from an OS package (don't use the bolt RubyGem)
    • Note: The example inventory.yaml assumes Bolt 2.37+ (see comments)
  • A GitLab API personal auth token with sufficient scope


To use this plugin in your own Bolt project, configure it to provide targets in the inventory file.

Using the plugin in a Bolt inventory file

An example inventory.yaml file:

version: 2

  - name: gitlab_projects
      - _plugin: gitlab_inventory  # <- Plugin provides `local` Targets
        group:                     # <- GitLab group with Target repos
          _plugin: env_var
          var: GITLAB_GROUP
          default: simp
        # some optional parameters:
        gitlab_api_token:          # <- API token with scope that can get repos
          _plugin: env_var         # <- (provided by another Bolt plugin)
        archived_repos: true
          - '/^pupmod-simp/'
          - 'simp-core'
          - '/gitlab-oss/'
  transport: local
    bundled-ruby: true
     _plugin: env_var
     var: PWD




In order to provide an example Bolt project in the same module as the inventory plugin, the example bolt-project.yaml adds .. to the modulepath. This means that (when using the example Bolt project) the folder containing this repo must be named gitlab_inventory. There may be other weirdness, depending on whether neighboring directories contain Bolt projects or Puppet modules.

This quirk only affects the example Bolt project; it will not affect the inventory plugin or Bolt plans from your own Bolt projects.


Submit PRs at the project's GitHub repository.