influxdb-formula
1. 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.
2. Contributing to this repo
Commit message formatting is significant!!
Please see How to contribute for more details.
3. Available states
3.1. influxdb
Installs InfluxDB from [provided packages](http://influxdb.com/download/).
At the moment you have to specify the InfluxDB version in the
influxdb:version
pillar.
3.2. influxdb.cli
Installs the [influxdb-cli](https://github.com/phstc/influxdb-cli) gem system wide.
3.3. influxdb.config
Renders the InfluxDB configuration from data provided in the
influxdb:conf
pillar.
It requires the installation of the [toml Python module](https://github.com/hit9/toml.py) via pip.
The formula ships with default configuration settings for various minor
versions of InfluxDB. That means that, if you define configuration
settings in your influxdb.conf
pillar, your settings will be merged
with the default ones of that minor version. You can set
influxdb:no_conf_defaults
in your pillar if you want to completely
specify the configuration yourself, without falling back to defaults.
4. Testing
Linux testing is done with kitchen-salt
.
4.1. 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
.
4.2. bin/kitchen converge
Creates the docker instance and runs the influxdb
main state, ready
for testing.