xcat-core/xCAT-OpenStack/chef-cookbooks/grizzly-xcat/cookbooks/sysctl/README.md

82 lines
2.5 KiB
Markdown
Raw Normal View History

# sysctl [![Build Status](https://travis-ci.org/onehealth-cookbooks/sysctl.png?branch=master)](https://travis-ci.org/onehealth-cookbooks/sysctl)
Description
===========
Set [sysctl](http://en.wikipedia.org/wiki/Sysctl) system control parameters via Opscode Chef
Platforms
=========
* Debian/Ubuntu
* RHEL/CentOS (work in progress)
Usage
=======
There are two main ways to interact with the cookbook. This is via chef [attributes](http://docs.opscode.com/essentials_cookbook_attribute_files.html) or via the provided [LWRP](http://docs.opscode.com/lwrp.html).
## Attributes
* node['sysctl']['params'] - A namespace for setting sysctl parameters
* node['sysctl']['conf_dir'] - Specifies the sysctl.d directory to be used. Defaults on Debian to /etc/sysctl.d, otherwise nil
* node['sysctl']['allow_sysctl_conf'] - Defaults to false. This will write params to /etc/sysctl.conf directly when set to true.
## LWRP
### sysctl_param
Actions
- apply (default)
- remove
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
This cookbook can be tested 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.2.1)
* vagrant-berkshelf (1.2.0)
* vagrant-omnibus (1.0.2)
# 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.
* [Linux Kernel Sysctl](https://www.kernel.org/doc/Documentation/sysctl/)
* [Linux Kernel IP Sysctl](http://www.kernel.org/doc/Documentation/networking/ip-sysctl.txt)
* [THE /proc FILESYSTEM (Jun 2009)](http://www.kernel.org/doc/Documentation/filesystems/proc.txt)
* [RHEL 5 VM/Page Cache Tuning Presentation (2009) pdf](http://people.redhat.com/dshaks/Larry_Shak_Perf_Summit1_2009_final.pdf)
* [Arch Linux SysCtl Tutorial (Feb 2013)](http://gotux.net/arch-linux/sysctl-config/)
* [Old RedHat System Tuning Overview (2001!)](http://people.redhat.com/alikins/system_tuning.html)