Adoptable Cookbooks List

Looking for a cookbook to adopt? You can now see a list of cookbooks available for adoption!
List of Adoptable Cookbooks

Supermarket Belongs to the Community

Supermarket belongs to the community. While Chef has the responsibility to keep it running and be stewards of its functionality, what it does and how it works is driven by the community. The chef/supermarket repository will continue to be where development of the Supermarket application takes place. Come be part of shaping the direction of Supermarket by opening issues and pull requests or by joining us on the Chef Mailing List.

Select Badges

Select Supported Platforms

Select Status

The push-jobs cookbook has been deprecated

Author provided reason for deprecation:

The push-jobs cookbook has been deprecated and is no longer being maintained by its authors. Use of the push-jobs cookbook is no longer recommended.


push-jobs (33) Versions 2.6.3

Installs the Chef Push Jobs Client

cookbook 'push-jobs', '= 2.6.3', :supermarket
cookbook 'push-jobs', '= 2.6.3'
knife supermarket install push-jobs
knife supermarket download push-jobs
Quality 100%

push-jobs cookbook

Build Status
Cookbook Version

Installs the Chef Push client package and sets it up to run as a service.

The official documentation is on


Requires Chef Server with the Chef Push Server add-on.


  • Debian/Ubuntu
  • Windows

Tested on Ubuntu 10.04, 12.04, CentOS 6.4, and Windows 2008 R2. It may work on other debian, rhel, or windows platform families with or without modification.

Testing for Ubuntu/CentOS can be done with Test Kitchen, see in this repository.


  • Chef 11.4+


Install the Workstation

To set up the Chef push jobs workstation, install the knife push plugin. The simplest way to install the plugin is by entering the following command at a shell prompt:

chef gem install knife-push  

Alternatives to chef gem install be found at Once installed, the following subcommands will be available:
* knife job list
* knife job start
* knife job status.


Include the default recipe in a node's run list. On Windows, the URL to the package to install and its SHA256 checksum are required so the package may be retrieved. For example:

node.default['push_jobs']['package_url'] = ""
node.default['push_jobs']['package_checksum'] = "a-sha256-checksum"

Set a whitelist of job names and their commands in the configuration file. This is automatically generated from the node['push_jobs']['whitelist'] attribute Hash, such as:

node.default['push_jobs']['whitelist'] = {
  "chef-client" => "chef-client",
  "apt-get-update" => "apt-get update"

As this is an attribute, interesting uses arise from orchestrating a
Chef Client run. Assuming the above is present on the node prior to
running the recipe, run Chef Client with this command from the local

knife job start chef-client A_NODE_NAME

New jobs can be added to the whitelist simply by creating attributes.
This can be done with knife exec:

knife exec -E 'nodes.transform("name:A_NODE_NAME") do |n|
  n.set["push_jobs"]["whitelist"]["ntpdate"] = "ntpdate -u time"

Then, run the chef-client job, and then the ntpdate job:

knife job start chef-client A_NODE_NAME
knife job start ntpdate A_NODE_NAME

In a future release, an LWRP may be added to automatically add push


Attributes are documented in metadata.rb. See attributes/default.rb
for default values.


There are several recipes in this cookbook, so they can be used all
together (include the default recipe), or as necessary.


The default recipe includes the appropriate recipe based on the node's
platform_family. It will raise an error if:

  • The package URL and checksum attributes are not set on Windows
  • The whitelist is not a Hash.
  • The node's platform is not supported.


This recipe ensures the platform-specific configuration directory
(/etc/chef) is created, and renders the configuration file
(push-jobs-client.rb) using the whitelist attribute.
Any environment variables can be set using environment_variables
attribute with key value pairs.
You can provide your own push-jobs-client.rb.erb template file in
a wrapper cookbook and set the ['config']['template_cookbook']
attribute to the name of that wrapper cookbook.

The path to the configuration file is set using the PushJobsHelper
module's #config_path method. This is done to ensure the correct
file path is used on Linux and Windows platforms, as it uses
Chef::Config's #platform_specific_path method.


This recipe downloads and installs the Chef Push client from CHEF's public repositories. Setting the node['push_jobs']['package_version'] attribute installs a specific version from the public repositories. Setting the node['push_jobs']['package_url'] and node['push_jobs']['package_checksum'] attributes together will override the default behavior and download the package from the specified URL.


If the node['push_jobs']['gem_url'] attribute is set, this
recipe will download the knife-pushy gem to the system.

Use this recipe on workstation systems that should manage running jobs
with the knife plugin.


This recipe is responsible for handling the service resource based on
the node's platform. On Linux (Debian and RHEL families), it will
create a runit service. The default logger is used, and the log will
be /var/log/push-jobs-client/current. On Windows, it will add a
registry key for the Chef Push client, and manage the Windows service.

The service resources expect to be restarted if the configuration
template is changed, using subscribes notification.


The node['push_jobs']['package_url'] and node['push_jobs']['package_checksum'] attributes must be set
to use this recipe. The URL will be used (with the
checksum attribute) to install the package using the windows_package
resource from the windows cookbook.

Client Connection Configuration

The push job client establishes a command and heartbeat channel to the
push server over tcp. The tcp connection information is read from
the Chef Server upon startup of the push client service from an endpoint
similar to the following:


The connection information for the push server is established when the
push server is installed and the Chef Server is reconfigured. In the case
the Chef Server is not providing the correct push server configuration,
please verify hostnames are correct and that both the push server and
Chef Server have been reconfigured.

Verify Push Jobs Client Connection

If the push client has been successfully installed on a node, the
client should be able to successfully respond to a knife job directed
to the node. If the node is not responding correctly, please consult the
logs /var/log/push-jobs-client/current (for Debian and Rhel families) and
look for entries similar to the following:

INFO: [pclient] Starting client ...
INFO: [pclient] Retrieving configuration from https://private-chef-server/organizations/org1/pushy/config/pc_6_1 ...
INFO: [pclient] Connecting to command channel at tcp://private-chef-server:10002
INFO: [pclient] Listening for server heartbeat at tcp://private-chef-server:10000
INFO: [pclient] Started client.

License & Authors

Copyright:: 2009-2015, 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

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
See the License for the specific language governing permissions and
limitations under the License.

Dependent cookbooks

runit >= 0.0.0
windows >= 0.0.0
chef-ingredient >= 0.0.0

Contingent cookbooks

There are no cookbooks that are contingent upon this one.

push-jobs Cookbook CHANGELOG

This file is used to list changes made in each version of the push-jobs cookbook.

v2.6.3 (2015-11-10)

  • Stopped the windows service from restarting with every CCR.

v2.6.2 (2015-11-04)

  • Added an attribute so we can enable timetsamps on Windows.
  • Fix pushy client service registration on Windows to correctly read config file.

v2.6.1 (2015-10-21)

  • #56 - Replaced symbols with strings in recipe

v2.6.0 (2015-10-13)

  • Use chefdk version of berks for travis.
  • #54 Unbreak chef-ingredient installs, and improve version independence logic.

v2.5.0 (2015-10-06)

  • #53 - Allow node_name and chef_server_url to be overridden
  • #49 - Support the name changes in 1.3x and 2.0 push client, especially on windows
  • #52 - More updates for newer rubocop and foodcritic
  • #50 - Allow ssl to be disabled
  • Cleanups for travis testing and general hygiene
    • test on modern ruby
    • update kitchen.yml boxes
    • bump gem versions
    • rubocop update, use standard rules, misc fixes
    • foodcritic fixes
    • update urls/emails

v2.4.2 (2015-09-08)

  • #42 - Windows push client to use own config
  • #43 - Include version in package name for idempotency
  • #46 - debug flag to logging level flag

v2.4.1 (2015-07-29)

  • #41 - fix client path and node_name

v2.4.0 (2015-07-20)

  • Using chef-ingredient
  • service_container recipe

v2.3.0 (2015-06-18)

  • Support environment variables in config file
  • Correctly generate the chef client config.rb path on windows boxes.
  • Greatly improved README

v2.2.1 (2014-07-09)

  • Refactored the service creation in the same manner as chef-client cookbook.
  • Changed up the kitchen file to remove CentOS 5.9 and switched out Ubuntu 10.04 for Ubuntu 14.04.

v2.2.0 (2014-03-07)

  • Move config and service resources to separate recipes
  • Add new helper methods for config path
  • Update ChefSpec to v3 and specs to match

v2.0.1 (2014-02-20)

  • Make whitelist rendering is more robust
  • Ensure node['push_jobs']['whitelist'] is a Hash (or subclass thereof)

v2.0.0 (2014-02-18)

  • node['push_jobs']['package_url'] and node['push_jobs']['package_checksum'] are now required when installing the client package. The previous version of this cookbook automatically determined the proper values for the node if values were not supplied.

v1.0.0 (2013-10-28)

  • Initial release

Foodcritic Metric

2.6.3 passed this metric