Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/bdangit/chef-influxdb

A cookbook for InfluxDB, a time-series database (influxdb.org)
https://github.com/bdangit/chef-influxdb

chef-cookbook cookbooks database influxdb infrastructure-management monitoring

Last synced: 6 days ago
JSON representation

A cookbook for InfluxDB, a time-series database (influxdb.org)

Host: GitHub
URL: https://github.com/bdangit/chef-influxdb
Owner: bdangit
License: mit
Created: 2013-11-13T01:21:25.000Z (almost 11 years ago)
Default Branch: master
Last Pushed: 2022-05-16T14:43:23.000Z (over 2 years ago)
Last Synced: 2024-08-02T07:12:02.714Z (3 months ago)
Topics: chef-cookbook, cookbooks, database, influxdb, infrastructure-management, monitoring
Language: Ruby
Homepage:
Size: 247 KB
Stars: 54
Watchers: 7
Forks: 83
Open Issues: 8
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Awesome Lists containing this project

awesome-influxdb - chef-influxdb - Chef cookbook for InfluxDB (Provisioning InfluxDB / Other tools)

README

# InfluxDB

[![wercker status](https://app.wercker.com/status/d0f175cb46e417cde7974f179e63084d/s/master "wercker status")](https://app.wercker.com/project/byKey/d0f175cb46e417cde7974f179e63084d)

Chef cookbook to install and configure InfluxDB.

## Support

|*Cookbook Version*|*InfluxDB Version*|
|------------------|------------------|
| v5.x.x | >= v1.0.0 |
| v4.4.1 | < v1.0.0 |

## Usage
To install InfluxDB and place its configuration file, include the
`influxdb::default` recipe in your node's `run_list`. The `default` recipe
installs the necessary dependencies to use the custom resources defined in this
cookbook.

For rendering the config set the parameter under
`node['influxdb']['config']`

`default['influxdb']['config']['MyParameter'] = 'val'`

## Resources
The following gems are used by the custom resources and are installed by the
`default` recipe:

- [InfluxDB gem](https://github.com/influxdb/influxdb-ruby)
- [toml](https://github.com/jm/toml)

This cookbook ships with five custom resources for managing the configuration
file, users, databases, cluster admins, and retention policies:

### influxdb\_config
This resource writes a configuration file for InfluxDB based on the passed
configuration hash:

```ruby
influxdb_config node['influxdb']['config_file_path'] do
config node['influxdb']['config']
action :create
end
```

This resource is used by the `default` recipe to place the configuration
defined in `node['influxdb']['config']`.

### influxdb\_database
Configures an InfluxDB database.

```ruby
influxdb_database 'my_db' do
action :create
end
```

### influxdb\_install
This resource sets up or removes the appropriate repositories and
installs/removes the appropriate packages

```ruby
influxdb_install 'influxdb' do
arch_type 'amd64' # if undefined will auto detect
include_repository true # default
influxdb_key 'https://repos.influxdata.com/influxdb.key' # default
action :install # default
end
```

```ruby
influxdb_install 'influxdb' do
action :remove
end
```

> Note : InfluxDB Enterprise uses different version naming schema and is
> distributed in two packages: `influxdb-data` and `influxdb-meta`.
> Install it this way:

```ruby
node.default['influxdb']['version'] = "1.3.5-c1.3.5"
node.default['influxdb']['download_urls'] = {
'debian' => 'https://dl.influxdata.com/enterprise/releases',
'rhel' => 'https://dl.influxdata.com/enterprise/releases'
}

influxdb_install 'influxdb-meta' do
install_version node['influxdb']['version']
install_type 'file'
checksum '87d99ba4a90487ee1a9'
action [:install]
end

influxdb_install 'influxdb-data' do
install_version node['influxdb']['version']
install_type 'file'
checksum '4c17e7d3bac8f565c140'
action [:install]
end
```

### influxdb\_user
This resources configures a user to interact with InfluxDB databases.

```ruby
influxdb_user 'user' do
password 'changeme'
databases ['my_db']
action :create
end
```

### influxdb\_admin
This resources configures a cluster admin to interact with InfluxDB.

```ruby
influxdb_admin 'admin' do
password 'changeme'
action :create
end
```

### influxdb\_retention\_policy
This resources configures a retention policy on a given database. The name
attribute is not used, the database and policy name provide the unique names
used by InfluxDB.

> Note: in v1.0.0+ there is an auto-generated default profile called autogen.
> To make your policy the default, you will want to set `default` parameter
> `true`.

```ruby
influxdb_retention_policy "foodb default retention policy" do
policy_name 'default'
database 'foodb'
duration '1w'
replication 1
action :create
end
```

### influxdb\_continuous\_query
This resources configures a continuous query on a given database.

> If you need rewrite continuous query if it already exist set `rewrite` parametr to `true`.

```ruby
influxdb_continuous_query "test_continuous_query" do
database 'foodb'
rewrite false
query 'SELECT min(mouse) INTO min_mouse FROM zoo GROUP BY time(30m)'
action :create
end
```

## Client Libraries
Right now, this cookbook only supports the Ruby and CLI client libraries so as
not to add too many dependencies. That might change in the near future. By
default both flavors are disabled. Enable e.g. Ruby via:

`node.default['influxdb']['client']['ruby']['enable'] = true`

Finally include the `influxdb::client` in your node's `run_list` to install the
clients.

## Tests

To run tests, install all dependencies with [bundler](http://bundler.io/):

bundle install

Then to run tests:

rake # Quick tests only (rubocop + minitest)
rake test:complete # All tests (rubocop + minitest + kitchen)

## Release Steps

rake publish

## License
This project is licensed under the MIT license

## Maintainers
Ben Dang

E Camden Fisher