Version information
This version is compatible with:
- Puppet Enterprise 2018.1.x, 2017.3.x, 2017.2.x, 2017.1.x, 2016.5.x, 2016.4.x
- Puppet >= 4.0.0 < 6.0.0
Start using this module
Add this module to your Puppetfile:
mod 'gerardkok-reposado', '1.0.3'Learn more about managing modules with a PuppetfileDocumentation
reposado
Table of Contents
- Overview
- Module Description - What the module does and why it is useful
- Setup - The basics of getting started with reposado
- Usage - Configuration options and additional functionality
- Reference - An under-the-hood peek at what the module is doing and how
- Limitations - OS compatibility, etc.
- Development - Guide for contributing to the module
Overview
Installs Greg Neagle's Reposado (https://github.com/wdas/reposado) on an Ubuntu server. Reposado is an open-source macOS Software Update Server.
Module Description
This module sets up syncing of macOS updates through Reposado, and, optionally, an Apache vhost to allow for replication of those updates.
Setup
What reposado affects
- Make sure
base_diris large enough to be able to hold all updates (my server is currently holding 232 Gb worth of updates). reposado::apache_vhostincludespuppetlabs/apache.
Beginning with reposado
Minimal usage:
class { 'reposado': }
If you wish to enable the Apache vhost, you need to include the reposado::apache_vhost class:
class { 'reposado::apache_vhost': }
Usage
Example configuration through hiera:
reposado::base_dir: '/var/www/reposado'
reposado::document_root: "%{hiera('reposado::base_dir')}/html"
reposado::git_ensure: 'latest'
reposado::apple_catalogs:
- '10.10'
- '10.11'
reposado::apache_vhost::document_root: "%{alias('reposado::document_root')}"
reposado::apache_vhost::apple_catalogs: "%{alias('reposado::apple_catalogs')}"
Reference
The module uses puppetlabs/vcsrepo to clone https://github.com/wdas/reposado.
Parameters
reposado class
The reposado class takes the following:
user
The user that owns the Reposado files, both installed and downloaded, and runs the cron job. Default: 'reposado'.
group
All reposado files belong to this group. Default: 'reposado'.
base_dir
The directory that holds all Reposado related files and directories. Default: '/srv/reposado'.
document_root
The directory where all the downloads are cached, and that serves as document root for the webserver. Default 'base_dir/html'
metadata_dir
The directory wherre reposado stores its metadata. Default 'base_dir/metadata'
reposado_root
The directory the reposado git repository is cloned to. Default 'base_dir/reposado'
git_source
The git repository to clone Reposado from. Default: 'https://github.com/wdas/reposado'
git_ensure
How to clone the git repository. 'latest' keeps up with the latest revision, 'present' clones the repository, but does not keep up with the latest revision. Default: 'present'.
git_revision
Which revision to clone from the git repository. Default: undef (i.e. the HEAD revision).
cronjob_time
The time to run the sync cron job. Format: 'HH:MM', you can omit a leading '0' in 'HH'. Default: '0:30'.
cronjob_command
The cron job command to run. Default: 'reposado_root/code/repo_sync'. If you would like to remove deprecated updates by default, set this to 'reposado_root/code/repo_sync && reposado_root/code/repoutil --purge-product all-deprecated', for example.
server_name
Name of the server. Default: 'hostname.domain'.
manage_user
Whether puppet should manage user. Default: true.
manage_group
Whether puppet should manage group. Default: true.
manage_cronjob
Whether puppet should manage the sync cron job. Default: true.
packages
Packages that need to be installed by this module. Default: '['git', 'curl', 'python']'.
apple_catalogs
An array of operating system names, that specifies the Apple SUS catalog URLs to replicate. If left empty, this module follows the Reposado default, and replicates all available updates. The operating system names can be either the macOS version (e.g. '10.8', '10.10'), or its name (e.g. 'mountainlion', 'yosemite'). Names are lowercase, and without separating blanks, if more than one word. Default: '[]'.
additional_curl_options
Value of the 'AdditionalCurlOptions' key in Reposado's Preferences.plist configuration file. Default: '[]'.
preferred_localizations
Value of the 'PreferredLocalizations' key in Reposado's Preferences.plist configuration file. Default: '[]'.
curl_path
Value of the 'CurlPath' key in Reposado's Preferences.plist configuration file. Default: undef.
repo_sync_log_file
Value of the 'RepoSyncLogFile' key in Reposado's Preferences.plist configuration file. Default: undef.
human_readable_sizes
Value of the 'HumanReadableSizes' key in Reposado's Preferences.plist configuration file. Boolean, defaults to false.
reposado::apache_vhost class
user
The user that owns the document root. Default: 'reposado'.
group
All files in the document root belong to this group. Default: 'reposado'.
base_dir
The directory that holds all Reposado related files and directories. Default: '/srv/reposado'.
document_root
Path to the document root. Default: 'base_dir/html'.
server_name
Name of the server. Default: 'hostname.domain'.
server_port
Apache port for this vhost.
apple_catalogs
An array of operating system names, that specifies the Apple SUS catalog URLs to replicate. If left empty, this module follows the Reposado default, and replicates all available updates. The operating system names can be either the macOS version (e.g. '10.8', '10.10'), or its name (e.g. 'mountainlion', 'yosemite'). Names are lowercase, and without separating blanks, if more than one word. Default: '[]'.
Limitations
Currently tested on Ubuntu 14.04 and 16.04 only.
Development
Run rake spec to run all tests.
Release 1.0.3
- support for macOS 10.15 ('Catalina')
- PDK updated to 1.15.0
Release 1.0.2
- support for macOS 10.14 ('Mojave')
- PDK updated to 1.9.0
Release 1.0.1
- changed 'cronjob_time' from String to Regexp, and fixed documentation
- the default values for 'document_root', 'metadata_dir', 'reposado_root' and 'cronjob_command' now ultimately depend on 'base_dir', instead of their counterparts in params.pp
Release 1.0.0
Features
- puppet 4 support:
- added types
- migrated functions from legacy to modern Ruby API
- migrated erb to epp
- added 'document_root' parameter to both reposado and reposado::apache_vhost classes
- all parameters now have defaults in params.pp
- support for macOS High Sierra (10.13)
Bugfixes
- fixed catalog compilation error when user and/or group not managed
Release 0.2.1
Bugfixes
- fixed macOS Sierra rewrite missing from the vhost rewrites
- fixed 'open ended dependency warning' when running the tests
Release 0.2.0
Features
- added macOS Sierra support
- support for 'HumanReadableSizes' key in preferences.plist
- support for setting an apache port in the vhost
Bugfixes
- added rspec tests
- bugfixes for bugs found with the above
Release 0.1.0
Initial release.
Dependencies
- puppetlabs/stdlib (>= 1.0.0 < 6.0.0)
- puppetlabs/vcsrepo (>= 0.1.2 < 3.0.0)
- puppetlabs/apache (>= 1.3.0 < 5.0.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.