Information for: DEVELOPERS   PARTNERS

Upgrading to Acquia Search with Solr 7

This documentation page describes features and procedures for a limited availability release, and its contents may change at any time. Acquia does not recommend bookmarking this page as its location may change without notice.
The following documentation is for Drupal 8.

Use the following requirements and instructions to upgrade from Acquia Search with Solr 4 to Acquia Search with Solr 7.

Important

After upgrading to Acquia Search with Solr 7, you can’t revert to an earlier version of Acquia Search unless you perform a full code and database restore, and manually import the configuration of required elements.

Requirements

  • Prepare a local, virtual development environment for the project.
  • Install the following applications for use with your development environments:
  • Create an SSH key for your user, and provide access to that key to your Acquia Cloud environment.

Upgrade process

The upgrade process includes the following sections:

Prepare your new Drupal project, environment, or code base

To prepare your Drupal project, environment, or codebase, use your preferred method (such as Acquia BLT, Acquia Dev Desktop, or Acquia Developer Studio) to copy a remote website configuration to your development environment.

Upgrade to the new Acquia Search Drupal modules

Use the following procedure to upgrade your existing modules to enable the use of Acquia Search with Solr 7:

  1. If you’re using the Acquia Connector module, uninstall the Acquia Search module packaged with it on your local environment.

    Uninstall the Acquia Search module packaged with Acquia Connector.

  2. Run the following command to update the Acquia Connector module to the latest version:

    composer update drupal/acquia_connector --with-dependencies
    

    If Composer doesn’t update the module successfully, use the following command instead:

    composer require "drupal/acquia_connector:^2.0"
    
  3. Install and enable the Acquia Search Solr module.

  4. Export the configuration by running the following Drush command:

    drush config:export
    

    This command exports the configuration into the config synchronization path which, by default, is located at <project_folder>/config/sync).

  5. Commit the changes and push your branch (in this example, your-new-branch-name) to the Git repository by running the following Git commands:

    Note

    Be sure to examine your changes before adding them to version control to prevent committing unwanted changes.

    git status
    git add .
    git status
    git commit -m "Updating to Acquia Search Solr"
    git push origin <your-new-branch-name>
    
  6. If the Acquia Search Solr module doesn’t display on the Extend page’s list of modules, run the following commands:

    rm -rf docroot/modules/contrib/acquia_search_solr/.git
    git rm docroot/modules/contrib/acquia_search_solr --cached
    
  7. Run the following commands to ensure all information has been added to version control and returns content for the Acquia Search Solr module:

    git status
    git add .
    git status
    git commit -m "Updating to Acquia Search Solr"
    git push origin <your-new-branch-name>
    

Note

For more information about Drupal 8 modules for Acquia Search with Solr 7, see Modules for Acquia Search.

Deploy the updated code

After you have installed and enabled the Acquia Search modules, complete the following steps to deploy the new code to your Acquia Cloud application:

  1. Sign in to Acquia Cloud with the Owner or Administrator role and select the environment to deploy your changes.

    In the Acquia Cloud user interface, select an environment to deploy changes.

  2. Deploy the updated code from <your-new-branch-name> to the environment you have selected.

    In the Acquia Cloud user interface, deploy updated code to the environment you selected.

Preserve views and reindex

After connecting to the search index, you can preserve views and customized indexes by completing the following steps:

  1. On your website, from the Search API page, move the Acquia Search Solr Index from Indexes not currently associated with any server to the Acquia Search Solr Search API Solr server (Optional).

    Move the Acquia Search Solr Index to the Acquia Search Solr Search API Solr server.

    If you don’t require maintaining views or a customized index, you can skip moving the index and continue to configure the Acquia Search Solr Search API Solr index.

  2. In the Operations menu, click Edit, and then select the Acquia Search Solr Search API Solr server as the Server for the index.

    Select the Acquia Search Solr Search API Solr server for the index.

    Note

    From Index Options, be sure Read only for the Acquia Search Solr Search API Solr index is disabled, else indexing won’t work.

    Ensure the Read-only index option isn't enabled.

  3. Click Save configuration to save the index.

    The website redirects you to the Search API page.

  4. From the Operations menu, click Enable to enable the index.

    Enabling a search index.

Reindex

To reindex the information in your search index, complete the following steps:

  1. On your website, from the Search API page, click the index name to open the index detail page.

    Queue all items for reindexing on the index detail page.

  2. Click Queue all items for reindexing. Acquia Search will display a confirmation page that prompts you to confirm the reindexing attempt.

    Are you sure you want to reindex the index confirmation?

    After confirmation, you’re redirected to the index details page.

  3. Scroll to the end of the page, and then click Index now.

    The Index status displays the number of items indexed out of the total number of items in the index.

    When reindexing is complete, Acquia Search displays a banner message that indicates the reindexing completed as expected.

    The search index completed reindexing.

You’ve now completed the upgrade from Acquia Search with Solr 4 to Acquia Search with Solr 7. For more information about migrating to Acquia Search with Solr 7, see Moving to Acquia Search with Solr 7.