Chef cookbook for tar packages
Ruby
Latest commit 23450e4 Jun 28, 2017 @tas50 tas50 Testing updates
Signed-off-by: Tim Smith <tsmith@chef.io>

README.md

tar Cookbook

Build Status Cookbook Version

Installs tar and includes resources for managing remote tar files. tar_package handles remote source package compilation. tar_extract handles retrieving remote tar files and extracting them locally.

Resources

tar_package

A tar_package LWRP provides an easy way to download remote files and compile and install them. This only works for the most basic Autoconf programs that can do ./configure && make && make install.

Actions

  • :install: Installs the package

Properties

  • source: name attribute. The source remote URL.
  • prefix: Directory to be used as the --prefix configure flag.
  • source_directory: Directory to which source files are download.
  • creates: A file this command creates - if the file exists, the command will not be run.
  • configure_flags: Array of additional flags to be passed to ./configure.
  • archive_name: Specify a different name for the downloaded archive. Use it if the directory name inside the tar file is different than the name defined in the URL. Additionally, tar_package supports most remote_file attributes.

Example

tar_package 'http://pgfoundry.org/frs/download.php/1446/pgpool-3.4.1.tar.gz' do
  prefix '/usr/local'
  creates '/usr/local/bin/pgpool'
end

This will download, compile, and install the package from the given URL and install it into /usr/local.

tar_extract

A tar_extract LWRP provides an easy way to download remote tar files and extract them to a local directory.

Actions

  • :extract: Extracts the tar file from a url
  • :extract_local: Extracts the tar file from a local file path

Properties

  • source: name attribute. The source remote URL.
  • target_dir: Directory to extract into, e.g. tar xzf -C (target_dir)
  • download_dir: Directory to which tarball is downloaded (defaults to chef cache which requires root group and user).
  • creates: A file this command creates - if the file exists, the command will not be run.
  • compress_char: Flag for compression type, such as z for gzip. man tar for options.
  • tar_flags: Array of additional flags to be passed to tar xzf command.
  • group: Group name or group ID to extract the archive under. If set to non-root group, point to a download_dir the group has permission to access.
  • user: User name or user ID to extract the archive under. If set to non-root user, point to a download_dir the user has permission to access. Additionally, tar_extract supports most remote_file attributes.

Example

tar_extract 'http://dev.mycoderepo.com/artifacts/mycode-1.2.3.tar.gz' do
  target_dir '/opt/myapp/mycode'
  creates '/opt/myapp/mycode/lib'
  tar_flags [ '-P', '--strip-components 1' ]
end

This will download the tarball to cache, extract the contents to /opt/myapp/mycode, use the file '/opt/myapp/mycode/lib' to determine idempotency, and pass both '-P' and '--strip-components 1' flags to the tar xzf command.

tar_extract '/tmp/mycode-1.2.3.tar.gz' do
  action :extract_local
  target_dir '/opt/myapp/mycode'
  creates '/opt/myapp/mycode/lib'
end

This will extract the contents of /tmp/mycode-1.2.3.tar.gz to /opt/myapp/mycode and use the file '/opt/myapp/mycode/lib' to determine idempotency.

ChefSpec Matchers

ChefSpec matchers are defined for tar_package and tar_extract.

LICENSE AND AUTHOR

Author:: Nathan L Smith (nathan@cramerdev.com) Author:: George Miranda (gmiranda@chef.io) Author:: Mark Van de Vyver (mark@@taqtiqa.com)

Copyright 2011, Cramer Development, Inc. Copyright 2011, Opscode, Inc. Copyright 2013, TAQTIQA LLC.

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.