Skip to content
Pull request Compare This branch is 129 commits ahead, 498 commits behind chef:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
..
Failed to load latest commit information.
attributes
libraries
recipes
README.md
metadata.rb

README.md

Overview

An '''ark''' is like an archive but '''Kewler''

Does the fetch-unpack-configure-build-install dance. This is a modified verion of Infochimps awesome install_from cookbook [http://github.com/infochimps-cookbooks/install_from]. The main ark is fairly complex as it encompasses a lot of functionality. Simpler LWRPs such as ark_put, ark_dump, and ark_extract have been added.

Given a project pig, with url http://apache.org/pig/pig-0.8.0.tar.gz, and the default :path of /usr/local, this provider will

  • fetch it to to /var/cache/chef/
  • unpack it to :path (/usr/local/pig-0.8.0)
  • create a symlink for :home_dir (/usr/local/pig) pointing to :path
  • add specified binary commands to the enviroment PATH variable

By default, the ark will not run again if the :path is not empty. You can specify a more granular condition by using :creates whose existence in :path indicates that the ark has already been unpacked. This is useful when you use several arks to deposit libraries in a common directory like /usr/local/lib/ or /usr/local/share/tomcat/lib

At this time ark only handles files available from URLs. It does not handle local files.

Attributes

You can customize the basic attributes to meet your organization's conventions

Resources/Providers

  • ark_put: extract a tarball to a directory that matches the name of the resource, simplest case
  • ark_dump: strips all directory paths and dumps files to a specified path. Creates that path if it doesn't exist. (Zip only)
  • ark_cherry_pick: extract a specified file from tarball and place it in the specified path
  • ark: the macdaddy or extractors, opinionated unpacker and installer

Actions for all LWRPs

  • :install: extracts the file and makes a symlink of requested
  • :remove: removes the extracted directory and related symlink #TODO

ark_put

Attribute Parameters

  • url: url for tarball, .tar.gz, .bin (oracle-specific), .war, and .zip currently supported.
  • owner: owner of extracted directory, set to "root" by default
  • path: path to extract to, defaults to
  • checksum: sha256 checksum, used for security
  • has_binaries: array of binary commands to symlink to /usr/local/bin/, you must specify the relative path example: [ 'bin/java', 'bin/javaws' ]
  • append_env_path: boolean, if true, append the ./bin directory of the extracted directory to the global PATH variable for all users
  • mode: file mode for app_home, is an integer

ark_dump

NOTE: This currently only works for zip archives

Attribute Parameters

  • url: url for tarball, .tar.gz, .bin (oracle-specific), .war, and .zip currently supported.
  • path: path to dump files to
  • owner: owner of extracted directory, set to "root" by default
  • mode: file mode for app_home, is an integer
  • creates: if you are appending files to a given directory, ark needs a condition to test whether the file has already been extracted. You can specify with creates, a file whose existence indicates the ark has previously been extracted and does not need to be extracted again

ark_cherry_pick

Attribute Parameters

  • url: url for tarball, .tar.gz, .bin (oracle-specific), .war, and .zip currently supported.
  • owner: owner of extracted directory, set to "root" by default
  • path: directory to place file in
  • file: specific file to cherry-pick, defaults to resource name
  • mode: file mode for app_home, is an integer

ark

Attribute Parameters

  • name: name of the package, defaults to the resource name
  • url: url for tarball, .tar.gz, .bin (oracle-specific), .war, and .zip currently supported. Also supports special syntax :name:version:apache_mirror: that will auto-magically construct download url from the apache mirrors site
  • version: software version, required
  • checksum: sha256 checksum, used for security
  • path: path for installation, defaults to /usr/local/
  • mode: file mode for app_home, is an integer TODO
  • path: path to extract the ark to, by default is or /usr/local/-
  • home_dir: symbolic link to the path /usr/local/
  • has_binaries: array of binary commands to symlink to /usr/local/bin/, you must specify the relative path example: [ 'bin/java', 'bin/javaws' ]
  • append_env_path: boolean, similar to has_binaries but less granular
    • If true, append the ./bin directory of the extracted directory to the PATH environment variable for all users, does this by placing a file in /etc/profile.d/ which will be read by all users be added to the path. The commands are symbolically linked to /usr/bin/* . Examples are mvn, java, javac, etc. This option provides more granularity than the boolean option
  • autoconf_opts: an array of command line options for use with the GNU autoconf script
  • make_opts: an array of command line options for use with make
  • owner: owner of extracted directory, set to "root" by default

Examples

 # install Apache Ivy dependency resolution tool
 ark "ivy" do
   url 'http://someurl.example.com/ivy.tar.gz'
   version '2.2.0'        
   checksum '89ba5fde0c596db388c3bbd265b63007a9cc3df3a8e6d79a46780c1a39408cb5'
 end

This example copies ivy.tar.gz to /var/cache/chef/ivy-2.2.0.tar.gz, unpacks its contents to /usr/local/ivy-2.2.0/ -- stripping the leading directory, and symlinks /usr/local/ivy to /usr/local/ivy-2.2.0

 ark 'jdk' do
   url 'http://download.oracle.com/jdk-7u2-linux-x64.tar.gz'
   version '7.2'
   path "/usr/local/jvm/"
   home_dir    "/usr/local/jvm/default" 
   checksum  '89ba5fde0c596db388c3bbd265b63007a9cc3df3a8e6d79a46780c1a39408cb5'
   append_env_path true
   owner 'foobar'
 end

This example copies jdk-7u2-linux-x64.tar.gz to /var/cache/chef/jdk-7.2.tar.gz, unpacks its contents to /usr/local/jvm/jdk-7.2/ -- stripping the leading directory, symlinks /usr/local/jvm/default to /usr/local/jvm/jdk-7.2, and adds /usr/local/jvm/jdk-7.2/bin/ to the global PATH for all users. The user 'foobar' is the owner of the /usr/local/jvm/jdk-7.2 directory

 # install Apache Ivy dependency resolution tool
 # in <path>/resource_name in this case
 # /usr/local/ivy, no symlink created
 # it does strip any leading directory if one exists
 ark_put "ivy" do
    url 'http://someurl.example.com/ivy.tar.gz'
    checksum '89ba5fde0c596db388c3bbd265b63007a9cc3df3a8e6d79a46780c1a39408cb5'
 end

 # install Apache Ivy dependency resolution tool
 # in /home/foobar/ivy 
 # it does strip any leading directory if one exists
 ark_put "ivy" do
   path "/home/foobar/
   url 'http://someurl.example.com/ivy.tar.gz'
   checksum '89ba5fde0c596db388c3bbd265b63007a9cc3df3a8e6d79a46780c1a39408cb5'
 end



 # strip all directories and dump files into path specified by 
 # the path attribute, you must specify the `creates` attribute
 # in order to keep the extraction from running every time
 # the directory path will be created if it doesn't already exist
 ark_dump "my_jars"
   url  "http://example.com/bunch_of_jars.zip"
   path "/usr/local/tomcat/lib"
   creates "mysql.jar"
   owner "tomcat"       
 end

 # extract specific files from a tarball, currently only handles
 # one named file
 ark_cherry_pick 'mysql-connector-java' do
   url 'http://oracle.com/mysql-connector.zip'
   file 'mysql-connector-java-5.0.8-bin.jar'
   path '/usr/local/tomcat/lib'
 end

License and Author

Author:: Philip (flip) Kromer - Infochimps, Inc (coders@infochimps.com) Author:: Bryan W. Berry (bryan.berry@gmail.com) Copyright:: 2011, Philip (flip) Kromer - Infochimps, Inc copyright:: 2012, Bryan W. Berry

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.

Something went wrong with that request. Please try again.