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


shinken (17) Versions 1.13.0

Installs/Configures shinken

cookbook 'shinken', '= 1.13.0', :supermarket
cookbook 'shinken', '= 1.13.0'
knife supermarket install shinken
knife supermarket download shinken
Quality 50%

Shinken Logo


Set up the Shinken Monitor Server and its built in Web UI module.

Supported Platforms

Currently only tested on Ubuntu (and almost certainly will not work on RedHat).

Data Bags (Required)

These define the access credentials, email addresses, and phone numbers of the users for your Shinken system. You will need two data bag items, one encrypted and one unencrypted:

Users (this one's unencrypted)

Ideally this data bag is based on the structure from the Chef Users Cookbook, but all that's really required is that you create a data bag called users with one user per item, and the user items should look (at minimum) like this:

  "id": "testuser",
  "shinken": {
    "email": "",
    "phone": "6175551212",
    "is_admin": "1"

…with is_admin being optional.


This one can be anywhere you want. It's location is defined by these attributes:

  • node['shinken']['webui']['credentials_data_bag']
  • node['shinken']['webui']['credentials_data_bag_item']

…and its structure should look like this:

  "id": "example_credentials_data_bag_item",
  "shinken": {
    "testuser": "PASSWORD"

Note that only the shinken key is sourced, so it does not have to be in its own data bag.


All attributes live under the node['shinken'] key. Attributes fall into two basic groups, global configuration and resource definitions

Currently only services and hostgroups resources can be defined. Everything else is automatically populated.

Global Configuration

  • user - String - User to run Shinken (and all plugins) as (and own all of its config files).
  • group - String - Group to run Shinken (and all plugins) as.

The following will be parsed into their respective resource definition as such:

['key'] = 'value' becomes key value

…so you can pretty much add any key detailed in the linked configuration and expect it to end up in the config files.

  • global_defaults - Hash - Subkeys to this key will appear in resource definitions for all hosts and services.
  • service_defaults - Hash - Defaults for services (detailed here)
  • host_defaults - Hash - Defaults for hosts (detailed here)

Resource Definitions

  • hostgroups - Hostgroups can either be defined with a search, e.g.:
    "shinken": {
    "hostgroups": {
    "my-hostgroup": {
    "search_str": "recipes:important-recipe\\:\\:default",
    "conf": {
    "alias": "My HostGroup"

    …or they can be defined with an array of server names:

      "shinken": {
        "hostgroups": {
          "my-hostgroup": {
            "members": [
            "conf": {
              "alias": "My HostGroup"

    either way, conf defines the other keys in the resource, all of which are detailed in the Shinken docs. hostgroup_name in the above example will automatically be set to "my-hostgroup".

  • services - Defined exactly according to the Shinken docs with little automation, e.g.:
    "shinken": {
    "services": {
    "my-service": {
    "hostgroup_name": "my-hostgroup",
    "service_description": "My Service Check",
    "check_command": "some_check_command",
    "contact_groups": "admins"

    key/value pairs are parsed directly into the resource definition file with defaults (defined above) automatically being merged in.



Include shinken in a wrapper cookbook (or a node run list):

include_recipe 'shinken::default'
include_recipe 'shinken::webui'
include_recipe 'shinken::broker'


  1. Fork the repository on Github
  2. Create a named feature branch (i.e. add-new-recipe)
  3. Write your change
  4. Write tests for your change (if applicable)
  5. Run the tests, ensuring they all pass
  6. Submit a Pull Request

License and Authors

Author:: EverTrue, Inc. (

Dependent cookbooks

ark >= 0.0.0
apt >= 0.0.0
python >= 0.0.0

Contingent cookbooks

There are no cookbooks that are contingent upon this one.



  • Bump Shinken source install to 2.4.3
  • kitchen yaml: test host_defaults
  • Add notify_slack_for_host command
  • Oops: handler_enabled should be 1 not 0


  • Always enable event_handler if one is specified


  • Set default max_check_attempts to 1


  • Check that test-dns config is merged correctly
  • When merging, override defaults with specifics, not the other way around


  • Inherit generic-service in all services
  • Serverspec: Expect status code 2 from cassandra check


  • check_cassandra: Fail with 2 on connection refused


  • Add missing arguments to slack notifier command
  • Dramatically shorten the default check_interval from 60m to 5m


  • Add a Slack notification event handler
  • Don't fail if node['shinken']['hosts'] not defined


  • Add ability to check an API


  • Add a Pagerduty notification event handler


  • Add plugin: cassandra_check
  • Set an IAM profile so we can test with Fog


  • Don't check fake filesystems for inodes


  • Allow check_inodes_snmp script to take community as a parameter


  • Create a plugin to check for inode counts via snmp
  • Include nagios-snmp-plugins package of plugins
  • Test on real-life ec2


  • Add Mesos CPU/Memory check
  • Run shinken-init before setting up services


  • Attributize _hostgroups search (#4)
  • Clean up Test Kitchen config
  • Consistently use user/group attributes
  • Update ec2dnsserver to bring in bugfix


  • Bump shinken package version to 2.4 and update webui package


  • Move different definition types into their own recipies
  • Update install sources and associated checksums
  • Delete old services and hostgroups


  • Add RuboCop config (#3)
  • Fix convergence by removing nonexistent user from test-data cookbook (#3)
  • Clean up unused files
  • Clean up README
  • Add Rakefile with test tasks
  • Fix up some Foodcritic violations
  • Fix up some RuboCop violations
  • Add integration testing on Ubuntu 14.04
  • Other misc. fixes to configs


  • Update source-based install URLs to point to more recent copies of Shinken & its Web UI
  • Add install of cherrypy library as per Shinken’s pip install instruction


  • Forgot super-important "map" method call


  • Delete hosts and hostgroups if they no longer exist in the environment
  • Replace references to /etc/shinken with an attribute
  • Switch to rspec3 test syntax


  • Add attribute for shinken agent user


  • Add private key install code so that we can use check_by_ssh


  • Add a "from source" install method and include a way to differentiate between that and "from package"


  • Fix command name in check_http_content (to make it reflect the file name)


  • Add command: check_http_content


  • Attribute-ize host search string


  • Move definitions to earlier in the process


  • Add check_http command


Initial release of shinken

  • Enhancements

    • an enhancement
  • Bug Fixes

    • a bug fix

Collaborator Number Metric

1.13.0 passed this metric

Foodcritic Metric

1.13.0 failed this metric

FC003: Check whether you are running with chef server before using server-specific features: /tmp/04e091d85d9bc9c458cb85a1/shinken/recipes/_hostgroups.rb:41
FC003: Check whether you are running with chef server before using server-specific features: /tmp/04e091d85d9bc9c458cb85a1/shinken/recipes/_hosts.rb:20
FC003: Check whether you are running with chef server before using server-specific features: /tmp/04e091d85d9bc9c458cb85a1/shinken/recipes/_users.rb:27
FC010: Invalid search syntax: /tmp/04e091d85d9bc9c458cb85a1/shinken/recipes/_hostgroups.rb:43
FC064: Ensure issues_url is set in metadata: /tmp/04e091d85d9bc9c458cb85a1/shinken/metadata.rb:1
FC065: Ensure source_url is set in metadata: /tmp/04e091d85d9bc9c458cb85a1/shinken/metadata.rb:1