diff --git a/CHANGELOG.md b/CHANGELOG.md index bf52ab0..506beb4 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,6 +3,10 @@ All notable changes to this project will be documented in this file. ## [Unreleased][unreleased] +## [0.5.1] - 2015-03-25 +### Changed +- Updated documentation. + ## [0.5.0] - 2015-03-25 ### Added - Added systemd init for redhat platform family version 7 or greater. @@ -36,7 +40,8 @@ Thank You! ### Changed - Initial release of prometheus cookbook -[unreleased]: https://github.com/rayrod2030/chef-prometheus/compare/0.5.0...HEAD +[unreleased]: https://github.com/rayrod2030/chef-prometheus/compare/0.5.1...HEAD +[0.5.1]: https://github.com/rayrod2030/chef-prometheus/compare/0.5.0...0.5.1 [0.5.0]: https://github.com/rayrod2030/chef-prometheus/compare/0.4.0...0.5.0 [0.4.0]: https://github.com/rayrod2030/chef-prometheus/compare/0.3.0...0.4.0 [0.3.0]: https://github.com/rayrod2030/chef-prometheus/compare/0.2.0...0.3.0 diff --git a/README.md b/README.md index 43599e7..c09f9b6 100644 --- a/README.md +++ b/README.md @@ -31,8 +31,46 @@ Recipes ------- ### default -The default recipe installs [Prometheus][] using the default `install_method` and -supervises the [Prometheus][] binary under [runit][]. +The `default` recipe installs creates all the default [Prometheus][] directories, +config files and and users. Default also calls the configured `install_method` +recipe and finally calls the prometheus `service` recipe. + +### source +The `source` recipe builds Prometheus from a Github source tag. + +### binary +The `binary` recipe retrieves and installs a pre-compiled Prometheus build from +a user-defined location. + +### service +The `service` recipe configures Prometheus to run under a process supervisor. +Default supervisors are chosen based on distribution. Currently supported +supervisors are init, runit, systemd and bluepill. (Upstart coming soon) + +Resource/Provider +----------------- + +### prometheus_job + +This resource adds a job definition to the Prometheus config file. Here is an +example of using this resource to define the default Prometheus job: + +```ruby +prometheus_job ‘prometheus’ do + scrape_interval ‘15s’ + target “http://localhost#{node[‘prometheus’][‘flags’][‘web.listen-address’]}#{node[‘prometheus’][‘flags’][‘web.telemetry-path’]}” +end +``` + +Note: This cookbook uses the accumulator pattern so you can define multiple +prometheus_job’s and they will all be added to the Prometheus config. + +Externally managing `prometheus.conf` +------------------------------------- + +If you prefer to manage your `prometheus.conf` file externally using your own +inventory or service discovery mechanism you can set +`default[‘prometheus’][‘allow_external_config’]` to `true`. Dependencies ------------ @@ -41,8 +79,10 @@ The following cookbooks are dependencies: * [build-essential][] * [apt][] +* [yum][] * [runit][] * [bluepill][] +* [accumulator][] * [ark][] @@ -89,4 +129,6 @@ limitations under the License. [runit]: https://github.com/hw-cookbooks/runit [Prometheus]: https://github.com/prometheus/prometheus [bluepill]: https://github.com/opscode-cookbooks/bluepill -[ark]: https://github.com/burtlo/ark +[ark]: https://github.com/burtlo/ark +[yum]: https://github.com/chef-cookbooks/yum +[accumulator]: https://github.com/kisoku/chef-accumulator diff --git a/metadata.rb b/metadata.rb index 654bf31..e1557e8 100644 --- a/metadata.rb +++ b/metadata.rb @@ -5,7 +5,7 @@ license 'Apache 2.0' description 'Installs/Configures Prometheus' long_description IO.read(File.join(File.dirname(__FILE__), 'README.md')) -version '0.5.0' +version '0.5.1' # rubocop:enable Style/SingleSpaceBeforeFirstArg %w( ubuntu debian centos redhat fedora ).each do |os|