Solr Chef Cookbook

DESCRIPTION:

Install Solr as either a master or a replica.

This configures Solr to be used with Sunspot by default.

REQUIREMENTS:

This cookbook has only been tested on SmartOS.

The following cookbooks are expected to exist in the Chef server:

• java
• smf
• paths

ATTRIBUTES:

PROVIDERS:

solr

Install a specific version of Solr, explicitly configured via the provider attributes.

solr 'solr' do
  version '5.4.0'
  solr_home '/var/solr/solr5'
  port 8985
  hostname 'solr.prod'
  heap_size '1g'
  jvm_params '-Xdebug'
  notifies :enable, 'solr[solr]'
end

Available actions:

• :create - default
• :enable
• :restart

solr_core

Creates a solr core in a running Solr instance. Note that Solr must already be running. This provider uses Chef notifications to delay the core creation until an :enable delayed notification has time to run on the service itself.

solr 'solr' do
  version '5.4.0'
  solr_home '/var/solr/solr5'
  port 8985
  hostname 'solr.prod'
  heap_size '1g'
  jvm_params '-Xdebug'
  notifies :enable, 'solr[solr]'
end

solr_core 'default' do
  core_name 'default'
  version '5.4.0'
  solr_home '/var/solr/solr5'
  port 8985
  confdir 'basic_configs'
end

Configuration files for a Solr core can be managed through the config_template method. This can be used to configure replication (note the different ports used below, implying two different solr instances).

solr_core 'master default' do
  core_name 'default'
  version '5.4.0'
  solr_home '/var/solr/solr-master'
  port 8985
  confdir 'basic_configs'
  
  config_template 'solrconfig.xml' do
    source 'solr5/solrconfig.xml.erb'
    cookbook 'solr'
  end
end

solr_core 'replica default' do
  core_name 'default'
  version '5.4.0'
  solr_home '/var/solr/solr-replica'
  port 8986
  confdir 'basic_configs'
  
  config_template 'solrconfig.xml' do
    source 'solr5/solrconfig-replica.xml.erb'
    cookbook 'solr'
    variables 'master' => 'localhost:8985',
      'core' => 'awesome_data'
  end
end

Available actions:

• :create
• :install - used internally to delay core creation. Not intended to be run manually.
• :reload - used internally after updating config files

Attributes:

• confdir - [basic_configs, data_driven_schema_configs, sample_techproducts_configs], default: data_driven_schema_configs. Can also be used to pass the path to a configuration directory.
• core_name - Required
• port - how to communicate with solr. Required
• solr_home - where to find the solr home directory. Required.
• version - the version of Solr. Required.

Config templates:

• name - the file name to use, within the core's conf directory
• source - the erb template to be used
• cookbook - the cookbook in which to find the source file
• mode - the file mode to use (default 0644)
• variables - a hash of arbitrary variables to pass into the template. version from the solr_core attribute will be merged into this hash when passed into the template provider.

RECIPES:

Solr Master

include_recipe "solr::master"

This will create a service in SMF named solr-master on port 9985.

Solr Replica

include_recipe "solr::replica"

This will create a service in SMF named solr-replica on port 8983. By default it will look for a master on localhost. This can be configured by updating the solr.master.hostname attribute on a host.

Attribution

Based on work originally found in the ModCloth solr cookbook.