Chef Cookbook to update the chef client on nodes
Clone or download
tas50 Release 3.5.0
Signed-off-by: Tim Smith <tsmith@chef.io>
Latest commit dac1dcd Sep 1, 2018
Permalink
Failed to load latest commit information.
.delivery Initial commit of the cookbook Mar 29, 2017
.github Add a few missing files Mar 29, 2017
attributes Move logic into provider, improve regex for handle matching, cleanup May 21, 2018
gemfiles update to support chef-11 upgrades to chef-12/13 Jun 6, 2017
libraries Add ChefSpec matcher Apr 7, 2017
providers only run cron job 5 minutes from now Aug 30, 2018
recipes Move logic into provider, improve regex for handle matching, cleanup May 21, 2018
resources Allow for a configurable package install timeout. (#130) Aug 1, 2018
spec Initial commit of the cookbook Mar 29, 2017
test Update RVM to 2.4.4 and fix test Aug 1, 2018
.foodcritic yes, we have to do this for chef-11 Mar 16, 2018
.gitignore Initial commit of the cookbook Mar 29, 2017
.kitchen.dokken.yml Add cron to apt-get intermediate instruction Aug 1, 2018
.kitchen.yml rubygems_url: Allow the rubygems source to be specified Jun 10, 2018
.travis.yml Update RVM to 2.4.4 and fix test Aug 1, 2018
Berksfile Test using a test recipe so we can use the resources directly May 11, 2017
CHANGELOG.md Release 3.5.0 Aug 31, 2018
CONTRIBUTING.md Initial commit of the cookbook Mar 29, 2017
Gemfile Move maintainer information to the readme Aug 8, 2017
LICENSE Initial commit of the cookbook Mar 29, 2017
README.md Allow for a configurable package install timeout. (#130) Aug 1, 2018
TESTING.md Initial commit of the cookbook Mar 29, 2017
chefignore Added integration test for default and kill suites: Nov 1, 2017
metadata.rb Release 3.5.0 Aug 31, 2018

README.md

chef_client_updater

Build Status Cookbook Version

This cookbook updates the chef-client

Requirements

Platforms

  • All platforms with a chef-client package on downloads.chef.io

Chef

  • Chef 11.6.2+

Usage

This cookbook provides both a custom resource and a default recipe. The default recipe simply uses the custom resource with a set of attributes. You can add chef_client_updater::default to your run list or use the custom resource in a wrapper cookbook.

Init System Caveats

When Chef runs as a service under a system init daemon such as Sys-V or systemd each chef run forks off from the main chef-client process being managed by the init system. For a chef-client upgrade to occur, the running chef-client as well as the parent process must be killed, and a new chef-client must start using the updated binaries. This cookbook handles killing the chef-client, but your init system must properly handle starting the service back up. For systemd and upstart this can be handled via configuration, and chef-client cookbook 8.1.1 or later handles this by default. This functionality is not available in sys-v (RHEL 6, Debian 7, AIX and others).

For systems where the init system will not properly handle starting the service back up automatically (like Sys-V or SRC) this cookbook will attempt to restart the service via a temporary cron job when either of the following conditions are met:

  • node['chef_client']['init_style'] == 'init'
  • node['chef_client_updater']['restart_chef_via_cron'] == true

Updating Windows Nodes

On Windows, a scheduled task is used in combination with a PowerShell-based upgrade script and the downloaded Handle tool. First, the resource moves the current installation to a staging directory and that clears the way for the newer installer to run. Any existing file handles to the old installation folder are forcibly removed and the Eventlog service will be restarted immediately prior to the new installation to release any open file locks. After installation, a log file from the upgrade can be found at c:\opscode\chef_upgrade.log until the next Chef Client run where it will be cleaned up along with the backup folder.

On Windows, the recommended post_install_action is exec instead of kill if you intend to run Chef periodically. In chef_client_updater versions >= 3.1.0 and <= 3.2.9, the updater resource by default started a new Chef run after upgrading. Newer versions simply run chef-client only if post_install_action is set to exec. To run a custom other Powershell command after-upgrade, define post_install_action exec and define your custom command in exec_command

Running Chef Client as a Scheduled Task

If you run as a scheduled task, then this will work smoothly. The path to the newly installed Chef Client will be the same and the scheduled task will launch it. Part of this resource's job on the next run is to make sure the staging directory with the older client is removed.

Running Chef Client As A Windows Service

If you run Chef Client as a service, things get a tiny bit more complicated. When the new installer runs, the service is removed. This isn't a big deal if you've got the chef-client cookbook set to configure the Windows service. If that is the case, define post_install_action exec and the Chef-run triggered after the upgrade will take care of installing the service.

Upgrading from Chef 11

Moving from Chef 11 has a few challenges when we are dealing with public update sources. Chef 11 ships with a very old cacert.pem. To work through this, we need to get a more current cacert.pem file and point OpenSSL to it. Unfortunately, for this to work consistently on Windows, we'll need to reboot. Chef 11 does not have the reboot resource, so this isn't a graceful process. However, on the next Chef run after the reboot, things will be back on track and the upgrade will perform as on other platforms.

Below is an example of a recipe that can set up Chef 11 to work using public update sources.

if platform_family?('windows') && (Chef::VERSION < '12')
  new_cert_file = File.join(ENV['USERPROFILE'], 'cacert.pem')

  remote_file new_cert_file do
    source 'https://curl.haxx.se/ca/cacert.pem'
    action :create
  end

  powershell_script 'restart' do
    code <<-EOH
    restart-computer -force
    EOH
    action :nothing
  end

  env 'SSL_CERT_FILE' do
    value new_cert_file
    notifies :run, 'powershell_script[restart]', :immediately
  end
end

chef_client_updater 'Install latest Chef' do
  post_install_action 'kill'
end

Resources

chef_client_updater

Installs the mixlib-install/mixlib-install gems and upgrades the chef-client.

properties

  • channel - The chef channel you fetch the chef client from. stable contains all officially released chef-client builds where as current contains unreleased builds. Default: stable
  • prevent_downgrade - Don't allow this cookbook to downgrade the chef-client version. Default: false
  • version - The version of the chef-client to install. Default :latest
  • post_install_action - After installing the chef-client what should we do. exec to exec the new client or kill to kill the client and rely on the init system to start up the new version. Default: kill
  • exec_command - The chef-client command. default: $PROGRAM_NAME.split(' ').first. You can also enter a custom post-action command.
  • exec_args - An array of arguments to exec the chef-client with. default: ARGV
  • download_url_override - The direct URL for the chef-client package.
  • checksum - The SHA-256 checksum of the chef-client package from the direct URL.
  • install_timeout - The install timeout for non-windows systems. The default is 600, slow machines may need to extend this.
  • upgrade_delay - The delay in seconds before the scheduled task to upgrade chef-client runs on windows. default: 61. Lowering this limit is not recommended.
  • product_name - The name of the product to upgrade. This can be chef or chefdk default: chef
  • rubygems_url - The location to source rubygems. Replaces the default https://www.rubygems.org.
  • handle_zip_download_url - Url to the Handle zip archive used by Windows. Used to override the default in airgapped environments. default: https://download.sysinternals.com/files/Handle.zip

examples

chef_client_updater 'Install latest'
chef_client_updater 'Install latest Chef 13.x' do
  version '13'
end
chef_client_updater 'Install 12.13.36 and kill' do
  version '12.13.36'
  post_install_action 'kill'
end

Test Kitchen Testing

In order to test this cookbook it will be necessary to change the post_install_action to exec from kill. While kill is better in most actual production use cases as it terminates the chef-client run along with cleaning up the parent process, the use of kill under test kitchen will fail the chef-client run and fail the test-kitchen run. The use of exec allows test-kitchen to complete and then re-runs the recipe to validate that the cookbook does not attempt to re-update the chef-client and will succeed with the new chef-client. This, however, means that it is not possible to exactly test the config which will be running in production. The best practice advice for this cookbook will be to ignore common best practices and not worry about that. If you change your production config to use exec in order to run what you test in test-kitchen, then you will find sharp edge cases where your production upgrades will hang and/or fail, which testing will not replicate. In order to test you should most likely test upgrades on your full-scale integration environment (not under test-kitchen) before rolling out to production and not use test-kitchen at all. If you think that there's a rule that you must test absolutely everything you run under test-kitchen, you should probably read this or this.

In order to test that your recipes work under the new chef-client codebase, you should simply test your cookbooks against the new version of chef-client that you wish to deploy in "isolation" from the upgrade process. If your recipes all work on the old client, and all work on the new client, and the upgrader works, then the sum of the parts should work as well (and again, if you really deeply care about the edge conditions where that might not work -- then test on real production-like images and not with test-kitchen).

Use of 'exec' in production

This is highly discouraged since the exec will not clean up the supervising process. You're very likely to see it upgrade successfully and then see the old chef-client process continue to run and fork off copies of the old chef-client to run again. Or for the upgrade process to hang, or for other issues to occur causing failed upgrades.

You can use 'exec' in production if you are running from cron or some other process manager and firing off single-shot --no-fork chef-client processes without using the --interval option. This will have the advantage that the new chef-client kicks off immediately after the upgrade giving fast feedback on any failures under the new chef-client. The utility of this approach is most likely is not enough to justify the hassle.

A note about purpose

While this cookbook supports running on Chef versions back to 11/12, the supported behavior of the cookbook is to upgrade those versions to 13/14 or newer. It is not intended that users would maintain old Chef-11/12 versions with this cookbook. The latest released version of Chef 12 (12.22.1 or later) is still be supported as a target. Older versions of omnibus chef will have their embedded rubygems force upgraded by this cookbook to avoid having to regression test against 5+ years of rubygems bugs and establish a stable basis for the cookbook to use.

Maintainers

This cookbook is maintained by Chef's Community Cookbook Engineering team. Our goal is to improve cookbook quality and to aid the community in contributing to cookbooks. To learn more about our team, process, and design goals see our team documentation. To learn more about contributing to cookbooks like this see our contributing documentation, or if you have general questions about this cookbook come chat with us in #cookbok-engineering on the Chef Community Slack

License

Copyright:: 2016-2018, Chef Software, Inc

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

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

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.