Release Notes: Chef Development Kit 0.19 - 4.0

[edit on GitHub]

Chef Development Kit is released on a monthly schedule with new releases the third Monday of every month. Below are the major changes for each release. For a detailed list of changes, see the ChefDK Changelog on GitHub

What’s New in 4.0

  • Breaking Changes

    • Chef EULA

      Usage of ChefDK 4.0, Chef Infra Client 15, and InSpec 4 requires accepting the Chef EULA. See the frequently asked questions for information about the license update and the associated business model change.

    • Chef Provisioning

      Chef Provisioning is no longer included with Chef DK, and will be officially end of life on August 31, 2019. The source code of Chef Provisioning and the drivers have been moved into the chef-boneyard GitHub organization and will not be further maintained. Current users of Chef Provisioning should contact your Chef Customer Success Manager or Account Representative to review your options.

    • ** knife bootstrap against cloud providers**

      knife bootstrap was rewritten in Chef Infra Client 15. The knife-* cloud providers need to be updated to use this new API. As of ChefDK 4.0, knife bootstrap functionality against the cloud providers will be broken. We will fix this ASAP in a ChefDK 4.1 release. The only gem not affected is the knife-windows gem. It has already been re-written to leverage the new bootstrap library.

      Affected gems:

      • knife-ec2
      • knife-google
      • knife-vsphere

      If you leverage this functionality, please wait to update ChefDK until 4.1 is released with fixes for these gems.

  • Improved Chef Generate command

    The chef generate command has been updated to produce cookbooks and repositories that match Chef’s best practices.

    • chef generate repo now generates a Chef repository with Policyfiles by default. You can revert to the previous roles / environment behavior with the --roles flag.
    • chef generate cookbook now generates a cookbook with a Policyfile and no Berksfile by default. You can revert to the previous behavior with the --berks flag.
    • chef generate cookbook now includes ChefSpecs that utilize the ChefSpec 7.3+ format. This is a much simpler syntax that requires less updating of specs as older platforms are deprecated.
    • chef generate cookbook no longer creates cookboook files with the unnecessary frozen_string_literal: true comments.
    • chef generate cookbook no longer generates a full Workflow (Delivery) build cookbook by default. A new --workflow flag has been added to allow generating the build cookbook. This flag replaces the previously unused --delivery flag.
    • chef generate cookbook now generates cookbooks with metadata requiring Chef 14 or later.
    • chef generate cookbook --kitchen dokken now generates a fully working kitchen-dokken config.
    • chef generate cookbook now generates Test Kitchen configs with the product_name/product_version method of specifying Chef Infra Client releases as require_chef_omnibus will be removed in the next major Test Kitchen release.
    • chef generate cookbook_file no longer places the specified file in a “default” folder as these aren’t needed in Chef Infra Client 12 and later.
    • chef generate repo no longer outputs the full Chef Infra Client run information while generating the repository. Similar to the cookbook command you can view this verbose output with the --verbose flag.
  • Chef InSpec 4

    Chef InSpec has been updated to 4.3.2 which includes the new InSpec AWS resource pack with 59 new AWS resources, multi-region support, and named credentials support. This release also includes support for auditing systems that use ed25519 SSH keys.

  • Chef Infra Client 15

    Chef Infra Client has been updated to Chef 15 with 8 new resources, target mode prototype functionality, ed25519 SSH key support, and more. See the Chef Infra Client 15 Release Notes for more details.

  • Fauxhai 7.3

    Fauxhai has been updated from 6.11 to 7.3. This removes all platforms that were previously marked as deprecated. So if you’ve noticed deprecation warnings during your ChefSpec tests, you will need to update those specs for the latest supported Faxhai platforms. This release also adds the following new platform releases for testing in ChefSpec:

    • RHEL 6.10 and 8.0
    • openSUSE 15.0
    • CentOS 6.10
    • Debian 9.8 / 9.9
    • Oracle Linux 6.10, 7.5, and 7.6
  • Test Kitchen 2.2

    Test Kitchen has been updated from 1.24 to 2.2.5. This update adds support for accepting the Chef Infra Client and Chef InSpec EULAs during testing, as well as support for newer ed25519 format SSH keys on guests. The newer release does remove support for the legacy Librarian depsolver and testing of Chef Infra Client 10/11 releases in some scenarios. See the Test Kitchen Release Notes for additional details on this release.

  • Kitchen-ec2 3.0

    Kitchen-ec2 has been updated to 3.0, which uses the newer aws-sdk-v3 and includes a large number of improvements to the driver including improved hostname detection, backoff retries, additional security group configuration options, and more. See the kitchen-ec2 Changelog for additional details.

  • kitchen-dokken 2.6.9

    Kitchen-dokken has been updated to 2.6.9 with a new config option pull_platform_image, which allows you to disable pulling the platform Docker image on every Test Kitchen converge / test. This is particularly useful for local platform image testing.

    kitchen.yml example:

    driver:
      name: dokken
      pull_platform_image: false
    

What’s New in 3.11

  • Chef Infra Client 14.13.11

    Chef Infra Client has been updated to 14.13.11 with resource improvements and bug fixes. See the Release Notes for a detailed list of changes.

  • Test Kitchen 1.25

    Test Kitchen has been updated to 1.25 with backports of many non-breaking Test Kitchen 2.0 features:

    • Support for accepting the Chef 15 license in Test Kitchen runs. See Accepting the Chef License for usage details.
    • A new --fail-fast command line flag for use with the concurrency flag. With this flag set, Test Kitchen will immediately fail when any converge fails instead of continuing to test additional instances.
    • The policyfile_path config option now accepts relative paths.
    • A new berksfile_path config option allows specifying Berkshelf files in non-standard locations.
    • Retries are now honored when using SSH proxies
  • kitchen-dokken 2.7.0

    • The Chef Docker image is now pulled by default so that locally cached latest or current container versions will be compared to those available on DockerHub. See the readme for instructions on reverting to the previous behavior.
    • User namespace mode can be disabled when running privileged containers with a new userns_host config option. See the readme for details.
    • You can now disable pulling the platform Docker images for local platform image testing or air gapped testing. See the readme for details.
  • Other Updated Components

    • openssl 1.0.2r -> 1.0.2s (bugfix only release)
    • cacerts 2019-01-23 -> 2019-05-15
  • Security Updates

    • curl 7.65.0
      • CVE-2019-5435: Integer overflows in curl_url_set
      • CVE-2019-5436: tftp: use the current blksize for recvfrom()
      • CVE-2018-16890: NTLM type-2 out-of-bounds buffer read
      • CVE-2019-3822: NTLMv2 type-3 header stack buffer overflow
      • CVE-2019-3823: SMTP end-of-response out-of-bounds read

What’s New in 3.10

  • New Policy File Functionality

    include_policy now supports :remote policy files. This new functionality allows you to include policy files over http. Remote policy files require remote cookbooks and install will fail otherwise if the included policy file includes cookbooks with paths. Thanks mattray!

  • Other updates

    • kitchen-vagrant: 1.5.1 -> 1.5.2
    • mixlib-install: 3.11.12 -> 3.11.18
    • ohai: 14.8.11 -> 14.8.12

What’s New in 3.9

  • Chef 14.12.3

    ChefDK now ships with Chef 14.12.3. See Chef 14.12 release notes for more information on what’s new.

  • InSpec 3.9.0

    ChefDK now ships with InSpec 3.9.0. See InSpec 3.9.0 release details for more information on what’s new.

  • Ruby 2.5.5

    Ruby has been updated from 2.5.3 to 2.5.5, which includes a large number of bug fixes.

  • kitchen-hyperv

    kitchen-hyperv has been updated to 0.5.3, which now automatically disables snapshots on the VMs and properly waits for the IP to be set.

  • kitchen-vagrant

    kitchen-vagrant has been updated to 1.5.1, which adds support for using the new bento/amazonlinux-2 box when setting the platform to amazonlinux-2.

  • kitchen-ec2

    kitchen-ec2 has been updated to 2.5.0 with support for Amazon Linux 2.0 image searching using the platform ‘amazon2’. This release also adds supports Windows Server 1709 and 1803 image searching.

  • knife-vsphere

    knife-vsphere has been updated to 2.1.3, which adds support for knife’s bootstrap_template flag and removes the legacy distro and template_file flags.

  • Push Jobs Client

    Push Jobs Client has been updated to 2.5.6, which includes significant optimizations and minor bug fixes.

  • Security Updates

    • Rubygems 2.7.9

      Rubygems has been updated from 2.7.8 to 2.7.9 to resolves the following CVEs:

      • CVE-2019-8320: Delete directory using symlink when decompressing tar
      • CVE-2019-8321: Escape sequence injection vulnerability in verbose
      • CVE-2019-8322: Escape sequence injection vulnerability in gem owner
      • CVE-2019-8323: Escape sequence injection vulnerability in API response handling
      • CVE-2019-8324: Installing a malicious gem may lead to arbitrary code execution
      • CVE-2019-8325: Escape sequence injection vulnerability in errors

What’s New in 3.8

  • Updated Tooling

    • InSpec 3.6.6

      ChefDK now ships with Inspec 3.6.6. See https://github.com/inspec/inspec/releases/tag/v3.6.6 for more information on what’s new.

    • Fauxhai 6.11.0

      • Added Windows 2019 Server, Red Hat Linux 7.6, Debian 9.6, and CentOS 7.6.1804.
      • Updated Windows7, 8.1, and 10, 2008 R2, 2012, 2012 R2, and 2016 to Chef 14.10.
      • Updated Oracle Linux 6.8/7.2/7.3/7.4 to Ohai 14.8 in EC2.
      • Updated the fetcher logic to be compatible with ChefSpec 7.3+. Thanks oscar123mendoza!
      • Removed duplicate json data in gentoo 4.9.6.
  • Other updates

    • kitchen-digitalocean: 0.10.1 -> 0.10.2
    • mixlib-install: 3.11.5 -> 3.11.11

What’s New in 3.7

  • Chef 14.10.9

    ChefDK now ships with Chef 14.10.9. See Chef 14.10 release notes for more information on what’s new.

  • Updated Tooling

    • InSpec 3.4.1

      • New aws_billing_report / aws_billing_reports resources
      • Many under the hood improvements
    • kitchen-inspec 1.0.1

      • Support for bastion configuration in transport options.
    • kitchen-vagrant 1.4.0

      • This fixes audio for VirtualBox users by disabling audio in VirtualBox by default to prevent interrupting host Bluetooth audio.
    • kitchen-azurerm 0.14.8

      • Support Azure Managed Identities and apply vm_tags to all resources in resource group.
  • Updated Components

    • bundler: 1.16.1 -> 1.17.3
    • chef-apply: 0.2.4 -> 0.2.7
    • kitchen-tidy: 1.2.0 -> 2.0.0
    • rubygems: 2.7.6 -> 2.7.8
  • Deprecations

    Chef Provisioning has been in maintenance mode since 2015 and due to the age of its dependencies it cannot be included in ChefDK 4 which is scheduled for an April 2019 release.

What’s New in 3.6

  • Chef 14.8.12

    ChefDK now ships with Chef 14.8.12. See Chef 14.8 release notes for more information on what’s new.

  • Security Updates

    • OpenSSL updated to 1.0.2q

      • Microarchitecture timing vulnerability in ECC scalar multiplication CVE-2018-5407
      • Timing vulnerability in DSA signature generation CVE-2018-0734
  • New Chef Command Functionality

    New option: chef generate cookbook –kitchen (dokken|vagrant) Generate cookbooks with a specific kitchen configuration (defaults to vagrant).

  • Updated Tooling

    • InSpec 3.2.6

      • Added new aws_sqs_queue resource. Thanks amitsaha
      • Exposed additional WinRM options for transport, basic auth, and SSPI. Thanks frezbo
      • Improved UI experience throughout including new CLI flags –color/–no-color and –interactive/–no-interactive
    • Berkshelf 7.0.7

      • Added berks outdated –all command to get a list of outdated dependencies, including those that wouldn’t satisfy the version constraints set in Berksfile. Thanks jeroenj
    • Fauxhai 6.10.0

      • Added Fedora 29 Ohai data for use in ChefSpec
    • chef-sugar 5.0

      • Added a new parallels? helper. Thanks ehanlon
      • Added support for the Raspberry Pi 1 and Zero to armhf? helper
      • Added a centos_final? helper. Thanks kareiva
    • Foodcritic 15.1

      • Updated the Chef metadata to Chef versions 13.12 / 14.8 and removed all other Chef metadata
    • kitchen-azurerm 0.14.7

      • Resolved failures in the plugin by updating the azure API gems
    • kitchen-ec2 2.4.0

      • Added support for arm64 architecture instances
      • Support Windows Server 1709 and 1803 image searching. Thanks xtimon
      • Support Amazon Linux 2.0 image searching. Use the platform ‘amazon2’. Thanks pschaumburg
    • knife-ec2 0.19.16

      • Allow passing the –bootstrap-template option during node bootstrapping
    • knife-google 3.3.7

      • Allow running knife google zone list, region list, region quotas, project quotas to run without specifying the gce_zone option
    • stove 7.0.1

      • The yank command has been removed as this command causes large downstream impact to other users and should not be part of the tooling
      • The metadata.rb file will now be included in uploads to match the behavior of berkshelf 7+
    • test-kitchen 1.24

      • Added support for the Chef 13+ root aliases. With this chance you can now test a cookbook with a simple recipe.rb and attributes.rb file.
      • Improve WinRM support with retries and graceful connection cleanup. Thanks bdwyertech and dwoz

What’s New in 3.5

  • Chef 14.7.17

    ChefDK now ships with Chef 14.7.17. See Chef 14.7 release notes for more information on what’s new.

  • Docker image updates

    The chef/chefdk Docker image now includes graphviz (to support berks viz) and rsync (to support kitchen-dokken) which makes it a little bigger, but also a little more useful in development and test pipelines.

What’s New in 3.4

  • Chef 14.6.47

    ChefDK now ships with Chef 14.6.47. See Chef 14.6 release notes for more information on what’s new.

  • Smaller package size

    ChefDK RPM and Debian packages are now compressed. Additionally many gems were updated to remove extraneous files that do not need to be included. The download size of packages has decreased accordingly (all measurements in megabytes):

    • .deb: 108 -> 84 (22%)
    • .rpm: 112 -> 86 (24%)
  • Platform Additions

    macOS 10.14 (Mojave) is now fully tested and packages are available on downloads.chef.io.

  • Updated Tooling

    • Fauxhai 6.9.1

      • Updated mock Ohai run data for use with ChefSpec for multiple platforms
      • Added Linux Mint 19, macOS 10.14, Solaris 5.11 (11.4 release), and SLES 15.
      • Deprecated the following platforms for removal April 2018: Linux Mint 18.2, Gentoo 4.9.6, All versions of ios_xr, All versions of omnios, All versions of nexus, macOS 10.10, and Solaris 5.10.
      • See Fauxhai Supported Platforms for a complete list of supported platform data for use with ChefSpec.
    • Foodcritic 14.3

      • Updated the metadata that ships with Foodcritic to provide the latest Chef 13.11 and 14.5 metadata
      • Removed metadata from older Chef releases. This update also
      • Removed the FC121 rule, which was causing confusion with community cookbook authors. This rule will be added back when Chef 13 goes EOL in April 2019.
    • InSpec 3.0.12

      • Added a new plugin system for inspec and the train transport system
      • Added a new global attributes system
      • Enhanced skip messages
      • Many more enhancements
    • Kitchen AzureRM

      • Added support for the Shared Image Gallery.
    • Kitchen DigitalOcean

      • Added support for FreeBSD 10.4 and 11.2
    • Kitchen EC2

      • Improved Windows system support. The auto-generated security group will now include support for RDP and the log directory will alway be created.
    • Kitchen Google

      • Added support for adding labels to instances with a new labels config that accepts labels as a hash.
    • Knife Windows

      • Improved Windows detection support to identify Windows 2012r2, 2016, and 10.
      • Added support for using the client.d directories when bootstrapping nodes.
    • Security Updates

      • Ruby has been updated to 2.5.3 to resolve the following vulnerabilities: * CVE-2018-16396: Tainted flags are not propagated in Array#pack and String#unpack with some directives * CVE-2018-16395: OpenSSL::X509::Name equality check does not work correctly

What’s New in 3.3

  • Chef 14.5.33

    ChefDK now ships with Chef 14.5.33. See Chef 14.5 release notes for more information on what’s new.

  • New Functionality

    New option: chef update –exclude-deps for policyfiles will only update the cookbook(s) given on the command line.

  • Updated Tooling

    ChefSpec 7.3

    A new simplified ChefSpec syntax now allows testing of custom resources. See the ChefSpec README and especially the section on testing custom resources for examples of the new syntax.

  • Updated Components

    • chef-provisioning-aws: 3.0.4 -> 3.0.6
    • chef-vault: 3.3.0 -> 3.4.2
    • foodcritic: 14.0.0 -> 14.1.0
    • inspec: 2.2.70 -> 2.2.112
    • kitchen-inspec: 0.23.1 -> 0.24.0
    • kitchen-vagrant: 1.3.3 -> 1.3.4
  • Deprecations

    • `chef generate app - Application repos were a pattern that didn’t take off.
    • chef generate lwrp - Use chef generate resource. Every supported release of Chef supports custom resources. Custom resources are awesome. No one should be writing new LWRPs any more. LWRPS are not awesome.

What’s New in 3.2

  • Chef 14.4.56

    ChefDK now ships with Chef 14.4.56. See Chef 14.4 release notes for more information on what’s new.

  • New Functionality

    • New chef describe-cookbook command to display the cookbook checksum.
    • Change policyfile generator to use policyfiles directory instead of policies directory
  • New Tooling

    Kitchen AzureRM

    ChefDK now includes a driver for Azure Resource Manager. This allows Microsoft Azure resources to be provisioned prior to testing. This driver uses the new Microsoft Azure Resource Management REST API via the azure-sdk-for-ruby.

  • Updated Tooling

    Test Kitchen

    Test Kitchen 1.23 now includes support for lifecycle hooks.

  • Updated Components

    • berkshelf: 7.0.4 -> 7.0.6
    • chef-provisioning: 2.7.1 -> 2.7.2
    • chef-provisioning-aws: 3.0.2 -> 3.0.4
    • chef-sugar: 4.0.0 -> 4.1.0
    • fauxhai: 6.4.0 -> 6.6.0
    • inspec: 2.1.72 ->2.2.70
    • kitchen-google: 1.4.0 -> 1.5.0
  • Security Updates

    OpenSSL
    OpenSSL updated to 1.0.2p to resolve:

What’s New in 3.1

  • Chef 14.2.0

    ChefDK now ships with Chef 14.2.0. See Chef 14.2 release notes for more information on what’s new.

  • Habitat Packages

    ChefDK is now released as a habitat package under the identifier chef/chef-dk. All successful builds are available in the unstable channel and all promoted builds are available in the stable channel.

  • Updated Homebrew Cask Tap

    You can install ChefDK on macOS using brew cask install chef/chef/chefdk. The tap name is new, but not the behavior.

  • Updated Tooling

    Fauxhai 6.4

    • Added for 3 new platforms - CentOS 7.5, Debian 8.11, and FreeBSD 11.2.
    • Updated platform data for Amazon Linux, Red Hat, SLES, and Ubuntu to match Chef 14.2 output.
    • Deprecated the FreeBSD 10.3 platform data.

    Foodcritic 14.0

    • Added support for Chef 14.2 metadata
    • Removes older Chef 13 metadata.
    • Updated rules for clarity and removes an unnecessary rule.
    • Added a new rule saying when cookbooks have unnecessary dependencies now that resources moved into core Chef.

    knife-acl

    • knife-acl is now included with ChefDK. This knife plugin allows admin users to modify Chef Server ACLs from their command line.

    knife-tidy

    • knife-tidy is now included with ChefDK. This knife plugin generates reports about stale nodes and helps clean them up.

    Test Kitchen 1.22

    • Added a new ssh_gateway_port config.
    • Fixed a bug on Unix systems where scripts are not created as executable.
  • Other Updated Components and Tools

    • kitchen-digitalocean: 0.9.8 -> 0.10.0
    • knife-opc: 0.3.2 -> 0.4.0
  • Security Updates

    • ffi

      CVE-2018-1000201: DLL loading issue which can be hijacked on Windows OS

What’s New in 3.0

  • Chef 14.1.1

    ChefDK now ships with Chef 14.1.1. See the Chef 14.1 release notes for more information on what’s new.

  • Updated Operating System support

    ChefDK now ships packages for Ubuntu 18.04 and Debian 9. In accordance with Chef’s platform End Of Life policy, ChefDK is no longer shipped on macOS 10.10.

  • Enhanced cookbook archive handling

    ChefDK now uses an embedded copy of libarchive to support Policyfile and Berkshelf. This improves overall performance and provides a well tested interface to different types of archives. It also resolves the long standing “not an octal string” problem users face when depending on certain cookbooks in the supermarket.

  • Policyfiles: updated include_policy support

    Policyfiles now support git targets for included policies.

    include_policy 'base_policy',
                  git: 'https://github.com/happychef/chef-repo.git',
                  branch: master,
                  path: 'policies/base/Policyfile.lock.json'
    
  • Updated Tooling

    • Test Kitchen
      Test Kitchen has been updated from 1.20.0 to 1.21.2. This release allows you to use a kitchen.yml config file instead of .kitchen.yml so the kitchen config will no longer be hidden in your cookbook directories. It also introduces new config options for SSH proxy servers and allows you to specify multiple paths for data bags. See the CHANGELOG for a complete list of changes.
    • InSpec
      InSpec has been updated from 1.51.21 to 2.1.68. InSpec 2.0 brings compliance automation to the cloud, with new resource types specifically built for AWS and Azure clouds. Along with these changes are major speed improvements and quality of life updates. Please visit ` Inspec <https://www.inspec.io>`__ for more information.
    • ChefSpec
      ChefSpec has been updated to 7.2.1 with Fauxhai 6.2.0. This release removes all platforms that were previously marked as deprecated in Fauxhai. If you saw Fauxhai deprecation warnings during your ChefSpec runs you will now see failures. This update also adds 9 new platforms and updates existing data for Chef 14. To see a complete list of platforms that can be mocked in ChefSpec see https://github.com/chefspec/fauxhai/blob/master/PLATFORMS.md.
    • Foodcritic
      Foodcritic has been updated to from 12.3.0 to 13.1.1. This updates Foodcritic for Chef 13 or later by removing Chef 12 metadata and removing several legacy rules that suggested writing resources in a Chef 12 manner. The update also adds 9 new rules for writing custom resources and updating cookbooks to Chef 13 and 14, resolves several long standing file detection bugs, and improves performance.
    • Cookstyle
      Cookstyle has been updated to 3.0, which updates the underlying RuboCop engine to 0.55 with a long list of bug fixes and improvements. This release of Cookstyle also enables 19 new rules available in RuboCop. See the CHANGELOG for a complete list of newly enabled rules.
    • Berkshelf
      Berkshelf has been updated to 7.0.2. Berkshelf 7 moves to using the same libraries as the Chef Client, ensuring consistent behavior - for instance, ensuring that chefignore files work the same - and enabling a quicker turnaround on bug fixes. The “Actor crashed” failures of celluloid will no longer be produced by Berkshelf.
    • VMware vSphere support
      The knife-vsphere plugin for managing VMware vSphere is now bundled with ChefDK.
    • Cookbook generator creates a CHANGELOG.md
      chef cookbook generate [cookbook_name] now creates a CHANGELOG.md file.
  • Updated Components and Tools
    • chef-provisioning 2.7.0 -> 2.7.1
    • knife-ec2 0.17.0 -> 0.18.0
    • opscode-pushy-client 2.3.0 -> 2.4.11
  • Security Updates

What’s New in 2.5.3

  • Rename smoke tests to integration tests

    The cookbook, recipe, and app generators now name the test directory integration instead of smoke. This will not impact existing cookbooks generated with older releases of ChefDK, but it does simplify the .kitchen.yml configuration for all new cookbooks.

  • Chef 13.8.5

    ChefDK now ships with Chef 13.8.5. See the Chef 13.8 release notes for more information.

  • Updated chef_version in cookbook generator

    When running chef generate cookbook the generated cookbook will now specify a minimum Chef release of 12.14 not 12.1.

  • Security Updates

  • Updated Components

    • chefspec 7.1.1 -> 7.1.2
    • chef-api 0.7.1 -> 0.8.0
    • chef-provisioning 2.6.0 -> 2.7.0
    • chef-provisioning-aws 3.0.0 -> 3.0.2
    • chef-sugar 3.6.0 -> 4.0.0
    • foodcritic 12.2.1 -> 12.3.0
    • inspec 1.45.13 -> 1.51.21
    • kitchen-dokken 2.6.5 -> 2.6.7
    • kitchen-ec2 1.3.2 -> 2.2.1
    • kitchen-inspec 0.20.0 -> 0.23.1
    • kitchen-vagrant 1.2.1 -> 1.3.1
    • knife-ec2 0.16.0 -> 0.17.0
    • knife-windows 1.9.0 -> 1.9.1
    • test-kitchen 1.19.2 -> 1.20.0
    • chef-provisioning-azure has been removed as it used deprecated Azure APIs

What’s New in 2.4.17

  • Improved performance downloading cookbooks from a Chef server

    Policyfile users who use a Chef server as a cookbook source will experience faster cookbook downloads when running chef install. Chef server’s API requires each file in a cookbook to be downloaded separately; ChefDK will now download the files in parallel. Additionally, HTTP keepalives are enabled to reduce connection overhead.

  • Cookbook artifact source for policyfiles

    Policyfile users may now source cookbooks from the Chef server’s cookbook artifact store. This is mainly intended to support the upcoming include_policy feature, but could be useful in some situations.

    Given a cookbook that has been uploaded to the Chef server via chef push, it can be used in another policy by adding code like the following to the ruby policyfile:

    cookbook "runit",
      chef_server_artifact: "https://chef.example/organizations/myorg",
      identifier: "09d43fad354b3efcc5b5836fef5137131f60f974"
    
  • Added include_policy directive

    Policyfile can use the include_policy directive as described in RFC097. This directive’s purpose is to allow the inclusion policyfile locks to the current policyfile. In this iteration, we support sourcing lock files from a local path or a Chef server. Below is a simple example of how the include_policy directive can be used:

    Given a policyfile base.rb:

    name 'base'
    
    default_source :supermarket
    
    run_list 'motd'
    
    cookbook 'motd', '~> 0.6.0'
    

    Run:

    >> chef install ./base.rb
    
    Building policy base
    Expanded run list: recipe[motd]
    Caching Cookbooks...
    Using      motd         0.6.4
    Using      chef_handler 3.0.2
    
    Lockfile written to /home/jaym/workspace/chef-dk/base.lock.json
    Policy revision id: 1238e7a353ec07a4df6636cdffd8805220a00789bace96d6d70268a4b0064023
    

    This will produce the base.lock.json file that will be included in our next policy, users.rb:

    name 'users'
    
    default_source :supermarket
    
    run_list 'user'
    
    cookbook 'user', '~> 0.7.0'
    
    include_policy 'base', path: './base.lock.json'
    

    Run:

    >> chef install ./users.rb
    
    Building policy users
    Expanded run list: recipe[motd::default], recipe[user]
    Caching Cookbooks...
    Using      motd         0.6.4
    Installing user         0.7.0
    Using      chef_handler 3.0.2
    
    Lockfile written to /home/jaym/workspace/chef-dk/users.lock.json
    Policy revision id: 20fac68f987152f62a2761e1cfc7f1dc29b598303bfb2d84a115557e2a4a8f27
    

    This will produce a users.lock.json file that has the base policyfile lock merged in.

    More information can be found in RFC097 and the Policyfile documentation.

  • New tools bundled

    We are now shipping these tools as part of ChefDK:

See the detailed change log for additional information.

What’s New in 2.3.4

ChefDK 2.3.4 pins the net-ssh gem to version 4.1 to prevent errors in test-kitchen and kitchen-inspec that would prevent systems from properly converging or verifying. This release is recommended for all users of ChefDK 2.3.

What’s New in 2.3.3

This release restores macOS support in ChefDK 2.3. See the change log for more information.

What’s New in 2.3.1

This release includes Ruby 2.4.2 to fix the following CVEs:

ChefDK 2.3 includes:

  • Chef 13.4.19
  • InSpec 1.36.1
  • Berkshelf 6.3.1
  • Chef Vault 3.3.0
  • Foodcritic 11.4.0
  • Test Kitchen 1.17.0
  • Stove 6.0

Additionally, the cookbook generator now adds a LICENSE file when creating a new cookbook.

See the detailed change log for a complete list of changes.

Note

Due to issues beyond our control, this release is only built for Linux (x86_64) and Windows. We’ll release a new build with macOS support as soon as possible.

What’s New in 2.2.1

This release includes RubyGems 2.6.13 to address the following CVEs:

ChefDK 2.2.1 includes:

  • Chef 13.3.42
  • InSpec 1.35.1
  • Berkshelf 6.3.1
  • Chef Vault 3.3.0
  • Foodcritic 11.3.1
  • Test Kitchen 1.17.0

What’s New in 2.1.11

This release updates the version of git shipped in ChefDK to 2.14.1 to address CVE-2017-1000117.

Notable Updated Gems

  • berkshelf 6.2.0 -> 6.3.0
  • chef-provisioning 2.4.0 -> 2.5.0
  • chef-zero 13.0.0 -> 13.1.0
  • fauxhai 5.2.0 -> 5.3.0
  • fog 1.40 -> 1.41
  • inspec 1.31.1 -> 1.33.1
  • kitchen-dokken 2.5.1 -> 2.6.1
  • kitchen-vagrant 1.1.0 -> 1.2.0
  • knife-push 1.0.2 -> 1.0.3
  • ohai 13.2.0 -> 13.3.0
  • serverspec 2.39.1 -> 2.40.0
  • test-kitchen 1.16 -> 1.17

See the detailed change log for a full list of changes.

What’s New in 2.0.28

Chef 2.0.28 fixes an issue in ChefDK 2.0 where chef push would upload incomplete cookbooks.

What’s New in 2.0

Chef Client 13.2

Chef Client 13 is the most delightful version of Chef Client available. We’ve taken what we’ve learned from many bug reports, forum posts, and conversations with our users, and we’ve made it safer and easier than ever to write great cookbooks. We’ve also included a number of new resources that better support our most popular operating systems, and we’ve made it easier to write patterns that result in reusable, efficient code.

Chef Client 13.2 solves a number of issues that were reported in our initial releases of Chef Client 13, and we regard it as suitable for general use.

PolicyFiles

It’s now possible to update a single cookbook using chef update <cookbook>. Artifactory is now supported as a cookbook source.

Cookbook Generator

Adds chef generate helpers <HELPERS_NAME> to generate a helpers file in libraries.

Berkshelf 6.2.0

Berkshelf adds support for two new sources:

Chef Vault 3.1

Chef Vault 3.1 includes a number of optimizations for large numbers of nodes. In most situations, we’ve seen at least 50% faster creation, update, and refresh operations, and much more efficient memory usage. We’ve also added a new sparse mode, which dramatically reduces the amount of network traffic that occurs as nodes decrypt vaults. A lot of the scalability work has been built and tested by our friends at Criteo.

Chef Vault 3.1 also makes it much easier to use provisioning nodes to manage vaults by using the public_key_read_access group, which is available in Chef server 12.5 and above.

Foodcritic 11

Foodcritic 11 covers many of the patterns that were removed in Chef Client 13, so you’ll get up-front notification that your cookbooks will no longer work with this release. In general, the patterns that were removed enabled dangerous ways of writing cookbooks. Ensuring that you’re compliant with Foodcritic 11 means your cookbooks are safer with every version of Chef.

The release of Foodcritic 11 also marks the creation of the Foodcritic org on GitHub, which makes it easier to get involved in writing rules and contributing code. We are excited to start building more of a community around Foodcritic, and can’t wait to see what the community cooks up.

InSpec 1.30

Since the last release of ChefDK, InSpec has been independently released multiple times with a number of great enhancements, including some new resources (rabbitmq_config, docker, docker_image, docker_container, oracledb_session), some enhancements to the Habitat package creator for InSpec profiles, and a whole slew of bug fixes and documentation updates.

ChefSpec 7.1.0

It’s no longer necessary to create custom matchers; ChefSpec will automatically create matchers for any resources in the cookbooks under test.

Cookstyle 2.0

Cookstyle 2.0 is based on Rubocop 0.49.1, which changed a large number of rule names.

What’s New in 1.6.11

This release contains only dependency updates, including several security fixes:

What’s New in 1.5

Chef Client 12.21

Chef has been updated to the 12.21 release, fixing a number of bugs:

  • Debian-based systems will now correctly prefer Systemd to Upstart
  • Better handling of the supports pseudo-property
  • Fixes crashes that occurred when downgrading from Chef 13 to Chef 12
  • Provides better system information when Chef crashes

See the full release notes for more details.

Chef Client 12.21 also contains a new version of zlib, fixing 4 CVEs:

Notable Updated Gems

  • cookstyle 1.3.1 -> 1.4.0

What’s New in 1.4

InSpec 1.25.1

  • Consistent hashing for InSpec profiles
  • Add platform info to json formatter
  • Allow mysql_session to test databases on different hosts
  • Add an oracledb_session resource
  • Support new Chef Automate compliance backend
  • Add command-line completions for fish shell

Cookstyle 1.3.1

  • Disabled Style/DoubleNegation rule, which can be necessary in not_if / only_if blocks

What’s New in 1.3

Chef Client 12.19

ChefDK now ships with Chef 12.19. Check out Release Notes for all the details of this new release.

Workflow Build Cookbooks

Build cookbooks generated via chef generate build-cookbook will no longer depend on the delivery_build or delivery-base cookbook. Instead, the Test Kitchen instance will use ChefDK as the standard workflow runner setup.

The build cookbook generator will not overwrite your config.json or project.toml if they exist already on your project.

ChefSpec 6.0

ChefDK includes the new ChefSpec 6.0 release with improvements to the ServerRunner behavior. Rather than creating a Chef Zero instance for each ServerRunner test context, a single Chef Zero instance is created that all ServerRunner test contexts will leverage. The Chef Zero instance is reset between each test case, emulating the existing behavior without needing a monotonically increasing number of Chef Zero instances.

Additionally, if you are using ChefSpec to test a pre-defined set of Cookbooks, there is now an option to upload those cookbooks only once, rather than before every test case. To take advantage of this performance enhancer, simply set the server_runner_clear_cookbooks RSpec configuration value to false in your spec_helper.rb.

RSpec.configure do |config|
  config.server_runner_clear_cookbooks = false
end

Setting server_runner_clear_cookbooks value to false has been shown to increase the ServerRunner performance by 75%, improve stability on Windows, and make the ServerRunner as fast as SoloRunner.

This new release also includes three new matchers: dnf_package, msu_package, and cab_package and utilizes the new Fauxhai 4.0 release. This release adds several new platforms and removes many older end-of-life platforms. See PLATFORMS.md for a list of all supported platforms for use in ChefSpec.

InSpec

InSpec has been updated to 1.19.1 with the following new functionality:

  • Better filter support for the processes resource.
  • New packages, crontab, x509_certificate, and x509_private_key resources
  • New inspec habitat profile create command to create a Habitat artifact for a given InSpec profile.
  • Functional JUnit reporting
  • A new command for generating profiles has been added

Foodcritic

Foodcritic has been updated to 10.2.2. This release includes the following new functionality

  • FC003, which required gating certain code when running on Chef Solo has been removed
  • FC023, which preferred conditional (only_if / not_if) code within resources has been removed as many disagreed with this coding style
  • False positives in FC007 and FC016 have been resolved
  • New rules have been added requiring the license (FC068), supports (FC067), and chef_version (FC066) metadata properties in cookbooks

Kitchen EC2 Driver

Kitchen-ec2 has been updated to 1.3.2 with support for Windows 2016 instances

Cookbook generator improvements

chef generate cookbook has been updated to better generate cookbooks for sharing with the Chef community. Generated cookbooks now require Chef client 12.1+, include the chef_version metadata, and use SPDX standard license strings.

Notable Updated Gems

  • berkshelf 5.6.0 -> 5.6.4
  • chef-provisioning 2.1.0 -> 2.2.1
  • chef-provisioning-aws 2.1.0 -> 2.2.0
  • chef-zero 5.2.0 -> 5.3.1
  • chef 12.18.31 -> 12.19.36
  • cheffish 4.1.0 -> 5.0.1
  • chefspec 5.3.0 -> 6.2.0
  • cookstyle 1.2.0 -> 1.3.0
  • fauxhai 3.10.0 -> 4.1.0
  • foodcritic 9.0.0 -> 10.2.2
  • inspec 1.11.0 -> 1.19.1
  • kitchen-dokken 1.1.0 -> 2.1.2
  • kitchen-ec2 1.2.0 -> 1.3.2
  • kitchen-vagrant 1.0.0 -> 1.0.2
  • mixlib-install 2.1.11 -> 2.1.12
  • opscode-pushy-client 2.1.2 -> 2.2.0
  • specinfra 2.66.7 -> 2.67.7
  • test-kitchen 1.15.0 -> 1.16.0
  • train 0.22.1 -> 0.23.0

What’s New in 1.2

Delivery CLI

  • The project.toml file, which can be used to execute local phases, now supports:
    • An optional functional phase.
    • New remote_file option to specify a remote project.toml.
    • The ability to run stages (collection of phases).
  • Fixed bug where the generated project.toml file did not include the prefix chef exec for some phases.
  • Project git remotes will now update automatically, if applicable, based on the values in the cli.toml or options provided through the command-line.
  • Project names specified in project config (cli.toml) or options provided through the command-line will now be honored.

Policyfiles

  • Added a chef_server default source option to Policyfiles.

Automate Workflow Adopts SSH for Cookbook Generation

The chef generate cookbook command now uses the SSH based job dispatch system as its default behavior. For more details on this new system and how to use it, see Job Dispatch Docs

FIPS (Windows and RHEL only)

  • ChefDK now comes bundled with the Stunnel tool and the FIPS OpenSSL module for users who need to enforce FIPS compliance.
  • Support for FIPS options in delivery CLI’s cli.toml was added to handle communication with the Automate Server when FIPS mode is enabled.

Notable Updated Gems

  • berkshelf 5.2.0 -> 5.5.0
  • chef 12.17.44 -> 12.18.31
  • chef-provisioning 2.0.2 -> 2.1.0
  • chef-vault 2.9.0 -> 2.9.1
  • chef-zero 5.1.0 -> 5.2.0
  • cheffish 4.0.0 -> 4.1.0
  • cookstyle 1.1.0 -> 1.2.0
  • foodcritic 8.1.0 -> 8.2.0
  • inspec 1.7.2 -> 1.10.0
  • kitchen-dokken 1.0.9 -> 1.1.0
  • kitchen-vagrant 0.21.1 -> 1.0.0
  • knife-windows 1.7.1 -> 1.8.0
  • mixlib-install 2.1.9 -> 2.1.10
  • ohai 8.22.1 -> 8.23.0
  • test-kitchen 1.14.2 -> 1.15.0
  • train 0.22.0 -> 0.22.1
  • winrm 2.1.0 -> 2.1.2

What’s New in 1.1

New InSpec Test Location

To address bugs and confusion with the previous test/recipes location, all newly generated cookbooks and recipes will place their InSpec tests in test/smoke/default. This placement creates the association of the smoke phase in Chef Automate and the default Test Kitchen suite where the tests are run.

Default Docker image in kitchen-dokken is now official Chef image

chef/chef is now the default Docker image used in kitchen-dokken.

New Test Kitchen driver caching mechanisms

Test Kitchen will automatically cache downloaded chef-client packages for use between provisions. For people who use the kitchen-vagrant driver to run Chef, it will automatically consume the new caching mechanism to share the client packages to the guest VM, meaning that you no longer have to wait for the client to download on every guest provision.

In addition, if the chef-client packages are already cached, then it is now possible to use Test Kitchen completely off-line.

Cookstyle 1.1.0 with new code linting Cops

Cookstyle has been updated from 0.0.1 to 1.1.0, which upgrades the RuboCop engine from 0.39 to 0.46, and enables several new cops. This will most likely result in Cookstyle warnings on cookbooks that previously passed.

Newly Disabled Cops:

  • Metrics/CyclomaticComplexity
  • Style/NumericLiterals
  • Style/RegexpLiteral in ‘tests’ directory
  • Style/AsciiComments
  • Style/TernaryParentheses
  • Metrics/ClassLength
  • All rails/* cops

Newly Enabled Cops:

  • Bundler/DuplicatedGem
  • Style/SpaceInsideArrayPercentLiteral
  • Style/NumericPredicate
  • Style/EmptyCaseCondition
  • Style/EachForSimpleLoop
  • Style/PreferredHashMethods
  • Lint/UnifiedInteger
  • Lint/PercentSymbolArray
  • Lint/PercentStringArray
  • Lint/EmptyWhen
  • Lint/EmptyExpression
  • Lint/DuplicateCaseCondition
  • Style/TrailingCommaInLiteral
  • Lint/ShadowedException

New DCO tool included

We have included a new DCO command-line tool that makes it easier to contribute to projects like Chef that use the Developer Certificate of Origin. The tool allows you to enable/disable DCO sign-offs for each repository and also allows you to retroactively sign off all commits on a branch. See https://github.com/coderanger/dco for details.

Notable Upgraded Gems

  • chef 12.16.42 -> 12.17.44
  • ohai 8.21.0 -> 8.22.0
  • inspec 1.4.1 -> 1.7.2
  • train 0.21.1 -> 0.22.0
  • test-kitchen 1.13.2 -> 1.14.2
  • kitchen-vagrant 0.20.0 -> 0.21.1
  • winrm-elevated 1.0.1 -> 1.1.0
  • winrm-fs 1.0.0 -> 1.0.1
  • cookstyle 0.0.1 -> 1.1.0

What’s New in 1.0

Version 1.0!

We’re recognizing ChefDK’s continued stability with the honor of a 1.0 tag. There is nothing in this release that breaks backwards compatibility with previous installations of ChefDK: it is simply a formal recognition of the stability of the product.

Foodcritic

  • Foodcritic constraint updated to require v8.0 or greater.
  • Supermarket Foodcritic rules are now disabled by default when you run chef generate cookbook.

InSpec

The inspec command is now included in the PATH managed by ChefDK. Just run chef shell-init to update your PATH.

knife-opc

Knife OPC is now bundled with ChefDK adding chef server organization and user commands to knife

Notable Upgraded Gems

  • chef 12.15.19 -> 12.16.42
  • inspec 1.2.0 -> 1.4.1
  • train 0.20.1 -> 0.21.1
  • kitchen-dokken 1.0.3 -> 1.0.4
  • kitchen-inspec 0.15.2 -> 0.16.1
  • berkshelf 5.1.0 -> 5.2.0
  • fauxhai 3.9.0 -> 3.10.0
  • foodcritic 7.1.0 -> 8.1.0

What’s New in 0.19

InSpec 1.2.0

InSpec Updated to v1.2.0. See the InSpec CHANGELOG for details.

Mixlib::Install

New mixlib-install command allows you to quickly download Chef binaries. Run mixlib-install help for command usage.

Delivery CLI

  • Deprecation of GitHub V1 backed project initialization.
  • Initialization of GitHub V2 backed projects (delivery init --github). Requires Chef Automate server version 0.5.432 or above.
  • Project name verification with repository name for projects with Source Control Management (SCM) integration.
  • Increased clarity of the command structure by introducing the --pipeline alias for the --for option.
  • Honor custom config on project initialization (delivery init -c /my/config.json).
  • Build cookbook is now generated using the more appropriate chef generate build-cookbook on project initialization.
  • Support providing your password non-interactively to delivery token via the AUTOMATE_PASSWORD environment variable (AUTOMATE_PASSWORD=password delivery token).

Notable Upgraded Gems

  • chef 12.14.89 -> 12.15.19
  • inspec 1.0.0 -> 1.2.0
  • kitchen-dokken 1.0.0 -> 1.0.3
  • knife-windows 1.6.0 -> 1.7.0
  • mixlib-install 2.0.1 -> 2.1.1
  • winrm 2.0.3 -> 2.1.0