REFERENCE.md

Reference

Table of Contents

Classes

Public Classes

• solr: Installs and configures the Solr search platform.

Private Classes

• solr::config: Setup and configure Solr.
• solr::customplugins: Manages custom plugins for Solr.
• solr::install: Installs and prepares the Solr application.
• solr::prometheus_exporter: Configure the embedded prometheus exporter as a service.
• solr::service: Installs and configures the Solr service.

Defined types

• solr::core: Creates a Solr core or collection.

Classes

solr

Installs and configures the Solr search platform.

Parameters

The following parameters are available in the solr class:

• additional_packages
• allow_paths
• cloud
• custom_plugins
• custom_plugins_dir
• custom_plugins_id
• enable_prometheus_exporter
• enable_remote_jmx
• enable_security_manager
• enable_syslog
• extract_dir
• gc_log_opts
• gc_tune
• java_home
• java_mem
• jetty_host
• limit_file_max
• limit_proc_max
• log_dir
• manage_allow_paths
• manage_additional_packages
• manage_custom_plugins
• manage_service_limits
• mirror
• service_name
• prometheus_exporter_user
• prometheus_exporter_env_vars
• prometheus_exporter_extra_options
• prometheus_exporter_service_name
• solr_base
• solr_home
• solr_host
• solr_opts
• solr_port
• solr_time
• solr_user
• staging_dir
• syslog_app_name
• syslog_facility
• syslog_host
• syslog_port
• syslog_protocol
• upgrade
• var_dir
• version
• zk_chroot
• zk_ensemble
• zk_timeout

additional_packages

Data type: Array

Specifies a list of additional packages that are required for Solr or one of its components.

allow_paths

Data type: Array

Specifies a list of directories that should be added to the allowPath Solr option.

cloud

Data type: Boolean

Determines whether to enable Solr Cloud.

custom_plugins

Data type: Array

A list of custom plugins that will be installed.

custom_plugins_dir

Data type: Stdlib::Absolutepath

Sets the target directory for custom plugins.

custom_plugins_id

Data type: String

Sets the Solr config option that is used to configure custom plugins.

enable_prometheus_exporter

Data type: Boolean

Determines whether to enable embedded prometheus exporter as a service.

enable_remote_jmx

Data type: Boolean

Determines whether to enable remote JMX support.

enable_security_manager

Data type: Boolean

Enable Java Security Manager. This affects filesystem access permissions and may require to provide a custom security policy.

enable_syslog

Data type: Boolean

Configure syslog appender instead of file.

extract_dir

Data type: Stdlib::Absolutepath

Sets the directory where the Solr installation archive should be extracted.

gc_log_opts

Data type: Optional[Array]

Sets the contents of the GC_LOG_OPTS environment variable to enable verbose GC logging.

gc_tune

Data type: Optional[Array]

Sets the contents of the GC_TUNE environment variable to enable custom GC settings.

java_home

Data type: Optional[Stdlib::Absolutepath]

Sets the path to a Java installation that should be used by Solr instead of the default.

java_mem

Data type: String

Sets JVM memory settings for Solr.

jetty_host

Data type: Optional[String]

Sets the IP address that Solr binds to.

limit_file_max

Data type: Integer

Sets the maximum number of file descriptors.

limit_proc_max

Data type: Integer

Sets the maximum number of processes.

log_dir

Data type: Stdlib::Absolutepath

Sets the directory for Solr logs.

manage_allow_paths

Data type: Boolean

Whether to add the allowPaths option to the Solr config. When storing data outside the default paths, allowPaths must be used.

manage_additional_packages

Data type: Boolean

Whether to manage the installation of additional packages.

manage_custom_plugins

Data type: Boolean

Determines whether to enable support for custom plugins.

manage_service_limits

Data type: Boolean

Determines whether to set resource limits for the Solr service. The service is NOT restarted when limits are changed.

mirror

Data type: Variant[Stdlib::HTTPUrl,Stdlib::HTTPSUrl]

Sets the download location for Solr archives. It will be used during installations and upgrades.

service_name

Data type: String

Sets the name of the system service that should be setup.

prometheus_exporter_user

Data type: String

Sets the user running the solr-exporter binary.

prometheus_exporter_env_vars

Data type: Optional[Hash]

Sets solr-exporter environment variables in service file (see https://solr.apache.org/guide/solr/latest/deployment-guide/monitoring-with-prometheus-and-grafana.html#environment-variable-options).

prometheus_exporter_extra_options

Data type: Optional[String]

Sets solr-exporter custom command line options (see https://solr.apache.org/guide/solr/latest/deployment-guide/monitoring-with-prometheus-and-grafana.html#command-line-parameters).

prometheus_exporter_service_name

Data type: String

Sets the name of the prometheus exporter system service that should be setup.

solr_base

Data type: Stdlib::Absolutepath

Internal module parameter, SHOULD NOT BE CHANGED! Specifies a symlink that is created by the Solr installer.

solr_home

Data type: Stdlib::Absolutepath

Sets the Solr data directory.

solr_host

Data type: String

Sets the hostname that should be used for Solr.

solr_opts

Data type: Array

Changes optional parameters to customize Solr's startup parameters.

solr_port

Data type: Integer

Sets the TCP port that should be used to access the Solr service.

solr_time

Data type: String

Sets the timezone that shoule be used by Solr.

solr_user

Data type: String

Sets the name of the user to use for Solr.

staging_dir

Data type: String

Sets the staging directory that is used when installing or upgrading Solr.

syslog_app_name

Data type: String

Sets the appName for syslog.

syslog_facility

Data type: String

Sets the destination facility for syslog.

syslog_host

Data type: String

Sets the destination host for syslog.

syslog_port

Data type: Integer

Sets the destination port for syslog.

syslog_protocol

Data type: String

Sets the protocol for syslog.

upgrade

Data type: Boolean

Determines whether to enable upgrades to a new Solr version (see $version).

var_dir

Data type: Stdlib::Absolutepath

Sets the base directory for Solr configuration, data and logs.

version

Data type: String

Sets the version of Solr that should be installed or the target version for an upgrade (see $upgrade).

zk_chroot

Data type: Optional[String]

Sets the ZooKeeper chroot path when using Solr Cloud (see $cloud).

zk_ensemble

Data type: Optional[String]

Sets the host:port information for every machine that is part of the ZooKeeper ensemble when using Solr Cloud (see $cloud).

zk_timeout

Data type: Integer

Sets the timeout (in milliseconds) for connections to machines in the ZooKeeper ensemble.

Defined types

solr::core

Creates a Solr core or collection.

Parameters

The following parameters are available in the solr::core defined type:

• core_name

core_name

Data type: String

Sets the name of the core or collection.

Default value: $name