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


openstack-common (11) Versions 16.0.0

Common OpenStack attributes, libraries and recipes.

cookbook 'openstack-common', '= 16.0.0', :supermarket
cookbook 'openstack-common', '= 16.0.0'
knife supermarket install openstack-common
knife supermarket download openstack-common
Quality 67%

Team and repository tags

Team and repository tags

Chef OpenStack Logo


This cookbook provides common setup recipes, helper methods and attributes that
describe an OpenStack deployment as part of the OpenStack reference deployment
Chef for OpenStack.

Please relate to the official OpenStack Configuration Reference for a more detailed documentation on operating and administration of an OpenStack cluster:


  • Chef 12 or higher
  • chefdk 0.15.15 for testing (also includes berkshelf for cookbook dependency resolution)


  • ubuntu
  • redhat
  • centos


The following cookbooks are dependencies:

  • 'apt', '~> 2.8'
  • 'database', '~> 4.0.2'
  • 'mariadb', '~> 0.3.1'
  • 'mysql', '~> 6.0.13'
  • 'yum', '~> 3.5.4'
  • 'yum-epel', '~> 0.6.0'
  • 'galera', '~> 0.4.1'


Please see the extensive inline documentation in attributes/*.rb for
descriptions of all the settable attributes for this cookbook.

Note that all attributes are in the default["openstack"] "namespace"

Attributes to generate OpenStack service configuration files

Since the mitaka release, we moved to a completely new way to generate all
OpenStack service configuration files. The base template is the
'openstack-service.conf.erb' included in the templates of this cookbook. In each
of the service cookbook (e.g. openstack-network, openstack-identity or
openstack-compute), the service configuration file (e.g neutron.conf,
keystone.conf or nova.conf) gets generated directly from attributes set inside of
the cookbook. To merge all the configuration options (including the secrets)
properly, before handing them over as '@service_config' to the mentioned
template above, we use the methods defined in 'libraries/config_helpers'.

For examples how to use these attributes, please refer to the attribute files
included in the service cookbooks (e.g. attributes/neutron_conf.rb in
openstack-network or attributes/keystone_conf.rb in openstack-identity). The
basic structure of all these attributes always follows this model:

# usual config option that should evventually be saved to the node object
# configuration options like passwords that should not be saved in the node
# object



  • Install the common python openstack client package


  • Installs/Configures common recipes


  • Installs/Configures common logging


  • Iterates over the contents of the node['openstack']['sysctl'] hash and writes the entries to /etc/sysctl.d/60-openstack.conf.

Data Bags

This cookbook contains Libraries to work with passwords and secrets in
databags. Databags can be unencrypted (for dev) or encrypted (for prod).
In addition to traditionally encrypted data bags they can also be created as
chef-vault items. To read more about chef-vault and how to use it, go to

Documentation for Attributes for selecting databag format can be found in the
attributes section of this cookbook.

Documentation for format of these Databags can be found in the Openstack Chef


This cookbook provides the openstack_common_database LWRP, which replaces the
old database library function 'db_create_with_user'. When this cookbook is
included as dependency, this LWRP can be used to create databases needed by the
OpenStack services.

depends 'openstack-common'
openstack_common_database 'compute' do
  service 'compute' # name_attribute
  user 'nova'
  pass 'supersecret'

An example of the usage can be seen here


This cookbook exposes a set of default library routines:

  • cli -- Used to call openstack CLIs
  • endpoint -- Used to return a ::URI object representing the named OpenStack endpoint
  • admin_endpoint -- Used to return a ::URI object representing the named OpenStack admin endpoint if one was specified. Otherwise, it will return the same value as endpoint.
  • internal_endpoint -- Used to return a ::URI object representing the named OpenStack internal endpoint if one was specified. Otherwise, it will return the same value as endpoint.
  • public_endpoint -- Used to return a ::URI object representing the named OpenStack public endpoint if one was specified. Otherwise, it will return the same value as endpoint.
  • endpoints -- Useful for operating on all OpenStack endpoints
  • db -- Returns a Hash of information about a named OpenStack database
  • db_uri -- Returns the SQLAlchemy RFC-1738 DB URI (see: for a named OpenStack database
  • secret -- Returns the value of an encrypted data bag for a named OpenStack secret key and key-section
  • get_password -- Ease-of-use helper that returns the decrypted password for a named database, service or keystone user.
  • matchers -- A custom matcher(render_config_file) for testing ini format file section content by with_section_content.


The following are code examples showing the above library routines in action.
Remember when using the library routines exposed by this library to include
the Openstack routines in your recipe's ::Chef::Recipe namespace, like so:

class ::Chef::Recipe
  include ::Openstack

Example of using the endpoint routine:

nova_api_ep = endpoint "compute-api""Using Openstack Compute API endpoint at #{nova_api_ep.to_s}")

# Note that endpoint URIs may contain variable interpolation markers such
# as `%(tenant_id)s`, so you may need to decode them. Do so like this:

require "uri"

puts ::URI.decode nova_api_ap.to_s

Example of using the get_password and db_uri routine:

db_pass = get_password "db" "cinder"
db_user = node["cinder"]["db"]["user"]
sql_connection = db_uri "volume", db_user, db_pass

template "/etc/cinder/cinder.conf" do
  source "cinder.conf.erb"
  owner  node["cinder"]["user"]
  group  node["cinder"]["group"]
  mode   00644
    "sql_connection" => sql_connection

URI Operations

Use the Openstack::uri_from_hash routine to helpfully return a ::URI::Generic
object for a hash that contains any of the following keys:

  • host
  • uri
  • port
  • path
  • scheme

If the uri key is in the hash, that will be used as the URI, otherwise the URI
will be constructed from the various parts of the hash corresponding to the keys

# Suppose node hash contains the following subhash in the :identity_service key:
# {
#   :host => '',
#   :port => 5000,
#   :scheme => 'https'
# }
uri = ::Openstack::uri_from_hash(node[:identity_service])
# uri.to_s would == ""

The routine will return nil if neither a uri or host key exists in the
supplied hash.

Using the library without prefixing with ::Openstack

Don't like prefixing calls to the library's routines with ::Openstack? Do this:

class ::Chef::Recipe
  include ::Openstack

in your recipe.

License and Author

Author Jay Pipes (
Author John Dewey (
Author Matt Ray (
Author Craig Tracey (
Author Sean Gallagher (
Author Ionut Artarisi (
Author Chen Zhiwei (
Author Brett Campbell (
Author Mark Vanderwiel (
Author Jan Klare (
Author Christoph Albers (
Copyright Copyright (c) 2012-2013, AT&T Services, Inc.
Copyright Copyright (c) 2013, Opscode, Inc.
Copyright Copyright (c) 2013, Craig Tracey
Copyright Copyright (c) 2013-2014, SUSE Linux GmbH
Copyright Copyright (c) 2013-2015, IBM, Corp.
Copyright Copyright (c) 2013-2014, Rackspace US, 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

etcd ~> 3.0
mariadb ~> 1.5
memcached ~> 4.1
mysql ~> 8.2
poise-python ~> 1.5
selinux >= 0.0.0

Contingent cookbooks

openstack-bare-metal Applicable Versions
openstack-block-storage Applicable Versions
openstack-compute Applicable Versions
openstack-dashboard Applicable Versions
openstack-dns Applicable Versions
openstack-identity Applicable Versions
openstack-image Applicable Versions
openstack-integration-test Applicable Versions
openstack-network Applicable Versions
openstack-ops-database Applicable Versions
openstack-ops-messaging Applicable Versions
openstack-orchestration Applicable Versions
openstack-telemetry Applicable Versions

Collaborator Number Metric

16.0.0 failed this metric

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

Contributing File Metric

16.0.0 passed this metric

Foodcritic Metric

16.0.0 passed this metric

No Binaries Metric

16.0.0 passed this metric

Testing File Metric

16.0.0 passed this metric

Version Tag Metric

16.0.0 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