This repository has been archived by the owner. It is now read-only.
DEPRECATED: Chef cookbook to update the omnibus packaged Chef client
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.delivery
attributes
libraries
recipes
spec
tasks
test
.gitignore
.kitchen.yml
.rubocop.yml
.travis.yml
Berksfile
CHANGELOG.md
CONTRIBUTING.md
Gemfile
LICENSE
MAINTAINERS.md
MAINTAINERS.toml
README.md
TESTING.md
chefignore
metadata.rb

README.md

omnibus_updater cookbook

Build Status Cookbook Version

This cookbook allows you to upgrade the omnibus based Chef install package via Chef. You can run either latest or pin to specific version.

Deprecation notice

Going forward we're focusing Chef Client updater work on the new chef_client_updater cookbook. This cookbook is a complete rewrite utilizing Chef's mixlib-install and mixlib-version gems to better update the Chef Client. The new cookbook features both a simple recipe for upgrading the client and a custom resource for more advanced usage in wrapper cookbooks. It does require Chef Client 12.1+ so you'll need to have your clients updated to to this release first, but once there we believe you'll have a far superior experience.

https://github.com/chef-cookbooks/chef_client_updater

Requirements

Platforms

  • Debian / Ubuntu
  • Mac OS X
  • RHEL (redhat, centos, amazon, scientific, oracle)
  • Solaris
  • SLES / openSUSE
  • Windows
  • AIX

Chef

  • Chef 11+

Cookbooks

  • none

Usage

Add the recipe to your run list and specify what version should be installed on the node:

knife node run_list add recipe[omnibus_updater]

In your role you'll likely want to set the version. It defaults to nothing, and will install the latest..

override_attributes(
  :omnibus_updater => {
    :version => '11.4.0'
  }
)

Features

Latest Version

Force installation of the latest version regardless of value stored in version attribute by setting the force_latest attribute.

Chef Killing

By default the omnibus updater will kill the chef instance by raising an exception. You can turn this off using the kill_chef_on_upgrade attribute. It is not recommended to turn this off. Internal chef libraries may change, move, or no longer exist. The currently running instance can encounter unexpected states because of this. To prevent this, the updater will attempt to kill the Chef instance so that it can be restarted in a normal state.

When kill_chef_on_upgrade is true Test-kitchen's converge stage will fail. To avoid this and attempt a second converge after the initial converge aborts, you can configure .kitchen.yml to retry a converge given a specific exit code from node['omnibus_updater']['kill_chef_on_upgrade_exit_code']. The second converge should pick up the new chef-client version and exit without error. The following is how to accomplish this:

provisioner:
  retry_on_exit_code:
    - 213
  max_retries: 1
  wait_for_retry: 1
  client_rb:
    exit_status: :enabled
    client_fork: false

Exit code 213 is a special designation for Chef Client Upgrade and only exists in Chef Client >= 12.15.19. If using an older client, you can replace exit code 213 (Chef upgrade) with 3 (SIGTERM recvd) as a workaround. Exit codes are documented here: https://github.com/chef/chef-rfc/blob/master/rfc062-exit-status.md

Restart chef-client Service

Use the restart_chef_service attribute to restart chef-client if you have it running as a service.

Prerelease

Prereleases can be installed via the auto-installation using prerelease attribute.

Disable

If you want to disable the updater you can set the disabled attribute to true. This might be useful if the cookbook is added to a role but should then be skipped for example on a Chef server.

Prevent Downgrade

If you want to prevent the updater from downgrading chef on a node, you can set the prevent_downgrade attribute to true. This can be useful for testing new versions manually. Note that the always_download attribute takes precedence if set.

License & Authors

Copyright:: 2010-2016, 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.