Skip to content

Files

This branch is 17 commits ahead of, 11 commits behind cogini/chef-cookbooks:master.

sysctl

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
Apr 1, 2014
Apr 1, 2014
Apr 1, 2014
Apr 1, 2014
Dec 25, 2013
Apr 1, 2014
Apr 1, 2014
Apr 1, 2014
Apr 1, 2014
Dec 25, 2013
Dec 25, 2013
Apr 1, 2014
Dec 25, 2013
Apr 1, 2014
Dec 25, 2013
Apr 1, 2014
Apr 1, 2014
Apr 1, 2014
Dec 25, 2013
Dec 25, 2013
Apr 1, 2014

sysctl Build Status

Description

Set sysctl system control parameters via Opscode Chef

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
  • 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

Examples

# set vm.swapiness to 20 via attributes

node.default['sysctl']['params']['vm']['swappiness'] = 20

# set vm.swapiness to 20 via sysctl_param LWRP
sysctl_param 'vm.swappiness' do
  value 20
end

# remove sysctl parameter and set net.ipv4.tcp_fin_timeout back to default
sysctl_param 'net.ipv4.tcp_fin_timeout' do
  value 30
  action :remove
end

Development

We have written unit tests using chefspec and integration tests in bats 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:

vagrant plugin install vagrant-omnibus
vagrant plugin install vagrant-berkshelf

Tested with

  • Vagrant (version 1.4.3)
  • vagrant-berkshelf (1.3.5)
  • vagrant-omnibus (1.1.2)

Running tests

The following commands will run the tests:

bundle install
bundle exec rubocop
bundle exec foodcritic .
bundle exec rspec
bundle exec kitchen test default-ubuntu-1204
bundle exec kitchen test default-centos-65

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 12.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.