Forge Home

vra_puppet_plugin_prep

Prepares a Puppet Enterprise master for vRA Puppet Plugin integration

3,096 downloads

3,096 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.0 (latest)
released Apr 7th 2020
This version is compatible with:
  • Puppet Enterprise 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
  • Puppet >= 5.0.0 < 7.0.0
  • ,

Start using this module

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

Add this module to your Puppetfile:

mod 'puppetlabs-vra_puppet_plugin_prep', '0.2.0'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add puppetlabs-vra_puppet_plugin_prep
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install puppetlabs-vra_puppet_plugin_prep --version 0.2.0

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

puppetlabs/vra_puppet_plugin_prep — version 0.2.0 Apr 7th 2020

vra_puppet_plugin_prep

Prepares a Puppet Enterprise master for vRA Puppet Plugin integration.

Table of Contents

  1. Description
  2. Beginning with vra_puppet_plugin_prep
  3. Usage
  4. Reference
  5. Contributors

Description

When setting up the vRA Puppet Plugin there are some setup steps that need to be performed on the Puppet Enterprise Master. This module automates many of these, ie it ensures that:

  • a system user exists for the plugin to ssh in with
  • an api user exists for the plugin to utilise
  • sudo rules are in place for this user so the plugin can run the commands it needs to
  • autosign policy is configured (shared secret via challengePassword in the CSR)

Beginning with vra_puppet_plugin_prep

Default behaviour (including autosign configuration enabled):

include vra_puppet_plugin_prep

Usage

class { 'vra_puppet_plugin_prep':
  vro_plugin_user   => 'vro-plugin-user',
  vro_password      => 'puppetlabs',
  vro_password_hash => '$1$Fq9vkV1h$4oMRtIjjjAhi6XQVSH6.Y.',
  manage_autosign   => true,
  manage_localuser  => true,
  autosign_secret   => 'S3cr3tP@ssw0rd!',
}

Reference

Class: vra_puppet_plugin_prep

Parameters:

vro_plugin_user The username the plugin will connect to Puppet with, both via ssh, and api

Default: vro-plugin-user

vro_password The password the plugin will authenticate to the Puppet apis with.

Default: puppetlabs

vro_password_hash The hash of the password the plugin will authenticate with via ssh to the Puppet Master.

Default: $1$Fq9vkV1h$4oMRtIjjjAhi6XQVSH6.Y. ('puppetlabs')

system_uid Whether to create the vro plugin user as a system user.

Default: false

manage_autosign Whether to configure autosigning with this module.

Default: True

manage_localuser Whether to configure the local user creation with this module

Default: True

autosign_secret The secret to use for autosign validation. It is placed into the challengePassword within the CSR.

Default: S3cr3tP@ssw0rd!

Contributors

Thank you to Jeremy Adams and other contributors to the vRO Starter Content project, from which much of the code in this repo has been stolen.