puppet-nomad

What This Module Affects

• Installs the nomad daemon (via url or package)
  • If installing from zip, you must ensure the unzip utility is available.
• Installs a configuration file (/etc/nomad.d/config.json)
• Manages the nomad service via systemd

Reference

See REFERENCE.

Limitations

Depends on the JSON gem, or a modern ruby. (Ruby 2.5 and newer are supported)

Development

Open an issue or fork and open a Pull Request

Acknowledgement

Must of this module was refactored from Kyle Anderson's great consul module available on the puppet forge. Go give him stars and likes and what not -- he deserves them!

Reference

Table of Contents

Classes

Public Classes

• nomad: Installs, configures, and manages nomad
• nomad::server_recovery: This class is used to generate a peers.json and a recovery script file for Nomad servers. It is used to recover from a Nomad server outage.

Private Classes

• nomad::config: This class is called from nomad::init to install the config file.
• nomad::install: This class is called from nomad::init to install the config file.
• nomad::reload_service: This class is meant to be called from certain configuration changes that support reload.
• nomad::run_service: This class is meant to be called from nomad It ensure the service is running

Classes

nomad

Installs, configures, and manages nomad

Examples

To set up a single nomad server, with several agents attached, on the server.

class { 'nomad':
  config_hash => {
    'region'     => 'us-west',
    'datacenter' => 'ptk',
    'log_level'  => 'INFO',
    'bind_addr'  => '0.0.0.0',
    'data_dir'   => '/opt/nomad',
    'server'     => {
      'enabled'          => true,
      'bootstrap_expect' => 3,
    }
  }
}

On the agent(s)

class { 'nomad':
  config_hash => {
    'region'     => 'us-west',
    'datacenter' => 'ptk',
    'log_level'  => 'INFO',
    'bind_addr'  => '0.0.0.0',
    'data_dir'   => '/opt/nomad',
    'client'     => {
      'enabled' => true,
      'servers' => [
        "nomad01.your-org.pvt:4647",
        "nomad02.your-org.pvt:4647",
        "nomad03.your-org.pvt:4647"
      ]
    }
  },
}

Install from zip file for a CPU architecture HashiCorp does not provide native packages for.

class { 'nomad':
  arch                => 'armv7l',
  install_method      => 'url',
  manage_service_file => true,
  version             => '1.0.3', # check latest version at https://github.com/hashicorp/nomad/blob/master/CHANGELOG.md
  config_hash         => {
    'region'     => 'us-west',
    'datacenter' => 'ptk',
    'log_level'  => 'INFO',
    'bind_addr'  => '0.0.0.0',
    'data_dir'   => '/opt/nomad',
    'client'     => {
      'enabled' => true,
      'servers' => [
        "nomad01.your-org.pvt:4647",
        "nomad02.your-org.pvt:4647",
        "nomad03.your-org.pvt:4647"
      ]
    }
  },
}

Disable install and service components

class { 'nomad':
  install_method => 'none',
  manage_service => false,
  config_hash    => {
    region     => 'us-west',
    datacenter => 'ptk',
    log_level  => 'INFO',
    bind_addr  => '0.0.0.0',
    data_dir   => '/opt/nomad',
    'client'     => {
      'enabled' => true,
      'servers' => [
        "nomad01.your-org.pvt:4647",
        "nomad02.your-org.pvt:4647",
        "nomad03.your-org.pvt:4647"
      ]
    }
  },
}

Parameters

The following parameters are available in the nomad class:

• arch
• purge_config_dir
• data_dir_mode
• join_wan
• bin_dir
• version
• install_method
• os
• download_url
• download_url_base
• download_extension
• package_name
• config_dir
• extra_options
• config_hash
• config_defaults
• config_validator
• config_mode
• manage_repo
• manage_service
• manage_service_file
• pretty_config
• service_enable
• service_ensure
• restart_on_change
• env_vars
• user
• group
• server_recovery
• recovery_nomad_server_regex
• recovery_nomad_server_hash
• recovery_network_interface
• recovery_rpc_port

arch

Data type: String[1]

cpu architecture

purge_config_dir

Data type: Boolean

Purge config files no longer generated by Puppet

Default value: true

data_dir_mode

Data type: Stdlib::Filemode

Specify unix permissions for data dir directory managed by this module

Default value: '0755'

join_wan

Data type: Optional[String[1]]

join nomad cluster over the WAN

Default value: undef

bin_dir

Data type: Stdlib::Absolutepath

location of the nomad binary

Default value: '/usr/bin'

version

Data type: String[1]

Specify version of nomad binary to download.

Default value: 'installed'

install_method

Data type: Enum['none', 'package', 'url']

install via system package, download and extract from a url.

Default value: 'package'

os

Data type: String[1]

operation system to install for

Default value: downcase($facts['kernel'])

download_url

Data type: Optional[String[1]]

download url to download from

Default value: undef

download_url_base

Data type: String[1]

download hostname to down from

Default value: 'https://releases.hashicorp.com/nomad/'

download_extension

Data type: String[1]

archive type to download

Default value: 'zip'

package_name

Data type: String[1]

Only valid when the install_method == package.

Default value: 'nomad'

config_dir

Data type: Stdlib::Absolutepath

location of the nomad configuration

Default value: '/etc/nomad.d'

extra_options

Data type: Optional[String[1]]

Extra arguments to be passed to the nomad agent

Default value: undef

config_hash

Data type: Hash

Use this to populate the JSON config file for nomad.

Default value: {}

config_defaults

Data type: Hash

default set of config settings

Default value: {}

config_validator

Data type:

Variant[
    Enum['nomad_validator', 'ruby_validator'], Pattern[/\A.*\ %\z/]
  ]

Use this to set the JSON config file validation command. It defaults to nomad validator which is currenly missing some validation checks. If ruby is available on the system you could use 'ruby_validator', or create your own script (ending with space and % symbol).

Default value: 'nomad_validator'

config_mode

Data type: Stdlib::Filemode

Use this to set the JSON config file mode for nomad.

Default value: '0660'

manage_repo

Data type: Boolean

Configure the upstream HashiCorp repository. Only relevant when $nomad::install_method = 'package'.

Default value: true

manage_service

Data type: Boolean

manage the nomad service

Default value: true

manage_service_file

Data type: Boolean

create and manage the systemd service file

Default value: false

pretty_config

Data type: Boolean

Generates a human readable JSON config file.

Default value: false

service_enable

Data type: Boolean

enable the nomad service

Default value: true

service_ensure

Data type: Stdlib::Ensure::Service

ensure the state of the nomad service

Default value: 'running'

restart_on_change

Data type: Boolean

Determines whether to restart nomad agent on $config_hash changes. This will not affect reloads when service, check or watch configs change.

Default value: true

env_vars

Data type: Hash[String[1], String]

Hash of optional environment variables that should be passed to nomad

Default value: {}

user

Data type: String[1]

User to run the Nomad binary as. Also used as owner of directories and config files managed by this module.

Default value: 'root'

group

Data type: String[1]

Group to run the Nomad binary as. Also used as group of directories and config files managed by this module.

Default value: 'root'

server_recovery

Data type: Boolean

Nomad server outage recovery configuration

Default value: false

recovery_nomad_server_regex

Data type: Optional[String]

Regex to match Nomad server hostnames within the same puppet environment. It requires PuppetDB and it's mutually exclusive with nomad_server_hash.

Default value: undef

recovery_nomad_server_hash

Data type: Optional[Hash]

If you don't have the PuppetDB you can supply a Hash with server IPs and corresponding node-ids. It works without PuppetDB and it's mutually exclusive with nomad_server_regex.

Default value: undef

recovery_network_interface

Data type: Optional[String]

NIC where Nomad server IP is configured

Default value: undef

recovery_rpc_port

Data type: Stdlib::Port

Nomad server RPC port

Default value: 4647

nomad::server_recovery

This class is used to generate a peers.json and a recovery script file for Nomad servers. It is used to recover from a Nomad server outage.

Examples

using PuppetDB

class { 'nomad':
  config_hash                 => {
    'region'     => 'us-west',
    'datacenter' => 'ptk',
    'bind_addr'  => '0.0.0.0',
    'data_dir'   => '/opt/nomad',
    'server'     => {
      'enabled'          => true,
      'bootstrap_expect' => 3,
    },
  },
  server_recovery             => true,
  recovery_nomad_server_regex => 'nomad-server0',
  recovery_network_interface  => 'eth0',
}

Parameters

The following parameters are available in the nomad::server_recovery class:

• nomad_server_regex
• nomad_server_hash
• network_interface
• rpc_port

nomad_server_regex

Data type: Optional[String]

Regex to match Nomad server hostnames within the same puppet environment. It's mutually exclusive with nomad_server_hash.

Default value: undef

nomad_server_hash

Data type: Optional[Hash]

If you don't have the PuppetDB you can supply a Hash with server IPs and corresponding node-ids. It's mutually exclusive with nomad_server_regex.

Default value: undef

network_interface

Data type: Optional[String]

NIC where Nomad server IP is configured

Default value: undef

rpc_port

Data type: Stdlib::Port

Nomad server RPC port

Default value: 4647

Changelog

All notable changes to this project will be documented in this file. Each new release typically also includes the latest modulesync defaults. These should not affect the functionality of the module.

v3.0.0 (2023-08-21)

Full Changelog

Breaking changes:

• Drop Puppet 6 support #88 (bastelfreak)

Implemented enhancements:

• Add EL9 support #98 (bastelfreak)
• Add Rocky/AlmaLinux/OracleLinux support #97 (bastelfreak)
• Ubuntu: Add support for 22.04 #96 (bastelfreak)
• puppet/systemd: Allow 5.x #95 (bastelfreak)
• puppet/hashi_stack: Allow 3.x #94 (bastelfreak)
• puppet/archive: Allow 7.x #93 (bastelfreak)
• Add Puppet 8 support #91 (bastelfreak)
• puppetlabs/stdlib: Allow 9.x #90 (bastelfreak)
• Add config validate #85 (maxadamo)
• add peers.json and script to recover from outage #82 (maxadamo)
• bump puppet/systemd to \< 5.0.0 #74 (jhoblitt)

Closed issues:

• add config validate #84
• Nomad server recover helper #77
• exec statement "reload nomad service" contains wrong command #75

Merged pull requests:

• use systemd to reload the daemon #76 (maxadamo)

v2.2.0 (2023-01-07)

Full Changelog

Implemented enhancements:

• Allow overriding user and group used #71 (jonasdemoor)
• Allow setting the data dir file mode #69 (optiz0r)

v2.1.0 (2022-05-23)

Full Changelog

Implemented enhancements:

• Add fact for nomad_node_id #63 (sebastianrakel)

Merged pull requests:

• extra_options: default to undef instead of '' #64 (bastelfreak)

v2.0.0 (2021-08-27)

Full Changelog

Breaking changes:

• Drop Debian 9; Add Debian 11 support #58 (root-expert)

Merged pull requests:

• add puppet-lint-param-docs #57 (bastelfreak)
• Allow up-to-date dependencies #55 (smortex)
• switch from camptocamp/systemd to voxpupuli/systemd #54 (bastelfreak)
• Fix variable type in env_vars documentation line #53 (bplunkert)

v1.1.0 (2021-05-14)

Full Changelog

Implemented enhancements:

• Add support for nomad.env file / Add nomad 1.0.5 support #50 (bastelfreak)

v1.0.0 (2021-02-13)

Full Changelog

Breaking changes:

• Aligning with upstream package layout, stdlib::to_json and install method #48 (attachmentgenie)
• removing os x support #47 (attachmentgenie)
• adding the option to setup the upstream HashiCorp repository #40 (attachmentgenie)

Closed issues:

• Default config is not in sync with upstream defaults #45
• user and group are not used #44
• Add support for puppet 7 #43
• Remove the environmentFile from service file #39
• add option to manage the upstream repo #35
• clean up init.pp params #34
• get systemd file in sync with upstream version #33
• nomad.service file large changes after upgrading to 0.0.4 #32
• Do not monkey patch JSON function #23
• Push puppet module 0.0.4 to forge #20

Merged pull requests:

• Adding puppet 7 support #46 (attachmentgenie)
• Init.pp cleanup; bump nomand 1.0.1 -> 1.0.2 #42 (attachmentgenie)
• Service file cleanup #41 (attachmentgenie)
• adding OOMScoreAdjust from upstream PR https://github.com/hashicorp/n… #38 (star3am)
• README.md: Add badges and fix links #31 (bastelfreak)

v0.0.4 (2021-01-07)

Full Changelog

Closed issues:

• Syntax error on README.md :) #22
• donate this module to voxpupuli #21
• Add CONSUL_HTTP_SSL to systemd unit file #19
• Migrate this module to Vox Pupuli #18
• Reason to not support armv7l #17
• Cannot create /etc/sysconfig/nomad #10
• Replace puppet-staging with puppet-archive #7

Merged pull requests:

• prepare for 0.0.4 release #30 (attachmentgenie)
• Remove private class parameters #29 (ekohl)
• Documenting remaining params and example to puppet-strings tags #27 (attachmentgenie)
• renaming to puppet-nomad in the vox namespace, updating dependencies … #26 (attachmentgenie)
• modulesync 4.0.0-8-g292033c #25 (attachmentgenie)
• Porting functions to the modern Puppet 4.x API #16 (binford2k)
• ensure latest is often unwanted #15 (attachmentgenie)
• example doesnt show valid puppet code #14 (attachmentgenie)
• switching to upstream module to configure systemd service file #13 (attachmentgenie)
• Update version and add version parameter #12 (LEDfan)
• update systemd service #11 (damoun)
• Replace 'staging' puppet module with 'archive' #8 (herver)
• Nomad has arm builds, adding it to the $arch case #6 (ncorrare)
• correct var file setting for systemd #5 (vamitrou)
• Remove code to install Nomad UI (there is no UI for Nomad) #4 (mmickan)
• nomad agent does not have a -pid-file option #3 (phpwutz)

0.0.2 (2016-03-30)

Full Changelog

Merged pull requests:

• pass $nomad::init_style #2 (phpwutz)
• Changing systemd CentOS7 init script #1 (gangsta)

* This Changelog was automatically generated by github_changelog_generator