goggot / canaryboard

Status application with REST API

CanaryBoard

Description

This app lets you inform people about the status of services you provide and projects you're responsible for. Clean installation has a superuser account with admin:admin credentials; be sure to change it after first login.

While Rails can be installed on many operating systems, we've include detailed instructions for installing on Ubuntu 12.04 LTS.

Configuration of Linux Instance

You'll need to first download and install Ubuntu 12.04 LTS. To do this, go to Ubuntu.

Installing Rails on Ubuntu 12.04 LTS

After you've installed Ubuntu, follow the instructions below (which were adpated from digitalocean)

1. sudo apt-get update
2. sudo apt-get -y install curl nodejs git libxslt-dev libxml2-dev
3. \curl -L https://get.rvm.io | bash -s stable
4. source ~/.rvm/scripts/rvm
5. rvm requirements
6. rvm install 1.9.3
7. rvm use 1.9.3 --default
8. rvm rubygems current
9. gem install rails

Installing CanaryBoard

Now that you've intalled Ruby and other packages, you will install CanaryBoard on this instance.

1. git clone https://github.com/stelligent/canaryboard.git
2. cd canaryboard
3. bundle install
4. bundle exec rake db:setup
5. bundle exec rake db:test:prepare
6. bundle exec rspec spec/
7. rails s

Running CanaryBoard

1. Launch and web browser and type http://[hostname]:3000
2. Login to the application using the default credentials (admin:admin).

Using CanaryBoard

After your CanaryBoard Rails app is up and running, you can use the examples here:

• set-indicators.rb - You can customize set-indicators.rb (making the appropriate changes to API_URL and API_KEY)
• update-indicators.rb - You can customize and update-indicators.rb (making the appropriate changes to API_URL and API_KEY).
• You can also view api-usage-example to update the status indicators for projects and services

(Note: if you're having trouble running the scripts, you may need to run them as sudo. It shouldn't be necessary but has gotten some people around issues.)

More Information

For more information, you can read the Agile DevOps: Build a DevOps dashboard from IBM developerWorks on using CanaryBoard.

LICENSE

The MIT License (MIT)

Copyright (c) 2013 Stelligent Systems LLC

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 NONINFRINGEMENT. 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.