cookbook 'ark', '= 6.0.1'
Provides a custom resource for installing runtime artifacts in a predictable fashion
cookbook 'ark', '= 6.0.1', :supermarket
knife supermarket install ark
knife supermarket download ark
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
ark resource will:
- fetch it to to
- unpack it to the default path (
- create a symlink for
/usr/local/pig) pointing to path
- add specified binary commands to the environment
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
For remote files ark supports URLs using the remote_file resource. Local files are accessed with the
This cookbook is maintained by the Sous Chefs. The Sous Chefs are a community of Chef cookbook maintainers working together to maintain important cookbooks. If you’d like to know more please visit sous-chefs.org or come chat with us on the Chef Community Slack in #sous-chefs.
- openSUSE / SUSE Linux Enterprises
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 14+
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:
node['ark']['prefix_root']- default base location if the
prefix_rootis not passed into the resource. default:
node['ark']['prefix_bin']- default binary location if the
prefix_binis not passed into the resource. default:
node['ark']['prefix_home']- default home location if the
prefix_homeis not passed into the resource. default:
node['ark']['package_dependencies']- prerequisite system packages that need to be installed to support ark. default: varies based on platform
node['ark']['tar']- allows overriding the default path to the tar binary, which varies based on platform
node['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, runs
: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.
Relevant Attribute Parameters for :cherry_pick
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
Attribute Parameters for :dump
path: path to dump files to.
mode: file mode for
app_home, as 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.
Extract the archive to a specified path, does not create any symbolic links.
Attribute Parameters for :put
path: path to extract to.
append_env_path: boolean, if true, append the
./bindirectory of the extracted directory to the global
PATHvariable for all users.
name: name of the package, defaults to the resource name.
url: url for tarball,
.zipcurrently 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 to
mode: file mode for
app_home, is an integer.
prefix_root, for use with
prefix_home: default directory prefix for a friendly symlink to the path.
prefix_bin: default directory to place a symlink to a binary command.
/opt/maven-2.2.1/bin/mvn, where the
path: path to extract the ark to. The
:install*actions overwrite any user-provided values for
home_dir: symbolic link to the path
:prefix_root/:name-:version, does not apply to
has_binaries: array of binary commands to symlink into
/usr/local/bin/, you must specify the relative path.
[ 'bin/java', 'bin/javaws' ]
append_env_path: boolean, similar to
has_binariesbut less granular. If true, append the
./bindirectory of the extracted directory to. the
PATHenvironment 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.
environment: hash of environment variables to pass to invoked shell commands like
strip_components: number of components in path to strip when extracting archive. With default value of
1, ark strips the leading directory from an archive, which is the default for both
autoconf_opts: an array of command line options for use with the GNU
[ '--include=/opt/local/include', '--force' ]
make_opts: an array of command line options for use with
[ '--warn-undefined-variables', '--load-average=2' ]
owner: owner of extracted directory.
group: group of extracted directory.
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.
This example copies
/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
# 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
/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/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
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
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
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
This project exists thanks to all the people who contribute.
Thank you to all our backers!
Support this project by becoming a sponsor. Your logo will show up here with a link to your website.
|seven_zip >= 3.1|
ark Cookbook CHANGELOG
This file is used to list changes made in each version of the ark cookbook.
6.0.1 - 2021-06-01
6.0.0 - 2021-05-22
- Chef 17 updates: enable
unified_modeon all resources
- Bump required Chef Infra Client to >= 15.3
- Migrate to using
seven_zip_toolresource directly and require
- Various ChefSpec fixes
5.1.1 - 2021-04-29
- Added a version pin on seven_zip
5.1.0 - 2021-01-24
- Sous Chefs Adoption
- Standardise files with files in sous-chefs/repo-management
- Cookstyle fixes
- Add integration testing for Windows and MacOS
- Remove testing for Amazon Linux 201x, CentOS 6 and Ubuntu 16.04
- Fix ChefSpec tests
- Fix issues with
:cherry_pickaction on MacOS
/etc/profile.dexists on MacOS if
- Require Chef Infra Client 14+ and remove the need for the build_essential dependency - @tas50
- Use Ruby classes in resource properties - @tas50
- Simplify the platform check logic - @tas50
- Remove the .foocritic file - @tas50
- Remove long_description and recipe metadata - @tas50
- Expand testing - @tas50
- Remove Ubuntu 14.04 testing - @tas50
- Support append_env_path property on Windows, which increases the minimum required Chef release to Chef 13.4
- Remove ChefSpec matchers since these are autogenerated now
- Update specs to the latest platform versions
- Remove template out of defaults directory
- Remove dependency on the Windows cookbook
- Ensure the dependencies get installed on Chef 13 Amazon Linux systems
- Require Chef 12.7+ and remove action_class.class_eval usage
- Rewrite of resource to custom resources.
- Remove EOL platforms from testing.
- Update zlib URL
- Use Ohai root_group attribute to avoid trying to set the group to root on BSD/macOS.
- Add missing accessor for owner property
- Add detection of .7z file extensions
- Fix 7zip extraction using strip_components >= 1 to properly extract to the path instead of the user's home_dir
- Always quote the path to the 7zip and xcopy binaries as they may have spaces
- Clarified in the readme that the install_with_make action includes the configure action
- Fix files with very long paths failing to extract on Windows
- Fix default owner of 'root' failing on Windows
- Fix 7-zip extraction with long paths when strip_components is >= 1
- Add the group attribute parameter to README
- Fix package installation failure on macOS systems
- Use x to extract with 7-zip, not e. Use e only for dump, which strips directories.
- Move tar/7zip path logic out of attributes and into helpers to prevent failures when 7zip is not installed before the chef run starts
- Improve platform testing in Test Kitchen
- Recognize Windows as a supported platform in the readme
- Introduce a new attribute for overriding the 7-zip location: node['ark']['sevenzip_binary']
- Fix suse support and centos < 6
- Use multipackage installs to speed up installation
- Avoid installation package dependencies on Windows entirely
- Remove the testing bin stubs
- Add CentOS 7.2, Fedora 23, and Suse specs
- Add centos 5, debian, and opensuse travis testing
- Add a contributing doc
- Fix cookstyle warnings
- Require Chef 12.1+
- Create seven_zip unpack command when strip_components is 0 #155 (terkill)
- Get 7zip path from the windows registry. #153 (buri17)
- Use fullpath for xcopy and icacls. #152 (buri17)
- Define custom matcher helper for notification testing, fixes #139 #144 (szymonpk)
- Add support for RHEL 7
- Fixes to the readme to clarify actions / properties
- Expose the backup property in remote file to the ark resource
- Transfer the cookbook back to Chef
- Resolve all rubocop warnings
- Add maintainers files and Chef contributing docs
- Test on the latest platforms in .kitchen.yml and update Travis to use kitchen-dokken with additional platforms
- Remove a large number of zero byte archives that snuck into the repository
- Remove a Chef 10 compatibility check in the custom resource
- Added the pkg-config package to the debian platform family
- Added tar, xz-lzma-compat, and bzip2 packages to the RHEL and fedora platform families
- Updated FreeBSD to install gmake instead of make
- Added OS X, SmartOS, and FreeBSD to the tar path attributes to support those platforms
- Removed the has_binaries attribute from put action documentation in the readme file since this isn't supported there
- Moved the libraries module locations to no longer be under Opscode:: and broke out libraries into more logical units
- Fixed issues with spaces in Windows paths that could cause failures
- Fixed a bad attribute for the 7zip home on windows. Instead of using a node attribute use the value directly to avoid computed attribute overiding issues
- Switched from the 7-zip cookbook to seven_zip since the 7-zip cookbook is now deprecated
- Changed unzip commands to not use -u so that a newer archive can overwrite an existing directory
- Added support for actions py_setup, py_setup_install, py_setup_build
- Fixed setting home_dir attribute
- Added source_url and issues_url to the metadata.rb
- Expanded the supported platforms in metadata.rb
- Removed all references to Opscode
- Improved error logging when an unknown extension is encountered
- Added support for .tar files
Improved overall testing:
- Removed the kitchen.cloud.yml file and gem dependencies
- Added integration testing in Travis with Kitchen-Docker and Travis tests now run using the nightly build of ChefDK
- Expanded platforms tested in the .kitchen.yml file
- Updated the Gemfile with the latest testing dependencies
- Added full Chefspec coverage
- Greatly expanded the ark_spec test cookbook
- Removed the original minitests
Added standard Chef .gitignore and chefignore files
Resolved a large number of rubocop warnings
Removed old Opscode contributing and testing docs
Added a cookbook version badge to the readme
Removed the Toftfile
- [COOK-3642] Add Windows support
- [COOK-4514] - Support for SLES with the Ark cookbook
- [COOK-2771] - Add support for XZ compression
- [COOK-4477] - Fix failing test suite
- [COOK-4484] - Replace strip_leading_dir attribute with more general strip_components
- [COOK-4437] - configure and install_with_make should chown after unpack
[COOK-3786] - Unable to install multiple versions of archive without duplication
- COOK-4288 - Cleanup the Kitchen
- COOK-4264 - Add node['ark']['package_dependencies'] to allow tuning packages.
- COOK-3854 - Capability with mac_os_x: '/bin/chown' - No such file or directory
- Cleaning up some style for rubucop
- Updating test harness
- COOK-3539 - Allow dumping of bz2 and gzip files
- COOK-3191 - Propogate unzip failures
- COOK-3118 - Set cookbook attribute in provider
- COOK-3055 - Use proper scope in helper module
- COOK-3054 - Fix notification resource updating
- COOK-3179 - README updates and refactor
- [COOK-3087]: Can't use ark with chef < 11
only_ifstatements in ark's
install_with_makeand configure actions are not testing for file existence correctly.
- [COOK-3067]: ark kitchen test for
cherry_pickis expecting the binary to be in the same parent folder as in the archive.
- [COOK-3048]: Ark provider contains a
ruby_blockresource without a block attribute
- [COOK-3063]: Ark cookbook
cherry_pickaction's unzip command does not close if statement
- [COOK-3065]: Ark install action does not symlink binaries correctly
- Update the README to reflect the requirement for Chef 11 to use the ark resource (
- Making this a release so it will also appear on the community site page.
- [COOK-2772]: Ark cookbook has foodcritic failures in provides/default.rb
- [COOK-2520]: Refactor ark providers to use the '
use_inline_resources' LWRP DSL feature
- [COOK-2335] - ark resource broken on Chef 11
- [COOK-2026] - Allow
cherry_pickaction to be used for directories as well as files
- [COOK-1593] - README formatting updates for better display on Community Site
- dangling "unless"
- add vagrantfile
- add foodcritic test
- travis.ci support
v0.0.10 (May 23, 2012
strip_leading_dirnot working for zip files https://github.com/bryanwb/chef-ark/issues/19
- use autogen.sh to generate configure script for configure action https://github.com/bryanwb/chef-ark/issues/16
- support more file extensions https://github.com/bryanwb/chef-ark/pull/18
- add extension attribute which allows you to download files which do not have the file extension as part of the URL