Adoptable Cookbooks List

Looking for a cookbook to adopt? You can now see a list of cookbooks available for adoption!
List of Adoptable Cookbooks

Supermarket Belongs to the Community

Supermarket belongs to the community. While Chef has the responsibility to keep it running and be stewards of its functionality, what it does and how it works is driven by the community. The chef/supermarket repository will continue to be where development of the Supermarket application takes place. Come be part of shaping the direction of Supermarket by opening issues and pull requests or by joining us on the Chef Mailing List.

Select Badges

Select Supported Platforms

RSS

lita (15) Versions 0.1.0

Installs/configures the Lita chatbot

Berkshelf/Librarian
Policyfile
Knife
cookbook 'lita', '= 0.1.0'
cookbook 'lita', '= 0.1.0', :supermarket
knife cookbook site install lita
knife cookbook site download lita
README
Dependencies
Changelog
Quality

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.

Key Type Description Default
name String Name of chatbot Lita Chatbot
mention_name String Name chatbot listens for Value of name
version String Gemfile-style version dependency of lita to install nil (latest)
config_coookbook String Name of cookbook where config template stored lita (current)
config_template String Name of config template file lita_config.rb.erb
locale String/Symbol Language to use ":en"
log_level String/Symbol Locale ":info"
admin Array of Strings Adapter specific IDs of Lita admins empty
adapters Array of Strings/Symbols Adapters to use for Lita instance [:shell]
adapter_versions Hash of Fixed Versions of adapter to use { :shell => nil } (latest)
adapter_config Hash of Hashes Hashes of adapter specific configurations empty
plugins Array of Strings and/or Hashes List of plugins to install and, optionally, Gemfile line options empty
plugin_config Hash of Hashes Hash of plugin specific configuration empty
gems Array of Strings and/or Hashes List of gems to install and, optionally, Gemfile line options empty
packages Array of Strings List of system packages to install SSL related stuff
http_host String IP address to bind http server 0.0.0.0
http_port Numeric Port to bind http server 8080
http_min_threads Numeric Min number of http threads 0
http_max_threads Numeric Max number of http threads 0
redis_host String IP address of redis instance 127.0.0.1
redis_port Numeric Port of redis instance 6379
install_dir String Lita home directory /opt/lita
log_dir String Lita log directory /opt/lita/logs
run_dir String Lita var/run directory /opt/lita/run
daemon_user String User to run daemon as nobody
ruby_install_type String How to install ruby depedency auto
redis_install_type String How to install redis depedency auto

Important Note

It turns out that creating a valid ruby file from Chef attributes is trickier than I originally thought. Attributes can be added to the node object via JSON strings (node attributes or environment/role in JSON form) or Ruby methods (wrapper cookbooks or the ruby version of environments/roles). There is a library file called helpers.rb which includes the typecast method which is used in the lita_config.rb.erb template to build out valid ruby configuration.

This method is new and I've tested it with contrived data. However, if you find a situation that doesn't work, you can can create a wrapper cookbook and set the config_cookbook and config_template attributes to your own template. Then be sure to notify me through GitHub issues and I'll attempt to adjust the method to support whatever case I missed.

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 bin/lita

Adapter Configuration

The adapter config now supports complex ruby data types (i.e. hashes, hash of arrays, etc.)

Plugins

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

default["lita"]["plugins"] = [
  "ping",
  { "jenkins" => ">= 0.0.1" }
  { "foo" => ">= 1.2.3, :git => 'git://github.com/foo/foo.git'" }
  { "bar" => ":path => '/path/to/local/plugin/lita-bar'" }
]

The above example has four different ways to install / manage plugins:

  • the latest version of the lita-ping plugin from rubygems.org
  • the version greater than 0.0.1 of lita-jenkins plugin from rubygems.org
  • the repository for foo-lita from git want having version greater than or equal to 1.2.3 (This could be public or private depending on whether the node/user has access to git.)
  • A local plugin called 'lita-bar' on the filesystem of the lita node found at the path /path/to/local/plugin/lita-bar

Plugin Configuration

The plugins can also be configured with complex data types in ruby or json:

default["lita"]["plugin_config"] = {
  "foo" => {
    "bar" => {
      "key1" => "val1"
    }
  }
}
{
  "lita": {
    "plugin_config": {
      "foo": {
        "bar": {
          "key1": "val1"
        }
      }
    }
  }
}

It can even take a string that looks like a hash and convert it appropriately:

{
  "lita": {
    "plugin_config": {
      "foo": "{ \"bar\": { \"key1\": \"val1\" } }"
    }
  }
}

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": {
    "adapters": ["hipchat"],
    "adapter_config": {
      "hipchat": {
        "jid": "99999_0000000@chat.hipchat.com",
        "password": "sekret1",
        "rooms": ":all",
        "muc_domain": "conf.hipchat.com"
      }
    },
    "gems": {
      "pagerduty-sdk", ":git => \"https://github.com/kryptek/pagerduty-sdk.git\""
    },
    "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"
      }
    }
}

License and Authors

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.

Dependent cookbooks

redis2 ~> 0.5.0
ruby-ng ~> 0.1.1
build-essential >= 0.0.0
apt >= 0.0.0

Contingent cookbooks

There are no cookbooks that are contingent upon this one.

v0.1.0 (2014-12-02)

  • [#10] - Breaking change. Supports new config.adapters for Lita v4+. Older versions of Lita will likely not work anymore.
  • Changed these attribute names and class types to make them plural. ["lita"]["adapters"] and ["lita"]["adapter_versions"]

v0.0.4 (2014-09-29)

  • [#3] - Runs bundler as the daemon user but also does some backflips to try to ensure a little degree of security
  • [#5] - Using su instead of sudo and writes out console output to daemon.log
  • [#6] - Full embracing of the hack to try to and rubyify strings and/or normal ruby attributes into the ruby config
  • Added the exit code in the init script but I don't think it helps alot. I think most failures happen after lita has backgrounded itself.

v0.0.3 (2014-08-12)

  • Added the rest of the standard Lita attributes (mention name and http properties) (issue #2)
  • Added new "gems" attribute to add in custom gem setups. This allowed me to remove the pagerduty-sdk logic in the Gemfile.erb
  • Turned the package installation into an attribute so native packages can be added as needed by adapter or handlers
  • Fixed single/double quote stuff in the recipe. I'm not very consistent with that stuff

v0.0.2 (2014-07-23)

  • Initial version

Foodcritic Metric
            

0.1.0 passed this metric