Vendor the external cookbooks
Knife-Zero doesn't include Berkshelf support, so vendoring everything in the repo is convenient again
This commit is contained in:
103
cookbooks/poise-archive/README.md
Normal file
103
cookbooks/poise-archive/README.md
Normal file
@@ -0,0 +1,103 @@
|
||||
# Poise-Archive Cookbook
|
||||
|
||||
[](https://travis-ci.org/poise/poise-archive)
|
||||
[](https://rubygems.org/gems/poise-archive)
|
||||
[](https://supermarket.chef.io/cookbooks/poise-archive)
|
||||
[](https://codecov.io/github/poise/poise-archive)
|
||||
[](https://gemnasium.com/poise/poise-archive)
|
||||
[](https://www.apache.org/licenses/LICENSE-2.0)
|
||||
|
||||
A [Chef](https://www.chef.io/) cookbook to unpack file archives.
|
||||
|
||||
It supports `.tar`, `.tar.gz`, `.tar.bz2`, and `.zip` archive files.
|
||||
|
||||
## Quick Start
|
||||
|
||||
To download an unpack and archive:
|
||||
|
||||
```ruby
|
||||
poise_archive 'https://example.com/myapp.tgz' do
|
||||
destination '/opt/myapp'
|
||||
end
|
||||
```
|
||||
|
||||
## Requirements
|
||||
|
||||
Chef 12.1 or newer is required.
|
||||
|
||||
## Platforms
|
||||
|
||||
This cookbook supports all platforms (including Windows) but some Unix platforms
|
||||
(Solaris, AIX) may see very slow tar file unpacking when using the pure-Ruby fallback
|
||||
implementation.
|
||||
|
||||
## Resources
|
||||
|
||||
### `poise_archive`
|
||||
|
||||
The `poise_archive` resource unpacks file archives.
|
||||
|
||||
```ruby
|
||||
poise_archive '/tmp/myapp-1.2.0.tar' do
|
||||
destination '/srv/myapp-1.2.0'
|
||||
end
|
||||
```
|
||||
|
||||
A URL can also be passed as the source path, optionally with extra properties to
|
||||
be merged with `source_properties`.
|
||||
|
||||
```ruby
|
||||
poise_archive 'http://example.com/myapp-1.2.0.zip' do
|
||||
destination '/srv/myapp-1.2.0'
|
||||
end
|
||||
|
||||
poise_archive ['http://example.com/myapp-1.2.0.zip', {headers: {'Authentication' => '...'}}] do
|
||||
destination '/srv/myapp-1.2.0'
|
||||
end
|
||||
```
|
||||
|
||||
#### Actions
|
||||
|
||||
* `:unpack` – Unpack the archive. *(default)*
|
||||
|
||||
#### Properties
|
||||
|
||||
* `path` – Path to the archive. If relative, it is taken as a file inside
|
||||
`Chef::Config[:file_cache_path]`. If a URL, it is downloaded to a cache file
|
||||
first. *(name attribute)*
|
||||
* `destination` – Path to unpack the archive to. If not specified, the path of
|
||||
the archive without the file extension is used. Required when unpacking from
|
||||
a URL. *(default: auto)*
|
||||
* `group` – Group to run the unpack as.
|
||||
* `keep_existing` – Keep existing files in the destination directory when
|
||||
unpacking. *(default: false)*
|
||||
* `source_properties` – Property key/value pairs to be applied to the
|
||||
`remote_file` file resource when downloading a URL. *(default: {retries: 5})*
|
||||
* `strip_components` – Number of intermediary directories to skip when
|
||||
unpacking. Works like GNU tar's `--strip-components`. *(default: 1)*
|
||||
* `user` – User to run the unpack as.
|
||||
|
||||
## Sponsors
|
||||
|
||||
Development sponsored by [Bloomberg](http://www.bloomberg.com/company/technology/).
|
||||
|
||||
The Poise test server infrastructure is sponsored by [Rackspace](https://rackspace.com/).
|
||||
|
||||
## License
|
||||
|
||||
Copyright 2016-2017, Noah Kantrowitz
|
||||
|
||||
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.
|
||||
|
||||
BZip2 implementation is based on RBzip2. Copyright Sebastian Staudt, Brian Lopez.
|
||||
RBzip2 code used under the terms of the new BSD license.
|
||||
Reference in New Issue
Block a user