<a name="title"></a> Homesick Chef Cookbook

<a name="description"></a> Description

Chef library cookbook to manage Homesick castle repositories.

<a name="usage"></a> Usage

Simply include recipe[homesick] in your run_list and the homesick_repo
resource will be available.

To use recipe[homesick::data_bag], include it in your run_list and have a
data bag called "users" with an item for your user like the following:

{
  "id"  : "wigglebottom",
  "homesick_castles"  : [
    { "name"    : "dotvim",
      "source"  : "git://github.com/fnichol/dotvim.git"
    },
    { "name"    : "dotfiles",
      "source"  : "git://github.com/fnichol/dotfiles.git",
      "action"  : "update"
    }
  ]
}

The data bag recipe will iterate through a list of usernames defined in
node['users'] and attempt to pull in the homesick information from the data
bag item. In other words, having:

node['users'] = ['hsolo']

will set up the hsolo user's castles and not use the wigglebottom user.

<a name="requirements"></a> Requirements

<a name="requirements-chef"></a> Chef

Tested on 11.4.4 but newer and older version should work just fine.
File an issue if this isn't the case.

<a name="requirements-platform"></a> Platform

The following platforms have been tested with this cookbook, meaning that the
recipes run on these platforms without error:

• ubuntu
• debian
• centos
• scientific
• mac_os_x
• suse
• openbsd

Please report any additional platforms so they can be added.

<a name="requirements-cookbooks"></a> Cookbooks

This cookbook depends on the following external cookbooks:

• git

<a name="installation"></a> Installation

Depending on the situation and use case there are several ways to install
this cookbook. All the methods listed below assume a tagged version release
is the target, but omit the tags to get the head of development. A valid
Chef repository structure like the Opscode repo is also assumed.

<a name="installation-site"></a> From the Opscode Community Site

To install this cookbook from the Community Site, use the knife command:

knife cookbook site install homesick

<a name="installation-berkshelf"></a> Using Berkshelf

Berkshelf is a cookbook dependency manager and development
workflow assistant. To install Berkshelf:

cd chef-repo
gem install berkshelf
berks init

To use the Community Site version:

echo "cookbook 'homesick'" >> Berksfile
berks install

Or to reference the Git version:

repo="fnichol/chef-homesick"
latest_release=$(curl -s https://api.github.com/repos/$repo/git/refs/tags \
| ruby -rjson -e '
  j = JSON.parse(STDIN.read);
  puts j.map { |t| t["ref"].split("/").last }.sort.last
')
cat >> Berksfile < 'git://github.com/$repo.git', :branch => '$latest_release'
END_OF_BERKSFILE
berks install

<a name="installation-librarian"></a> Using Librarian-Chef

Librarian-Chef is a bundler for your Chef cookbooks.
To install Librarian-Chef:

cd chef-repo
gem install librarian
librarian-chef init

To use the Community Site version:

echo "cookbook 'homesick'" >> Cheffile
librarian-chef install

Or to reference the Git version:

repo="fnichol/chef-homesick"
latest_release=$(curl -s https://api.github.com/repos/$repo/git/refs/tags \
| ruby -rjson -e '
  j = JSON.parse(STDIN.read);
  puts j.map { |t| t["ref"].split("/").last }.sort.last
')
cat >> Cheffile < 'git://github.com/$repo.git', :ref => '$latest_release'
END_OF_CHEFFILE
librarian-chef install

<a name="recipes"></a> Recipes

<a name="recipes-default"></a> default

This recipe is a no-op and does nothing.

Use this recipe when you only want access to the homesick_castle LWRP.

<a name="recipes-data-bag"></a> data_bag

Fetches an list of homesick castles with data drawn from a data bag. The
default data bag is "users" and the list of user accounts to iterate through
is set on node['users'].

Use this recipe when you want data bag driven data in your workflow.

<a name="attributes"></a> Attributes

<a name="attributes-data-bag-name"></a> data_bag_name

The data bag name containing a group of user account information. This is used
by the data_bag recipe to use as a database of user accounts. The default is
"users".

<a name="attributes-user-array-node-attr"></a> user_array_node_attr

The node attributes containing an array of users to be managed. If a nested
hash in the node's attributes is required, then use a / between subhashes.
For example, if the users' array is stored in node['system']['accounts']),
then set node['homesick']['user_array_node_attr'] to "system/accounts".

The default is "users".

<a name="attributes-gem-version"></a> gem_version

The version of the Homesick gem to install.

The default is "~> 0.7.0"
(pending upstream PR #40).

<a name="lwrps"></a> Resources and Providers

<a name="lwrps-castle"></a> homesick_castle

<a name="lwrps-castle-actions"></a> Actions

<table>
<thead>
<tr>
<th>Action</th>
<th>Description</th>
<th>Default</th>
</tr>
</thead>
<tbody>
<tr>
<td>install</td>
<td>Clones the castle and symlinks it.</td>
<td>Yes</td>
</tr>
<tr>
<td>update</td>
<td>Pulls updates for the castle and re-symlinks it.</td>
<td> </td>
</tr>
</tbody>
</table>

<a name="lwrps-castle-attributes"></a> Attributes

<table>
<thead>
<tr>
<th>Attribute</th>
<th>Description</th>
<th>Default Value</th>
</tr>
</thead>
<tbody>
<tr>
<td>name</td>
<td><b>Name attribute:</b> The name of the homesick castle.</td>
<td><code>nil</code></td>
</tr>
<tr>
<td>user</td>
<td>The user using the castle.</td>
<td><code>nil</code></td>
</tr>
<tr>
<td>source</td>
<td>The clone URL (http, https, git, etc.) of the castle.</td>
<td><code>nil</code></td>
</tr>
</tbody>
</table>

<a name="lwrps-castle-examples"></a> Examples

Install a Castle

homesick_castle 'dotvim' do
  user    'wigglebottom
  source  'git://github.com/fnichol/dotvim.git'
end

Note: the install action is the default.

Pull Updates for a Castle

homesick_castle 'dotfiles' do
  user    'wigglebottom
  source  'git://github.com/fnichol/dotfiles.git'
  action  :update
end

<a name="development"></a> Development

• Source hosted at GitHub
• Report issues/Questions/Feature requests on GitHub Issues

Pull requests are very welcome! Make sure your patches are well tested.
Ideally create a topic branch for every separate change you make.

<a name="license"></a> License and Author

Author:: Fletcher Nichol (fnichol@nichol.ca)

Copyright 2011, Fletcher Nichol

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.