Version information
This version is compatible with:
- Puppet Enterprise 2023.8.x, 2023.7.x, 2023.6.x, 2023.5.x, 2023.4.x, 2023.3.x, 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
- Puppet >= 7.0.0 < 9.0.0
- , ,
Start using this module
Add this module to your Puppetfile:
mod 'markt-thumbor', '2.3.0'Learn more about managing modules with a PuppetfileDocumentation
puppet-thumbor
Table of Contents
Overview
Puppet module to deploy and manage Thumbor.
Requirements
- A supported version of Puppet
- A platform/distribution where Python 3.8+ is readily available
- Only Thumbor 7+ is supported
- EPEL repositories on RHEL-based distributions
Usage
Basic usage
Install Thumbor in your environment:
class { 'thumbor':
ports => [ '8000' ],
security_key => 'AAAAABBBBCCCCC111112222233333',
}
Next run a simple test on the same machine to verify that Thumbor is working as expected:
curl -v http://localhost:8000/unsafe/200x200/https%3A%2F%2Fgithub.com%2Fthumbor%2Fthumbor%2Fraw%2Fmaster%2Fexample.jpg
It is also supported to run multiple instances and to customize various installation parameters:
class { 'thumbor':
config => {
'AUTO_WEBP' => true,
'ENGINE_THREADPOOL_SIZE' => 4,
'HTTP_LOADER_MAX_CLIENTS' => 1024,
},
listen => '127.0.0.1',
ports => [ '8000', '8001', '8002' ],
security_key => 'AAAAABBBBCCCCC111112222233333',
version => '7.0.9',
}
Python venv
It is possible to run Thumbor in a Python venv and configure various aspects of the Python installation:
class { 'thumbor':
manage_python => true,
ports => [ '8000' ],
python_config => {
version => 'python3',
pip => 'present',
dev => 'present',
venv => 'present',
},
security_key => 'AAAAABBBBCCCCC111112222233333',
update_enabled => true,
venv_path => '/opt/thumbor_venv',
}
This configuration will also automatically update the Python venv to the specified version (if necessary).
Plugins
Additional Thumbor plugins may also be installed via PIP:
class { 'thumbor':
plugins => [ 'opencv-python', 'tc_aws', 'thumbor_spaces' ],
...
}
Updating Thumbor
When using the default configuration, the module will only install the currently available version of Thumbor. In order to update Thumbor, the $version parameter must be changed:
class { 'thumbor':
version => '7.1.0',
update_enabled => true,
...
}
The value is directly passed through to the pip defined type. All values supported by this defined type may be used.
Reference
Classes and parameters are documented in REFERENCE.md.
Development
Contributing
Please use the GitHub issues functionality to report any bugs or requests for new features. Feel free to fork and submit pull requests for potential contributions.
Reference
Table of Contents
Classes
Public Classes
thumbor: Install and configure Thumbor
Private Classes
thumbor::config: Setup configuration files for Thumborthumbor::install: Install packages and dependencies for Thumborthumbor::python: Manage the Python installationthumbor::service: Manage Thumbor system service and instancesthumbor::upgrade: Upgrade Thumbor's Python venvthumbor::user: Setup users and groups for Thumbor
Defined types
thumbor::service::systemd: Setup a Thumbor service instance
Classes
thumbor
Install and configure Thumbor
Parameters
The following parameters are available in the thumbor class:
additional_packagesconfigconfig_dirensuregrouppluginslistenmanage_epelmanage_groupmanage_pythonmanage_userpathpackage_namepackage_ensurepip_providerpip_proxyserverportspython_configsecurity_keystatefileupdate_enableduserversionvenv_path
additional_packages
Data type: Array
Specifies a list of additional packages that are required for thumbor or any of it's dependencies.
config
Data type: Hash
The configuration for Thumbor. Note the hash keys will be converted to upper case. You can refer to Thumbor wiki for configuration options: https://github.com/thumbor/thumbor/wiki/Configuration
config_dir
Data type: Stdlib::Absolutepath
Thumbor configuration files are stored in this directory if venv is not used
ensure
Data type: Enum['present', 'absent']
Controls the installation and removal of application components (files, user, group), default present
group
Data type: String
Name of the group to install (optional) and under which we run the thumbor service, default thumbor
plugins
Data type: Variant[Array[String],String]
Thumbor plugins to install via PIP
listen
Data type: String
Host address to listen on, default 127.0.0.1
manage_epel
Data type: Boolean
If EPEL should be enabled on RHEL-based distributions.
manage_group
Data type: Boolean
If we control the installation of the group, default true
manage_python
Data type: Boolean
If we control the installation of Python, default true
manage_user
Data type: Boolean
If we control the installation of the user, default true
path
Data type: String
Specifies the content of the PATH environment variable when running commands.
package_name
Data type: String
Package name of the thumbor application as found in pip, default thumbor
package_ensure
Data type: Enum['present', 'absent', 'latest']
Control the ensure on additional pip installations, default $ensure ('present')
pip_provider
Data type: Optional[String]
The version of pip to use.
pip_proxyserver
Data type: Optional[String]
The full url (including credentials) to a proxy server or undef to not use one at all, default undef
ports
Data type: Variant[Array[String],String]
Array of port strings to let thumbor listen on. This also controls how many instances are spinned up. Default: [ '8000' ]
python_config
Data type: Hash
Config for Python that should be used (if $manage_python is enabled)
security_key
Data type: Optional[String]
Security key to use in thumbor, default undef
statefile
Data type: String
This file contains the version information, it is internally used to determine if a venv upgrade is necessary
update_enabled
Data type: Boolean
Whether to automatically update the Python venv if necessary. Note that updates of the Thumbor PIP are controlled by the $version parameter.
user
Data type: String
Name of the user to install (optional) and under which we run the thumbor service, default thumbor
version
Data type: String
Version of Thumbor that should be installed, default 'present'
venv_path
Data type: Optional[Stdlib::Absolutepath]
If we use virtualenv (false if undef) and what path we use as base, default undef
Defined types
thumbor::service::systemd
Setup a Thumbor service instance
Parameters
The following parameters are available in the thumbor::service::systemd defined type:
port
Data type: String
The port Thumbor listens on.
Default value: $name
Changelog
All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog and this project adheres to Semantic Versioning.
v2.3.0 - 2023-07-25
Changed
- Update module dependencies
Fixed
- Fix GitHub Actions
v2.2.0 - 2022-10-10
Added
- add new parameter
$service_timeout
Changed
- change default service stop timeout to 10s
v2.1.1 - 2022-08-30
Fixed
- fix missing puppet/epel dependency
v2.1.0 - 2022-08-30
This is a maintenance release. However, some default values were changed on RHEL-based distributions. These changes should be tested to avoid breakage of existing installations.
Added
- add new parameter
$pip_provider - add new parameter
$manage_epel - add unit tests to cover the basic functionality
- add basic acceptance tests
Fixed
- fix wrong path to Thumbor binary when not using Python venv
- fix installation issues on CentOS/Rocky
- fix puppet-lint offenses
Changed
- enable EPEL on RHEL-based distributions by default
- set default Python version to 3.8 on RHEL8-based distributions
- update documentation (requirements, examples)
- update OS support
- update to PDK 2.5.0
Removed
- drop support for RHEL7 and Debian 10 (due to incompatible Python3)
- drop obsolete examples
v2.0.0 - 2022-05-09
This is a new major release of this module. It adds new functionality, but also introduces some breaking changes.
Added
- add support for updating Thumbor and the Python venv
- add new parameter
$versionto control the version of Thumbor - add new parameter
$python_configto control Python installation options - add new parameter
$config_dirto control where config files are stored - add new parameter
$update_enabledto control automatic updates of the Python venv
Fixed
- fix compatibility issues with voxpupuli/python >=6.0.0
- fix compatibility issues with voxpupuli/systemd >=3.0.0
Changed
- ensure that the service is always 'running'
- migrate
params.ppto module data - rename parameter
$ensure_userto$manage_user - rename parameter
$ensure_groupto$manage_group - rename parameter
$extentionsto$plugins - rename parameter
$virtualenv_pathto$venv_path - use the
$ensureparameter for files, user, group, etc. - add 'opencv-python' to
$plugins(was previously hardcoded) - change default python version from 'system' to 'python3'
- change default config directory from '/usr/local' to '/etc'
- enable automatic updates of Thumbor's Python venv
- refactor code into smaller Puppet classes
Removed
- drop support for Thumbor 6 (upgrades should still be possible)
- remove parameter
$default_options(use$configinstead)
v1.0.0 - 2019-10-23
Initial release before forking the module
Dependencies
- puppet/epel (>= 3.1.0 < 5.0.0)
- puppetlabs/stdlib (>= 6.0.0 < 10.0.0)
- puppet/python (>= 6.2.1 < 7.0.0)
- puppet/systemd (>= 3.2.0 < 6.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.