Forge Home

clienttags

/etc/clienttags for a puppet managed self-service environment.

5,181 downloads

4,652 latest version

4.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.

Support the Puppet Community by contributing to this module

You are welcome to contribute to this module by suggesting new features, currency updates, or fixes. Every contribution is valuable to help ensure that the module remains compatible with the latest Puppet versions and continues to meet community needs. Complete the following steps:

  1. Review the module’s contribution guidelines and any licenses. Ensure that your planned contribution aligns with the author’s standards and any legal requirements.
  2. Fork the repository on GitHub, make changes on a branch of your fork, and submit a pull request. The pull request must clearly document your proposed change.

For questions about updating the module, contact the module’s author.

Version information

  • 1.0.1 (latest)
  • 1.0.0
released Jul 6th 2017
This version is compatible with:
  • , , , , , , , , ,

Start using this module

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

Add this module to your Puppetfile:

mod 'josenk-clienttags', '1.0.1'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add josenk-clienttags
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install josenk-clienttags --version 1.0.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

josenk/clienttags — version 1.0.1 Jul 6th 2017

josenk-clienttags - /etc/clienttags for a puppet managed "self-service" environment.

Table of Contents

  1. Description
  2. Setup - The basics of getting started with clienttags
  3. Usage - Configuration options and additional functionality
  4. Limitations - OS compatibility, etc.
  5. Development

Description

This module provides a way to give System Administrators a "self-service" access to puppet modules. In some organizations, not all environments are fully managed by the puppet team. If you have a "self-service" environment, you can write puppet modules that will run based on the tags managed by the system administrators.

Basically, you're giving systems owners the ability to tag their own servers without access to puppet.

This module will install a text file /etc/clienttags on the puppet client. It can then be edited by the system owner. The unremarked lines will be stored in a fact "clienttags". Using this custom fact, you can build modules to provide any type of functionality the remote system administrator is requesting.

$ puppet facts |grep  clienttags
    "clienttags": "'installdevtools'\n'installprinting'\n'set_ssh_noknown_hosts'\n'set_tuned_performance'\n'vmware_guest'",

Setup

What clienttags affects

This module will copy an example /etc/clienttags to your puppet clients. You may want to customize the sample file to set some defaults or to list all available tags you support.

A custom fact will be created "clienttags".

Usage

For example:

The contents of /etc/clienttags contain a line:

installdevtools

You write a puppet module to install some basic development tools.

class { 'do_stuff_by_clienttags':
    include ::clienttags
    if ( $::facts['clienttags'] =~ /installdevtools/ ) {
        include ::stdlib
        ensure_packages('gcc')
        ensure_packages('git')
        ensure_packages('make')
    }
}

Limitations

Currently this is for Linux/Unix type OS's only.

Be careful of your REGEX!

Development

A new version (coming soon). Instead of a hard-coded source, you will be able to specify any source for the default /etc/clienttags.

Release Notes.

v1.0.0 This is the initial release.