Data

Tools

Indexes

Applications

Experiments

Awesome

An open API service indexing awesome lists of open source software.

https://github.com/fnichol/chef-homesick

Chef library cookbook to manage Homesick castle repositories.
https://github.com/fnichol/chef-homesick

Last synced: 2 months ago
JSON representation

Chef library cookbook to manage Homesick castle repositories.

Awesome Lists containing this project

README 

        
#  Homesick Chef Cookbook



[![Build Status](https://travis-ci.org/fnichol/chef-homesick.png?branch=master)](https://travis-ci.org/fnichol/chef-homesick)



##  Description



Chef library cookbook to manage [Homesick][homesick] castle repositories.



* Website: http://fnichol.github.io/chef-homesick/

* Opscode Community Site: http://community.opscode.com/cookbooks/homesick

* Source Code: https://github.com/fnichol/chef-homesick



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



##  Requirements



###  Chef



Tested on 11.4.4 but newer and older version should work just fine.

File an [issue][issues] if this isn't the case.



###  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][issues] any additional platforms so they can be added.



###  Cookbooks



This cookbook depends on the following external cookbooks:



* [git][git_cb]



##  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][chef_repo] is also assumed.



###  From the Opscode Community Site



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



    knife cookbook site install homesick



###  Using Berkshelf



[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



###  Using Librarian-Chef



[Librarian-Chef][librarian] 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



##  Recipes



###  default



This recipe is a no-op and does nothing.



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



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



##  Attributes



###  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"`.



###  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"`.



###  gem_version



The version of the Homesick gem to install.



The default is `"~> 0.7.0"`

(pending [upstream PR #40](https://github.com/technicalpickles/homesick/pull/40)).



##  Resources and Providers



###  homesick_castle



###  Actions



  

    

      Action

      Description

      Default

    

  

  

    

      install

      Clones the castle and symlinks it.

      Yes

    

    

      update

      Pulls updates for the castle and re-symlinks it.

       

    

  



###  Attributes



  

    

      Attribute

      Description

      Default Value

    

  

  

    

      name

      Name attribute: The name of the homesick castle.

      nil

    

    

      user

      The user using the castle.

      nil

    

    

      source

      The clone URL (http, https, git, etc.) of the castle.

      nil

    

  



####  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



##  Development



* Source hosted at [GitHub][repo]

* Report issues/Questions/Feature requests on [GitHub Issues][issues]



Pull requests are very welcome! Make sure your patches are well tested.

Ideally create a topic branch for every separate change you make.



##  License and Author



Author:: [Fletcher Nichol][fnichol] () [![endorse](http://api.coderwall.com/fnichol/endorsecount.png)](http://coderwall.com/fnichol)



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.



[berkshelf]:    http://berkshelf.com/

[chef_repo]:    https://github.com/opscode/chef-repo

[cheffile]:     https://github.com/applicationsonline/librarian/blob/master/lib/librarian/chef/templates/Cheffile

[git_cb]:       http://community.opscode.com/cookbooks/git

[homesick]:     https://github.com/technicalpickles/homesick

[librarian]:    https://github.com/applicationsonline/librarian#readme



[fnichol]:      https://github.com/fnichol

[repo]:         https://github.com/fnichol/chef-homesick

[issues]:       https://github.com/fnichol/chef-homesick/issues