Skip to content

Latest commit

 

History

History
226 lines (128 loc) · 5.5 KB

REFERENCE.md

File metadata and controls

226 lines (128 loc) · 5.5 KB
Raw

Reference

Table of Contents

Classes

Public Classes

  • thumbor: Install and configure Thumbor

Private Classes

  • thumbor::config: Setup configuration files for Thumbor
  • thumbor::install: Install packages and dependencies for Thumbor
  • thumbor::python: Manage the Python installation
  • thumbor::service: Manage Thumbor system service and instances
  • thumbor::upgrade: Upgrade Thumbor's Python venv
  • thumbor::user: Setup users and groups for Thumbor

Defined types

Classes

thumbor

Install and configure Thumbor

Parameters

The following parameters are available in the thumbor class:

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