Skip to content

Latest commit

 

History

History
148 lines (123 loc) · 4.37 KB

README.md

File metadata and controls

148 lines (123 loc) · 4.37 KB
Raw

dashing Cookbook

Installs Dashing and configures dashboards to run as services.

Tested with Ubuntu 12.04.

License

MIT License

Requirements

In order to use the Dashing cookbook, you need to have Ruby installed, and some sort of JavaScript engine.

Dashing is written in Ruby, and requires Ruby to run. In order to make your installation as flexible as possible, the Dashing cookbook does not explicitly install Ruby; you can have a system-wide ruby installed, or use rvm or rbenv to install Ruby. If you are not using a globally accessible version of ruby, or don't want to use the system default, then set node["dashing"]["ruby_env"] to a set of bash commands to set up your environment appropriately. (e.g. `'source /etc/profile.d/rvm.sh && rvm use ruby-1.9.3-p385')

Dashing also requires a JavaScript framework installed, as it relies on execjs to compile coffee-script widgets. We recommend using node.js, but you can use whatever you like. As with Ruby, there exists a node["dashing"]["js_env"] attribute you can use to set up your javascript enviroment (e.g. 'source /usr/local/src/nvm/nvm.sh && nvm use v0.8.16')

Attributes

dashing::default

Key Type Description Default
["dashing"]["ruby_env"] String Bash commands to set up ruby environemnt. ""
["dashing"]["js_env"] String Bash commands to set up js environemnt. ""
["dashing"]["dashing_exec"] String Used to explicitly locate the dashing executable.. "dashing"
["dashing"]["user"] String The user to run dashboards as. dashing
["dashing"]["group"] String The group to run dashboards as. dashing
["dashing"]["service_type"] String The service type to install dashboards as. "upstart" on ubuntu, "init.d" otherwise

LWRPs

See "Usage" below for examples.

dashing_dashboard

Actions:

  • :nothing - Standard do-nothing action.
  • :create - Creates a service which runs the given dashboard automatically at system startup. This will also run bundle in the dashboard's directory. If the dashboard already is configured as a service, :create will not restart it.
  • :restart - Like :create, but this will always restart the service - handy if you're going to use notifies on whatever resource you're using to deploy your dashboard.
  • :delete - Stops and removes the service for a dashboard. This won't actually delete the directory the dashboard is stored in.

Attributes:

  • path - The path to the dashboard (if not specified, the name of the resource is used.)
  • port - Optional - The port to run the thin webserver on. Note that dashing has no security, so some sort of firewall is recommended. Defaults to 8080.
  • service_type - Optional - Defaults to node["dashing"]["service_type"], although you can use this if, for some crazy reason, you want some of your dashboards to be managed by upstart, and some by init.d.

Usage

Including dashing in your node's run_list will install Dashing:

{
  "name":"my_node",
  "run_list": [
    "recipe[dashing]"
  ]
}

This cookbook also provides the dashing_dashboard LWRP for setting up dashboards as system services:

# Install dashing
include_recipe 'dashing'

# Fetch our dashboard from git
git "/opt/dashing/my_dashboard" do
    repository "git://github.com/benbria/dashboard.git"
    reference "master"
    action :sync
end

# Configure the dashboard as a service.
dashing_dashboard "/opt/dashing/my_dashboard" do
    action :restart
    port 9090
end

Contributing

Fork and pull request, please! :)

License and Authors

Authors: