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

copperegg (4) Versions 0.2.3

Installs/Configures CopperEgg services

Policyfile
Berkshelf
Knife
cookbook 'copperegg', '~> 0.2.3', :supermarket
cookbook 'copperegg', '~> 0.2.3'
knife supermarket install copperegg
knife supermarket download copperegg
README
Dependencies
Quality 17%

Chef Cookbook for CopperEgg services

  • Chef cookbook for the CopperEgg collector agent and website / port probes.
  • Requires a CopperEgg account to use. Free trial available.

Recent Updates

Version 0.2.3 Released November 18, 2013
This release fixes the idempotence issue: namely, the collector re-installing every chef run.

Version 0.2.2 Released July 11, 2013
This release fixes the problem of 'Cookbook Annotations do not work for omnibus install', reported both as an issue in GitHub, and on our support site.

Requirements

Chef 10 and up.

Platform

  • Any Linux 2.6+ OS, including: Ubuntu, Debian, Vyatta, RedHat Enterprise, CentOS, Fedora, Amazon, SuSE, openSuSE, Gentoo, and many derivatives.
  • Windows

Attributes

  • default[:copperegg][:apikey] = Your API Key available from the CopperEgg App Settings Page.
  • default[:copperegg][:tags] = A comma separated list of tags to apply. Optional. Manage your tags.
  • default[:copperegg][:label] = Label to apply in place of hostname when displaying in the dashboard. WARNING: If you want the same label applied to multiple systems, you may want to consider tags instead. This is most useful if you intend a recipe for a single server. Optional.
  • default[:copperegg][:oom_protect] = Flag for determining if the Linux Out Of Memory manager (OOM) should be allowed to kill the RevealCloud process. Default false (allow OOM to kill the process). Optional.
  • default[:copperegg][:proxy] = Proxy server required to talk to the revealcloud api servers, such as myproxy.mycorp.com:8080. Optional. Leave blank unless you know what you are doing.
  • `default[:copperegg][:use_fqdn] = Flag for using the fqdn as the uuid. true => Agent will be started with -U node.fqdn . Default false. Optional.
  • default[:copperegg][:include_chef_tags] = Propagate Chef node tags to CopperEgg tags. Default true.
  • default[:copperegg][:include_roles_astags] = Propagate Chef node Roles to CopperEgg tags. Default true.
  • default[:copperegg][:include_env_astag] = Propagate the Chef environment to a CopperEgg tag. Default true.
  • default[:copperegg][:annotate_chefrun_success] = Send CopperEgg an annotation for each successful chef run. Default false.
  • default[:copperegg][:annotate_chefrun_fail] = Send CopperEgg an annotation for each failed chef run. Default true.

Usage

  1. Download the CopperEgg cookbook into your chef-repo/cookbooks/copperegg directory: (the cookbook directory name must be copperegg)
  2. git clone https://github.com/CopperEgg/chef-copperegg.git ./copperegg, or
  3. manually download from the Opscode community site http://community.opscode.com/cookbooks/copperegg, or
  4. knife cookbook site download copperegg
  5. Set your apikey as described in the Attributes section.
  6. edit copperegg/attributes/default.rb and change YOUR_USER_API_KEY to be correct.
  7. Set any other optional attributes described above, as desired.
  8. Upload the cookbook to your chef server or hosted chef:
  9. knife cookbook upload -a -o copperegg
  10. Include recipe[revealcloud] in the run_list for all of your servers.
  11. knife node run_list add NODES 'recipe[copperegg]'
  12. Run chef-client on your nodes in whatever manner suits you, such as sudo chef-client or a batch job.
  13. View your systems within 10 seconds in the RevealCloud App

Creating and managing website and port probes

  1. The CopperEgg Cookbook contains a LightWeight Resource Provider (LWRP) for simplifying the automation of CopperEgg probes.
  2. To create a copperegg probe, you need to include something similar to the following example:
  copperegg_probe "ChefProbe2" do
    provider "copperegg_probe"
    action :update                        # update will create or update
    probe_desc 'ChefProbe2'               # the 'name' of the probe
    probe_dest "http://yoursite.com"      # the URL to test
    type 'GET'                            # the test type; in this case, an HTTP GET request
    stations ['dal','nrk']                # override the defaults and specify testing from Dallas and Fremont
    tags ["production",'load_balancer']   # The tags to apply to this probe
  end 
  1. You can find descriptions of all required and optional fields in copperegg/resources/probe.rb.
  2. Refer to the Probe section of the CopperEgg API for further details: CopperEgg Probe API

Creating Annotations in the CopperEgg UI for chef run events.

The CopperEgg Cookbook includes integration with the Chef Report and Exception
Handlers. To enable this functionality choose one of the following:
* Include the recipe copperegg-handler.rb in your run_list, or
* Include the recipe copperegg-handler in your application cookbook with
include_recipe.

That's it!

Note:
* By default, each chef run will create an annotation at copperegg only when the chef run fails.
* You can change this behavior by changing the [:copperegg][:annotate_chefrun_success] and [:copperegg][:annotate_chefrun_fail] attributes in the default attributes file or by overriding them in your application cookbook.

Links

License and Author

Authors:: Ross Dickey, Scott Johnson
With Contributions from Drew Oliner (https://github.com/Drewzar)

(The MIT License)

Copyright © 2013 CopperEgg Corporation

Permission is hereby granted, free of charge, to any person obtaining a
copy of this software and associated documentation files (the "Software"),
to deal in the Software without restriction, including without
limitation the rights to use, copy, modify, merge, publish, distribute,
sublicense, and/or sell copies of the Software, and to permit persons
to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included
in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL
THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.

Dependent cookbooks

chef_handler > 1.0.0

Contingent cookbooks

There are no cookbooks that are contingent upon this one.

Collaborator Number Metric
            

0.2.3 failed this metric

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

Contributing File Metric
            

0.2.3 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.2.3 failed this metric

FC025: Prefer chef_gem to compile-time gem install: copperegg/recipes/copperegg-handler.rb:17
FC064: Ensure issues_url is set in metadata: copperegg/metadata.rb:1
FC065: Ensure source_url is set in metadata: copperegg/metadata.rb:1
FC066: Ensure chef_version is set in metadata: copperegg/metadata.rb:1
FC070: Ensure supports metadata defines valid platforms: copperegg/metadata.rb:1
FC074: LWRP should use DSL to define resource's default action: copperegg/resources/probe.rb:1
FC104: Use the :run action in ruby_block instead of :create: copperegg/recipes/default.rb:77
FC104: Use the :run action in ruby_block instead of :create: copperegg/recipes/reload.rb:18
FC104: Use the :run action in ruby_block instead of :create: copperegg/recipes/reload.rb:27
FC104: Use the :run action in ruby_block instead of :create: copperegg/recipes/reload.rb:45
FC104: Use the :run action in ruby_block instead of :create: copperegg/recipes/uninstall.rb:14
FC104: Use the :run action in ruby_block instead of :create: copperegg/recipes/uninstall.rb:33
FC121: Cookbook depends on cookbook made obsolete by Chef 14: copperegg/metadata.rb:1
Run with Foodcritic Version 16.3.0 with tags metadata,correctness ~FC031 ~FC045 and failure tags any

No Binaries Metric
            

0.2.3 passed this metric

Testing File Metric
            

0.2.3 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.2.3 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