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


cockroachdb-platform (10) Versions 1.0.0

Cookbook used to install and configure cockroachdb

cookbook 'cockroachdb-platform', '= 1.0.0', :supermarket
cookbook 'cockroachdb-platform', '= 1.0.0'
knife supermarket install cockroachdb-platform
knife supermarket download cockroachdb-platform
Quality 29%

CockroachDB Platform


CockroachDB is an open source, scalable,
survivable, strongly consistent database.

This cookbook is designed to install and configure a CockroachDB cluster.


Cookbooks and gems

Declared in [metadata.rb](metadata.rb) and in [Gemfile](Gemfile).


A systemd managed distribution:
- RHEL Family 7, tested on Centos

Note: it should work fine on Debian 8 but the official docker image does not
allow systemd to work easily, so it could not be tested.


Easy Setup

Set node['cockroachdb-platform']['hosts'] to an array containing the
hostnames of the nodes of the CockroachDB cluster.

The recommended way to use this cookbook is through the creation of a role per
CockroachDB cluster. This enables the search by role feature, allowing a
simple service discovery.

In fact, there are two ways to configure the search:

  1. With a static configuration through a list of hostnames (attributes hosts that is node['cockroachdb-platform']['hosts']) for nodes belonging to CockroachDB cluster.
  2. With a real search, performed on a role (attributes role and size like in node['cockroachdb-platform']['role']). The role should be in the run-list of all nodes of the cluster. The size is a safety and should be the number of nodes of this role.

If hosts is configured, role and size are ignored

See [roles](test/integration/roles) for some examples and
[Cluster Search][cluster-search] documentation for more information.


This cookbook is fully tested through the installation of a working 3-nodes
cluster in docker hosts. This uses kitchen, docker and some monkey-patching.

For more information, see [.kitchen.yml](.kitchen.yml) and [test](test)


Configuration is done by overriding default attributes. All configuration keys
have a default defined in [attributes/default.rb](attributes/default.rb).
Please read it to have a comprehensive view of what and how you can configure
this cookbook behavior.



Include search, user, install, config and systemd recipes.

Search the node (initiator) that will initialize first the CockroachDB cluster.
Other nodes will join the CockroachDB cluster after the initiator.


Create user/group used by CockroachDB.


Install CockroachDB using ark.


Generate options for the CockroachDB node.

Global options for each CockroachDB node in the cluster are defined through
the following attribute: node['cockroachdb-platform']['options'].

By default, the CockroachDB cluster will be created and started in insecure
mode. To enable the secure mode, change option insecure to false (in
attribute node['cockroachdb-platform']['options']['insecure']). Then SSL
certificates used for the secure mode have to be stored in an encrypted data
bag (data bag 'secrets' with items 'ca' and 'node' by default). For an example,
look at the test configuration which uses secure mode.


Create systemd service file for CockroachDB.


Available in [](


Please read carefully []( before making a merge

License and Author

Copyright (c) 2016 Sam4Mobile

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

ark >= 0.0.0
cluster-search >= 0.0.0

Contingent cookbooks

There are no cookbooks that are contingent upon this one.



  • Initial version, with beta-20161103 support

Collaborator Number Metric

1.0.0 failed this metric

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

Contributing File Metric

1.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 contain a file

Foodcritic Metric

1.0.0 failed this metric

FC066: Ensure chef_version is set in metadata: cockroachdb-platform/metadata.rb:1
FC069: Ensure standardized license defined in metadata: cockroachdb-platform/metadata.rb:1
Run with Foodcritic Version 10.3.1 with tags metadata,correctness ~FC031 ~FC045 and failure tags any

License Metric

1.0.0 passed this metric

No Binaries Metric

1.0.0 passed this metric

Testing File Metric

1.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 contain a file

Version Tag Metric

1.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