This cookbook provides ark
, a resource for managing software archives. It manages the fetch-unpack-configure-build-install process common to installing software from source, or from binary distributions that are not fully fledged OS packages.
This cookbook started its life as a modified version of Infochimp's install_from cookbook. It has since been heavily refactored and extended to meet different use cases.
Given a simple project archive available at a url:
ark 'pig' do
url 'http://apache.org/pig/pig-0.8.0.tar.gz'
end
The ark
resource will:
- fetch it to to
/var/cache/chef/
- unpack it to the default 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 environment
PATH
variable
By default, the ark will not run again if the :path
is not empty. Ark provides many actions to accommodate different use cases, such as :dump
, :cherry_pick
, :put
, and :install_with_make
.
At this time ark only handles files available from URLs using the remote_file provider. It does handle local files using the file://
protocol.
- Debian/Ubuntu
- RHEL/CentOS/Scientific/Oracle
- Fedora
- FreeBSD
- SmartOS
- Mac OS X
- openSUSE / SUSE Linux Enterprises
- Windows
Should work on common Unix/Linux systems with typical userland utilities like tar, gzip, etc. May require the installation of build tools for compiling from source, but that installation is outside the scope of this cookbook.
- Chef 12.7+
- build-essential
- seven_zip
Customize the attributes to suit site specific conventions and defaults.
node['ark']['apache_mirror']
- if the URL is an apache mirror, use the attribute as the default. default:http://apache.mirrors.tds.net
node['ark']['prefix_root']
- default base location if theprefix_root
is not passed into the resource. default:/usr/local
node['ark']['prefix_bin']
- default binary location if theprefix_bin
is not passed into the resource. default:/usr/local/bin
node['ark']['prefix_home']
- default home location if theprefix_home
is not passed into the resource. default:/usr/local
node['ark']['package_dependencies']
- prerequisite system packages that need to be installed to support ark. default: varies based on platformnode['ark']['tar']
- allows overriding the default path to the tar binary, which varies based on platformnode['ark']['sevenzip_binary']
- allows overriding the default path to the 7zip binary, which is determined based on registry key value
ark
- does the extract/build/configure
:install
: extracts the file and creates a 'friendly' symbolic link to the extracted directory path:configure
: configure ahead of the install action:install_with_make
: extracts the archive to a path, runsconfigure
,make
, andmake install
.:dump
: strips all directories from the archive and dumps the contained files into a specified path:cherry_pick
: extract a specified file from an archive and places in specified path:put
: extract the archive to a specified path, does not create any symbolic links:remove
: removes the extracted directory and related symlink #TODO:setup_py
: runs the command "python setup.py" in the extracted directory:setup_py_build
: runs the command "python setup.py build" in the extracted directory:setup_py_install
: runs the command "python setup.py install" in the extracted directory
Extract a specified file from an archive and places in specified path.
path
: directory to place file in.creates
: specific file to cherry-pick.
Strips all directories from the archive and dumps the contained files into a specified path.
NOTE: This currently only works for zip archives
-
path
: path to dump files to. -
mode
: file mode forapp_home
, as an integer.- Example:
0775
- Example:
-
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.
Extract the archive to a specified path, does not create any symbolic links.
-
path
: path to extract to.- Default:
/usr/local
- Default:
-
append_env_path
: boolean, if true, append the./bin
directory of the extracted directory to the globalPATH
variable for all users.
-
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, defaults to1
. -
mode
: file mode forapp_home
, is an integer. -
prefix_root
: defaultprefix_root
, for use with:install*
actions. -
prefix_home
: default directory prefix for a friendly symlink to the path.- Example:
/usr/local/maven
->/usr/local/maven-2.2.1
- Example:
-
prefix_bin
: default directory to place a symlink to a binary command.- Example:
/opt/bin/mvn
->/opt/maven-2.2.1/bin/mvn
, where theprefix_bin
is/opt/bin
- Example:
-
path
: path to extract the ark to. The:install*
actions overwrite any user-provided values for:path
.- Default:
/usr/local/<name>-<version>
for the:install
,:install_with_make
actions
- Default:
-
home_dir
: symbolic link to the path:prefix_root/:name-:version
, does not apply to:dump
,:put
, or:cherry_pick
actions.- Default:
:prefix_root/:name
- Default:
-
has_binaries
: array of binary commands to symlink into/usr/local/bin/
, you must specify the relative path.- Example:
[ 'bin/java', 'bin/javaws' ]
- Example:
-
append_env_path
: boolean, similar tohas_binaries
but less granular. If true, append the./bin
directory of the extracted directory to. thePATH
environment variable for all users, by placing a file in/etc/profile.d/
. The commands are symbolically linked into/usr/bin/*
. This option provides more granularity than the boolean option.- Example:
mvn
,java
,javac
, etc.
- Example:
-
environment
: hash of environment variables to pass to invoked shell commands liketar
,unzip
,configure
, andmake
. -
strip_components
: number of components in path to strip when extracting archive. With default value of1
, ark strips the leading directory from an archive, which is the default for bothunzip
andtar
commands. -
autoconf_opts
: an array of command line options for use with the GNUautoconf
script.- Example:
[ '--include=/opt/local/include', '--force' ]
- Example:
-
make_opts
: an array of command line options for use withmake
.- Example:
[ '--warn-undefined-variables', '--load-average=2' ]
- Example:
-
owner
: owner of extracted directory.- Default:
root
- Default:
-
group
: group of extracted directory.- Default:
root
- Default:
-
backup
: The number of backups to be kept in /var/chef/backup (for UNIX- and Linux-based platforms) or C:/chef/backup (for the Microsoft Windows platform). Set to false to prevent backups from being kept.- Default:
5
- Default:
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
# install Apache Ivy dependency resolution tool
ark "ivy" do
url 'http://someurl.example.com/ivy.tar.gz'
version '2.2.0'
checksum '89ba5fde0c596db388c3bbd265b63007a9cc3df3a8e6d79a46780c1a39408cb5'
action :install
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:
ark 'jdk' do
url 'http://download.example.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
Install Apache Ivy dependency resolution tool in /resource_name
in this case /usr/local/ivy
, do not symlink, and strip any leading directory if one exists in the tarball:
ark "ivy" do
url 'http://someurl.example.com/ivy.tar.gz'
checksum '89ba5fde0c596db388c3bbd265b63007a9cc3df3a8e6d79a46780c1a39408cb5'
action :put
end
Install Apache Ivy dependency resolution tool in /home/foobar/ivy
, strip any leading directory if one exists, don't keep backup copies of ivy.tar.gz
:
ark "ivy" do
path "/home/foobar"
url 'http://someurl.example.com/ivy.tar.gz'
checksum '89ba5fde0c596db388c3bbd265b63007a9cc3df3a8e6d79a46780c1a39408cb5'
action :put
backup false
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 "my_jars" do
url "http://example.com/bunch_of_jars.zip"
path "/usr/local/tomcat/lib"
creates "mysql.jar"
owner "tomcat"
action :dump
end
Extract specific files from a tarball (currently only handles one named file):
ark 'mysql-connector-java' do
url 'http://oracle.com/mysql-connector.zip'
creates 'mysql-connector-java-5.0.8-bin.jar'
path '/usr/local/tomcat/lib'
action :cherry_pick
end
Build and install haproxy and use alternative values for prefix_root
, prefix_home
, and prefix_bin
:
ark "haproxy" do
url "http://haproxy.1wt.eu/download/1.5/src/snapshot/haproxy-ss-20120403.tar.gz"
version "1.5"
checksum 'ba0424bf7d23b3a607ee24bbb855bb0ea347d7ffde0bec0cb12a89623cbaf911'
make_opts [ 'TARGET=linux26' ]
prefix_root '/opt'
prefix_home '/opt'
prefix_bin '/opt/bin'
action :install_with_make
end
You can also supply the file extension in case the file extension can not be determined by the URL:
ark "test_autogen" do
url 'https://github.com/zeromq/libzmq/tarball/master'
extension "tar.gz"
action :install_with_make
end
- Author: Philip (flip) Kromer - Infochimps, Inc(coders@infochimps.com)
- Author: Bryan W. Berry (bryan.berry@gmail.com)
- Author: Denis Barishev (denis.barishev@gmail.com)
- Author: Sean OMeara (someara@chef.io)
- Author: John Bellone (jbellone@bloomberg.net)
- Copyright: 2011, Philip (flip) Kromer - Infochimps, Inc
- Copyright: 2012, Bryan W. Berry
- Copyright: 2012, Denis Barishev
- Copyright: 2013-2017, Chef Software, Inc
- Copyright: 2014, Bloomberg L.P.
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.