Application Launcher

The SearchStax migration script migrates a Drupal site from Acquia Search to Acquia Search powered by SearchStax. The script does these tasks:

Provisions the service
Clones the index
Configures the site

Prerequisites

Before you run the SearchStax migration script, ensure the following are complete:

Cloud IDE: Acquia recommends to run this script from an Acquia Cloud IDE instance to ensure a universal, standardized environment.
Documentation and planning: Document your current Acquia Search setup.
Backups: Take a complete backup of your database and configuration before you start.
Module preparation: Install the latest version of the required SearchStax modules. You can do this manually or through the script prompt. For instructions, visit Installing the SearchStax module.

Migration process

Launch and pre-flight phase
1. Run the following command to install the tool. Visit SearchStax Migration Script repository for more information.
```
curl -fsSL - https://raw.githubusercontent.com/acquia/search-stax-migration/main/install.sh
```
2. Navigate to the tool directory (by default, tools/search-stacks-migration/srx-migrate) or use the application alias.
3. Run the script.
  The script initializes the pre-flight phase and gathers data about the site, such as environment and multisite status. It connects to and identifies the existing Acquia Search API server and search index.
4. Read the documentation, confirm that a backup is complete, and choose whether to install the latest required modules.
Create the SearchStax app
The script can provision the SearchStax application for you.
1. When prompted, agree to allow the script to create the SearchStax application.
2. Log in: Enter the SearchStax credentials.
3. Account selection: Select the target account, such as Acquia Tam.
4. Environment
  type: Select the environment that matches the current site, such as Development.
API token and endpoints
1. After the application is provisioned, the script automatically retrieves the correct update endpoint.
2. The script prompts you for a Read/Write Token.
3. Log in to the SearchStax application in a browser.
4. Navigate to the application settings and copy the Read/Write Token.
5. Paste the token into the CLI prompt and press Return.
6. Optional: Skip the prompt for the Analytics URL if analytics configuration is not required.
Server and index configuration
1. Server phase: The script creates the SearchStax server based on the Acquia Search server settings that exist.
2. Index phase: The script clones the legacy Acquia Search index into the SearchStax copy.
3. The script triggers a reindex of the content into the new SearchStax index. Wait for the process to complete.
Switch view and configuration
1. The script updates the Search API views used by Acquia Search to point to the new SearchStax index.
2. The script applies the required settings changes in the Drupal site to route traffic correctly.
3. Select how to manage configuration. Skip this step to avoid local export and immediate staging.
4. When the prompt asks to delete Acquia Search, press Ctrl+C to stop the script.
5. Test the configuration before you delete Acquia Search.
Test and validate
To verify the migration before you apply changes to production traffic:
1. Log in to the adminitrative interface of Drupal.
2. Select Configuration > Search and metadata > Search API.
3. Verify that both the legacy Acquia Search server and the SearchStax server display.
4. Deactivate the Acquia Search server manually to test.

Rollback procedures

If issues occur during test, complete the following steps to revert changes:

Ensure that the migrate_from_searchstax module in the SearchStax package is installed.
Use the module UI to revert the changes made by the CLI tool.
Re-enable the Acquia Search server before you restore views to prevent errors, then select the option to revert views to Acquia Search.

AI-Generated Draft

To help publish information faster, this documentation uses AI-assisted drafting alongside human technical review. If you spot an inaccuracy or need to verify a critical implementation, please contact your Acquia representative or Acquia Support directly.

The SearchStax migration script migrates a Drupal site from Acquia Search to Acquia Search powered by SearchStax. The script does these tasks:

Provisions the service
Clones the index
Configures the site

Prerequisites

Before you run the SearchStax migration script, ensure the following are complete:

Cloud IDE: Acquia recommends to run this script from an Acquia Cloud IDE instance to ensure a universal, standardized environment.
Documentation and planning: Document your current Acquia Search setup.
Backups: Take a complete backup of your database and configuration before you start.
Module preparation: Install the latest version of the required SearchStax modules. You can do this manually or through the script prompt. For instructions, visit Installing the SearchStax module.

Migration process

Launch and pre-flight phase

The SearchStax migration script migrates a Drupal site from Acquia Search to Acquia Search powered by SearchStax. The script does these tasks:

Provisions the service
Clones the index
Configures the site

Prerequisites

Before you run the SearchStax migration script, ensure the following are complete:

Cloud IDE: Acquia recommends to run this script from an Acquia Cloud IDE instance to ensure a universal, standardized environment.
Documentation and planning: Document your current Acquia Search setup.
Backups: Take a complete backup of your database and configuration before you start.
Module preparation: Install the latest version of the required SearchStax modules. You can do this manually or through the script prompt. For instructions, visit Installing the SearchStax module.

Migration process

Launch and pre-flight phase
1. Run the following command to install the tool. Visit SearchStax Migration Script repository for more information.
```
curl -fsSL - https://raw.githubusercontent.com/acquia/search-stax-migration/main/install.sh
```
2. Navigate to the tool directory (by default, tools/search-stacks-migration/srx-migrate) or use the application alias.
3. Run the script.
  The script initializes the pre-flight phase and gathers data about the site, such as environment and multisite status. It connects to and identifies the existing Acquia Search API server and search index.
4. Read the documentation, confirm that a backup is complete, and choose whether to install the latest required modules.
Create the SearchStax app
The script can provision the SearchStax application for you.
1. When prompted, agree to allow the script to create the SearchStax application.
2. Log in: Enter the SearchStax credentials.
3. Account selection: Select the target account, such as Acquia Tam.
4. Environment
  type: Select the environment that matches the current site, such as Development.
API token and endpoints
1. After the application is provisioned, the script automatically retrieves the correct update endpoint.
2. The script prompts you for a Read/Write Token.
3. Log in to the SearchStax application in a browser.
4. Navigate to the application settings and copy the Read/Write Token.
5. Paste the token into the CLI prompt and press Return.
6. Optional: Skip the prompt for the Analytics URL if analytics configuration is not required.
Server and index configuration
1. Server phase: The script creates the SearchStax server based on the Acquia Search server settings that exist.
2. Index phase: The script clones the legacy Acquia Search index into the SearchStax copy.
3. The script triggers a reindex of the content into the new SearchStax index. Wait for the process to complete.
Switch view and configuration
1. The script updates the Search API views used by Acquia Search to point to the new SearchStax index.
2. The script applies the required settings changes in the Drupal site to route traffic correctly.
3. Select how to manage configuration. Skip this step to avoid local export and immediate staging.
4. When the prompt asks to delete Acquia Search, press Ctrl+C to stop the script.
5. Test the configuration before you delete Acquia Search.
Test and validate
To verify the migration before you apply changes to production traffic:
1. Log in to the adminitrative interface of Drupal.
2. Select Configuration > Search and metadata > Search API.
3. Verify that both the legacy Acquia Search server and the SearchStax server display.
4. Deactivate the Acquia Search server manually to test.

Rollback procedures

If issues occur during test, complete the following steps to revert changes:

Ensure that the migrate_from_searchstax module in the SearchStax package is installed.
Use the module UI to revert the changes made by the CLI tool.
Re-enable the Acquia Search server before you restore views to prevent errors, then select the option to revert views to Acquia Search.

AI-Generated Draft

Run the following command to install the tool. Visit SearchStax Migration Script repository for more information.
```
curl -fsSL - https://raw.githubusercontent.com/acquia/search-stax-migration/main/install.sh
```
Navigate to the tool directory (by default, tools/search-stacks-migration/srx-migrate) or use the application alias.
Run the script.
The script initializes the pre-flight phase and gathers data about the site, such as environment and multisite status. It connects to and identifies the existing Acquia Search API server and search index.
Read the documentation, confirm that a backup is complete, and choose whether to install the latest required modules.

Create the SearchStax app

The script can provision the SearchStax application for you.

When prompted, agree to allow the script to create the SearchStax application.
Log in: Enter the SearchStax credentials.
Account selection: Select the target account, such as Acquia Tam.
Environment
type: Select the environment that matches the current site, such as Development.
Region: Select the region that matches the Acquia application, such as US East.
Platform: Select the Drupal version, such as Drupal 10.
Name the index: Accept the index name suggested by the tool or override it.
Confirm the creation.
The script pings SearchStax until the application is provisioned.

API token and endpoints

After the application is provisioned, the script automatically retrieves the correct update endpoint.
The script prompts you for a Read/Write Token.
Log in to the SearchStax application in a browser.
Navigate to the application settings and copy the Read/Write Token.
Paste the token into the CLI prompt and press Return.
Optional: Skip the prompt for the Analytics URL if analytics configuration is not required.

Server and index configuration

Server phase: The script creates the SearchStax server based on the Acquia Search server settings that exist.
Index phase: The script clones the legacy Acquia Search index into the SearchStax copy.
The script triggers a reindex of the content into the new SearchStax index. Wait for the process to complete.

Switch view and configuration

The script updates the Search API views used by Acquia Search to point to the new SearchStax index.
The script applies the required settings changes in the Drupal site to route traffic correctly.
Select how to manage configuration. Skip this step to avoid local export and immediate staging.
When the prompt asks to delete Acquia Search, press Ctrl+C to stop the script.
Test the configuration before you delete Acquia Search.

Test and validate

To verify the migration before you apply changes to production traffic:

Log in to the adminitrative interface of Drupal.
Select Configuration > Search and metadata > Search API.
Verify that both the legacy Acquia Search server and the SearchStax server display.
Deactivate the Acquia Search server manually to test.
Note
In production environments, keep both servers active until the final test is approved, then perform the switch.
Clear the Drupal caches through Drush with the drush cr command or through the UI.
Perform a search on the front end of the site to verify search results.
Access the SearchStax Cloud dashboard and verify that the endpoints match the keys. Disregard warnings about Solr 10 upgrades.

Ensure that the migrate_from_searchstax module in the SearchStax package is installed.
Use the module UI to revert the changes made by the CLI tool.
Re-enable the Acquia Search server before you restore views to prevent errors, then select the option to revert views to Acquia Search.

AI-Generated Draft

Prerequisites

Migration process

Launch and pre-flight phase

Create the SearchStax app

API token and endpoints

Server and index configuration

Switch view and configuration

Test and validate

Rollback procedures

Prerequisites

Migration process

Launch and pre-flight phase

Prerequisites

Migration process

Launch and pre-flight phase

Create the SearchStax app

API token and endpoints

Server and index configuration

Switch view and configuration

Test and validate

Rollback procedures

Create the SearchStax app

API token and endpoints

Server and index configuration

Switch view and configuration

Test and validate

Rollback procedures

Did not find what you were looking for?

Did not find what you were looking for?