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 partial_search cookbook has been deprecated

Author provided reason for deprecation:

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


partial_search (6) Versions 1.0.9

Provides experimental interface to partial search API in Chef Software Hosted Chef for Chef-Client pre-12.0

cookbook 'partial_search', '~> 1.0.9', :supermarket
cookbook 'partial_search', '~> 1.0.9'
knife supermarket install partial_search
knife supermarket download partial_search
Quality 33%

Partial Search Cookbook

Build Status
Cookbook Version

Partial Search
is a search API available on Chef Server. (see Notes below for version compatibility)
It can be used to reduce the network bandwidth and the memory used by
chef-client to process search results.

This cookbook provides an experimental interface to the partial search
API by providing a partial_search method that can be used instead of
the search method in your recipes.

The partial_search method allows you to retrieve just the attributes
of interest. For example, you can execute a search to return just the
name and IP addresses of the nodes in your infrastructure rather than
receiving an array of complete node objects and post-processing them.

NOTE: Since Chef Client 12.0 the partial_search capability has been built-in
so it does not require this cookbook.


Upload this cookbook and include it in the dependencies of any
cookbook where you would like to use partial_search.


When you call partial_search, you need to specify the key paths of the
attributes you want returned. Key paths are specified as an array
of strings. Each key path is mapped to a short name of your
choosing. Consider the following example:

partial_search(:node, 'role:web',
   :keys => { 'name' => [ 'name' ],
              'ip'   => [ 'ipaddress' ],
              'kernel_version' => [ 'kernel', 'version' ]
).each do |result|
  puts result['name']
  puts result['ip']
  puts result['kernel_version']

In the example above, two attributes will be extracted (on the
server) from the nodes that match the search query. The result will
be a simple hash with keys 'name' and 'ip'.


  • We would like your feedback on this feature and the interface
    provided by this cookbook. Please send comments to the chef-dev
    mailing list.

  • The partial search API is available in the Open Source Chef Server since 11.0.4

  • The partial search API is available in Enterprise Chef Server since 1.2.2

License & Authors

Copyright:: 2012-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

This cookbook has no specified dependencies.

Contingent cookbooks

alternate_search Applicable Versions
bjn_dsh Applicable Versions
btsync Applicable Versions
burp Applicable Versions
cutlery Applicable Versions
etcd Applicable Versions
eucalyptus Applicable Versions
magentostack Applicable Versions
rundeck-alt Applicable Versions
sbp_mremoteng Applicable Versions
search-utils Applicable Versions
sk_ssh_known_hosts Applicable Versions
ssh_known_hosts Applicable Versions
stale-node-checker Applicable Versions
ziggrid Applicable Versions

partial_search Cookbook CHANGELOG

This file is used to list changes made in each version of the partial_search cookbook.

v1.0.9 (2015-10-21)

  • Updated description to clarify that this cookbook is no longer needed for chef-client 12.0
  • Updated .gitignore file
  • Added .foodcritic file to exclude rules that don't apply
  • Added Test Kitchen config
  • Added Chef standard Rubocop config
  • Added Travis CI testing to use Chef DK
  • Added Berksfile
  • Added Gemfile with the latest development dependencies
  • Updated contributing and testing docs
  • Added and maintainers.toml files
  • Added Travis and cookbook version badges to the readme
  • Updated Opscode -> Chef Software
  • Added a Rakefile for simplified testing
  • Added a Chefignore file
  • Resolved Rubocop warnings
  • Added source_url and issues_url to the metadata
  • Added basic convergence Chefspec test

v1.0.8 (2014-02-25)

  • [COOK-4260] Update compatibility in


  • Hotfix - Revert client-side caching bug


New Feature



  • [COOK-3164]: partial_search should use Chef::Config[:chef_server_url] instead of search_url


  • Initial release

Collaborator Number Metric

1.0.9 failed this metric

Failure: Cookbook has 0 collaborators. A cookbook must have at least 2 collaborators to pass this metric.

Contributing File Metric

1.0.9 failed this metric

Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of, and your repo must contain a file

Foodcritic Metric

1.0.9 passed this metric

No Binaries Metric

1.0.9 passed this metric

Testing File Metric

1.0.9 failed this metric

Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of, and your repo must contain a file

Version Tag Metric

1.0.9 failed this metric

Failure: To pass this metric, your cookbook metadata must include a source url, the source url must be in the form of, and your repo must include a tag that matches this cookbook version number