Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/bolterrific/puppet-gitlab_inventory

Bolt inventory plugin to generate local Targets from a GitLab group's projects
https://github.com/bolterrific/puppet-gitlab_inventory

bolt bolt-inventory bolt-plans devops gitlab-api inventory-plugin orchestration puppet puppet-bolt

Last synced: 8 days ago
JSON representation

Bolt inventory plugin to generate local Targets from a GitLab group's projects

Host: GitHub
URL: https://github.com/bolterrific/puppet-gitlab_inventory
Owner: bolterrific
Created: 2020-12-31T22:43:14.000Z (about 4 years ago)
Default Branch: main
Last Pushed: 2023-04-26T20:21:08.000Z (almost 2 years ago)
Last Synced: 2024-04-19T11:07:26.049Z (10 months ago)
Topics: bolt, bolt-inventory, bolt-plans, devops, gitlab-api, inventory-plugin, orchestration, puppet, puppet-bolt
Language: Ruby
Homepage:
Size: 30.3 KB
Stars: 2
Watchers: 2
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md

Awesome Lists containing this project

README

        # gitlab_inventory

#### Table of Contents

* [Description](#description)

* [Setup](#setup)

  * [Setup Requirements](#setup-requirements)

* [Usage](#usage)

  * [Using the plugin in a Bolt inventory file](#using-the-plugin-in-a-bolt-inventory-file)

* [Reference](#reference)

* [Limitations](#limitations)

* [Development](#development)

## Description

**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

### Setup Requirements

* [Puppet Bolt][bolt]

  * Preferred version: Bolt 3.17+

  * Strict minimum is Bolt 2.15+ (untested)

  * Bolt must be installed from an [OS package][bolt-install] (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

## Usage

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:

```yaml

version: 2

groups:

  - name: gitlab_projects

    targets:

      - _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)

          var: GITLAB_API_PRIVATE_TOKEN

        gitlab_api_endpoint: https://gitlab.com/api/v4

        archived_repos: true

        allow_list:

          - '/^pupmod-simp/'

          - 'simp-core'

        block_list:

          - '/gitlab-oss/'

config:

  transport: local

  local:

    bundled-ruby: true

    tmpdir:

     _plugin: env_var

     var: PWD

```

## Reference

See [REFERENCE.md](./REFERENCE.md)

## Limitations

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.

## Development

Submit PRs at the project's GitHub repository.

[bolt]: https://puppet.com/docs/bolt/latest/bolt.html

[bolt-install]: https://puppet.com/docs/bolt/latest/bolt_installing.html

[inventory file]: https://puppet.com/docs/bolt/latest/inventory_file_v2.html

[inventory reference plugin]: https://puppet.com/docs/bolt/latest/using_plugins.html#reference-plugins

[`local` transport]: https://puppet.com/docs/bolt/latest/bolt_transports_reference.html#local

[gitlab-rb]: https://rubygems.org/gems/gitlab

[Puppet Bolt]: https://puppet.com/docs/bolt/latest/bolt.html

[rvm]: https://rvm.io