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

RSS

kill-switch (2) Versions 1.0.1

Kill switch to prevent Chef runs from occuring

Berkshelf/Librarian
Policyfile
Knife
cookbook 'kill-switch', '~> 1.0.1'
cookbook 'kill-switch', '~> 1.0.1', :supermarket
knife cookbook site install kill-switch
knife cookbook site download kill-switch
README
Dependencies
Changelog
Quality 89%

kill-switch

This cookbook allows you a quick and easy way to stop Chef runs in your environment either through a touch file on the filesystem or through a node attribute. You also have the choice of a clean or unclean exit.

The exit logic occurs during the compilation phase. This recipe should be included at the very tippy top of your run_list to ensure other compilation phase actions do not run.

You should absolutely use this functionality sparingly. Converging a node on a routine basis prevents configuration drift and the longer you go without running Chef, the more risk you take from more changes being introduced to the system on the next run. There are however use-cases and emergency situations where you need to shut-down Chef runs on a tier of servers or even globally for a period of time. This cookbook aims to be a tool that can be leveraged for those scenarios.

There is some monkey-patching that needs to happen to have the option of a clean exit during compilation. No refunds, sorry.

Attributes

<table> <tr> <th>Key</th> <th>Type</th> <th>Description</th> <th>Default</th> </tr> <tr> <td><tt>['kill_switch']['engage']</tt></td> <td>Bool</td> <td>Force Chef run to exit immediately.</td> <td><tt>false</tt></td> </tr> <tr> <td><tt>['kill_switch']['normal_exit']</tt></td> <td>Bool</td> <td>Exit should be "success" / 0. Will still generate a fatal level log message regardless.</td> <td><tt>false</tt></td> </tr> <tr> <td><tt>['kill_switch']['touch_file']</tt></td> <td>String</td> <td>Engage kill switch if a file exists at this path</td> <td><tt>C:\.kill_chef</tt> on Windows, <tt>/.kill_chef</tt> on Linux</td> </tr> </table>

Recipes

kill-switch::default

Checks for a touch file or node['kill_switch']['engage'] to be true and exits the Chef run immediately with desired exit status.

License and Authors

Authors: Matt Kulka matt@lqx.net

Dependent cookbooks

This cookbook has no specified dependencies.

Contingent cookbooks

There are no cookbooks that are contingent upon this one.

kill-switch CHANGELOG

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

1.0.1

  • [mattlqx] - Fix not honoring normal_exit if run_list contained kill-switch instead of kill-switch::default. (#1)

1.0.0

  • [mattlqx] - Initial release.

Check the Markdown Syntax Guide for help with Markdown.

The Github Flavored Markdown page describes the differences between markdown on github and standard markdown.

Collaborator Number Metric
            

1.0.1 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.1 passed this metric

Foodcritic Metric
            

1.0.1 passed this metric

License Metric
            

1.0.1 passed this metric

No Binaries Metric
            

1.0.1 passed this metric

Publish Metric
            

1.0.1 passed this metric

Supported Platforms Metric
            

1.0.1 passed this metric

Testing File Metric
            

1.0.1 passed this metric

Version Tag Metric
            

1.0.1 passed this metric