tfenv

Table of Contents

1. Overview
2. Module Description - What the module does and why it is useful
3. Setup - The basics of getting started with tfenv
   • What tfenv affects
   • Beginning with tfenv
4. Usage - Configuration options and additional functionality
5. Reference - An under-the-hood peek at what the module is doing and how
6. Limitations - OS compatibility, etc.
7. Development - Guide for contributing to the module

Overview

This module installs and configures tfenv tool which manages terraform version

Module Description

The tfenv module sets up from the github repo tfenv utility which manages terraform version. Module creates user and group jenkins by default. This behavior can be changed.

Setup

What tfenv affects

By default:

• Clone and install tfenv into /opt/tfenv folder;
• Create user jenkins and group jenkins

Beginning with tfenv

include '::tfenv'

Usage

All options and configuration can be done through interacting with the parameters on the main ::tfenv class. The default parameters are defined in ::tfenv::params

tfenv class

To start using tfenv one can use simple inclusion:

include '::tfenv'

If you don't need to create user you should define this explicitly, but please ensure that both user tfenv_user and group tfenv_group exists, otherwise puppet run will fail:

class { '::tfenv':
  manage_user  => false,
  manage_group => false,
  tfenv_user   => root,
  tfenv_group  => root,
}

You can also provide custom installation directory as well as tfenv version:

class { '::tfenv':
  install_dir    => '/home/jenkins/tfenv',
  tfenv_revision => 'v0.5.1',
}

tfenv::terraform

If you want to install several versions of terraform you can use tfenv::terraform, e.g. install terraform versions '0.9.8', '0.9.9', '0.10.0':

include ::tfenv

$terraform_versions = ['0.9.8', '0.9.9', '0.10.0']

::tfenv::terraform { $terraform_versions: }

Reference

Classes

• tfenv - Main class for installation and configuration.
• tfenv::params - Different configuration data for module.

Defined resource

• tfenv::terraform - install required version of terraform using tfenv tool

Limitations

Tested and work on:

• CentOS 7
• Ubuntu 14.04
• Ubuntu 16.04
• Debian Jessie

Development

Contributions will be gratefully accepted. All you pull requests should be done in separate branch, e.g. feature_abc, fix_version_issue, etc.

Change Log

0.2.1 (2017-08-11)

Full Changelog

Merged pull requests:

• Fix possible package installation conflict #8 (morkot)
• Fix typo in fixtures #7 (SergK)

0.2.0 (2017-08-10)

Full Changelog

Implemented enhancements:

• Run beaker tests under CentOS platform as well #5 (SergK)
• Add defined type ::tfenv:terraform #4 (SergK)

0.1.1 (2017-08-09)

Full Changelog

Merged pull requests:

• Release v0.1.1 #3 (SergK)
• Update module metadata #2 (SergK)

0.1.0 (2017-08-09)

Full Changelog

Merged pull requests:

• Update documentation #1 (SergK)

* This Change Log was automatically generated by github_changelog_generator