Adoptable Cookbooks List

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.

sysctl

Description

Platforms

Debian/Ubuntu

RHEL/CentOS

Scientific Linux

PLD Linux (not tested)

Usage

There are two main ways to interact with the cookbook. This is via chef attributes or via the provided LWRP.

Attributes

node['sysctl']['params'] - A namespace for setting sysctl parameters. These will be set during convergence, but will not be automatically persisted into a configuration file. The resource ruby_block[save-sysctl-params] is provided via the default recipe, which you can notify in order to persist these values.

node['sysctl']['conf_dir'] - Specifies the sysctl.d directory to be used. Defaults to /etc/sysctl.d on the Debian and RHEL platform families, otherwise nil

node['sysctl']['allow_sysctl_conf'] - Defaults to false. Using conf_dir is highly recommended. On some platforms that is not supported. For those platforms, set this to true and the cookbook will rewrite the /etc/sysctl.conf file directly with the params provided. Be sure to save any local edits of /etc/sysctl.conf before enabling this to avoid losing them.

LWRP

sysctl_param

Actions

apply (default)

remove

nothing

Attributes

key

value

Persistence rules

sysctl values will be persisted to the filesystem (so that they can be
initialized at boot) by this cookbook under the following conditions:

You use an LWRP to declare the value, or you declare its value via
a node attribute (node['sysctl']['params']) and invoke
ruby_block[save-sysctl-params'] via a notification; and

node['sysctl']['conf_dir'] is defined, in which case they are written
to VALUE/99-chef-attributes.conf; ornode['sysctl']['allow_sysctl_conf'] is set to true, in which case
they are written to /etc/sysctl.conf.

Ohai Plugin

The cookbook also includes an Ohai 7 plugin that can be installed by adding sysctl::ohai_plugin to your run_list. This will populate node['sys'] with automatic attributes that mirror the layout of /proc/sys.

To see ohai plugin output manually, you can run ohai -d /etc/chef/ohai_plugins sys on the command line.

Development

We have written unit tests using chefspec and integration tests in serverspec executed via test-kitchen.
Much of the tooling around this cookbook is exposed via guard and test kitchen, so it is highly recommended to learn more about those tools.

Vagrant Plugin Dependencies

The integration tests can be run via test-kitchen using vagrant, but it depends on the following vagrant plugins:

The above will do ruby style (rubocop) and cookbook style (foodcritic) checks followed rspec unit tests ensuring proper cookbook operation.Integration tests will be run next on two separate linux platforms (Ubuntu 14.04 LTS Precise 64-bit and CentOS 6.5). Please run the tests on any pull requests that you are about to submit and write tests for defects or new features to ensure backwards compatibility and a stable cookbook that we can all rely upon.

Running tests continuously with guard

This cookbook is also setup to run the checks while you work via the guard gem.

bundle install
bundle exec guard start

ChefSpec LWRP Matchers

The cookbook exposes a chefspec matcher to be used by wrapper cookbooks to test the cookbooks LWRP. See library/matchers.rb for basic usage.

Links

There are a lot of different documents that talk about system control parameters, the hope here is to point to some of the most useful ones to provide more guidance as to what the possible kernel parameters are and what they mean.