solr

Installs and configures the Solr search platform

Project URL RSS Feed Report issues

Module Stats

5,931 downloads

3,107 latest version

5.0 quality score

Version information

released Jun 2nd 2020

This version is compatible with:

Puppet Enterprise 2019.8.x, 2019.7.x, 2019.5.x, 2019.4.x, 2019.3.x, 2019.2.x, 2019.1.x, 2019.0.x, 2018.1.x
Puppet >= 5.5.0 < 7.0.0
, , , , Archlinux

Start using this module

Installation method

Add this module to your Puppetfile:

mod 'fraenki-solr', '2.2.1'

Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add fraenki-solr

Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install fraenki-solr --version 2.2.1

Tags: solr, lucene, apache, search, cloud, plugins

Documentation

fraenki/solr — version 2.2.1 Jun 2nd 2020

puppet-solr

Overview
Requirements
Usage
Reference
Development
- Contributing
License and Copyright

Overview

This module will install and configure the Solr search platform.

Requirements

Puppet 5 or higher
Java 8 or higher
Tested with Solr 7.x and 8.x

It is recommended to use puppetlabs/java to manage the Java installation.

Usage

Beginning with Solr

Install Solr with default settings and start the service afterwards:

class { 'solr': }

Furthermore, a number of simple options are available:

class { 'solr':
    # Change version
    version => '8.2.0',

    # Allow automatic upgrades (when changing $version)
    upgrade => true,

    # Network settings
    solr_port => 8983,
    solr_host => $fqdn,

    # Use custom installation and data directories
    extract_dir => '/opt',
    install_dir => '/opt/solr-8.2.0',
    var_dir     => '/opt/solr-home',
    log_dir     => '/opt/solr-home/log',
    solr_home   => '/opt/solr-home/data',

    # Change Solr runtime parameters
    java_mem  => '-Xms2g -Xmx8g',
    solr_time => 'Europe/Berlin',
    solr_opts => [
      '-Duser.language=de',
      '-Duser.country=DE',
    ],

    # Use an alternative download location (for old versions)
    mirror => 'https://archive.apache.org/dist/lucene/solr/',
}

Test Solr

Use cURL to test if Solr is running:

curl -v http://localhost:8983/solr/

(Or use your browser for more convenience.)

Solr Cloud

This module makes it pretty easy to configure Solr Cloud:

class { 'solr':
    # Setup Solr cloud
    cloud       => true,
    zk_chroot   => 'foo',
    zk_ensemble => 'zookeeper1.example.com:2181,zookeeper2.example.com:2181,zookeeper3.example.com:2181',
    zk_timeout  => 15000,
}

It is recommended to use deric/puppet-zookeeper to manage the ZooKeeper nodes.

Custom Plugins

When using Solr Cloud, you may use this module to manage your custom plugins with Puppet (instead of using the API):

class { 'solr':
    # Setup Solr cloud
    cloud       => true,
    ...
    # Manage custom plugins
    manage_custom_plugins => true,
    custom_plugin_id      => 'solr.custom_plugins.dir',
    custom_plugins        => [
      {
        source        => 'https://my.example.com/company_solr_plugins.tgz',
        extract       => true,
        creates       => 'company-search-enhancer-1.0.jar',
        checksum_type => 'md5',
        checksum      => 'a5d3ae0781765a702ca274191a4d7c97',
      },
      {
        source        => 'https://my.example.com/more_solr_plugins.tgz',
        extract       => true,
        creates       => 'my-private-plugin-2.0.jar',
        checksum_type => 'md5',
        checksum      => '7a4e95b26ac41250f8a65c4bf4dd1d25',
      }
    ]
}

As you can see, the $custom_plugins parameter expects options in a format that is compatible with voxpupuli/archive.

All custom plugins will automatically be installed and Solr will then be restarted. A new environment variable is added to Solr's startup options which points to the custom plugins directory. The name of this variable can be adjusted by altering the $custom_plugin_id parameter.

Note that you need to reference the $custom_plugin_id environment variable in your configuration in order to actually load the custom plugins in your Solr Core:

  <config>
    <lib dir="${solr.custom_plugins.dir}" />
    ...
  </config>

Reference

Public Classes

Class: `solr`

cloud: A flag to indicate if we should enable Solr Cloud. Valid options: true and false. Default: false.
enable_remote_jmx: A flag to indicate if we should enable remote JMX support. Valid options: true and false. Default: false.
extract_dir: Specifies the directory where the Solr installation archive should be extracted. Default: /opt.
gc_log_opts: Specifies the contents of the GC_LOG_OPTS environment variable to enable verbose GC logging. Valid options: an array.
gc_tune: Specifies the contents of the GC_TUNE environment variable to enable custom GC settings. Valid options: an array.
java_home: Specifies the path to a Java installation that should be used by Solr instead of the default. Valid options: an absolute path. Optional.
java_mem: Specifies JVM memory settings that should be used. Valid options: a string. Default: -Xms512m -Xmx512m.
log_dir: Specifies the directory for Solr logs. Valid options: an absolute path. Default: /var/log/solr.
mirror: Specifies the download location for Solr archives. Valid options: a HTTP(S) URL. Default: http://www.apache.org/dist/lucene/solr.
service_name: Specifies the name of the system service that should be setup. Valid options: a string. Default: solr.
solr_base: Internal parameter, DO NOT USE OR CHANGE! Specifies a symlink that is created by the Solr installer. Defaults to: $extract_dir/$service_name
solr_home: Specifies the Solr data directory. Valid options: an absolute path. Defaults to: $var_dir/data.
solr_host: Specifies the hostname that should be used for Solr. Valid options: a string. Defaults to: $fqdn.
solr_opts: Specifies optional parameters to customize Solr's startup parameters. Valid options: an array. Optional.
solr_port: Specifies the TCP port that should be used to access the Solr service. Valid options: an integer. Defaults to: 8983.
solr_time: Specifies the timezone that shoule be used by Solr. Valid options: a string: Defaults to: UTC.
solr_user: Specifies the name of the user to use for Solr. Valid options: a string. Default: solr.
upgrade: A flag to indicate if Solr should be automatically upgraded to a new version (see $version). Valid options: a boolean. Defaults to: false.
var_dir: Specifies the base directory for Solr configuration, data and logs. Valid options: an absolute path. Defaults to: /var/solr.
version: Specifies the version of Solr that should be installed or the target version for an upgrade (see $upgrade). Valid options: a string: Defaults to: 8.2.0.
zk_chroot: Specifies the ZooKeeper chroot path when using Solr Cloud (see $cloud). Valid options: a string. Defaults to: undef. Optional.
zk_ensemble: Specifies the host:port information for every machine that is part of the ZooKeeper ensemble when using Solr Cloud (see $cloud). Valid options: a string. Optional.
zk_timeout: Specifies the timeout (in milliseconds) for connections to machines in the ZooKeeper ensemble. Valid options: an integer. Defaults to: 15000.

Private Classes

Class: `solr::config`

Class: `solr::core`

Class: `solr::install`

Class: `solr::service`

Defined Types

Define: `solr::core`

This define creates a Solr core or collection.

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.

License and Copyright

See the LICENSE file at the top-level directory of this distribution.

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.

[2.2.1] - 2020-06-02

Changed

Update PDK to 1.18.0

Fixed

Ensure correct systemd dependency is used (#3)

2.2.0 - 2019-11-04

Changed

Make $zk_chroot optional to support a ZooKeeper ensemble without a chroot (#2)
Change default of $zk_chroot from solrcloud to undef (#2)

2.1.0 - 2019-10-24

Changed

Use camptocamp/systemd (new dependency) to trigger systemd reloads
Declare private classes private

Fixed

Fix non-zookeeper/cloud installs by making $zk_ensemble optional (#1)

2.0.0 - 2019-10-08

This is a feature release that may contain backwards incompatible changes.

Added

Add support to manage custom plugins
Add new parameters: $custom_plugins, $custom_plugins_dir, $custom_plugins_id, $manage_custom_plugins
Add new parameter $staging_dir to make the staging directory configurable

Changed

Only support Solr 7.x and 8.x (older versions may work but are unsupported)

[1.0.0] - 2019-10-01

This is the first release after forking the module. It should be possible to migrate from spacepants/puppet-solr to this version with only minor modifications.

Added

Add new parameter $zk_chroot to customize the ZooKeeper chroot when using Solr Cloud
Add new parameter $enable_remote_jmx to enable remote JMX support
Support log4j2 on Solr >= 7.4.0
Add new parameter $solr_opts to customize Solr startup parameters

Changed

Style: move parameters to the appropiate location in templates/solr.in.sh.erb
Various style fixes to make puppet-lint happy
Make default configuration compatible with JDK 11
Migrate default settings from params.pp to Hiera module data
Convert main template to EPP
Convert module to PDK
Update depencency and Puppet versions
Use native Puppet data types
Update default version to use most recent version of Solr
Migrate to puppet/archive (replacing nanliu/staging)
Run Solr installer with new -n parameter for more reliable installation

Fixed

Prevent Solr installer from starting an unconfigured instance (fixes a startup error)
Fix user creation by respecting the $solr_user parameter
Fix copy'n'paste errors in templates/solr.in.sh.erb (checking wrong parameters)
Reload systemd after changing the init script (fixes a warning message)

Removed

Remove unused parameter $install_dir

                              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.

Modules

Discover

Contribute

Puppet

Premium features

Downloads

Resources

About Forge

Getting Started

solr

Version information

This version is compatible with:

Start using this module

Documentation

puppet-solr

Table of Contents

Overview

Requirements

Usage

Beginning with Solr

Test Solr

Solr Cloud

Custom Plugins

Reference

Public Classes

Class: solr

Private Classes

Class: solr::config

Class: solr::core

Class: solr::install

Class: solr::service

Defined Types

Define: solr::core

Development

Contributing

License and Copyright

Changelog

[2.2.1] - 2020-06-02

Changed

Fixed

2.2.0 - 2019-11-04

Changed

2.1.0 - 2019-10-24

Changed

Fixed

2.0.0 - 2019-10-08

Added

Changed

[1.0.0] - 2019-10-01

Added

Changed

Fixed

Removed

Dependencies

Class: `solr`

Class: `solr::config`

Class: `solr::core`

Class: `solr::install`

Class: `solr::service`

Define: `solr::core`