puppet-hdm

Table of Contents

• puppet-hdm
  • Table of Contents
  • Description
  • Major Update
  • Setup
    • Setup Requirements
    • SLES and Docker module
    • Beginning with betadots HDM
  • Reference
  • Limitations
  • Transfer Notice
  • License

Description

This module manages the betadots HDM installation.

HDM can be installed on Puppet Server or on any other system with PuppetDB access and Puppet code deployed.

This module allows you to either make use of the betadots HDM Docker container or to install HDM using RVM.

Major Update

As of version 1.0.0 and newer the HDM Docker container runs in production mode. Existing installations using HDM container prior version 1.0.0 must prepare this change by copying the development.sqlite3 file to production.sqlite3

cp /etc/hdm/development.sqlite3 /etc/hdm/production.sqlite3

Now Puppet can configure the system. Once HDM is up and running the database can be changed from development to production:

docker exec -ti hdm /hdm/bin/rails db:environment:set RAILS_ENV=production

After the update and checking functionality the development.sqlite3 file can be deleted.

Setup

Setup Requirements

The puppet-hdm module needs puppetlabs/stdlib as we use some of the stdlib data types.

If you want to make use of the docker container, you need the following module:

• puppetlabs/docker - min version 4.4.0

If you want to install HDM using RVM, you need the following modules:

• puppet/rvm - min version 2.0.0
• golja/gnupg - min version 1.2.3
• puppetlabs/vcsrepo - min version 5.2.0
• puppet/systemd - min version 3.10.0

SLES and Docker module

The puppetlabs-docker Module lacks official SLES and SuSe support. Yet: the module is usable on SLES.

The installation of Docker can not be done using the module on SLES. Instead one must install Docker separately within a profile class.

But any other defined type like docker::image or docker::run is working.

One must set the acknowledge_unsupported_os parameter to true to prevent the Docker module from failing on SuSe systems.

Hiera:

---
# Allow Docker to work on SLES
docker::acknowledge_unsupported_os: true

Beginning with betadots HDM

The most simple approach is to just include the hdm class and provide the version parameter:

include hdm

You can find the released versions on HDM releases page

hdm::version: '1.0.1

Another option is to use class resource type declaration:

class { 'hdm':
  version => '1.0.1',
}

This will install HDM as docker container.

Reference

Please check the REFERENCE.md file.

Limitations

On SLES we can not use the puppetlabs/docker module. Instead set the manage_docker parameter to false and take care on docker package and service by yourself.

Transfer Notice

This Puppet module was originally authored by betadots GmbH. The maintainer preferred that Vox Pupuli take ownership of the module for future improvement and maintenance. Existing pull requests and issues were transferred over, please fork and continue to contribute here instead of github.com/betadots/puppet-hdm.

License

This module is licensed under the Apache-2 license.

Reference

Table of Contents

Classes

Public Classes

• hdm: HDM installation main class

Private Classes

• hdm::docker: Manage HDM using Docker
• hdm::rvm: Manage HDM using RVM

Data types

• Hdm::Gitdata: type to enforce git settings for HDM
• Hdm::Ldap_settings: type to enforce ldap settings for HDM
• Hdm::Puppetdb: type to enforce puppetdb settings for HDM

Classes

hdm

This class controls the installation of HDM

Examples

include hdm

Parameters

The following parameters are available in the hdm class:

• method
• manage_docker
• version
• container_registry_url
• ruby_version
• port
• bind_ip
• hostname
• timezone
• hdm_path
• secret_key_base
• git_url
• user
• group
• puppetdb_settings
• puppet_code_dir
• disable_authentication
• allow_encryption
• read_only
• git_data
• ldap_settings
• ldap_bind_dn_password
• hdm_hiera_config_file
• custom_lookup_function

method

Data type: Enum['docker', 'rvm']

Select the installation method. Available methods: docker, rvm When using rvm we install rvm into system and add the bundler gem.

Default value: 'docker'

manage_docker

Data type: Boolean

Set to false if this module should NOT also include the docker class (without any arguments) Please note that the docker module only works on Debian, RedHat and windows systems. SLES users must install and start docker via puppet package and service resource.

Default value: true

version

Data type: String[1]

Select the version to deploy. Version is the image tag name when using docker and the git tag when using rvm Please find the releases on HDM website: https://github.com/betadots/hdm/releases

Default value: '1.0.1'

container_registry_url

Data type: String[1]

Configure another registry. Contains the host, path and container name. The version is set via the version parameter. e.g. ghcr.io/betadots/hdm

Default value: 'ghcr.io/betadots/hdm'

ruby_version

Data type: String[1]

Select the ruby version when installing using rvm Please check hdm ruby version requirement

Default value: '3.1.2'

port

Data type: Stdlib::Port

The port where HDM should run on

Default value: 3000

bind_ip

Data type: Stdlib::IP::Address::Nosubnet

The ip address to bind the process to

Default value: '0.0.0.0'

hostname

Data type: String[1]

The HDM webservice hostname

Default value: $facts['networking']['fqdn']

timezone

Data type: String[1]

THe timezone to use when running with docker

Default value: $facts['timezone']

hdm_path

Data type: Stdlib::Unixpath

Path where one wants to install and configure hdm

Default value: '/etc/hdm'

secret_key_base

Data type: String[1]

A secret key. Key can be generated using openssl rand -hex 16

Default value: '7a8509ab31fdb0c15c71c941d089474a'

git_url

Data type: String[1]

The git URL to clone the hdm repo from

Default value: 'https://github.com/betadots/hdm.git'

user

Data type: String[1]

The hdm user name

Default value: 'hdm'

group

Data type: String[1]

The hdm group name

Default value: 'hdm'

puppetdb_settings

Data type: Hdm::Puppetdb

A hash to provide information on how HDM can connect to puppetdb The following options are possible: Plain text (default)

  {
    'server'           => 'http://localhost:8080',
  }

Using PE token:

  {
    'server'           => 'https://localhost:8081',
    'token'            => '/etc/hdm/puppetdb.token',
    'cacert'           => '<path to cacert>',
  }

Using SSL cert:

  {
    'server'           => 'https://localhost:8081',
    'pem'              => {
      'key'            => '/etc/hdm/ssl.key',
      'cert'           => '/etc/hdm/ssl.cert',
      'ca_file'        => '/etc/hdm/ssl.ca',
    },
  }

Default value: { 'server' => 'http://localhost:8080', }

puppet_code_dir

Data type: Stdlib::Unixpath

The path where HDM can find deployed Puppet environments (similar to puppet config code_dir) defaults to '/etc/puppetlabs/code'

Default value: '/etc/puppetlabs/code'

disable_authentication

Data type: Boolean

Disable user and login This makes HDM available to anyone.

Default value: false

allow_encryption

Data type: Boolean

Specify if HDM should use EYAML Needs HDM access to EYAML keys (public and private) Values for keys are taken from hiera.yaml file and can not be set individually.

Default value: false

read_only

Data type: Boolean

Set to false if you want the ability to change data via HDM webfrontend. WARNING!! setting to true is untested!!! Changes are stored via GIT. Setting this to true also needs the git_data Array parameter

Default value: true

git_data

Data type: Optional[Hdm::Gitdata]

Configure several settings related to the option to modify data via Webfrontend. WARNING!! untested!! Required Array of hash data:

  [
    {
      'datadir'        => 'modules/hieradata/data',
      'git_url'        => 'git@server:path/repo.git',
      'path_in_repo'   => 'data',
      'ssh_priv_key'   => '.ssh/id_rsa',
    }
  ]

Default value: undef

ldap_settings

Data type: Optional[Hdm::Ldap_settings]

Config for LDAP integration Needs the following Hash:

  {
    'host'             => 'localhost',
    'port'             => 389,
    'base_dn'          => 'ou=hdm,dc=nodomain',
    'bind_dn'          => 'cn=admin,dc=nodomain',
    'bind_dn_password' => 'openldap', # clear text
    'ldaps'            =>  false,
  }

Default value: undef

ldap_bind_dn_password

Data type: Optional[Sensitive[String[1]]]

set sensitive password for ldap bind

Default value: undef

hdm_hiera_config_file

Data type: String[1]

Set to another file if you want HDM to not use hiera.yaml.

Default value: 'hiera.yaml'

custom_lookup_function

Data type: Hash[String[1],Enum['yaml', 'eyaml']]

If you use your own developed hiera lookup function, HDM needs to know if the function returns yaml or eyaml data. Example:

  {
    'functon_name' => '<yaml|eyaml>'
  }

Default value: `{}`

## Data types

### <a name="Hdm--Gitdata"></a>`Hdm::Gitdata`

type to enforce git settings for HDM

Alias of

```puppet
Array[Struct[
    {
      datadir                => Stdlib::Unixpath,
      git_url                => String[1],
      path_in_repo           => String[1],
      Optional[ssh_priv_key] => String[1],
    }
  ]]

Hdm::Ldap_settings

type to enforce ldap settings for HDM

Alias of

Struct[{
    'host'             => Stdlib::Host,
    'port'             => Stdlib::Port,
    'base_dn'          => String[1],
    'bind_dn'          => String[1],
    'bind_dn_password' => Optional[Variant[Sensitive[String[1]],String[1]]],
    'ldaps'            => Boolean,
  }]

Hdm::Puppetdb

type to enforce puppetdb settings for HDM

Alias of

Struct[{
    server           => Stdlib::Httpurl,
    Optional[pem]    => Struct[
      {
        key     => Stdlib::Unixpath,
        cert    => Stdlib::Unixpath,
        ca_file => Stdlib::Unixpath,
      }
    ],
    Optional[token]  => Stdlib::Unixpath,
    Optional[cacert] => Stdlib::Unixpath,
  }]

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.2.0 (2024-03-14)

Full Changelog

Implemented enhancements:

• Manage option to use a custom lookup function #80 (tuxmea)
• HDM supports disabling authentication. #77 (tuxmea)

v3.1.0 (2024-01-11)

Full Changelog

Implemented enhancements:

• Sles support #75 (tuxmea)
• Update container env #72 (tuxmea)

Closed issues:

• SLES Support missing in docker implementation #68

Merged pull requests:

• Add description to use hdm module on SLES #74 (tuxmea)
• Add Suse support #71 (tuxmea)

v3.0.0 (2023-06-19)

Full Changelog

Breaking changes:

• Drop Puppet 6 support #56 (bastelfreak)

Implemented enhancements:

• Allow setting of different hiera.yaml to use #60 (tuxmea)
• Switch version from main to fix version. #54 (tuxmea)

v2.2.1 (2023-02-17)

Full Changelog

Merged pull requests:

• README.md: Fix license badge #49 (bastelfreak)

v2.2.0 (2023-02-17)

Full Changelog

Implemented enhancements:

• puppet-lint: validate docs and datatypes #48 (bastelfreak)

Merged pull requests:

• Update documentation: make more clear where the product originates from #47 (rwaffen)
• .fixtures.yml: Migrate from forge releases to git #45 (bastelfreak)
• Migrate module from betadots to Vox Pupuli #44 (bastelfreak)
• puppet/systemd: Allow 4.x #43 (bastelfreak)

v2.1.2 (2023-02-16)

Full Changelog

Implemented enhancements:

• Update Gems + CI config #39 (bastelfreak)

Fixed bugs:

• workaround "sensitive in hash" #38 (rwaffen)

Closed issues:

• Adapt changes from HDM #30

Merged pull requests:

• Fix syntax highlighting in README.md #37 (bastelfreak)

v2.1.1 (2023-01-31)

Full Changelog

Merged pull requests:

• minor update and new release #36 (tuxmea)
• fixes for production #35 (tuxmea)
• Release v2.0.0 #34 (tuxmea)

v2.0.2 (2023-01-30)

Full Changelog

v2.0.1 (2023-01-30)

Full Changelog

v2.0.0 (2023-01-30)

Full Changelog

Closed issues:

• mark passwords as sensitive #22

Merged pull requests:

• preparation for v1 container running in production mode #33 (tuxmea)
• Add badges to README.md #32 (bastelfreak)
• update docker and apt module versions #31 (tuxmea)
• restart if config file changes #29 (tuxmea)
• improve data types #28 (tuxmea)
• Manage changelog #27 (tuxmea)
• prepare v1.2.3 #26 (tuxmea)
• Create LICENSE #14 (tuxmea)
• Update issue templates #13 (tuxmea)
• Create CODE_OF_CONDUCT.md #12 (tuxmea)

v1.2.3 (2022-12-09)

Full Changelog

Closed issues:

• ldaps config not working #23

v1.2.2 (2022-12-09)

Full Changelog

Implemented enhancements:

• Add assert_private() to private classes #17 (bastelfreak)

Fixed bugs:

• Debian Docker: Configure correct shell for hdm user #20 (bastelfreak)

Merged pull requests:

• add missing parameter for ldap #24 (tuxmea)

v1.2.1 (2022-08-10)

Full Changelog

Merged pull requests:

• Release v1.2.1 #16 (tuxmea)
• Update documentation #15 (tuxmea)

v1.2.0 (2022-08-08)

Full Changelog

Merged pull requests:

• update new release to v1.2.0 #11 (tuxmea)
• installation via RVM #10 (tuxmea)
• new release v1.1.1 #9 (tuxmea)

v1.1.0 (2022-08-04)

Full Changelog

Merged pull requests:

• Disable puppet-ruby #8 (tuxmea)
• puppet-ruby typo npoc -> nproc #7 (tuxmea)

v1.0.3 (2022-08-04)

Full Changelog

Merged pull requests:

• Documentation #6 (tuxmea)
• Bugfixes #5 (tuxmea)

v1.0.2 (2022-08-04)

Full Changelog

v1.0.1 (2022-08-04)

Full Changelog

Merged pull requests:

• correct module version dependencies #4 (tuxmea)

v1.0.0 (2022-08-03)

Full Changelog

Merged pull requests:

• Use hdm data types on complex hashes and arrays #3 (tuxmea)
• Add GitHub actions #2 (tuxmea)
• Docker #1 (tuxmea)

* This Changelog was automatically generated by github_changelog_generator