cookbook 'scout', '= 0.4.0'
scout (6) Versions 0.4.0 Follow0
Installs and configures monitoring agent for server.pingdom.com
cookbook 'scout', '= 0.4.0', :supermarket
knife supermarket install scout
knife supermarket download scout
chef-scout
Installs the agent for Scout, a hosted server monitoring service. This recipe:
- Installs scoutd, the Scout monitoring daemon
- Runs scoutd
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
<table>
<thead>
<tr>
<th>Attribute</th>
<th>Description</th>
<th>Default Value</th>
</tr>
</thead>
<tbody>
<tr>
<td style="width:15%">[:scout][:account_key]</td>
<td>
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:
<code>0mZ6BD9DR0qyZjaBLCPZZWkW3n2Wn7DV9xp5gQPs</code>
</td>
<td style="width:15%"><code>nil</code></td>
</tr>
</tbody>
</table>
If the <code>[:scout][:account_key]</code> attribute is not provided the scout agent won't be installed but all other parts of the recipe will execute.
Optional Attributes
<table>
<thead>
<tr>
<th style="width:20%">Attribute</th>
<th>Description</th>
<th>Default Value</th>
</tr>
</thead>
<tbody>
<tr>
<td>[:scout][:hostname]</td>
<td>Optional hostname to uniquely identify this host to Scout.</td>
<td><code>nil</code></td>
</tr>
<tr>
<td>[:scout][:display_name]</td>
<td>Optional name to display for this node within the Scout UI.</td>
<td><code>nil</code></td>
</tr>
<tr>
<td>[:scout][:roles]</td>
<td>An comma-separated list of roles for this node. Roles are defined through Scout's UI.</td>
<td><code>nil</code></td>
</tr>
<tr>
<td>[:scout][:plugin_gems]</td>
<td>An Array of plugin gem dependencies to install. For example, you may want to install the <code>redis</code> gem if this node uses the redis plugin. Each entry in the array can be the name of a gem, or an array specifying the arguments required to install a specific version of a gem. For example, the following configuration will install the latest version of the <code>redis</code> gem: <code>node[:scout][:plugin_gems] = ['redis']</code> This configuration, on the other hand, will install version 3.2.1: <code>node[:scout][:plugin_gems] = [%w(redis --version 3.2.1)]</code></td>
<td><code>nil</code></td>
</tr>
<tr>
<td>[:scout][:ruby_path]</td>
<td>The full path to a ruby executable or rvm wrapper which will run the Scout Ruby code and where the gem dependencies will be installed. If installing under a user based RVM install, you should also set the <code>:user</code> and <code>:group</code> options in <code>:gem_shell_opts</code> (see below). Example: <code>:rvm_wrapper => "/home/vagrant/.rvm/wrappers/ruby-1.9.3-p547"</code></td>
<td><code>nil</code></td>
</tr>
<tr>
<td>[:scout][:gem_shell_opts]</td>
<td>A hash of valid <a href="https://github.com/opscode/mixlib-shellout">Mixlib::ShellOut</a> options. The recipe shells out to the <code>gem</code> command for installing gems. You can set things like the user/group to shell out as, shell environment variables such as $PATH, etc.</td>
<td><code>nil</code></td>
</tr>
<tr>
<td>[:scout][:version]</td>
<td>Scout agent version to install. <code>nil</code> installs the latest release.</td>
<td><code>nil</code></td>
</tr>
<tr>
<td>[:scout][:public_key]</td>
<td>If you use self-signed custom plugins, set this attribute to the public key value and it'll be installed on the node.</td>
<td><code>nil</code></td>
</tr>
<tr>
<td>[:scout][:environment]</td>
<td>The environment you would like this server to belong to, if you use environments. Environments are defined through scoutapp.com's web UI.</td>
<td><code>nil</code></td>
</tr>
<tr>
<td>[:scout][:plugin_properties]</td>
<td>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".</td>
<td><code>{}</code></td>
</tr>
<tr>
<td>[:scout][:delete_on_shutdown]</td>
<td>If true, will run a shutdown script to remove the server from Scout when the server is shutdown.</td>
<td><code>nil</code></td>
</tr>
<tr>
<td>[:scout][:repo][:enable]</td>
<td>If true, will install the correct archive.scoutapp.com repository based on the hosts platform. Only disable if you have the scoutd package hosted in a repository already installed on the host.</td>
<td><code>true</code></td>
</tr>
<tr>
<td>[:scout][:key][:bag_name]</td>
<td>If speficied, the account_key will be loaded from the given encrypted data bag. (Note: must also specifiy [:scout][:key][:item_name]
)</td>
<td><code>nil</code></td>
</tr>
<tr>
<td>[:scout][:key][:item_name]</td>
<td>If speficied, the account_key will be loaded from the given encrypted data bag item under the account_key
value in the bag. (Note: must also specifiy [:scout][:key][:bag_name]
)</td>
<td><code>nil</code></td>
</tr>
</tbody>
</table>
Questions?
Contact Scout (support@scoutapp.com) with any questions, suggestions, bugs, etc.
Authors and License
Additions, Modifications, & Updates:
Author: Derek Haynes (support@scoutapp.com)
Copyright: 2013, Scout
https://github.com/scoutapp/chef-scout
Author: Drew Blas (drew.blas@gmail.com)
Copyright: 2012, Drew Blas
https://github.com/drewblas/chef-scout_agent
Originally:
Author: Seth Chisamore (schisamo@gmail.com)
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.
Dependent cookbooks
apt >= 0.0.0 |
yum >= 0.0.0 |
Contingent cookbooks
There are no cookbooks that are contingent upon this one.
Foodcritic Metric
0.4.0 failed this metric
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/775f6c21c1fd22871c532dc8/scout/attributes/default.rb:6
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/775f6c21c1fd22871c532dc8/scout/attributes/default.rb:9
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/775f6c21c1fd22871c532dc8/scout/attributes/default.rb:10
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/775f6c21c1fd22871c532dc8/scout/attributes/default.rb:11
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/775f6c21c1fd22871c532dc8/scout/attributes/default.rb:12
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/775f6c21c1fd22871c532dc8/scout/attributes/default.rb:13
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/775f6c21c1fd22871c532dc8/scout/attributes/default.rb:14
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/775f6c21c1fd22871c532dc8/scout/attributes/default.rb:15
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/775f6c21c1fd22871c532dc8/scout/attributes/default.rb:16
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/775f6c21c1fd22871c532dc8/scout/attributes/default.rb:17
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/775f6c21c1fd22871c532dc8/scout/attributes/default.rb:18
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/775f6c21c1fd22871c532dc8/scout/attributes/default.rb:19
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/775f6c21c1fd22871c532dc8/scout/attributes/default.rb:20
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/775f6c21c1fd22871c532dc8/scout/attributes/default.rb:21
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/775f6c21c1fd22871c532dc8/scout/attributes/default.rb:22
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/775f6c21c1fd22871c532dc8/scout/attributes/default.rb:23
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/775f6c21c1fd22871c532dc8/scout/attributes/default.rb:25
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/775f6c21c1fd22871c532dc8/scout/attributes/default.rb:26
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/775f6c21c1fd22871c532dc8/scout/libraries/scout.rb:6
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/775f6c21c1fd22871c532dc8/scout/libraries/scout.rb:7
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/775f6c21c1fd22871c532dc8/scout/libraries/scout.rb:9
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/775f6c21c1fd22871c532dc8/scout/libraries/scout.rb:10
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/775f6c21c1fd22871c532dc8/scout/libraries/scout.rb:17
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/775f6c21c1fd22871c532dc8/scout/libraries/scout.rb:25
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/775f6c21c1fd22871c532dc8/scout/libraries/scout.rb:45
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/775f6c21c1fd22871c532dc8/scout/recipes/default.rb:7
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/775f6c21c1fd22871c532dc8/scout/recipes/default.rb:13
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/775f6c21c1fd22871c532dc8/scout/recipes/default.rb:19
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/775f6c21c1fd22871c532dc8/scout/recipes/default.rb:20
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/775f6c21c1fd22871c532dc8/scout/recipes/default.rb:28
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/775f6c21c1fd22871c532dc8/scout/recipes/default.rb:36
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/775f6c21c1fd22871c532dc8/scout/recipes/default.rb:43
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/775f6c21c1fd22871c532dc8/scout/recipes/default.rb:47
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/775f6c21c1fd22871c532dc8/scout/recipes/default.rb:64
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/775f6c21c1fd22871c532dc8/scout/recipes/default.rb:65
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/775f6c21c1fd22871c532dc8/scout/recipes/default.rb:66
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/775f6c21c1fd22871c532dc8/scout/recipes/default.rb:67
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/775f6c21c1fd22871c532dc8/scout/recipes/default.rb:68
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/775f6c21c1fd22871c532dc8/scout/recipes/default.rb:69
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/775f6c21c1fd22871c532dc8/scout/recipes/default.rb:70
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/775f6c21c1fd22871c532dc8/scout/recipes/default.rb:71
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/775f6c21c1fd22871c532dc8/scout/recipes/default.rb:72
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/775f6c21c1fd22871c532dc8/scout/recipes/default.rb:89
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/775f6c21c1fd22871c532dc8/scout/recipes/default.rb:99
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/775f6c21c1fd22871c532dc8/scout/recipes/default.rb:114
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/775f6c21c1fd22871c532dc8/scout/templates/default/scout_rsa.pub.erb:1
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/775f6c21c1fd22871c532dc8/scout/templates/default/scout_shutdown.erb:3
FC002: Avoid string interpolation where not required: /tmp/cook/775f6c21c1fd22871c532dc8/scout/libraries/scout.rb:45
FC019: Access node attributes in a consistent manner: /tmp/cook/775f6c21c1fd22871c532dc8/scout/recipes/default.rb:131
FC023: Prefer conditional attributes: /tmp/cook/775f6c21c1fd22871c532dc8/scout/recipes/default.rb:89
FC024: Consider adding platform equivalents: /tmp/cook/775f6c21c1fd22871c532dc8/scout/recipes/default.rb:22
0.4.0 failed this metric
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/775f6c21c1fd22871c532dc8/scout/attributes/default.rb:9
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/775f6c21c1fd22871c532dc8/scout/attributes/default.rb:10
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/775f6c21c1fd22871c532dc8/scout/attributes/default.rb:11
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/775f6c21c1fd22871c532dc8/scout/attributes/default.rb:12
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/775f6c21c1fd22871c532dc8/scout/attributes/default.rb:13
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/775f6c21c1fd22871c532dc8/scout/attributes/default.rb:14
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/775f6c21c1fd22871c532dc8/scout/attributes/default.rb:15
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/775f6c21c1fd22871c532dc8/scout/attributes/default.rb:16
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/775f6c21c1fd22871c532dc8/scout/attributes/default.rb:17
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/775f6c21c1fd22871c532dc8/scout/attributes/default.rb:18
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/775f6c21c1fd22871c532dc8/scout/attributes/default.rb:19
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/775f6c21c1fd22871c532dc8/scout/attributes/default.rb:20
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/775f6c21c1fd22871c532dc8/scout/attributes/default.rb:21
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/775f6c21c1fd22871c532dc8/scout/attributes/default.rb:22
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/775f6c21c1fd22871c532dc8/scout/attributes/default.rb:23
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/775f6c21c1fd22871c532dc8/scout/attributes/default.rb:25
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/775f6c21c1fd22871c532dc8/scout/attributes/default.rb:26
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/775f6c21c1fd22871c532dc8/scout/libraries/scout.rb:6
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/775f6c21c1fd22871c532dc8/scout/libraries/scout.rb:7
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/775f6c21c1fd22871c532dc8/scout/libraries/scout.rb:9
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/775f6c21c1fd22871c532dc8/scout/libraries/scout.rb:10
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/775f6c21c1fd22871c532dc8/scout/libraries/scout.rb:17
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/775f6c21c1fd22871c532dc8/scout/libraries/scout.rb:25
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/775f6c21c1fd22871c532dc8/scout/libraries/scout.rb:45
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/775f6c21c1fd22871c532dc8/scout/recipes/default.rb:7
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/775f6c21c1fd22871c532dc8/scout/recipes/default.rb:13
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/775f6c21c1fd22871c532dc8/scout/recipes/default.rb:19
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/775f6c21c1fd22871c532dc8/scout/recipes/default.rb:20
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/775f6c21c1fd22871c532dc8/scout/recipes/default.rb:28
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/775f6c21c1fd22871c532dc8/scout/recipes/default.rb:36
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/775f6c21c1fd22871c532dc8/scout/recipes/default.rb:43
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/775f6c21c1fd22871c532dc8/scout/recipes/default.rb:47
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/775f6c21c1fd22871c532dc8/scout/recipes/default.rb:64
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/775f6c21c1fd22871c532dc8/scout/recipes/default.rb:65
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/775f6c21c1fd22871c532dc8/scout/recipes/default.rb:66
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/775f6c21c1fd22871c532dc8/scout/recipes/default.rb:67
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/775f6c21c1fd22871c532dc8/scout/recipes/default.rb:68
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/775f6c21c1fd22871c532dc8/scout/recipes/default.rb:69
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/775f6c21c1fd22871c532dc8/scout/recipes/default.rb:70
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/775f6c21c1fd22871c532dc8/scout/recipes/default.rb:71
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/775f6c21c1fd22871c532dc8/scout/recipes/default.rb:72
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/775f6c21c1fd22871c532dc8/scout/recipes/default.rb:89
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/775f6c21c1fd22871c532dc8/scout/recipes/default.rb:99
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/775f6c21c1fd22871c532dc8/scout/recipes/default.rb:114
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/775f6c21c1fd22871c532dc8/scout/templates/default/scout_rsa.pub.erb:1
FC001: Use strings in preference to symbols to access node attributes: /tmp/cook/775f6c21c1fd22871c532dc8/scout/templates/default/scout_shutdown.erb:3
FC002: Avoid string interpolation where not required: /tmp/cook/775f6c21c1fd22871c532dc8/scout/libraries/scout.rb:45
FC019: Access node attributes in a consistent manner: /tmp/cook/775f6c21c1fd22871c532dc8/scout/recipes/default.rb:131
FC023: Prefer conditional attributes: /tmp/cook/775f6c21c1fd22871c532dc8/scout/recipes/default.rb:89
FC024: Consider adding platform equivalents: /tmp/cook/775f6c21c1fd22871c532dc8/scout/recipes/default.rb:22