download_and_do
Version information
Start using this module
Add this module to your Puppetfile:
mod 'geoffwilliams-download_and_do', '0.9.2'Learn more about managing modules with a PuppetfileDocumentation
download_and_do
Table of Contents
- Description
- Usage - Configuration options and additional functionality
- Limitations - OS compatibility, etc.
- Development - Guide for contributing to the module
Description
Download files using puppet-archive, then either run directly or unpack and run a command.
Usage
Download, Extract, Run
include download_and_do
download_and_do::extract_and_run { "test.tar.gz":
source => "http://blah/cut/spec/fixtures/test.tar.gz",
run_relative => "cp test.txt /extract_and_run",
}
Download from source to title, then perform the command at run_relative. Pass the creates parameter to specify the presence of a file that means that the resource is already converged.
Local filename is a unique relative path within download and do download directory /var/cache/download_and_do.
Download, Run
include download_and_do
download_and_do::run { "test.sh":
source => "http://blah/cut/spec/fixtures/test.sh"
}
Download from source to title, then make the local file executable and run it. Pass the creates parameter to specify the presence of a file that means that the resource is already converged.
Local filename is a unique relative path within download and do download directory /var/cache/download_and_do.
Limitations
- Requires the puppet archive module
- You may encounter errors with
download_and_do::extract_and_runon windows due to shell quoting
Development
PRs accepted :)
Testing
This module supports testing using PDQTest.
Test can be executed with:
bundle install
bundle exec pdqtest all
See .travis.yml for a working CI example
Reference
Table of Contents
Classes
download_and_do: Create common directories and set defaults
Defined types
download_and_do::extract_and_run: Download a file, extract it and then run a command.download_and_do::run: Download a file and then run it
Classes
download_and_do
Download_and_do base class to make download directories and for for setting default resource parameters
Parameters on this class become defaults for download_and_do::run and download_and_do::extract_and_run defined resource types. See those classes for a detailed explanation
Parameters
The following parameters are available in the download_and_do class.
path
Data type: Variant[String, Array[String]]
PATH variable to use when running commands (from module hiera data)
base_dir
Data type: String
Parent directory for downloaded files (from module hiera data)
extract_dir
Data type: String
Directory to extract archives in (from module hiera data)
download_dir
Data type: String
Directory to download files to (from module hiera data)
provider
Data type: String
Shell provider to use (from module hiera data)
file_owner
Data type: String
Owner for directory used to cache files
file_group
Data type: Variant[Undef, String, Integer]
Group for directory used to cache files
path_separator
Data type: String
Path separator character to use on this OS
allow_insecure
Data type: Boolean
Disable certificate validation (from module hiera data)
Default value: false
file_mode
Data type: String
Mode for directory used to cache files
Default value: "0755"
Defined types
download_and_do::extract_and_run
Perfect for things like downloadable tarballs containing RPMs to install. The downloaded archive will be retained after running. Use the checksum to force a local update and reinstall
Examples
Download a tarball, extact it and run its install script
download_and_do::extract_and_run { "test.tar.gz":
source => "http://files.megacorp.com/testcase/spec/mock/test.tar.gz",
run_relative => "./install.sh",
download_dir => "/usr/download",
extract_dir => "/usr/extract",
}
Parameters
The following parameters are available in the download_and_do::extract_and_run defined type.
source
Data type: String
Location to download archive from
download_dir
Data type: String
Directory to download archive to if not using module default
Default value: $download_and_do::download_dir
local_file
Data type: String
Where to save the file (inside $download_dir)
Default value: $title
extract_dir
Data type: String
Directory to extract archive to
Default value: $download_and_do::extract_dir
checksum
Data type: Optional[String]
Checksum of local archive file to see if update needed (SHA1)
Default value: undef
run_relative
Data type: String
Commands to run (relative to Extract dir) after downloading
path
Data type: Variant[String, Array[String]]
PATH (array) to use when running command after extraction
Default value: $download_and_do::path
creates
Data type: Optional[String]
Presence of this file indicates we do not need to download or execute anything
Default value: undef
unless
Data type: Optional[String]
Pass-through parameter to exec to control whether to run or not
Default value: undef
onlyif
Data type: Optional[String]
Pass-through parameter to exec to control whether to run or not
Default value: undef
user
Data type: Optional[String]
User for file ownership and to run command with (not supported on windows)
Default value: undef
group
Data type: Optional[String]
Group for file ownership
Default value: undef
environment
Data type: Optional[Variant[String, Array[String]]]
Environment variables (BASH) to run command with
Default value: undef
allow_insecure
Data type: Boolean
Allow insecure HTTPS downloads
Default value: $download_and_do::allow_insecure
provider
Data type: String
Set the exec provider - needed as cd is a builtin. On windows you will need to set
powershell if you are attempting to download and execute powershell
Default value: $download_and_do::provider
timeout
Data type: Optional[Integer]
How long to wait before killing command we were told to run, in seconds.
Pass 0 to wait upto forever seconds for the command to complete
Default value: undef
proxy_server
Data type: Optional[String]
specify a proxy server, with port number if needed. ie: https://example.com:8080.
Default value: undef
proxy_type
Data type: Optional[String]
proxy server type (none|http|https|ftp)
Default value: undef
cleanup
Data type: Boolean
Remove extracted archive after download?
Default value: true
path_separator
Data type: String
Path separator character to use on this OS
Default value: $download_and_do::path_separator
download_and_do::run
Perfect for things like self-installing bash scripts. The script will be retained after running. Use the checksum to force a local update and reinstall
Examples
Download a test script and run it
download_and_do::run { "test2.sh":
source => "http://files.megacorp.com/testcase/spec/mock/test2.sh",
}
Parameters
The following parameters are available in the download_and_do::run defined type.
source
Data type: String
File to download
local_file
Data type: String
Where to save the file (inside $download_dir)
Default value: $title
download_dir
Data type: String
Drectory to download to instead of module default
Default value: $download_and_do::download_dir
path
Data type: Variant[String, Array[String]]
PATH to use for executing file
Default value: $download_and_do::path
checksum
Data type: Optional[String]
Checksum (SHA1) of file, used to detect updates
Default value: undef
creates
Data type: Optional[String]
Presence of this file indicates we do not need to download or execute anything
Default value: undef
unless
Data type: Optional[String]
Pass-through parameter to exec to control whether to run or not
Default value: undef
onlyif
Data type: Optional[String]
Pass-through parameter to exec to control whether to run or not
Default value: undef
user
Data type: Optional[String]
User for file ownership and to run command (not supported on windows)
Default value: undef
group
Data type: Optional[String]
Group for file ownership
Default value: undef
environment
Data type: Optional[Variant[String, Array[String]]]
Environment variables (BASH) to run command with
Default value: undef
arguments
Data type: String
Arguments to pass to the downloaded file to be run
Default value: ""
allow_insecure
Data type: Boolean
Allow insecure HTTPS downloads
Default value: $download_and_do::allow_insecure
provider
Data type: String
Set the exec provider - needed as cd is a builtin. On windows you will need to set
powershell if you are attempting to download and execute powershell
Default value: $download_and_do::provider
timeout
Data type: Optional[Integer]
How long to wait before killing command we were told to run, in seconds.
Pass 0 to wait upto forever seconds for the command to complete
Default value: undef
proxy_server
Data type: Optional[String]
specify a proxy server, with port number if needed. ie: https://example.com:8080.
Default value: undef
proxy_type
Data type: Optional[String]
proxy server type (none|http|https|ftp)
Default value: undef
path_separator
Data type: String
Path separator character to use on this OS
Default value: $download_and_do::path_separator
Dependencies
- puppetlabs-stdlib (>= 1.0.0)
- puppet-archive (3.2.0)
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "{}"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright {yyyy} {name of copyright owner}
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.