pantheon-systems/search_api_pantheon

Connection module for Pantheon Search (solr 8)

Installs: 26 216

Dependents: 0

Suggesters: 0

Security: 0

Stars: 7

Watchers: 9

Forks: 16

Open Issues: 9

Type:drupal-module


README

Search API Pantheon Limited Availability

Solr at pantheon diagram

Requirements

This module is for you if you meet the following requirements:

  • Using Drupal 8.8/9.2+

  • Hosting the Drupal site on Pantheon's platform

  • Your site uses composer to install modules and upgrade Drupal core using one of the following integrations:

    • Pantheon's integrated composer (build step: true in your pantheon.yml)

    • A Continuous Integration service like Circle CI or Travis

  • Have Dashboard access to the platform (necessary to deploy code changes)

Intent

This module is meant to simplify the usage of Search API and Search API Solr on Pantheon's Platform.

Search API Solr provides the ability to connect to any Solr server by providing numerous configuration options. This module automatically sets the Solr connection options by extending the plugin from Search API Solr. The module also changes its connection information based on different Pantheon environments and each Pantheon Environment has it's own SOLR CORE. Doing so eliminates the need to do extra work setting up Solr servers for each environment.

What it provides

This module provides Drupal 9 integration with the Apache Solr project. Pantheon's current version as of the update of this document is 8.8.1.

Composer

Composer is the way you should be managing your drupal module requirements. This module will install its dependencies when you use composer to install.

Dependencies (installed by Composer):

  • Solarium. Solarium is a Solr client library for PHP and is not Drupal-specific. First, register Drupal.org as a provider of Composer packages. This command should be run locally from the root directory of your Drupal 8 git repository.

  • Search API. Search API is Drupal's module for indexing content entities.

  • Search API Solr. Search API Solr makes search API work with Apache Solr. Composer will manage which version.

  • Guzzle. Guzzle version 6 is standard with Drupal Core 8.x | 9.x (read 8.x OR 9.x).

Install

To require this module in your composer file:

composer require pantheon-systems/search_api_pantheon ^8 --prefer-dist

Install the module and push an updated composer.lock file to your Pantheon environment.

Setup

PLATFORM SUPPORT

See Drupal.org for complete documentation on Search API. To configure the connection with Pantheon, perform the following steps on your Dev environment (or a Multidev):

  • Enable Solr on your Pantheon site

    • Under "Settings" in your Pantheon site dashboard, enable Solr as an add on. This feature is available for sandbox sites as well as paid plans at the Professional level and above.
  • Enable Solr 8 in your pantheon.yml file

    • Add the bolded portion to your pantheon.yml file (** SYNTAX NOT FINAL; Use pantheon internal YGG instructions until yml support is final and available in prod **):

      php_version: 7.4
      database:
        version: 10.4
      drush_version: 10
      search:
        version: 8

      As you promote the code, the pantheon.yml file will follow the code through environments enabling the Solr server. However you will need to create an index for each environment and ensure the content is indexed after creation. Indices are specific to the Solr core with/for which they were created. Indices cannot be exported or moved once created.

USAGE

  • Enable the modules

    • Go to admin/modules and enable "Search API Pantheon."

    • Doing so will also enable Search API and Search API Solr if they are not already enabled.

  • OPTIONAL: Disable Drupal Core's search module

    • If you are using Search API, then you probably will not be using Drupal Core's Search module.

    • Uninstall it to save some confusion in the further configuration steps: admin/modules/uninstall.

  • The module should install a SEARCH API server for you

    • Navigate in the Drupal interface to CONFIG => SEARCH & METADATA => SEARCH API

    • Validate that the PANTHEON SEARCH server exists and is "enabled".

  • Solr versions and schemas

    • The version of Solr on Pantheon is Apache Solr 8.8. When you first create your index or alter it significantly, you will need to update the SCHEMA on the server. Do that either with a drush command or in the administration for the Solr Server.

    • Navigate to CONFIGURATION => SEARCH AND METADATA => SEARCH API => PANTHEON SEARCH => PANTHEON SEARCH ADMIN

    • Choose the button labeled "Post Solr Schema".

    • The module will post a schema specific to your site.

  • Use the server with an index

    The following steps are not Pantheon-specific. This module only alters the the configuration of Search API servers. To use a server, you next need to create an index.

    • Go to admin/config/search/search-api/add-index.

    • Name your index and choose a data source. If this is your first time using Search API, start by selecting "Content" as a data source. That option will index the articles, basic pages, and other node types you have configured.

    • Select "Pantheon" as the server.

    • Save the index.

    • For this index to be usable, you will also need to configure fields to be searched. Select the "fields" tab and CHOOSE FIELDS TO BE INCLUDED IN THE INDEX. You may want to index many fields. "Title" is a good field to start with.

    • After adding fields to the configuration, make sure the index is full by clicking "Index now" or by running cron.

  • Search the Index

    • Create a new view returning INDEX PANTHEON SOLR8 of type 'ALL'. Don't worry right now how it's sorted, we're going to change that to 'relevance' once we have some data being returned during the search.

    • In the view, CHOOSE FIELDS TO BE INCLUDED IN THE RESULTS from the fields you added to your index when you created it. In addition to the fields you added to the index, choose 'relevance' to add to the results.

    • Expose any keywords to the user to change and the view will put a KEYWORDS

    • Once your search is returning results, you can now sort by the "relevance" field and Solr will give the documents a relevance rating. A higher rating means Solr thinks the item is "more relevant" to your search term.

  • Export your changes

    • It is a best practice in Drupal 8 to export your changes to yml files. Using Terminus while in SFTP mode, you can run terminus --env=dev drush "config-export -y" to export the configuration changes you have made. Once committed, these changes can be deployed out to Test and Live environments.
  • OPTIONAL INSTALLS

    Any of the optional search_api modules should work without issue with Pantheon Solr, including but not limited to:

    • Search API Attachments

    • Search API Facets

    • Search API Autocomplete

    • Search API Spellcheck

    • Search API Ajax

Pantheon environments

Each Pantheon environment (Dev, Test, Live, and Multidevs) has its own Solr server. Indexing and searching in one environment does not impact any other environment.

Feedback and collaboration

Bug reports, feature requests, and feedback should be posted in the drupal.org issue queue. For code changes, please submit pull requests against the GitHub repository rather than posting patches to drupal.org.

SOLR JARGON:

Much of the jargon used in the Solr paradigm is used elsewhere in both Drupal and other technologies. Please familiarize yourself with the concept usage in a Solr context:

  • Commit - To make document changes permanent in the index. In the case of added documents, they would be searchable after a commit.

  • Core - An instance of the Solr server suitable for creating zero or more indices. Solr core is a way to represent a Lucene index and a set of configurations that control the accessing and using of the index with Solr. It's the main object you will interact with when working with Solr. You will create it, configure it, index data in it and preform queries on it. A Solr core is a Lucene index but wrapped in Solr related configurations.

  • Collection - Solr Cloud's version of a "CORE". Not currently used at Pantheon.

  • Document - A group of fields and their values. Documents are the basic unit of data in a collection. Documents are assigned to shards using standard hashing, or by specifically assigning a shard within the document ID. Documents are versioned after each write operation. Not to be confused with a PDF document which can be uploaded to Solr and searched via the SearchAPIAttachments module.

  • Facet - The arrangement of search results into categories based on indexed terms.

  • Field - The content to be indexed/searched along with metadata defining how the content should be processed by Solr.

  • Index - A group of metadata entries gathered by Solr into a searchable catalog.

  • Schema - A series of plain text and XML files that describe the data Solr will be indexing. The schema tells the server about the data that Solr will be indexing and tells Solr how to return the results. Schema is generated automatically by Drupal and uploaded using the PANTHEON_ADMIN tab of this module.

TROUBLESHOOTING

  • drush search-api-pantheon:diagnose (sapd) The DIAGNOSE command will check the various pieces of the Search API install and throw errors on the pieces that are not working. This command will develop further as the module nears general availability.

  • drush search-api-pantheon:select (saps) This command will run the given query against Solr server. It's recommended to use ?debug=true in any Solr page to get a good query to pass to this command to debug results.