Cloudify's Hubot
This repository contains Cloudify's configuration of Github's Hubot based on a Vagrantfile to load Hubot in Virtualbox and AWS.
Prereqs:
- For running the bot in AWS - vagrant and vagrant aws plugin
- For running the bot in virtualbox - vagrant and... guess!
IRC-Flowdock Relay Configuration
the vagrant/provision.sh file contains the following environment variables:
- HUBOT_FLOWDOCK_IRC_FLOWID
- HUBOT_FLOWDOCK_IRC_CHANNEL
- HUBOT_FLOWDOCK_IRC_SERVER
- HUBOT_FLOWDOCK_IRC_RELAY_CLIENT
- HEARTBEAT_INTERVAL
- HEARTBEAT_ENABLED
- HEARTBEAT_FLOWID
You can change these if necessary.
For more explanation on each ENV VAR, see here.
Running Hubot
To load the machine and run hubot:
Setup the environment variables
You must set the following environment variables on your local machine:
- HUBOT_FLOWDOCK_LOGIN_EMAIL
- HUBOT_FLOWDOCK_LOGIN_PASSWORD
If you're running on AWS, set the following variables as well:
- AWS_ACCESS_KEY_ID
- AWS_ACCESS_KEY
Running Hubot
Note: When loading the AWS machine, the default bot name is "bot". When loading the VBOX machine, the default name is "testbot". These are setup in advance. You can change the defaults there by changing the TEST_BOT_NAME and BOT_NAME variables in the Vagrantfile.
AWS
vagrant up hubot_aws --provider=aws
Virtualbox - for testing purposes
vagrant up
Upgrading Hubot
For now, vagrant destroy and vagrant up must be run to replace hubot unless you wanna upgrade manually (which is kind of a drag). We'll eventually come up with an upgrade process.
Writing New Scripts
You can write scripts in either JS or CoffeeScript. You can use this to convert from JS to Coffee and back.
After you've written your script, put it under the scripts
dir and add the name of the script to hubot-scripts.json.
NOTE: YOU DON'T HAVE TO CONVERT TO COFFEE! JS ALSO WORKS!
You can then vagrant up
and test that your script is working.
Let the Ops (yes, Ops, not DevOps) team know that you're done so that the new code can be deployed in our Hubot server.
Testing that the bot is actually running
By default, a heartbeat will be sent to the 'Cloudify3' flow stating that the Flowdock-IRC relay is up and running. You can also ping the bot by writing @BOTNAME ping. If everything is ok, it will return 'PONG'.
From Github:
Hubot
This is a version of GitHub's Campfire bot, hubot. He's pretty cool.
This version is designed to be deployed on Heroku. This README was generated for you by hubot to help get you started. Definitely update and improve to talk about your own instance, how to use and deploy, what functionality he has, etc!
Testing Hubot Locally
You can test your hubot by running the following.
% bin/hubot
You'll see some start up output about where your scripts come from and a prompt.
[Sun, 04 Dec 2011 18:41:11 GMT] INFO Loading adapter shell
[Sun, 04 Dec 2011 18:41:11 GMT] INFO Loading scripts from /home/tomb/Development/hubot/scripts
[Sun, 04 Dec 2011 18:41:11 GMT] INFO Loading scripts from /home/tomb/Development/hubot/src/scripts
Hubot>
Then you can interact with hubot by typing hubot help
.
Hubot> hubot help
Hubot> animate me <query> - The same thing as `image me`, except adds a few
convert me <expression> to <units> - Convert expression to given units.
help - Displays all of the help commands that Hubot knows about.
...
Scripting
Take a look at the scripts in the ./scripts
folder for examples.
Delete any scripts you think are useless or boring. Add whatever functionality you
want hubot to have. Read up on what you can do with hubot in the Scripting Guide.
Redis Persistence
If you are going to use the redis-brain.coffee
script from hubot-scripts
(strongly suggested), you will need to add the Redis to Go addon on Heroku which requires a verified
account or you can create an account at Redis to Go and manually
set the REDISTOGO_URL
variable.
% heroku config:set REDISTOGO_URL="..."
If you don't require any persistence feel free to remove the
redis-brain.coffee
from hubot-scripts.json
and you don't need to worry
about redis at all.
Adapters
Adapters are the interface to the service you want your hubot to run on. This can be something like Campfire or IRC. There are a number of third party adapters that the community have contributed. Check Hubot Adapters for the available ones.
If you would like to run a non-Campfire or shell adapter you will need to add
the adapter package as a dependency to the package.json
file in the
dependencies
section.
Once you've added the dependency and run npm install
to install it you can
then run hubot with the adapter.
% bin/hubot -a <adapter>
Where <adapter>
is the name of your adapter without the hubot-
prefix.
hubot-scripts
There will inevitably be functionality that everyone will want. Instead of adding it to hubot itself, you can submit pull requests to hubot-scripts.
To enable scripts from the hubot-scripts package, add the script name with
extension as a double quoted string to the hubot-scripts.json
file in this
repo.
external-scripts
Tired of waiting for your script to be merged into hubot-scripts
? Want to
maintain the repository and package yourself? Then this added functionality
maybe for you!
Hubot is now able to load scripts from third-party npm
packages! To enable
this functionality you can follow the following steps.
- Add the packages as dependencies into your
package.json
npm install
to make sure those packages are installed
To enable third-party scripts that you've added you will need to add the package
name as a double quoted string to the external-scripts.json
file in this repo.
Deployment
% heroku create --stack cedar
% git push heroku master
% heroku ps:scale app=1
If your Heroku account has been verified you can run the following to enable and add the Redis to Go addon to your app.
% heroku addons:add redistogo:nano
If you run into any problems, checkout Heroku's docs.
You'll need to edit the Procfile
to set the name of your hubot.
More detailed documentation can be found on the deploying hubot onto Heroku wiki page.
Deploying to UNIX or Windows
If you would like to deploy to either a UNIX operating system or Windows. Please check out the deploying hubot onto UNIX and deploying hubot onto Windows wiki pages.
Campfire Variables
If you are using the Campfire adapter you will need to set some environment variables. Refer to the documentation for other adapters and the configuraiton of those, links to the adapters can be found on Hubot Adapters.
Create a separate Campfire user for your bot and get their token from the web UI.
% heroku config:set HUBOT_CAMPFIRE_TOKEN="..."
Get the numeric IDs of the rooms you want the bot to join, comma delimited. If
you want the bot to connect to https://mysubdomain.campfirenow.com/room/42
and https://mysubdomain.campfirenow.com/room/1024
then you'd add it like this:
% heroku config:set HUBOT_CAMPFIRE_ROOMS="42,1024"
Add the subdomain hubot should connect to. If you web URL looks like
http://mysubdomain.campfirenow.com
then you'd add it like this:
% heroku config:set HUBOT_CAMPFIRE_ACCOUNT="mysubdomain"
Restart the bot
You may want to get comfortable with heroku logs
and heroku restart
if you're having issues.