Version information
This version is compatible with:
- Puppet Enterprise 2023.2.x, 2023.1.x, 2023.0.x, 2021.7.x, 2021.6.x, 2021.5.x, 2021.4.x, 2021.3.x, 2021.2.x, 2021.1.x, 2021.0.x, 2019.8.x
- Puppet >= 6.21.0 < 8.0.0
- , , , , ,
Start using this module
Add this module to your Puppetfile:
mod 'maartenbeeckmans-zot', '0.2.0'Learn more about managing modules with a PuppetfileDocumentation
Zot
Module for installing and configuring the Zot registry
Table of Contents
Description
This module installs and configures the Zot container registry on RHEL/Ubuntu/Debian, either through OS repos or a binary release from Github.
Usage
include zot
Hiera
All referenced parameters have sensible defaults set via the in-module Hiera. These can be overridden by passing the parameters with the class declaration or through Hiera itself.
Installation
Install with URL
This module, by default, will attempt to download and install the v1.4.3 binary from Zot's releases page on Github.
The desired version to download can be tweaked by overriding zot::archive_download_version.
class {'zot':
archive_download_version => 'v2.0.0-rc1',
}
Alternatively, you can specify the full download URL instead with zot::archive_download_url.
class {'zot':
archive_download_url => 'https://github.com/project-zot/zot/releases/download/v1.4.3/zot-linux-arm64',
}
Install with package manager
Although the majority of popular distributions have yet to release a package, this module also provides support for downloading the application with the operating system's package manager.
class {'zot':
install_method => 'package',
}
Please note that the module will not manage package manager repositories.
Configuration
This module currently provides support for tweaking the following configuration directives:
- Distribution Specification version
- Network configuration
- Storage location and configuration
- Log location and verbosity
- lint, metrics, scrub, search and/or sync extensions
The module manages the YAML config file by utilizing the to_yaml function - embedded into this module - to convert Hashes to their YAML equivalent.
Beware that configuration key-value pairs are not validated by the module. Please refer to Zot's documentation for a list of supported options.
Specifying distribution specification version
class {'zot':
config_dist_spec_version => '1.0.1-dev',
}
HTTP listening address and port
Networking options can be defined by configuring the zot::config_http hash. An example with Hiera:
zot::config_http:
address: '0.0.0.0'
port: 5000
tls:
cert: 'path/to/server.cert'
key: 'path/to/server.key'
Filesystem storage
Same principle for the storage directive.
zot::config_storage:
rootDirectory: /var/lib/zot
commit: true
dedupe: true
gc: true
gcDelay: 1h
gcInterval: 24h
Extensions
Each individual extension can be configured with the module:
zot::config_extensions_lint:
enable: false
zot::config_extensions_metrics:
enable: false
zot::config_extensions_scrub:
enable: false
zot::config_extensions_search:
enable: false
zot::config_extensions_sync:
enable: false
Additional options
Please refer to REFERENCE.md for a complete list of configuration options. This includes, but is not limited to:
- The user to run the service
- Basic Systemd service management
- Sync credentials and file location
Reference
See REFERENCE.md
License
This module is licensed with Apache 2.0.
Reference
Table of Contents
Classes
Public Classes
zot: Main class, includes all other classes
Private Classes
zot::config: This class handles the zot configuration file.zot::install: This class handles zot packages.zot::service: This class handles the zot service
Functions
zot::to_yaml: https://github.com/puppetlabs/puppet-specifications/blob/master/language/func-api.md#the-4x-api
Classes
zot
Main class, includes all other classes
Examples
include zot
Parameters
The following parameters are available in the zot class:
archive_download_archarchive_download_basearchive_download_osarchive_download_urlarchive_download_versionbinary_pathconfig_dirconfig_dist_spec_versionconfig_epp_parametersconfig_epp_templateconfig_fileconfig_hashconfig_httpdata_dirconfig_logconfig_extensions_lintconfig_extensions_metricsconfig_extensions_scrubconfig_extensions_searchconfig_extensions_syncconfig_storagegidgroupinstall_methodlog_dirmanage_config_dirmanage_data_dirmanage_groupmanage_log_dirmanage_service_filemanage_servicemanage_sync_credentials_filemanage_userpackage_ensurepackage_nameservice_enableservice_ensureservice_epp_parametersservice_epp_templateservice_namesync_credentials_filesync_credentialsuiduser
archive_download_arch
Data type: String
Archictecture for the binary archive
archive_download_base
Data type: Stdlib::HTTPUrl
Base url for the binary archive
archive_download_os
Data type: String
OS for the binary archive
archive_download_url
Data type: Optional[Stdlib::HTTPUrl]
Optional alternative url for downloading the archive
archive_download_version
Data type: String
Verison for the binary archive
binary_path
Data type: Stdlib::Unixpath
Path where the binary should be/is installed
config_dir
Data type: Stdlib::Unixpath
Directory to place the configuration files
config_dist_spec_version
Data type: String
Dist spec version set in the configuration file
config_epp_parameters
Data type: Hash
Hash with parameters to hash to the custom epp file
config_epp_template
Data type: Optional[String]
Optional epp template for the configuration file
config_file
Data type: Stdlib::Unixpath
Full path to place the configuration file
config_hash
Data type: Optional[Hash]
Optional config hash that will be converted to yaml for the config file
config_http
Data type: Hash
Hash containing the http section in the config file
data_dir
Data type: Stdlib::Unixpath
Directory where to store the zot data
config_log
Data type: Hash
Hash containing the log section in the config file
config_extensions_lint
Data type: Optional[Hash]
Hash containing the lint extension configuration in the config file
config_extensions_metrics
Data type: Optional[Hash]
Hash containing the metrics extension configuration in the config file
config_extensions_scrub
Data type: Optional[Hash]
Hash containing the scrub extension configuration in the config file
config_extensions_search
Data type: Optional[Hash]
Hash containing the search extension configuration in the config file
config_extensions_sync
Data type: Optional[Hash]
Hash containing the sync extension configuration in the config file
config_storage
Data type: Hash
Hash containing the storage section in the config file
gid
Data type: Accounts::User::Uid
GID of the zot group
group
Data type: String
Name of the zot group
install_method
Data type: Enum['url', 'package', 'none']
Method to install zot Possible values: url, package or none
log_dir
Data type: Stdlib::Unixpath
Directory to store the zot logs
manage_config_dir
Data type: Boolean
Whether to manage the zot config_dir
manage_data_dir
Data type: Boolean
Whether to manage the zot data_dir
manage_group
Data type: Boolean
Whether to manage the zot group
manage_log_dir
Data type: Boolean
Whether to manage the zot log dir
manage_service_file
Data type: Boolean
Whether to manage the zot systemd service file
manage_service
Data type: Boolean
Whether to manage the zot service
manage_sync_credentials_file
Data type: Boolean
Whether to manage the sync credentials file
manage_user
Data type: Boolean
Whether to manage the zot user
package_ensure
Data type: String
Ensure parameter of the zot package resource
package_name
Data type: String
Name of the zot package resource
service_enable
Data type: Boolean
Determines if the service should be enabled
service_ensure
Data type: String
Ensure parameter of the zot service resource
service_epp_parameters
Data type: Hash
Hash with parameters to hash to the custom epp file
service_epp_template
Data type: Optional[String]
Optional epp template for the zot systemd service file
service_name
Data type: String
Name of the zot service
sync_credentials_file
Data type: Stdlib::Unixpath
Path to store the sync credentials file
sync_credentials
Data type: Hash
Content of the sync credentials file
uid
Data type: Accounts::User::Uid
UID of the zot user
user
Data type: String
Name of the zot user
Functions
zot::to_yaml
Type: Ruby 4.x API
https://github.com/puppetlabs/puppet-specifications/blob/master/language/func-api.md#the-4x-api
zot::to_yaml(Any $data, Optional[Integer] $depth, Optional[Hash] $options)
https://github.com/puppetlabs/puppet-specifications/blob/master/language/func-api.md#the-4x-api
Returns: Any Returns a String with the structured data in YAML format.
data
Data type: Any
The data that should be transformed to YAML.
depth
Data type: Optional[Integer]
Optional. An Integer which described the number of space characters used to indent.
options
Data type: Optional[Hash]
Optional. Pass a Hash of additional options. Refer to Ruby's psych library.
Dependencies
- puppetlabs/stdlib (>= 7.0.0 <= 8.5.0)
- puppet/systemd (>= 3.1.0 <= 4.0.1)
- puppet/archive (>= 4.3.0 <= 6.1.1)
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 2023 Maarten Beeckmans
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.