Resource Type: influxdb_bucket

Defined in:
lib/puppet/type/influxdb_bucket.rb

Summary

Manages InfluxDB buckets

Overview

Examples:

influxdb_bucket {'my_bucket':
  ensure  => present,
  org     => 'my_org',
  labels  => ['my_label1', 'my_label2'],
  require => Influxdb_org['my_org'],
}

Properties

  • create_dbrp (defaults to: true)

    Whether to create a “database retention policy” mapping to allow for legacy access

  • ensure (defaults to: present)

    Whether the bucket should be present or absent on the target system.

  • host

    The host running InfluxDB

  • labels

    Labels to apply to the bucket. For convenience, these will be created automatically without the need to create influxdb_label resources

  • members

    List of users to add as members of the bucket. For convenience, these will be created automatically without the need to create influxdb_user resources

  • name

    Name of the bucket

  • org

    Organization which the buckets belongs to

  • port (defaults to: 8086)

    Port used by the InfluxDB service

  • retention_rules (defaults to: [{"type"=>"expire", "everySeconds"=>7776000, "shardGroupDurationSeconds"=>604800}])

    Rules to determine retention of data inside the bucket

  • token

    Administrative token used for authenticating API calls

  • token_file

    File on disk containing an administrative token

  • use_ssl (defaults to: true)

    Whether to enable SSL for the InfluxDB service

  • use_system_store

    Whether to use the system store for SSL connections