REFERENCE.md

Reference

Table of Contents

Classes

• influxdb: Manages an InfluxDB server
• influxdb::config: Manages directories and files; configuration and service
• influxdb::install: Manages package, group and user
• influxdb::params: Parameter definiton
• influxdb::repo: Manages gpg key information and repository, if necessary
• influxdb::service: Manages the service

Defined types

• influxdb::database: Manages databases depending on http / https authorization parameters
• influxdb::grant: Manages user grants within the databases depending on http / https authorization parameters
• influxdb::retention: Manages retentions of databases depending on http / https authorization parameters
• influxdb::user: Manages users of databases depending on http / https authorization parameters

Classes

influxdb

Manages an InfluxDB server

Examples

include influxdb

Parameters

The following parameters are available in the influxdb class.

manage_repo

Data type: Boolean

Default value: $influxdb::params::manage_repo

package_name

Data type: String

Default value: $influxdb::params::package_name

ensure

Data type: String

Default value: $influxdb::params::ensure

repo_location

Data type: Stdlib::HTTPSUrl

Default value: $influxdb::params::repo_location

repo_type

Data type: String

Default value: $influxdb::params::repo_type

group

Data type: String

Default value: $influxdb::params::group

user

Data type: String

Default value: $influxdb::params::user

configuration_path

Data type: Stdlib::Absolutepath

Default value: $influxdb::params::configuration_path

configuration_file

Data type: String

Default value: $influxdb::params::configuration_file

configuration_template

Data type: String

Default value: $influxdb::params::configuration_template

service_defaults

Data type: Stdlib::Absolutepath

Default value: $influxdb::params::service_defaults

service_default_template

Data type: String

Default value: $influxdb::params::service_default_template

service_definition

Data type: Stdlib::Absolutepath

Default value: $influxdb::params::service_definition

service_definition_template

Data type: String

Default value: $influxdb::params::service_definition_template

service_name

Data type: String

Default value: $influxdb::params::service_name

service_provider

Data type: String

Default value: $influxdb::params::service_provider

service_ensure

Data type: Stdlib::Ensure::Service

Default value: $influxdb::params::service_ensure

service_enable

Data type: Boolean

Default value: $influxdb::params::service_enable

service_has_status

Data type: Boolean

Default value: $influxdb::params::service_has_status

service_has_restart

Data type: Boolean

Default value: $influxdb::params::service_has_restart

manage_service

Data type: Boolean

Default value: $influxdb::params::manage_service

admin

Data type: String

Default value: $influxdb::params::admin

admin_password

Data type: String

Default value: $influxdb::params::admin_password

users

Data type: Hash

Default value: $influxdb::params::users

grants

Data type: Hash

Default value: $influxdb::params::grants

databases

Data type: Hash

Default value: $influxdb::params::databases

retentions

Data type: Hash

Default value: $influxdb::params::retentions

reporting_disabled

Data type: Boolean

Default value: $influxdb::params::reporting_disabled

rpc_bind_address

Data type: String

Default value: $influxdb::params::rpc_bind_address

metadata_raft

Data type: String

Default value: $influxdb::params::metadata_raft

tsm_data

Data type: String

Default value: $influxdb::params::tsm_data

tsm_wal

Data type: String

Default value: $influxdb::params::tsm_wal

series_id_set_cache_size

Data type: Integer

Default value: $influxdb::params::series_id_set_cache_size

https_enabled

Data type: Boolean

Default value: $influxdb::params::https_enabled

auth_enabled

Data type: Boolean

Default value: $influxdb::params::auth_enabled

meta

Data type: Hash

Default value: $influxdb::params::data

data

Data type: Hash

Default value: $influxdb::params::data

coordinator

Data type: Hash

Default value: $influxdb::params::coordinator

retention

Data type: Hash

Default value: $influxdb::params::retention

shard_precreation

Data type: Hash

Default value: $influxdb::params::shard_precreation

monitor

Data type: Hash

Default value: $influxdb::params::monitor

http

Data type: Hash

Default value: $influxdb::params::http

logging

Data type: Hash

Default value: $influxdb::params::logging

subscriber

Data type: Hash

Default value: $influxdb::params::subscriber

graphite

Data type: Hash

Default value: $influxdb::params::graphite

collectd

Data type: Hash

Default value: $influxdb::params::collectd

opentsdb

Data type: Hash

Default value: $influxdb::params::opentsdb

udp

Data type: Hash

Default value: $influxdb::params::udp

continuous_queries

Data type: Hash

Default value: $influxdb::params::continuous_queries

tls

Data type: Hash

Default value: $influxdb::params::tls

meta_obligatory

Data type: Hash

Default value: $influxdb::params::meta_obligatory

data_obligatory

Data type: Hash

Default value: $influxdb::params::data_obligatory

http_obligatory

Data type: Hash

Default value: $influxdb::params::http_obligatory

influxdb::config

Manages directories and files; configuration and service

Examples

include influxdb::config

Parameters

The following parameters are available in the influxdb::config class.

configuration_path

Data type: Stdlib::Absolutepath

Default value: $influxdb::configuration_path

configuration_file

Data type: String

Default value: $influxdb::configuration_file

configuration_template

Data type: String

Default value: $influxdb::configuration_template

service_defaults

Data type: Stdlib::Absolutepath

Default value: $influxdb::service_defaults

service_default_template

Data type: String

Default value: $influxdb::service_default_template

service_definition

Data type: Stdlib::Absolutepath

Default value: $influxdb::service_definition

service_definition_template

Data type: String

Default value: $influxdb::service_definition_template

group

Data type: String

Default value: $influxdb::group

user

Data type: String

Default value: $influxdb::user

reporting_disabled

Data type: Boolean

Default value: $influxdb::reporting_disabled

rpc_bind_address

Data type: String

Default value: $influxdb::rpc_bind_address

metadata_raft

Data type: String

Default value: $influxdb::metadata_raft

tsm_data

Data type: String

Default value: $influxdb::tsm_data

tsm_wal

Data type: String

Default value: $influxdb::tsm_wal

series_id_set_cache_size

Data type: Integer

Default value: $influxdb::series_id_set_cache_size

https_enabled

Data type: Boolean

Default value: $influxdb::https_enabled

auth_enabled

Data type: Boolean

Default value: $influxdb::auth_enabled

meta

Data type: Hash

Default value: $influxdb::meta

data

Data type: Hash

Default value: $influxdb::data

coordinator

Data type: Hash

Default value: $influxdb::coordinator

retention

Data type: Hash

Default value: $influxdb::retention

shard_precreation

Data type: Hash

Default value: $influxdb::shard_precreation

monitor

Data type: Hash

Default value: $influxdb::monitor

http

Data type: Hash

Default value: $influxdb::http

logging

Data type: Hash

Default value: $influxdb::logging

subscriber

Data type: Hash

Default value: $influxdb::subscriber

graphite

Data type: Hash

Default value: $influxdb::graphite

collectd

Data type: Hash

Default value: $influxdb::collectd

opentsdb

Data type: Hash

Default value: $influxdb::opentsdb

udp

Data type: Hash

Default value: $influxdb::udp

continuous_queries

Data type: Hash

Default value: $influxdb::continuous_queries

tls

Data type: Hash

Default value: $influxdb::tls

meta_obligatory

Data type: Hash

Default value: $influxdb::meta_obligatory

data_obligatory

Data type: Hash

Default value: $influxdb::data_obligatory

http_obligatory

Data type: Hash

Default value: $influxdb::http_obligatory

influxdb::install

Manages package, group and user

Examples

include influxdb::install

Parameters

The following parameters are available in the influxdb::install class.

ensure

Data type: String

Default value: $influxdb::ensure

package_name

Data type: String

Default value: $influxdb::package_name

influxdb::params

Parameter definiton

Examples

include influxdb::params

Parameters

The following parameters are available in the influxdb::params class.

manage_repo

Data type: Boolean

Default value: true

package_name

Data type: String

Default value: 'influxdb'

ensure

Data type: String

Default value: 'present'

repo_location

Data type: Stdlib::HTTPSUrl

Default value: 'https://repos.influxdata.com/'

repo_type

Data type: String

Default value: 'stable'

group

Data type: String

Default value: 'influxdb'

user

Data type: String

Default value: 'influxdb'

configuration_path

Data type: Stdlib::Absolutepath

Default value: '/etc/influxdb'

configuration_file

Data type: String

Default value: 'influxdb.conf'

configuration_template

Data type: String

Default value: 'influxdb/influxdb.conf.erb'

service_defaults

Data type: Stdlib::Absolutepath

Default value: '/etc/default/influxdb'

service_default_template

Data type: String

Default value: 'influxdb/service-defaults.erb'

service_definition

Data type: Stdlib::Absolutepath

Default value: '/lib/systemd/system/influxdb.service'

service_definition_template

Data type: String

Default value: 'influxdb/systemd.service.erb'

service_name

Data type: String

Default value: 'influxdb'

service_provider

Data type: String

Default value: 'systemd'

service_ensure

Data type: Stdlib::Ensure::Service

Default value: 'running'

service_enable

Data type: Boolean

Default value: true

service_has_status

Data type: Boolean

Default value: true

service_has_restart

Data type: Boolean

Default value: true

manage_service

Data type: Boolean

Default value: true

admin

Data type: String

Default value: 'admin'

admin_password

Data type: String

Default value: ''

users

Data type: Hash

Default value: {}

grants

Data type: Hash

Default value: {}

databases

Data type: Hash

Default value: {}

retentions

Data type: Hash

Default value: {}

reporting_disabled

Data type: Boolean

Default value: false

rpc_bind_address

Data type: String

Default value: '127.0.0.1:8088'

metadata_raft

Data type: String

Default value: '/var/lib/influxdb/meta'

meta_obligatory

Data type: Hash

Default value: { 'dir' => $metadata_raft, }

tsm_data

Data type: String

Default value: '/var/lib/influxdb/data'

tsm_wal

Data type: String

Default value: '/var/lib/influxdb/wal'

series_id_set_cache_size

Data type: Integer

Default value: 100

data_obligatory

Data type: Hash

Default value: { 'dir' => $tsm_data, 'wal-dir' => $tsm_wal, 'series-id-set-cache-size' => $series_id_set_cache_size, }

https_enabled

Data type: Boolean

Default value: false

auth_enabled

Data type: Boolean

Default value: false

http_obligatory

Data type: Hash

Default value: { 'https-enabled' => $https_enabled, 'auth-enabled' => $auth_enabled, }

meta

Data type: Hash

Default value: {}

data

Data type: Hash

Default value: {}

coordinator

Data type: Hash

Default value: {}

retention

Data type: Hash

Default value: {}

shard_precreation

Data type: Hash

Default value: {}

monitor

Data type: Hash

Default value: {}

http

Data type: Hash

Default value: {}

logging

Data type: Hash

Default value: {}

subscriber

Data type: Hash

Default value: {}

graphite

Data type: Hash

Default value: {}

collectd

Data type: Hash

Default value: {}

opentsdb

Data type: Hash

Default value: {}

udp

Data type: Hash

Default value: {}

continuous_queries

Data type: Hash

Default value: {}

tls

Data type: Hash

Default value: {}

influxdb::repo

Manages gpg key information and repository, if necessary

Examples

include influxdb::repo

Parameters

The following parameters are available in the influxdb::repo class.

manage_repo

Data type: Boolean

Default value: $influxdb::manage_repo

repo_location

Data type: Stdlib::HTTPSUrl

Default value: $influxdb::repo_location

repo_type

Data type: String

Default value: $influxdb::repo_type

influxdb::service

Manages the service

Examples

include influxdb::service

Parameters

The following parameters are available in the influxdb::service class.

service_name

Data type: String

Default value: $influxdb::service_name

service_ensure

Data type: Stdlib::Ensure::Service

Default value: $influxdb::service_ensure

service_enable

Data type: Boolean

Default value: $influxdb::service_enable

service_has_status

Data type: Boolean

Default value: $influxdb::service_has_status

service_has_restart

Data type: Boolean

Default value: $influxdb::service_has_restart

service_provider

Data type: String

Default value: $influxdb::service_provider

manage_service

Data type: Boolean

Default value: $influxdb::manage_service

service_definition

Data type: Stdlib::Absolutepath

Default value: $influxdb::service_definition

Defined types

influxdb::database

Manages databases depending on http / https authorization parameters

Examples

influxdb::database { 'database': }

Parameters

The following parameters are available in the influxdb::database defined type.

ensure

Data type: Enum['present', 'absent']

Default value: 'present'

database

Data type: String

Default value: $title

path

Data type: Stdlib::Unixpath

Default value: '/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin'

https_enabled

Data type: Boolean

Default value: $influxdb::https_enabled

auth_enabled

Data type: Boolean

Default value: $influxdb::auth_enabled

admin

Data type: String

Default value: $influxdb::admin

admin_password

Data type: String

Default value: $influxdb::admin_password

influxdb::grant

Manages user grants within the databases depending on http / https authorization parameters

Examples

influxdb::grant { 'grant': }

Parameters

The following parameters are available in the influxdb::grant defined type.

user

Data type: String

Default value: $title

ensure

Data type: Enum['present', 'absent']

Default value: 'present'

grant

Data type: Enum['ALL', 'READ', 'WRITE']

Default value: 'ALL'

database

Data type: String

Default value: 'database1'

path

Data type: Stdlib::Unixpath

Default value: '/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin'

https_enabled

Data type: Boolean

Default value: $influxdb::https_enabled

auth_enabled

Data type: Boolean

Default value: $influxdb::auth_enabled

admin

Data type: String

Default value: $influxdb::admin

admin_password

Data type: String

Default value: $influxdb::admin_password

influxdb::retention

Manages retentions of databases depending on http / https authorization parameters

Examples

influxdb::retention { 'retention': }

Parameters

The following parameters are available in the influxdb::retention defined type.

path

Data type: Stdlib::Unixpath

Default value: '/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin'

retention

Data type: String

Default value: $title

database

Data type: String

Default value: 'database1'

ensure

Data type: Enum['create', 'alter', 'drop']

Default value: 'create'

duration

Data type: String

Default value: '23h59m'

replication

Data type: Integer

Default value: 1

default

Data type: String

Default value: 'DEFAULT'

shard_duration

Data type: String

Default value: '2h'

https_enabled

Data type: Boolean

Default value: $influxdb::https_enabled

auth_enabled

Data type: Boolean

Default value: $influxdb::auth_enabled

admin

Data type: String

Default value: $influxdb::admin

admin_password

Data type: String

Default value: $influxdb::admin_password

influxdb::user

Manages users of databases depending on http / https authorization parameters

Examples

influxdb::user { 'user': }

Parameters

The following parameters are available in the influxdb::user defined type.

user

Data type: String

Default value: $title

password

Data type: String

Default value: '12345'

ensure

Data type: Enum['present', 'absent']

Default value: 'present'

arg_p

Data type: String

Default value: 'WITH PASSWORD'

arg_a

Data type: String

Default value: 'WITH ALL PRIVILEGES'

path

Data type: Stdlib::Unixpath

Default value: '/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin'

https_enabled

Data type: Boolean

Default value: $influxdb::https_enabled

auth_enabled

Data type: Boolean

Default value: $influxdb::auth_enabled

admin

Data type: String

Default value: $influxdb::admin

admin_password

Data type: String

Default value: $influxdb::admin_password