linux-on-ibm-z/chef-client

Name: chef-client

Owner: LinuxONE and Linux on z Systems Open-source Team

Description: Development repository for Chef Client cookbook

Created: 2016-04-12 16:56:45.0

Updated: 2016-04-12 16:56:46.0

Pushed: 2016-04-13 04:43:27.0

Homepage: http://supermarket.chef.io/cookbooks/chef-client

Size: 770

Language: Ruby

GitHub Committers

UserMost Recent Commit# Commits

Other Committers

UserEmailMost Recent Commit# Commits

README

Chef Client Cookbook

Build Status Cookbook Version

This cookbook is used to configure a system as a Chef Client.

Requirements
Platforms

The following platforms are tested directly under test-kitchen; see .kitchen.yml and TESTING.md for details.

The following platforms are known to work:

Other platforms may work with or without modification. Most notably, attribute modification may be required.

Chef
Dependent Cookbooks

Some cookbooks can be used with this cookbook but they are not explicitly required. The default settings in this cookbook do not require their use. The other cookbooks (on the supermarket) are:

Cron is a dependency, for default behavior of the cron recipe to work. This is a dependency because cron is cross platform, and doesn't carry additional dependencies, unlike the other cookbooks listed above.

See USAGE.

Attributes

The following attributes affect the behavior of the chef-client program when running as a service through one of the service recipes, or in cron with the cron recipe, or are used in the recipes for various settings that require flexibility.

The following attributes are set on a per-platform basis, see the attributes/default.rb file for default values.

This cookbook makes use of attribute-driven configuration with this attribute. See USAGE for examples.

Chef Client Config

The following attributes should be set using ['chef_client']['config']. Setting them at the ['chef_client'] attribute level is deprecated.

The following attributes are deprecated entirely.

Recipes

This section describes the recipes in the cookbook and how to use them in your environment.

config

Sets up the /etc/chef/client.rb config file from a template and reloads the configuration for the current chef-client run.

See USAGE for more information on how the configuration is rendered with attributes.

service recipes

The chef-client::service recipe includes one of the chef-client::INIT_STYLE_service recipes based on the attribute, node['chef_client']['init_style']. The individual service recipes can be included directly, too. For example, to use the init scripts, on a node or role's run list:

pe[chef-client::init_service]

To set up the chef-client under bluepill, daemontools or runit, those recipes must be specified on the node or role's run list first, to ensure that the dependencies are resolved, as this cookbook does not directly depend on them. For example, to use runit:

pe[runit]
pe[chef-client::runit_service]

Use this recipe on systems that should have a chef-client daemon running, such as when Knife bootstrap was used to install Chef on a new system.

default

Includes the chef-client::service recipe by default.

delete_validation

Use this recipe to delete the validation certificate (default /etc/chef/validation.pem) when using a chef-client after the client has been validated and authorized to connect to the server.

Note If you're using this on a Chef 10 Server, be careful when using this recipe. First, copy the validation.pem certificate file to another location, such as your knife configuration directory (~/.chef) or Chef Repository.

cron

Use this recipe to run chef-client as a cron job rather than as a service. The cron job runs after random delay that is between 0 and 90 seconds to ensure that the chef-clients don't attempt to connect to the chef-server at the exact same time. You should set node['chef_client']['init_style'] = 'none' when you use this mode but it is not required.

Usage

Use the recipes as described above to configure your systems to run Chef as a service via cron or one of the service management systems supported by the recipes.

The chef-client::config recipe is only required with init style init (default setting for the attribute on debian/redhat family platforms, because the init script doesn't include the pid_file option which is set in the config.

The config recipe is used to dynamically generate the /etc/chef/client.rb config file. The template walks all attributes in node['chef_client']['config'] and writes them out as key:value pairs. The key should be the configuration directive. For example, the following attributes (in a role):

ult_attributes(
hef_client" => {
"config" => {
  "ssl_verify_mode" => ":verify_peer",
  "client_fork" => true
}

will render the following configuration (/etc/chef/client.rb):

_server_url "https://api.chef.io/organizations/MYORG"
dation_client_name "MYORG-validator"
verify_mode :verify_peer
_name "config-ubuntu-1204"
nt_fork true

The chef_server_url, node_name and validation_client_name are set by default in the attributes file from Chef::Config. They are presumed to come from the knife bootstrap command when setting up a new node for Chef. To set the node name to the default value (the node['fqdn'] attribute), it can be set false. Be careful when setting this or the Server URL, as those values may already exist.

As another example, to set HTTP proxy configuration settings. By default Chef will not use a proxy.

ult_attributes(
hef_client" => {
"config" => {
  "http_proxy" => "http://proxy.vmware.com:3128",
  "https_proxy" => "http://proxy.vmware.com:3128",
  "http_proxy_user" => "my_username",
  "http_proxy_pass" => "Awe_some_Pass_Word!",
  "no_proxy" => "*.vmware.com,10.*"
}
Configuration Includes

The /etc/chef/client.rb file will include all the configuration files in /etc/chef/client.d/*.rb. To create custom configuration, simply render a file resource with file (and the content parameter), template, remote_file, or cookbook_file. For example, in your own cookbook that requires custom Chef client configuration, create the following cookbook_file resource:

_gem 'syslog-logger'

book_file "/etc/chef/client.d/myconfig.rb" do
urce "myconfig.rb"
de 00644
tifies :create, "ruby_block[reload_client_config]"


ude_recipe 'chef-client::config'

Then create files/default/myconfig.rb with the configuration content you want. For example, if you wish to create a configuration to log to syslog:

ire 'rubygems'
ire 'syslog-logger'
ire 'syslog'

er::Syslog.class_eval do
tr_accessor :sync, :formatter


location Logger::Syslog.new('chef-client', ::Syslog::LOG_DAEMON)

Or, if you're using Chef >= 12.4:

location Chef::Log::Syslog.new('chef-client', ::Syslog::LOG_DAEMON)
Requiring Gems

Use the load_gems attribute to install gems that need to be required in the client.rb. This attribute should be a hash. The gem will also be installed with chef_gem. For example, suppose we want to use a Chef Handler Gem, chef-handler-updated-resources, which is used in the next heading. Set the attributes, e.g., in a role:

ult_attributes(
hef_client" => {
"load_gems" => {
  "chef-handler-updated-resources" => {
    "require_name" => "chef/handler/updated_resources",
    "version" => "0.1"
  }
}

Each key in load_gems is the name of a gem. Each gem hash can have two keys, the require_name which is the string that will be require'd in /etc/chef/client.rb, and version which is the version of the gem to install. If the version is not specified, the latest version will be installed.

The above example will render the following in /etc/chef/client.rb:

ef/handler/updated_resources"].each do |lib|
gin
require lib
scue LoadError
Chef::Log.warn "Failed to load #{lib}. This should be resolved after a chef run."
d
Start, Report, Exception Handlers

To dynamically render configuration for Start, Report, or Exception handlers, set the following attributes in the config attributes:

This is an alternative to using the chef_handler cookbook.

Each of these attributes must be an array of hashes. The hash has two keys, class (a string), and arguments (an array). For example, to use the report handler in the Requiring Gems section:

ult_attributes(
hef_client" => {
"config" => {
  "report_handlers" => [
    {"class" => "SimpleReport::UpdatedResources", "arguments" => []}
  ]
}

If the handler you're using has an initialize method that takes arguments, then pass each one as a member of the array. Otherwise, leave it blank as above.

This will render the following in /etc/chef/client.rb.

rt_handlers << SimpleReport::UpdatedResources.new()
Alternate Init Styles

The alternate init styles available are:

Runit

To use runit, download the cookbook from the cookbook site.

Change the init_style to runit in the base role and add the runit recipe to the role's run list:

 "base"
ription "Base role applied to all nodes"
ult_attributes(
hef_client" => {
"init_style" => "runit"


list(
ecipe[chef-client::delete_validation]",
ecipe[runit]",
ecipe[chef-client]"

The chef-client recipe will create the chef-client service configured with runit. The runit run script will be located in /etc/sv/chef-client/run. The output log will be in the runit service directory, /etc/sv/chef-client/log/main/current.

Bluepill

To use bluepill, download the cookbook from the cookbook site.

Change the init_style to runit in the base role and add the bluepill recipe to the role's run list:

 "base"
ription "Base role applied to all nodes"
ult_attributes(
hef_client" => {
"init_style" => "bluepill"


list(
ecipe[chef-client::delete_validation]",
ecipe[bluepill]",
ecipe[chef-client]"

The chef-client recipe will create the chef-client service configured with bluepill. The bluepill “pill” will be located in /etc/bluepill/chef-client.pill. The output log will be to client.log file in the node['chef_client']['log_dir'] location, /var/log/chef/client by default.

Daemontools

To use daemontools, download the cookbook from the cookbook site.

Change the init_style to runit in the base role and add the daemontools recipe to the role's run list:

 "base"
ription "Base role applied to all nodes"
ult_attributes(
hef_client" => {
"init_style" => "daemontools"


list(
ecipe[chef-client::delete_validation]",
ecipe[daemontools]",
ecipe[chef-client]"

The chef-client recipe will create the chef-client service configured under daemontools. It uses the same sv run scripts as the runit recipe. The run script will be located in /etc/sv/chef-client/run. The output log will be in the daemontools service directory, /etc/sv/chef-client/log/main/current.

Launchd

On Mac OS X and Mac OS X Server, the default service implementation is “launchd”.

Since launchd can run a service in interval mode, by default chef-client is not started in daemon mode like on Debian or Ubuntu. Keep this in mind when you look at your process list and check for a running chef process! If you wish to run chef-client in daemon mode, set attribute chef_client.launchd_mode to “daemon”.

Installing and updating chef-client

This cookbook does not handle updating the chef-client, as that's out of the cookbook's current scope. To sensibly manage updates of the chef-client omnibus install, we refer you to:

For more on why this cookbook does not support installs, see Issue #102

License & Authors

Author: Cookbook Engineering Team (cookbooks@chef.io)

Copyright: 2010-2016, Chef Software, Inc.

nsed under the Apache License, Version 2.0 (the "License");
may not use this file except in compliance with the License.
may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

ss required by applicable law or agreed to in writing, software
ributed under the License is distributed on an "AS IS" BASIS,
OUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
the License for the specific language governing permissions and
tations under the License.
This work is supported by the National Institutes of Health's National Center for Advancing Translational Sciences, Grant Number U24TR002306. This work is solely the responsibility of the creators and does not necessarily represent the official views of the National Institutes of Health.