lita-cookbook

Installs and configures the lita chatbot.

Supported Platforms

• Ubuntu
  • 12.04 (precise)
  • 14.04 (precise)

It will likely work on other Ubuntu versions, however the automatic methods of installing ruby and redis will have issues.

Tunable Attributes

All tunable attributes are in the lita heirarchy.

Important Note

Many of the configuration elements (particularly in adapter or plugins) require symbols instead of strings. Since:

• The cookbook is using Chef templates (ERB) to generate more ruby AND
• ERB calls to_s on variables in the template

you'll need to put your items that should be symbols in as strings For example:

default["lita"]["adapter"] = ":shell"

For the adapter and plugin config the template will try to detect strings that begin with : and not quote them in the lita_config.rb.

Usage

lita::default

Installs and configures the lita chatbot.

Configuration

Adapter

To make this effective you'll need to choose a non-default adapter from the Lita plugin page. The :shell adapter will not startup in daemon mode so the only way to test with it is to spin up a node, change into the node["lita"]["install_dir"] and run lita

Adapter Configuration

The adapter config is simply key/value pairs. If you need more complicated ruby configuratino (as some adapters do) you'll likely want to create a wrapper cookbook and set the config_cookbook and config_template attributes to your own template.

Plugins

Plugins can be listed in an arry or, optionally listed as an array of hashes using plugin name as the key and Gemfile dependency syntax:

default["lita"]["plugins"] = [
  "ping",
  { "jenkins" => ">= 0.0.1" }
]

Plugin Configuration

The plugins can be configured with a hash of hashes that are keyed off the plugin name:

default["lita"]["plugin_config"] = {
  "jenkins" => {
    "url" => "http://test.com"
    "auth" => "user1:sekret"
  }
}

Ruby and Redis

Lita requires recent versions of Ruby and Redis. By default, the lita cookbook will automatically try to find appropriate ruyb and redis versions for your platform and version.

To install those dependencies yourself, simple set the install type attributes to none as such:

node.default["lita"]["ruby_install_type"] = "none"
node.default["lita"]["redit_install_type"] = "none"

If these versions don't work for you (or the cookbook doesn't currently support your platform/version), you can manage the installation of ruby and redis yourself through various methods:

• Add ruby and redis using community cookbooks in your node/role run_list
• Creating a wrapper cookbook that does the same
• Using a base image that already includes the dependencies

The only requirement for the lita cookbook is that ruby, gem and bundler are in the system path and provide the appropriate versions to work with lita.

Example

Here's an example node configuration for leveraging lita-hipchat:

{
  "lita": {
    "adapter": "hipchat",
    "adapter_config": {
      "jid": "99999_0000000@chat.hipchat.com",
      "password": "sekret1",
      "rooms": ":all",
      "muc_domain": "conf.hipchat.com"
    }
  },
    "plugins": [
      "jenkins",
      "pagerduty",
      "cron",
      "dig",
      "youtube",
      "xkcd",
      "jenkins",
      "wikipedia"
    ],
    "plugin_config": {
      "jenkins": {
        "url": "http://jenkins.notreally.com/",
        "auth": "lita:sekret1"
      },
      "pagerduty": {
        "api_key": "kkkkkkkkkkkkkkkkkkkkkk",
        "subdomain": "notreally"
      }
    }
}

TODO

• Remove Pagerduty Hack - The lita-pagerduty plugin depends on the gem pagerduty-sdk. The current version of pagerduty-sdk on rubygems.org has a bad dependency listed in it. (It references activesupport as active_support.) However, it has been fixed in Github since Feb 25, but not released. More info. As such, the Gemfile will detect if pagerduty is in the plugin list and pull the pagerduty-sdk directly from Github instead of rubygems.org.

License and Authors

• Author:: Harlan Barnes (hbarnes@pobox.com)

Copyright:: 2014 Harlan Barnes

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.