InfluxDB Formula

Manage InfluxDB with Salt.

Table of Contents

• General notes
• Special notes
• Configuration
• Available states
• Contributing to this repo
• Testing

General notes

See the full SaltStack Formulas installation and usage instructions.

If you are interested in writing or contributing to formulas, please pay attention to the Writing Formula Section.

If you want to use this formula, please pay attention to the FORMULA file and/or git tag, which contains the currently released version. This formula is versioned according to Semantic Versioning.

See Formula Versioning Section for more details.

If you need (non-default) configuration, please refer to:

• how to configure the formula with map.jinja
• the pillar.example file
• the Special notes section

Special notes

• The Vault integration needs my custom Vault database plugin.
• The Vault integration is setup statically, which means you need to create the required authorization manually and provide it to the formula. A complete bootstrap from scratch would be possible though.

Configuration

An example pillar is provided, please see pillar.example. Note that you do not need to specify everything by pillar. Often, it's much easier and less resource-heavy to use the parameters/<grain>/<value>.yaml files for non-sensitive settings. The underlying logic is explained in map.jinja.

Available states

The following states are found in this formula:

• influxdb
• influxdb.package
• influxdb.package.repo
• influxdb.config
• influxdb.cert
• influxdb.service
• influxdb.auth
• influxdb.auth.managed
• influxdb.vault
• influxdb.vault.connection
• influxdb.vault.roles
• influxdb.buckets
• influxdb.tasks
• influxdb.clean
• influxdb.package.clean
• influxdb.package.repo.clean
• influxdb.config.clean
• influxdb.cert.clean
• influxdb.service.clean
• influxdb.vault.clean
• influxdb.buckets.clean
• influxdb.tasks.clean

influxdb

Meta-state.

This installs the influxdb package, manages the influxdb configuration file and then starts the associated influxdb service.

influxdb.package

Installs the influxdb package only.

influxdb.package.repo

This state will install the configured influxdb repository. This works for apt/dnf/yum/zypper-based distributions only by default.

influxdb.config

Manages the influxdb service configuration. Has a dependency on influxdb.package.

influxdb.cert

influxdb.service

Starts the influxdb service and enables it at boot time. Has a dependency on influxdb.config.

influxdb.auth

influxdb.auth.managed

influxdb.vault

influxdb.vault.connection

influxdb.vault.roles

influxdb.buckets

influxdb.tasks

influxdb.clean

Meta-state.

Undoes everything performed in the influxdb meta-state in reverse order, i.e. stops the service, removes the configuration file and then uninstalls the package.

influxdb.package.clean

Removes the influxdb package. Has a dependency on influxdb.config.clean.

influxdb.package.repo.clean

This state will remove the configured influxdb repository. This works for apt/dnf/yum/zypper-based distributions only by default.

influxdb.config.clean

Removes the configuration of the influxdb service and has a dependency on influxdb.service.clean.

influxdb.cert.clean

influxdb.service.clean

Stops the influxdb service and disables it at boot time.

influxdb.vault.clean

influxdb.buckets.clean

influxdb.tasks.clean

Contributing to this repo

Commit messages

Commit message formatting is significant!

Please see How to contribute for more details.

pre-commit

pre-commit is configured for this formula, which you may optionally use to ease the steps involved in submitting your changes. First install the pre-commit package manager using the appropriate method, then run bin/install-hooks and now pre-commit will run automatically on each git commit.

$ bin/install-hooks
pre-commit installed at .git/hooks/pre-commit
pre-commit installed at .git/hooks/commit-msg

State documentation

There is a script that semi-autodocuments available states: bin/slsdoc.

If a .sls file begins with a Jinja comment, it will dump that into the docs. It can be configured differently depending on the formula. See the script source code for details currently.

This means if you feel a state should be documented, make sure to write a comment explaining it.

Testing

Linux testing is done with kitchen-salt.

Requirements

• Ruby
• Docker

$ gem install bundler
$ bundle install
$ bin/kitchen test [platform]

Where [platform] is the platform name defined in kitchen.yml, e.g. debian-9-2019-2-py3.

bin/kitchen converge

Creates the docker instance and runs the influxdb main state, ready for testing.

bin/kitchen verify

Runs the inspec tests on the actual instance.

bin/kitchen destroy

Removes the docker instance.

bin/kitchen test

Runs all of the stages above in one go: i.e. destroy + converge + verify + destroy.

bin/kitchen login

Gives you SSH access to the instance for manual testing.