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

RSS

topo (6) Versions 0.1.6

Sets node configuration from a topology data bag

Policyfile
Berkshelf
Knife
cookbook 'topo', '~> 0.1.6', :supermarket
cookbook 'topo', '~> 0.1.6'
knife supermarket install topo
knife supermarket download topo
README
Dependencies
Changelog
Quality 17%

topo Cookbook

This cookbook supports unattended bootstrap of nodes when
using the knife-topo plugin
to configure single or multi-node topologies.
This can be useful in combination with CloudFormation or other
provisioning tools.

The source for this cookbook is on Github.

setup_node recipe

Upload a topology definition to the Chef Server using knife-topo:

knife topo import test1.json
knife topo create test1

Use a single attribute in a first-boot json file of each node to specify
the topology name, and optionally a node type:

firstboot.json
{
  "topo": {
    "name": "test1",
    "node_type": "appserver"
  }
}

Trigger the unattended bootstrap by running:

chef-client -o topo::setup_node --json firstboot.json
chef-client

The first chef-client run will set the configuration (runlist, chef
environment, tags and attributes) based on the uploaded topology
and either the node name or the node type; the second run will apply
that configuration.

setup_chef_cleanup recipe

Use the 'setup_chef_cleanup' recipe to create a script that will invoke
the run_chef_cleanup recipe when the node is shutdown.

This recipe is platform-specific has only been tested on Ubuntu 14.04.

run_chef_cleanup recipe

Use the 'run_chef_cleanup' recipe to delete the chef node and client from
the Chef server, and also delete the validation and client keys.

To keep the validation key, set node['topo']['delete_validation_key']
to 'never'. Other values are 'startup' and 'shutdown'.

refresh_attributes recipe

Load attributes from topology data bag on each run.

Attributes

  • node['topo']['name'] - Name of the topology to be used to configure the node
  • node['topo']['node_type'] - If node.name is not found in the topology, then this attribute will be used to find a match.
  • node['topo']['blueprint_name'] - If no topology data bag item matching node['topo']['name'] is found, then this attribute is used as an alternative.
  • node['topo']['refresh_attributes'] - If true, load attributes from topology data bag on each chef run. Defaults to false.

Example

The [example](example) provides a Cloud Formation template that uses the topo cookbook
and knife topo to setup a nodejs application. My blog provides a
detailed walkthrough of the example.

License

Author:: Christine Draper (christine_draper@thirdwaveinsights.com)

Copyright:: Copyright (c) 2015-2016 ThirdWave Insights, LLC

License:: Apache License, Version 2.0

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

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

Dependent cookbooks

This cookbook has no specified dependencies.

Contingent cookbooks

There are no cookbooks that are contingent upon this one.

topo Cookbook Changelog

v0.1.2 (2015-12-01)

  • Do not raise error when no topology data bag is found
  • Set node['topo']['name'] to the actual topology name, even if blueprint data bag is used

v0.1.3 (2015-12-28)

  • Add recipes to cleanup the node, client and keys
  • Add an example CloudFormation template that uses the recipes

v0.1.4 (2016-02-02)

  • Fix problem with look-up by node type

v0.1.5 (2016-02-04)

  • Add option to refresh attributes from topology data bag on each run.
  • Store blueprint_name in normal node attribute, so can rerun topo::setup_node

v0.1.6 (2016-03-12)

  • Refresh attributes sets attributes rather than merging them, consistent with setup_node.

Collaborator Number Metric
            

0.1.6 failed this metric

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

Contributing File Metric
            

0.1.6 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 https://github.com/user/repo, and your repo must contain a CONTRIBUTING.md file

Foodcritic Metric
            

0.1.6 failed this metric

FC064: Ensure issues_url is set in metadata: topo/metadata.rb:1
FC066: Ensure chef_version is set in metadata: topo/metadata.rb:1
FC069: Ensure standardized license defined in metadata: topo/metadata.rb:1
Run with Foodcritic Version 16.3.0 with tags metadata,correctness ~FC031 ~FC045 and failure tags any

No Binaries Metric
            

0.1.6 passed this metric

Testing File Metric
            

0.1.6 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 https://github.com/user/repo, and your repo must contain a TESTING.md file

Version Tag Metric
            

0.1.6 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 https://github.com/user/repo, and your repo must include a tag that matches this cookbook version number