This module is meant to simplify the usage of Search API and Search API Solr on Pantheon. 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 the connection information between Pantheon environments. Doing so eliminates the need to do extra work setting up Solr servers for each environment.

The version of Solr on Pantheon is Apache Solr v3.6. To accommodate this older version of Solr, use the 4.x branch of Search API Solr, its "Search API Solr Legacy" submodule and use the 3.x schema file provided by this module.

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.

Composer is the best way to install this module because this module relies on 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 or 9 git repository.

composer config repositories.drupal composer https://packages.drupal.org/8

Next, require this module.

composer require "drupal/search_api_pantheon" --prefer-dist

You should now have this module along with Search API, Search API Solr, and Solarium. Commit the changes and push your repository to Pantheon. Be sure not to commit search_api_pantheon as a git submodule. One way to do that is by removing the .git repository that may have come with it through Composer.

rm -r modules/search_api_pantheon/.git

See the Drupal.org for complete documentation on Search API. To configure the connection with Pantheon, do 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 the modules
  • On the Drupal site go to admin/modules (the "Extend" option in the toolbar) and enable "Search API Pantheon". Doing so will also enable Search API, Search API Solr and Search API Solr Legacy if they are not already enabled.
• OPTIONAL: Disable Drupal Core's search module
  • If you are using Search API, then you probably will not need to use Drupal Core's Search module. Uninstall it to save some confusion in the further configuration steps: admin/modules/uninstall.
• Configure a Search API server
  • Go to /admin/config/search/search-api/add-server
  • Enter "Pantheon" as the server name. (You can name the server anything you want but using something like "Pantheon" is a good way to remember where the connection goes.)
  • Under "Backend", select "Solr".
  • Under "Solr Connector", select "Pantheon".
  • Having selected "Pantheon" you will then be presented with additional options. Choose the item that most closely matches the following: modules/contrib/search_api_pantheon/solr_conf/schema.xml (the exact full path will depend upon where the module is installed in the codebase).
  • Optional: It is suggested to also expand the "Multi-site Compatibility" fieldset and enable the "Retrieve results for this site only" option, this may resolve problems with incorrect data showing in the search results.
  • Click the "Save" button to save the configuration.
• 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 useable, 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 the configuration, make sure the index is full by clicking "Index now" or by running cron.
• Search the Index
  • To actually search your index you will need to use another module. Search API Pages provides a simple soution for building search pages, while for more advanced use cases consider using the Views module (included with Drupal 8 and 9) to build a page.
    • Search API Pages will not have been downloaded by using composer require on Search API Pantheon, it must be downloaded it separately.
    • When using Views to build a search page, use the data source named "Index [name of index]", e.g. following the example above "Index Content".
• Export your changes
  • It is a best practice in Drupal 8 & 9 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.

• The site indexes content but no results are displayed when content is searched.

  This happens when the wrong schema.xml file is used. Make sure that the schema.xml file provided by this module is the one used on the server's configuration, not one of the ones provided by Search API Solr.

Bug reports, feature requests and feedback should be posted in the drupal.org issue queue.