README.md

Puppet module to manage InfluxDB Server

Table of Contents

1. Description
2. Setup - The basics of getting started with InfluxDB
   • What InfluxDB affects
   • Setup requirements
   • Beginning with InfluxDB
3. Usage - Configuration options and additional functionality
4. Limitations - OS compatibility, etc.
5. Development - Guide for contributing to the module

Description

Installs, configures and manages the the InfluxDB time-series platform.

Setup

What InfluxDB affects

Default configuration

• manages GPG key, repository (default: manage_repo = true )

  • default: repo_location = https://repos.influxdata.com/ and repo_type = 'stable'

• manages package

• manages directories and configuration files (referring to templates)

  • /etc/influxdb/influxdb.conf
  • /etc/default/influxdb
  • Debian: /lib/systemd/system/influxdb.service
  • CentOs: /etc/systemd/system/influxdb.service

• starts service "influxdb" immediately (default: manage_service = true)

Setup Requirements

For an extensive list of requirements, see metadata.json.

Beginning with InfluxDB

The module comes along with several configuration files, which you can find in templates. Change configuration settings using according hashes or hiera.

• influxdb.conf.erb
• service-defaults.erb - adds empty file
• systemd.service.erb

Please refer to InfluxData documentation for the defaults used.

Configuration parameter

Some of the parameter in influxdb.conf are obligatory. These defaults are merged with provided hashes.

topic	parameter	default value
meta	dir	/var/lib/influxdb/meta *
data	dir	/var/lib/influxdb/meta *
data	wal-dir	/var/lib/influxdb/wal *
data	series-id-set-cache-size	100

* the directories are created

Hash values and paramter https-enabled / $https_enabled and auth-enabled / $auth_enabled are as well used in influxdb.conf as in the defines database, user and grants.

Usage

In combination with other influxdata module

• when influxdb shall handle GPG keys and repository

class { 'influxdb':
  manage_repo => true,
}

• when one of the other influxdata modules already handles GPG keys and repository

class { 'influxdb':
  manage_repo => false,
}

Set up databases, retention policies, users and grants

influxdb::database {'telegraf1':
  ensure         => present,
  https_enabled  => false,
  auth_enabled   => true,
  admin          => 'admin',
  admin_password => 'foo',
}

influxdb::user{'telegraf1':
  passwd => 'metricsmetricsmetrics',
  https_enabled  => false,
  auth_enabled   => true,
  admin          => 'admin',
  admin_password => 'foo',
}

influxdb::grant{'telegraf1':
  grant    => 'WRITE',
  database => 'telegraf1',
  https_enabled  => false,
  auth_enabled   => true,
  admin          => 'admin',
  admin_password => 'foo',
}

Retention policies may not work with a version lower than InfluxDB v1.8

influxdb::retention{'foo':
  ensure         => 'create',
  database       => 'telegraf1',
  duration       => '7h30m',
  replication    =>  1,
  default        => 'DEFAULT',
  shard_duration => '3h59m',
  https_enabled  => false,
  auth_enabled   => true,
  admin          => 'admin',
  admin_password => 'foo',
}

influxdb::retention{'bar':
  ensure         => 'create',
  database       => 'telegraf1',
  duration       => '5h20m',
  replication    =>  1,
  default        => '',
  shard_duration => '0h5m',
  https_enabled  => false,
  auth_enabled   => true,
  admin          => 'admin',
  admin_password => 'foo',
}

Reference

Please see document REFERENCE.md.

Limitations

• Tests had been executed on:
  • CentOS 7.8
  • Debian 10.4
  • Ubuntu 18.04

For an extensive list of supported operating systems, see metadata.json.

Development

• pdk-version 1.18.0
• template-url pdk-default 1.18.0
• template-ref tags/1.18.0-0-g095317c

Release Notes/Contributors/Etc.

• module: kogitoapp-influxdb
• version: 0.1.0
• author: Kogito UG [email protected]
• summary: Module for configuring InfluxDB
• license: Apache-2.0
• source: https://github.com/kogitoapp/puppet-influxdb