Skip to content
This repository has been archived by the owner on Nov 8, 2024. It is now read-only.

Latest commit

 

History

History
153 lines (130 loc) · 5.71 KB

README.md

File metadata and controls

153 lines (130 loc) · 5.71 KB
Raw

chef-scout

Installs the agent for Scout, a hosted server monitoring service. This recipe:

  • Installs the Scout Ruby gem
  • Configures a Cron job to run the monitoring agent

Supported Platforms

The following platforms are supported by this cookbook, meaning that the recipes run on these platforms without error:

  • Ubuntu
  • Debian
  • Red Hat
  • CentOS
  • Fedora
  • Scientific
  • Amazon

Recipes

  • scout - The default recipe.

Required Attributes

Attribute Description Default Value
[:scout][:key] The agent requires a Scout account and the account's associated key. The key can be found in the account settings tab within the Scout UI or in the server setup instructions. The key looks like: 0mZ6BD9DR0qyZjaBLCPZZWkW3n2Wn7DV9xp5gQPs nil

If the [:scout][:key] attribute is not provided or the scout executable is not found, the Cron job won't be installed but all other parts of the recipe will execute.

Optional Attributes

Attribute Description Default Value
[:scout][:user] User to run the Scout agent under. Will be created if it does not exist. scout
[:scout][:group] User group to run the Scout agent under. Will be created if it does not exist. scout
[:scout][:name] Optional name to display for this node within the Scout UI. nil
[:scout][:roles] An Array of roles for this node. Roles are defined through Scout's UI. nil
[:scout][:plugin_gems] An Array of plugin gem dependencies to install. For example, you may want to install the redis gem if this node uses the redis plugin. nil
[:scout][:rvm_wrapper] The full path to an rvm wrapper where the scout gem and binary will be installed. Overrides [:scout][:bin]. If installing under a user based RVM install, you should also set the :user and :group options in :gem_shell_opts (see below). Example: :rvm_wrapper => "/home/vagrant/.rvm/wrappers/ruby-1.9.3-p547" nil
[:scout][:gem_shell_opts] A hash of valid Mixlib::ShellOut options. The recipe shells out to the gem command for installing gems. You can set things like the user/group to shell out as, shell environment variables such as $PATH, etc. nil
[:scout][:bin] The full path to the scout gem executable. When nil, checks Gem::bindirvia invoking the first ruby found in $PATH (see :gem_shell_opts), or if no ruby is found, the Chef internal ruby. This value is ignored when [:scout][:rvm_wrapper] is set. nil
[:scout][:version] Gem version to install. nil installs the latest release. nil
[:scout][:public_key] If you use self-signed custom plugins, set this attribute to the public key value and it'll be installed on the node. nil
[:scout][:environment] The environment you would like this server to belong to, if you use environments. Environments are defined through scoutapp.com's web UI. nil
[:scout][:plugin_properties] Hash. Used to generate a plugins.properties file from encrypted data bags for secure lookups. E.g. "haproxy.password" => {"encrypted_data_bag" => "shared_passwords", "item" => "haproxy_stats", "key" => "password"} will create a plugins.properties entry with "haproxy.password=PASSWORD" where PASSWORD is an encrypted data bag item "haproxy_stats" in encrypted_data_bag "shared_passwords" with key "password". {}

Questions?

Contact Scout ([email protected]) with any questions, suggestions, bugs, etc.

Authors and License

Additions, Modifications, & Updates:

Author: Derek Haynes ([email protected]) Copyright: 2013, Scout https://github.com/scoutapp/chef-scout

Author: Drew Blas ([email protected]) Copyright: 2012, Drew Blas https://github.com/drewblas/chef-scout_agent

Originally:

Author: Seth Chisamore ([email protected]) Copyright: 2010, Seth Chisamore https://github.com/schisamo/chef_cookbooks

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.