Configure the primary deployment region or multi-region support

This is for:

Developer System Administrator

Coveo provides its customers with options as to where to store their data. The physical center of your Coveo organization is called the primary deployment region. Coveo also supports multi-region deployments which automatically replicate data required for search queries from your primary deployment region to one or multiple satellite regions. This strategy minimizes response times for your international search interface users, because search queries are automatically routed to the closest deployment region.

This article aims at providing existing Coveo for Sitecore customers with instructions should they want to change the primary deployment region or enable multi-region support for their Coveo organization.

Change the primary deployment region

When activating Coveo for Sitecore, you can connect your Sitecore instance to an existing Coveo organization (in a given primary deployment region) or create a new organization in the region of your choice. To determine the primary deployment region of the Coveo organization your Sitecore instance is currently connected to, navigate to the Command Center Configuration Manager (accessible at https://<INSTANCE_HOSTNAME>/coveo/command-center/index.html#cloud-organization/).

deployment region shown in Coveo Command Center | Coveo for Sitecore 5
The primary deployment region may be seen by hovering over your Coveo organization in the list of existing organizations.

If the Coveo organization you’re currently connected to isn’t located in your preferred deployment region, you may want to migrate your organization data.

To migrate your Coveo organization data from one deployment region to another

  1. Contact Coveo Sales to have the new Coveo organization created and to initiate the related administrative tasks.

    Note

    When a Coveo customer requests a primary deployment region data migration, Coveo must first create the new organization in the desired region. The old organization is maintained and available for a given time period only, as determined by Coveo and the customer.

  2. Migrate (or have Coveo Professional Services migrate) your data from the old organization to the new organization.

    Note

    Coveo currently has no automated process to migrate organization data.

    Customers can use the Resource Snapshot feature to migrate most resources (but not all[1]) from the old to the new organization themselves, or they may call upon Coveo Professional Services to perform the migration.

    Coveo Professional Services use the Resource Snapshot feature to migrate organization data, as customers would do themselves. However, Coveo can also copy the top 1,000 query suggestions from the old organization to the new one, though this option has its limitations.[2] Coveo can’t migrate other Usage Analytics data (e.g., Automatic Relevance Tuning (ART) and Content Recommendation (CR) data) to the new organization.

  3. Upgrade Coveo for Sitecore to the September 18, 2020 release (5.0.788.5) or higher.

    Important

    Ensure you follow the leading practices when upgrading.

  4. Follow the steps in the Modifying your Coveo organization section to link your Sitecore instance to your new organization.

    These steps will change settings in the following configuration files on your main CM server:

    • <SITECORE_INSTANCE_ROOT>\App_Config\Include\Coveo\Coveo.SearchProvider.Rest.Custom.config

    • <SITECORE_INSTANCE_ROOT>\App_Config\Include\Coveo\Coveo.CloudPlatformClient.Custom.config

  5. Copy the two configuration files that were updated on your main CM server and paste them to overwrite the same files on all your other CMs and CDs.

  6. Access the Indexes section of the Command Center.

  7. Rebuild your indexes.

Organization endpoints and multi-region support

Coveo provides custom, region-agnostic endpoints for multi-region support. These are called organization endpoints. Even if you currently only have one deployment region, Coveo recommends that you move to organization endpoints.

Note

Coveo for Sitecore 5.0.1277.4

 
New Coveo for Sitecore activations implement organization endpoints by default.

In the Coveo Cloud Organization section of the Command Center, if you have Platform Endpoints that begin with https://platform and https://analytics, your Sitecore instance is using legacy, region-specific endpoints.

Region-specific endpoints
Region-specific endpoints (Australia region endpoints shown here)

Instead, if you have Platform Endpoints that begin with your organization ID, your Sitecore instance is using organization endpoints.

Organization endpoints
Organization endpoints (the organization ID in this example is someorgq5r10yzu)

To enable organization endpoints

  1. If necessary, contact Coveo Sales to create the satellite region(s) for your Coveo organization.

  2. Upgrade to the latest Coveo for Sitecore release.

  3. In the Command Center, open the Coveo Cloud Organization page.

  4. Click Log in.

  5. Log in to your Coveo organization.

  6. Click Apply and Restart.

  7. Allowlist the new endpoint URLs.

1. Usage Analytics can’t be migrated.
2. Only part of the Query Suggestions (QS) data is copied in the process. As a result, customers don’t initially get the same level of QS functionality in the new Coveo organization as they did in the original organization. Having Query Suggestions data migrated ensures adequate query suggestions during the transitory period when analytics data begins accumulating in the new organization.