Forge Home

gremlin_agent

Install and configure the gremlin agent and daemon.

1,210 downloads

1,122 latest version

2.6 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 Mar 31st 2021
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
  • Puppet >= 6.21.0 < 8.0.0
  • , , , , , , ,
Tasks:
  • attack

Start using this module

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

Add this module to your Puppetfile:

mod 'gremlin-gremlin_agent', '0.1.1'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add gremlin-gremlin_agent
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install gremlin-gremlin_agent --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.

Download

Documentation

gremlin/gremlin_agent — version 0.1.1 Mar 31st 2021

gremlin_agent

This module installs and configures the gremlin agent on a variety of operating systems.

Table of Contents

  1. Description
  2. Setup - The basics of getting started with gremlin_agent
  3. Usage - Configuration options and additional functionality
  4. Limitations - OS compatibility, etc.
  5. Development - Guide for contributing to the module

Description

In order to better streamline and standardize the Gremlin agent installation and configuration, this module provides a supported method to manage and maintain the gremlin agent on your systems.

Setup

What gremlin_agent affects

The configuration follows the steps documented on the Gremlin docs

  • It installs the dependencies required based on the host OS.
  • It installs the gremlin repository, the agent, and the daemon.
  • It configures the daemon via config.yaml, and manages the service.

Beginning with gremlin_agent

You need to provide the gremlin_team_id and either gremlin_team_secret or the gremlin_team_certificate_or_file and gremlin_team_private_key_or_file

These can either come from Hiera or called directly as the below example:

class { 'gremlin_agent':
  gremlin_team_id     => '11111111-1111-1111-1111-111111111111',
  gremlin_team_secret => '11111111-1111-1111-1111-111111111111'
}
gremlin_agent::gremlin_team_id: '11111111-1111-1111-1111-111111111111'
gremlin_agent::gremlin_team_secret: '11111111-1111-1111-1111-111111111111'

Usage

If you wish to use the certificate pair instead of the team secret, you can provide either the filepath (prefixed with file://) or the whole certificate.

class { 'gremlin_agent':
  gremlin_team_id                  => '11111111-1111-1111-1111-111111111111',
  gremlin_team_certificate_or_file => 'file://var/lib/gremlin/key.cert',
  gremlin_team_private_key_or_file => 'file://var/lib/gremlin/key.pem',
}

Additional parameters that can be set can be viewed in the REFERENCE.md

Reference

See REFERENCE.md

Limitations

This module has had limited testing and doesn't currently support all features. Please open an issue for any bugs discovered.

Development

Feel free to open a PR for suggested changes or improvements.

TODO:

  • Finish fleshing out Windows support.
  • Add tasks to trigger gremlin checks.
  • Add some additional config validation to confirm agent is successfully talking to control plane.