bolt_pe

This modules delivers extensions to be used with Puppet Enterprise.

Table of Contents

1. Description
2. Setup - The basics of getting started with bolt_pe
   • Setup requirements
   • Beginning with bolt_pe
3. Usage - Configuration options and additional functionality

Description

Tasks and Plans

Terraform

On Puppet Enterprise the terraform tasks and plans are not available. These are only available within Bolt Open Source.

This module delivers the terraform tasks and plans and places them under a new namespace: bolt_pe

Get Targets from Node Groups

On Puppet Enterprise on can group servers into node groups. This module provides a task which will read an exusting node group and return the nodes from the provided node group.

Usage is straight forward like an other Puppet Task:

plan foo (
  Enum['All Nodes', 'Production Environment'] $node_group,
  String $puppet_server,
) {
  $targets = run_task('bolt_pe::get_targets_from_node_groups', $puppet_server, 'node_group' => $node_group)
  $targets.each |$target| {
    # ...
  }
}

Setup

Setup Requirements

This module needs the puppetlabs-ruby_task_helper module.

Beginning with bolt_pe

Bolt_pe has no Puppet classes. It only consists of tasks, plans and functions.

Usage

Add this module and the ruby_task_helper module to your Puppet Enterprise Server. This can be achieved by adding the modules to your control-repo Puppetfile.

Afterwards you should see the tasks in Puppet Enterprise console.

Reference

Table of Contents

Classes

• bolt_pe: Class: bolt_pe

Tasks

• get_targets_from_node_groups: This task reads node groups from PE console and returns an array of nodes being part of the node group
• terrafom_apply: Apply an HCL manifest
• terrafom_destroy: Destroy resources managed with Terraform
• terrafom_initialize: Initialize a Terraform project directory
• terrafom_output: JSON representation of Terraform outputs
• terrafom_resolve_reference: Generate targets from Terraform Statefile

Plans

• bolt_pe::get_node_groups: get all node groups and print to stdout
• bolt_pe::terraform_apply
• bolt_pe::terraform_destroy

Classes

bolt_pe

Class: bolt_pe

Tasks

get_targets_from_node_groups

This task reads node groups from PE console and returns an array of nodes being part of the node group

Supports noop? false

Parameters

node_group

Data type: String

Name of the node group

terrafom_apply

Apply an HCL manifest

Supports noop? false

Parameters

dir

Data type: Optional[String[1]]

Path to Terraform project directory. Path is relative to CWD, unless an absolute path is specified.

state

Data type: Optional[String[1]]

Path to read and save state. Defaults to "terraform.tfstate". Path is relative to "dir"

target

Data type: Optional[Variant[String[1], Array[String[1]]]]

Resource to target. Operation will be limited to this resource and its dependencies. Accepts a single resource string or an array of resources

var

Data type: Optional[Hash]

Set Terraform variables, expects a hash with key value pairs representing variables and values.

var_file

Data type: Optional[Variant[String[1], Array[String[1]]]]

Set variables in the Terraform configuration from a file. Path is relative to "dir". Accepts a single var-file path or an array of paths

state_out

Data type: Optional[String[1]]

Path to write state to that is different than "state". This can be used to preserve the old state.

terrafom_destroy

Destroy resources managed with Terraform

Supports noop? false

Parameters

dir

Data type: Optional[String[1]]

Path to Terraform project directory. Path is relative to CWD, unless an absolute path is specified.

state

Data type: Optional[String[1]]

Path to read and save state. Defaults to "terraform.tfstate", Path is relative to "dir"

target

Data type: Optional[Variant[String[1], Array[String[1]]]]

Resource to target. Operation will be limited to this resource and its dependencies. Accepts a single resource string or an array of resources

var

Data type: Optional[Hash]

Set Terraform variables, expects a hash with key value pairs representing variables and values.

var_file

Data type: Optional[Variant[String[1], Array[String[1]]]]

Set variables in the Terraform configuration from a file. Path is relative to "dir". Accepts a single var-file path or an array of paths

state_out

Data type: Optional[String[1]]

Path to write state to that is different than "state". This can be used to preserve the old state.

terrafom_initialize

Initialize a Terraform project directory

Supports noop? false

Parameters

dir

Data type: Optional[String[1]]

Path to Terraform project directory. Path is relative to CWD, unless an absolute path is specified.

terrafom_output

JSON representation of Terraform outputs

Supports noop? false

Parameters

dir

Data type: Optional[String[1]]

Path to Terraform project directory. Path is relative to CWD, unless an absolute path is specified.

state

Data type: Optional[String[1]]

Path to read and save state. Defaults to "terraform.tfstate", Path is relative to "dir"

terrafom_resolve_reference

Generate targets from Terraform Statefile

Supports noop? false

Parameters

dir

Data type: String[1]

resource_type

Data type: String[1]

state

Data type: Optional[String[1]]

backend

Data type: Optional[String[1]]

target_mapping

Data type: Hash

Plans

bolt_pe::get_node_groups

get all node groups and print to stdout

Parameters

The following parameters are available in the bolt_pe::get_node_groups plan:

• node_group
• puppet_server

node_group

Data type: Enum['All Nodes', 'Production Environment']

puppet_server

Data type: String

bolt_pe::terraform_apply

The bolt_pe::terraform_apply class.

Parameters

The following parameters are available in the bolt_pe::terraform_apply plan:

• dir
• state
• state_out
• target
• var
• var_file
• return_output
• terraform_host

dir

Data type: Optional[String[1]]

Default value: undef

state

Data type: Optional[String[1]]

Default value: undef

state_out

Data type: Optional[String[1]]

Default value: undef

target

Data type: Optional[Variant[String[1], Array[String[1]]]]

Default value: undef

var

Data type: Optional[Hash]

Default value: undef

var_file

Data type: Optional[Variant[String[1], Array[String[1]]]]

Default value: undef

return_output

Data type: Optional[Boolean]

Default value: false

terraform_host

Data type: TargetSpec

bolt_pe::terraform_destroy

The bolt_pe::terraform_destroy class.

Parameters

The following parameters are available in the bolt_pe::terraform_destroy plan:

• dir
• state
• state_out
• target
• var
• var_file
• terraform_host

dir

Data type: Optional[String[1]]

Default value: undef

state

Data type: Optional[String[1]]

Default value: undef

state_out

Data type: Optional[String[1]]

Default value: undef

target

Data type: Optional[Variant[String[1], Array[String[1]]]]

Default value: undef

var

Data type: Optional[Hash]

Default value: undef

var_file

Data type: Optional[Variant[String[1], Array[String[1]]]]

Default value: undef

terraform_host

Data type: TargetSpec

Changelog

All notable changes to this project will be documented in this file.

Release 0.1.0

Features

Bugfixes

Known Issues