Adoptable Cookbooks List

Looking for a cookbook to adopt? You can now see a list of cookbooks available for adoption!
List of Adoptable Cookbooks

Supermarket Belongs to the Community

Supermarket belongs to the community. While Chef has the responsibility to keep it running and be stewards of its functionality, what it does and how it works is driven by the community. The chef/supermarket repository will continue to be where development of the Supermarket application takes place. Come be part of shaping the direction of Supermarket by opening issues and pull requests or by joining us on the Chef Mailing List.

Select Badges

Select Supported Platforms

Select Status

RSS

graphite (44) Versions 1.3.0

Installs/Configures graphite

Policyfile
Berkshelf
Knife
cookbook 'graphite', '= 1.3.0', :supermarket
cookbook 'graphite', '= 1.3.0'
knife supermarket install graphite
knife supermarket download graphite
README
Dependencies
Changelog
Quality 83%

Graphite Cookbook

Cookbook Version
Build Status
OpenCollective
OpenCollective
License

Description

Library cookbook for installation and configuration of Graphite via Chef

Consult the Graphite documentation for more information:

Maintainers

This cookbook is maintained by the Sous Chefs. The Sous Chefs are a community of Chef cookbook maintainers working together to maintain important cookbooks. If you’d like to know more please visit sous-chefs.org or come chat with us on the Chef Community Slack in #sous-chefs.

Requirements

Platforms

  • Ubuntu 16.04+
  • Debian 8+
  • RHEL 7+

Chef

  • Chef 13+

Cookbooks

  • poise-python

Attributes

See default attributes for platform specific packages installed.

  • node['graphite']['version'] - package version to install, defaults to '0.9.12'
  • node['graphite']['twisted_version'] - twisted version to pin to, defaults to '13.1'
  • node['graphite']['django_version'] - django version to use, defaults to '1.5.5'
  • node['graphite']['user'] - graphite user, 'graphite'
  • node['graphite']['group'] - graphite group, 'graphite'
  • node['graphite']['base_dir'] - default base dir, '/opt/graphite'
  • node['graphite']['doc_root'] - doc root for graphite-web, '/opt/graphite/webapp'
  • node['graphite']['storage_dir'] - storage dir, '/opt/graphite/storage'
  • node['graphite']['install_type'] - 'package' or 'source'. Setting this to source will use latest github master branch
  • default['graphite']['package_names'] - package name hash, indexed by 'install_type' attribute.
  • default['graphite']['graph_templates'] - graphite template config hash
  • default['graphite']['sort_storage_schemas'] - Boolean attribute to specify whether or not storage schemas should be sorted in alphabetical order
  • default['graphite']['sort_configs'] - Boolean attribute to specify whether or not config stanzas should be sorted in alphabetical order

Adjusting package source location

You can override the node['graphite']['package_names'][#{name}]['source'] attribute, where #{name} is one of whisper, carbon or graphite_web, to set a custom install path. By default a source install will use the github master branch.

Recipes

default

No-op, assuming cookbook inclusion in a custom wrapper.

packages

Just install all packages, carbon and web

carbon

Install all carbon packages, setup the graphite user, storage paths and write the carbon configuration. Does not start any services.

web

Set up just about everything for graphite web, except configure it and start the service. Use the graphite_web_config resource and the uwsgi recipe for those two things.

Some of this weirdness may not really be needed, so send us a PR if you fix it before us. For example, I'd love some way to remove that execute block for selinux and there's probably a better way to manage all those files and directories.

uwsgi

Start a uwsgi runit service for graphite-web. That's it.

Various internal recipes

View the code for additional stub recipes that perform smaller pieces of functionality such as setup the user or install specific packages, the all begin with an underscore _.

It's like a treasure hunt.

Resources

Carbon daemons

Management for the various Carbon services which receive your metrics and write them to disk.

  • graphite_service: sets up a carbon service with runit, essentially a glorified runit_service. Carbon configuration should be defined first with one of the graphite_carbon_* resources. Multiple daemons can be run by using multiple resources with names such as cache:a, cache:b, etc..
  • graphite_carbon_aggregator: data driven resource for carbon-aggregator configuration
  • graphite_carbon_cache: data driven resource for carbon-cache configuration
  • graphite_carbon_relay: data driven resource for carbon-cache configuration

Storage

Whisper is pretty much a requirement right now, so these resources assume whisper libraries should be installed. Feel free to implement something else in your own wrapper if you live on the edge and prefer Ceres.

  • graphite_storage: makes a directory intended for graphite storage, installs whisper
  • graphite_storage_schema: data driven resource for storage schema

Graphite Web

Write the configuration file for Graphite Web

  • graphite_web_config: data driven python config file writer for graphite web. Assumes the whole file is managed, typically this is the path to local_settings.py. Custom python code can be placed in the optional 'dynamic template', by default a file named 'local_settings_dynamic.py' that is optimistically loaded if present.

Yes it's writing python via ruby.

A runit service definition is provided to start a uwsgi process, but note that choice of web server for proxying to the application server is left up to you. No more hard Apache dependency!

Accumulators

Due to the graphite config file format, the data driven resources use an accumulator pattern to find the appropriate resources in the run context and extract provided configuration data. You should never need to use these directly, but you're welcome to go crazy.

  • graphite_carbon_conf_accumulator: lookup named carbon resources in run context and gather config
  • graphite_storage_conf_accumulator: lookup named storage schema resources in run context and gather config

If you look at the example cookbook recipe you probably notice that many of the resources simply take a single config attribute, which is basically a hash of the configuration to be written.

This can come from attributes in a wrapper cookbook or via data bags if you like. Be as creative as you can tolerate.

Accumulator pattern came from excellent work by Mathieu Sauve-Frankel

Usage

It's a library cookbook, intended to be used in your custom wrapper cookbook to behave as needed. It's the building materials, not the house.

We have purposefully left out web server configuration to remove the dependency, so you're free to use whatever works in your environment. This avoids the need for this cookbook to keep up to date with configuration that isn't really graphite specific.

For example usage consult the reference cookbook example

Examples

You can find example usage in the graphite_example cookbook that is included in the git repository.

Data Bags

Sure, use em if you like. Even encrypt them.

Development / Contributing

  • Source hosted at [GitHub][repo]
  • Report issues/questions/feature requests on [GitHub Issues][issues]

Pull requests are very welcome! Make sure your patches are well tested. Ideally create a topic branch for every separate change you make. For example:

  1. Fork the repo
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Write some tests, see ChefSpec
  4. Commit your awesome changes (git commit -am 'Added some feature')
  5. Push to the branch (git push origin my-new-feature)
  6. Create a new Pull Request and tell us about it your changes.

Contributors

This project exists thanks to all the people who contribute.

Backers

Thank you to all our backers!

https://opencollective.com/sous-chefs#backers

Sponsors

Support this project by becoming a sponsor. Your logo will show up here with a link to your website.

https://opencollective.com/sous-chefs/sponsor/0/website
https://opencollective.com/sous-chefs/sponsor/1/website
https://opencollective.com/sous-chefs/sponsor/2/website
https://opencollective.com/sous-chefs/sponsor/3/website
https://opencollective.com/sous-chefs/sponsor/4/website
https://opencollective.com/sous-chefs/sponsor/5/website
https://opencollective.com/sous-chefs/sponsor/6/website
https://opencollective.com/sous-chefs/sponsor/7/website
https://opencollective.com/sous-chefs/sponsor/8/website
https://opencollective.com/sous-chefs/sponsor/9/website

Changelog

All notable changes to this project will be documented in this file.

1.3.0 (2020-06-06)

  • Fix bug with changing a frozen string in ruby 2.7.0

1.2.0 (2020-05-27)

  • Fix Django/Twisted overridden version (#318)

1.1.1 - (2020-05-14)

  • resolved cookstyle error: libraries/provider_carbon_conf_accumulator.rb:50:83 convention: Layout/TrailingWhitespace
  • resolved cookstyle error: libraries/provider_carbon_conf_accumulator.rb:50:84 refactor: ChefModernize/FoodcriticComments
  • resolved cookstyle error: libraries/provider_storage_conf_accumulator.rb:48:83 convention: Layout/TrailingWhitespace
  • resolved cookstyle error: libraries/provider_storage_conf_accumulator.rb:48:84 refactor: ChefModernize/FoodcriticComments
  • Migrate to github actions
  • Ran linters and addressed issues
  • Ran latest cookstyle
  • Remove unnecessary actions method in the resources

[1.1.0] - 2019-09-05

  • Fix cookstyle issues
  • Should now work with Chef 13, 14 and 15
  • Syntax and styling updates
  • Compatibility with Chef 13 (.@oscar123mendoza)

[1.0.4] - 2016-01-29

Added

  • Adds License and Code of Conduct

Fixed

  • Syntax and styling updates
  • Use full Twisted version number
  • Manage graphite nofile ulimit
  • Fixes carbon source

Known Issues

  • Reordering of Carbon .ini 241
  • Graphite web timeout when restarting 224

[1.0.2] - 2014-11-18

Fixed

  • README improvements to address resource usage and removal of Apache dependency (@webframp, #187)
  • restart graphite-web in graphite_example sample recipe (@obazoud, #182)
  • remove unused ['graphite']['web_server'] attribute (@obazoud, #181)

[1.0.1] - 2014-08-27

Fixed

  • Readme improvements.

[1.0.0] - 2014-08-27

Breaking Changes

  • Initial release of graphite library style cookbook. Complete rewrite of cookbook to provide reusable resources. Breaks backward compatibility with cookbook version prior 1.0. (@webframp, @fnichol, @agoddard)

Collaborator Number Metric
            

1.3.0 passed this metric

Contributing File Metric
            

1.3.0 passed this metric

Foodcritic Metric
            

1.3.0 failed this metric

FC085: Resource using new_resource.updated_by_last_action to converge resource: graphite/libraries/provider_carbon_conf_accumulator.rb:50
FC085: Resource using new_resource.updated_by_last_action to converge resource: graphite/libraries/provider_storage_conf_accumulator.rb:48
Run with Foodcritic Version 14.3.0 with tags metadata,correctness ~FC031 ~FC045 and failure tags any

No Binaries Metric
            

1.3.0 passed this metric

Testing File Metric
            

1.3.0 passed this metric

Version Tag Metric
            

1.3.0 passed this metric