# Copyright (C) 2012 Hewlett-Packard Development Company, L.P.
#
# Author: Avishai Ish-Shalom <avishai@fewbytes.com>
# Author: Mike Moulton <mike@meltmedia.com>
# Author: Juerg Haefliger <juerg.haefliger@hp.com>
#
# This file is part of cloud-init. See LICENSE file for license information.
"""
Chef
----
**Summary:** module that configures, starts and installs chef.
This module enables chef to be installed (from packages or
from gems, or from omnibus). Before this occurs chef configurations are
written to disk (validation.pem, client.pem, firstboot.json, client.rb),
and needed chef folders/directories are created (/etc/chef and /var/log/chef
and so-on). Then once installing proceeds correctly if configured chef will
be started (in daemon mode or in non-daemon mode) and then once that has
finished (if ran in non-daemon mode this will be when chef finishes
converging, if ran in daemon mode then no further actions are possible since
chef will have forked into its own process) then a post run function can
run that can do finishing activities (such as removing the validation pem
file).
**Internal name:** ``cc_chef``
**Module frequency:** per always
**Supported distros:** all
**Config keys**::
chef:
directories: (defaulting to /etc/chef, /var/log/chef, /var/lib/chef,
/var/cache/chef, /var/backups/chef, /run/chef)
validation_cert: (optional string to be written to file validation_key)
special value 'system' means set use existing file
validation_key: (optional the path for validation_cert. default
/etc/chef/validation.pem)
firstboot_path: (path to write run_list and initial_attributes keys that
should also be present in this configuration, defaults
to /etc/chef/firstboot.json)
exec: boolean to run or not run chef (defaults to false, unless
a gem installed is requested
where this will then default
to true)
chef.rb template keys (if falsey, then will be skipped and not
written to /etc/chef/client.rb)
chef:
client_key:
encrypted_data_bag_secret:
environment:
file_backup_path:
file_cache_path:
json_attribs:
log_level:
log_location:
node_name:
omnibus_url:
omnibus_url_retries:
omnibus_version:
pid_file:
server_url:
show_time:
ssl_verify_mode:
validation_cert:
validation_key:
validation_name:
"""
import itertools
import json
import os
from textwrap import dedent
from cloudinit import subp
from cloudinit.config.schema import (
get_schema_doc, validate_cloudconfig_schema)
from cloudinit import templater
from cloudinit import temp_utils
from cloudinit import url_helper
from cloudinit import util
from cloudinit.settings import PER_ALWAYS
RUBY_VERSION_DEFAULT = "1.8"
CHEF_DIRS = tuple([
'/etc/chef',
'/var/log/chef',
'/var/lib/chef',
'/var/cache/chef',
'/var/backups/chef',
'/run/chef',
])
REQUIRED_CHEF_DIRS = tuple([
'/etc/chef',
])
# Used if fetching chef from a omnibus style package
OMNIBUS_URL = "https://www.chef.io/chef/install.sh"
OMNIBUS_URL_RETRIES = 5
CHEF_VALIDATION_PEM_PATH = '/etc/chef/validation.pem'
CHEF_ENCRYPTED_DATA_BAG_PATH = '/etc/chef/encrypted_data_bag_secret'
CHEF_ENVIRONMENT = '_default'
CHEF_FB_PATH = '/etc/chef/firstboot.json'
CHEF_RB_TPL_DEFAULTS = {
# These are ruby symbols...
'ssl_verify_mode': ':verify_none',
'log_level': ':info',
# These are not symbols...
'log_location': '/var/log/chef/client.log',
'validation_key': CHEF_VALIDATION_PEM_PATH,
'validation_cert': None,
'client_key': '/etc/chef/client.pem',
'json_attribs': CHEF_FB_PATH,
'file_cache_path': '/var/cache/chef',
'file_backup_path': '/var/backups/chef',
'pid_file': '/var/run/chef/client.pid',
'show_time': True,
'encrypted_data_bag_secret': None,
}
CHEF_RB_TPL_BOOL_KEYS = frozenset(['show_time'])
CHEF_RB_TPL_PATH_KEYS = frozenset([
'log_location',
'validation_key',
'client_key',
'file_cache_path',
'json_attribs',
'pid_file',
'encrypted_data_bag_secret',
'chef_license',
])
CHEF_RB_TPL_KEYS = list(CHEF_RB_TPL_DEFAULTS.keys())
CHEF_RB_TPL_KEYS.extend(CHEF_RB_TPL_BOOL_KEYS)
CHEF_RB_TPL_KEYS.extend(CHEF_RB_TPL_PATH_KEYS)
CHEF_RB_TPL_KEYS.extend([
'server_url',
'node_name',
'environment',
'validation_name',
])
CHEF_RB_TPL_KEYS = frozenset(CHEF_RB_TPL_KEYS)
CHEF_RB_PATH = '/etc/chef/client.rb'
CHEF_EXEC_PATH = '/usr/bin/chef-client'
CHEF_EXEC_DEF_ARGS = tuple(['-d', '-i', '1800', '-s', '20'])
frequency = PER_ALWAYS
distros = ["all"]
schema = {
'id': 'cc_chef',
'name': 'Chef',
'title': 'module that configures, starts and installs chef',
'description': dedent("""\
This module enables chef to be installed (from packages,
gems, or from omnibus). Before this occurs, chef configuration is
written to disk (validation.pem, client.pem, firstboot.json,
client.rb), and required directories are created (/etc/chef and
/var/log/chef and so-on). If configured, chef will be
installed and started in either daemon or non-daemon mode.
If run in non-daemon mode, post run actions are executed to do
finishing activities such as removing validation.pem."""),
'distros': distros,
'examples': [dedent("""
chef:
directories:
- /etc/chef
- /var/log/chef
validation_cert: system
install_type: omnibus
initial_attributes:
apache:
prefork:
maxclients: 100
keepalive: off
run_list:
- recipe[apache2]
- role[db]
encrypted_data_bag_secret: /etc/chef/encrypted_data_bag_secret
environment: _default
log_level: :auto
omnibus_url_retries: 2
server_url: https://chef.yourorg.com:4000
ssl_verify_mode: :verify_peer
validation_name: yourorg-validator""")],
'frequency': frequency,
'type': 'object',
'properties': {
'chef': {
'type': 'object',
'additionalProperties': False,
'properties': {
'directories': {
'type': 'array',
'items': {
'type': 'string'
},
'uniqueItems': True,
'description': dedent("""\
Create the necessary directories for chef to run. By
default, it creates the following directories:
{chef_dirs}""").format(
chef_dirs="\n".join(
[" - ``{}``".format(d) for d in CHEF_DIRS]
)
)
},
'validation_cert': {
'type': 'string',
'description': dedent("""\
Optional string to be written to file validation_key.
Special value ``system`` means set use existing file.
""")
},
'validation_key': {
'type': 'string',
'default': CHEF_VALIDATION_PEM_PATH,
'description': dedent("""\
Optional path for validation_cert. default to
``{}``.""".format(CHEF_VALIDATION_PEM_PATH))
},
'firstboot_path': {
'type': 'string',
'default': CHEF_FB_PATH,
'description': dedent("""\
Path to write run_list and initial_attributes keys that
should also be present in this configuration, defaults
to ``{}``.""".format(CHEF_FB_PATH))
},
'exec': {
'type': 'boolean',
'default': False,
'description': dedent("""\
define if we should run or not run chef (defaults to
false, unless a gem installed is requested where this
will then default to true).""")
},
'client_key': {
'type': 'string',
'default': CHEF_RB_TPL_DEFAULTS['client_key'],
'description': dedent("""\
Optional path for client_cert. default to
``{}``.""".format(CHEF_RB_TPL_DEFAULTS['client_key']))
},
'encrypted_data_bag_secret': {
'type': 'string',
'default': None,
'description': dedent("""\
Specifies the location of the secret key used by chef
to encrypt data items. By default, this path is set
to None, meaning that chef will have to look at the
path ``{}`` for it.
""".format(CHEF_ENCRYPTED_DATA_BAG_PATH))
},
'environment': {
'type': 'string',
'default': CHEF_ENVIRONMENT,
'description': dedent("""\
Specifies which environment chef will use. By default,
it will use the ``{}`` configuration.
""".format(CHEF_ENVIRONMENT))
},
'file_backup_path': {
'type': 'string',
'default': CHEF_RB_TPL_DEFAULTS['file_backup_path'],
'description': dedent("""\
Specifies the location in which backup files are
stored. By default, it uses the
``{}`` location.""".format(
CHEF_RB_TPL_DEFAULTS['file_backup_path']))
},
'file_cache_path': {
'type': 'string',
'default': CHEF_RB_TPL_DEFAULTS['file_cache_path'],
'description': dedent("""\
Specifies the location in which chef cache files will
be saved. By default, it uses the ``{}``
location.""".format(
CHEF_RB_TPL_DEFAULTS['file_cache_path']))
},
'json_attribs': {
'type': 'string',
'default': CHEF_FB_PATH,
'description': dedent("""\
Specifies the location in which some chef json data is
stored. By default, it uses the
``{}`` location.""".format(CHEF_FB_PATH))
},
'log_level': {
'type': 'string',
'default': CHEF_RB_TPL_DEFAULTS['log_level'],
'description': dedent("""\
Defines the level of logging to be stored in the log
file. By default this value is set to ``{}``.
""".format(CHEF_RB_TPL_DEFAULTS['log_level']))
},
'log_location': {
'type': 'string',
'default': CHEF_RB_TPL_DEFAULTS['log_location'],
'description': dedent("""\
Specifies the location of the chef lof file. By
default, the location is specified at
``{}``.""".format(
CHEF_RB_TPL_DEFAULTS['log_location']))
},
'node_name': {
'type': 'string',
'description': dedent("""\
The name of the node to run. By default, we will
use th instance id as the node name.""")
},
'omnibus_url': {
'type': 'string',
'default': OMNIBUS_URL,
'description': dedent("""\
Omnibus URL if chef should be installed through
Omnibus. By default, it uses the
``{}``.""".format(OMNIBUS_URL))
},
'omnibus_url_retries': {
'type': 'integer',
'default': OMNIBUS_URL_RETRIES,
'description': dedent("""\
The number of retries that will be attempted to reach
the Omnibus URL""")
},
'omnibus_version': {
'type': 'string',
'description': dedent("""\
Optional version string to require for omnibus
install.""")
},
'pid_file': {
'type': 'string',
'default': CHEF_RB_TPL_DEFAULTS['pid_file'],
'description': dedent("""\
The location in which a process identification
number (pid) is saved. By default, it saves
in the ``{}`` location.""".format(
CHEF_RB_TPL_DEFAULTS['pid_file']))
},
'server_url': {
'type': 'string',
'description': 'The URL for the chef server'
},
'show_time': {
'type': 'boolean',
'default': True,
'description': 'Show time in chef logs'
},
'ssl_verify_mode': {
'type': 'string',
'default': CHEF_RB_TPL_DEFAULTS['ssl_verify_mode'],
'description': dedent("""\
Set the verify mode for HTTPS requests. We can have
two possible values for this parameter:
- ``:verify_none``: No validation of SSL \
certificates.
- ``:verify_peer``: Validate all SSL certificates.
By default, the parameter is set as ``{}``.
""".format(CHEF_RB_TPL_DEFAULTS['ssl_verify_mode']))
},
'validation_name': {
'type': 'string',
'description': dedent("""\
The name of the chef-validator key that Chef Infra
Client uses to access the Chef Infra Server during
the initial Chef Infra Client run.""")
},
'force_install': {
'type': 'boolean',
'default': False,
'description': dedent("""\
If set to ``True``, forces chef installation, even
if it is already installed.""")
},
'initial_attributes': {
'type': 'object',
'items': {
'type': 'string'
},
'description': dedent("""\
Specify a list of initial attributes used by the
cookbooks.""")
},
'install_type': {
'type': 'string',
'default': 'packages',
'description': dedent("""\
The type of installation for chef. It can be one of
the following values:
- ``packages``
- ``gems``
- ``omnibus``""")
},
'run_list': {
'type': 'array',
'items': {
'type': 'string'
},
'description': 'A run list for a first boot json.'
},
"chef_license": {
'type': 'string',
'description': dedent("""\
string that indicates if user accepts or not license
related to some of chef products""")
}
}
}
}
}
__doc__ = get_schema_doc(schema)
def post_run_chef(chef_cfg, log):
delete_pem = util.get_cfg_option_bool(chef_cfg,
'delete_validation_post_exec',
default=False)
if delete_pem and os.path.isfile(CHEF_VALIDATION_PEM_PATH):
os.unlink(CHEF_VALIDATION_PEM_PATH)
def get_template_params(iid, chef_cfg, log):
params = CHEF_RB_TPL_DEFAULTS.copy()
# Allow users to overwrite any of the keys they want (if they so choose),
# when a value is None, then the value will be set to None and no boolean
# or string version will be populated...
for (k, v) in chef_cfg.items():
if k not in CHEF_RB_TPL_KEYS:
log.debug("Skipping unknown chef template key '%s'", k)
continue
if v is None:
params[k] = None
else:
# This will make the value a boolean or string...
if k in CHEF_RB_TPL_BOOL_KEYS:
params[k] = util.get_cfg_option_bool(chef_cfg, k)
else:
params[k] = util.get_cfg_option_str(chef_cfg, k)
# These ones are overwritten to be exact values...
params.update({
'generated_by': util.make_header(),
'node_name': util.get_cfg_option_str(chef_cfg, 'node_name',
default=iid),
'environment': util.get_cfg_option_str(chef_cfg, 'environment',
default='_default'),
# These two are mandatory...
'server_url': chef_cfg['server_url'],
'validation_name': chef_cfg['validation_name'],
})
return params
def handle(name, cfg, cloud, log, _args):
"""Handler method activated by cloud-init."""
# If there isn't a chef key in the configuration don't do anything
if 'chef' not in cfg:
log.debug(("Skipping module named %s,"
" no 'chef' key in configuration"), name)
return
validate_cloudconfig_schema(cfg, schema)
chef_cfg = cfg['chef']
# Ensure the chef directories we use exist
chef_dirs = util.get_cfg_option_list(chef_cfg, 'directories')
if not chef_dirs:
chef_dirs = list(CHEF_DIRS)
for d in itertools.chain(chef_dirs, REQUIRED_CHEF_DIRS):
util.ensure_dir(d)
vkey_path = chef_cfg.get('validation_key', CHEF_VALIDATION_PEM_PATH)
vcert = chef_cfg.get('validation_cert')
# special value 'system' means do not overwrite the file
# but still render the template to contain 'validation_key'
if vcert:
if vcert != "system":
util.write_file(vkey_path, vcert)
elif not os.path.isfile(vkey_path):
log.warning("chef validation_cert provided as 'system', but "
"validation_key path '%s' does not exist.",
vkey_path)
# Create the chef config from template
template_fn = cloud.get_template_filename('chef_client.rb')
if template_fn:
iid = str(cloud.datasource.get_instance_id())
params = get_template_params(iid, chef_cfg, log)
# Do a best effort attempt to ensure that the template values that
# are associated with paths have their parent directory created
# before they are used by the chef-client itself.
param_paths = set()
for (k, v) in params.items():
if k in CHEF_RB_TPL_PATH_KEYS and v:
param_paths.add(os.path.dirname(v))
util.ensure_dirs(param_paths)
templater.render_to_file(template_fn, CHEF_RB_PATH, params)
else:
log.warning("No template found, not rendering to %s",
CHEF_RB_PATH)
# Set the firstboot json
fb_filename = util.get_cfg_option_str(chef_cfg, 'firstboot_path',
default=CHEF_FB_PATH)
if not fb_filename:
log.info("First boot path empty, not writing first boot json file")
else:
initial_json = {}
if 'run_list' in chef_cfg:
initial_json['run_list'] = chef_cfg['run_list']
if 'initial_attributes' in chef_cfg:
initial_attributes = chef_cfg['initial_attributes']
for k in list(initial_attributes.keys()):
initial_json[k] = initial_attributes[k]
util.write_file(fb_filename, json.dumps(initial_json))
# Try to install chef, if its not already installed...
force_install = util.get_cfg_option_bool(chef_cfg,
'force_install', default=False)
installed = subp.is_exe(CHEF_EXEC_PATH)
if not installed or force_install:
run = install_chef(cloud, chef_cfg, log)
elif installed:
run = util.get_cfg_option_bool(chef_cfg, 'exec', default=False)
else:
run = False
if run:
run_chef(chef_cfg, log)
post_run_chef(chef_cfg, log)
def run_chef(chef_cfg, log):
log.debug('Running chef-client')
cmd = [CHEF_EXEC_PATH]
if 'exec_arguments' in chef_cfg:
cmd_args = chef_cfg['exec_arguments']
if isinstance(cmd_args, (list, tuple)):
cmd.extend(cmd_args)
elif isinstance(cmd_args, str):
cmd.append(cmd_args)
else:
log.warning("Unknown type %s provided for chef"
" 'exec_arguments' expected list, tuple,"
" or string", type(cmd_args))
cmd.extend(CHEF_EXEC_DEF_ARGS)
else:
cmd.extend(CHEF_EXEC_DEF_ARGS)
subp.subp(cmd, capture=False)
def subp_blob_in_tempfile(blob, *args, **kwargs):
"""Write blob to a tempfile, and call subp with args, kwargs. Then cleanup.
'basename' as a kwarg allows providing the basename for the file.
The 'args' argument to subp will be updated with the full path to the
filename as the first argument.
"""
basename = kwargs.pop('basename', "subp_blob")
if len(args) == 0 and 'args' not in kwargs:
args = [tuple()]
# Use tmpdir over tmpfile to avoid 'text file busy' on execute
with temp_utils.tempdir(needs_exe=True) as tmpd:
tmpf = os.path.join(tmpd, basename)
if 'args' in kwargs:
kwargs['args'] = [tmpf] + list(kwargs['args'])
else:
args = list(args)
args[0] = [tmpf] + args[0]
util.write_file(tmpf, blob, mode=0o700)
return subp.subp(*args, **kwargs)
def install_chef_from_omnibus(url=None, retries=None, omnibus_version=None):
"""Install an omnibus unified package from url.
@param url: URL where blob of chef content may be downloaded. Defaults to
OMNIBUS_URL.
@param retries: Number of retries to perform when attempting to read url.
Defaults to OMNIBUS_URL_RETRIES
@param omnibus_version: Optional version string to require for omnibus
install.
"""
if url is None:
url = OMNIBUS_URL
if retries is None:
retries = OMNIBUS_URL_RETRIES
if omnibus_version is None:
args = []
else:
args = ['-v', omnibus_version]
content = url_helper.readurl(url=url, retries=retries).contents
return subp_blob_in_tempfile(
blob=content, args=args,
basename='chef-omnibus-install', capture=False)
def install_chef(cloud, chef_cfg, log):
# If chef is not installed, we install chef based on 'install_type'
install_type = util.get_cfg_option_str(chef_cfg, 'install_type',
'packages')
run = util.get_cfg_option_bool(chef_cfg, 'exec', default=False)
if install_type == "gems":
# This will install and run the chef-client from gems
chef_version = util.get_cfg_option_str(chef_cfg, 'version', None)
ruby_version = util.get_cfg_option_str(chef_cfg, 'ruby_version',
RUBY_VERSION_DEFAULT)
install_chef_from_gems(ruby_version, chef_version, cloud.distro)
# Retain backwards compat, by preferring True instead of False
# when not provided/overriden...
run = util.get_cfg_option_bool(chef_cfg, 'exec', default=True)
elif install_type == 'packages':
# This will install and run the chef-client from packages
cloud.distro.install_packages(('chef',))
elif install_type == 'omnibus':
omnibus_version = util.get_cfg_option_str(chef_cfg, "omnibus_version")
install_chef_from_omnibus(
url=util.get_cfg_option_str(chef_cfg, "omnibus_url"),
retries=util.get_cfg_option_int(chef_cfg, "omnibus_url_retries"),
omnibus_version=omnibus_version)
else:
log.warning("Unknown chef install type '%s'", install_type)
run = False
return run
def get_ruby_packages(version):
# return a list of packages needed to install ruby at version
pkgs = ['ruby%s' % version, 'ruby%s-dev' % version]
if version == "1.8":
pkgs.extend(('libopenssl-ruby1.8', 'rubygems1.8'))
return pkgs
def install_chef_from_gems(ruby_version, chef_version, distro):
distro.install_packages(get_ruby_packages(ruby_version))
if not os.path.exists('/usr/bin/gem'):
util.sym_link('/usr/bin/gem%s' % ruby_version, '/usr/bin/gem')
if not os.path.exists('/usr/bin/ruby'):
util.sym_link('/usr/bin/ruby%s' % ruby_version, '/usr/bin/ruby')
if chef_version:
subp.subp(['/usr/bin/gem', 'install', 'chef',
'-v %s' % chef_version, '--no-ri',
'--no-rdoc', '--bindir', '/usr/bin', '-q'], capture=False)
else:
subp.subp(['/usr/bin/gem', 'install', 'chef',
'--no-ri', '--no-rdoc', '--bindir',
'/usr/bin', '-q'], capture=False)
# vi: ts=4 expandtab