Validate routes and ports

Sitecore Ecommerce Website Workplace Developer System Administrator Product Documentation

This article is intended for developers and administrators who need an in-depth view of the interactions occurring between the services involved with Coveo for Sitecore and Coveo. You can use the information below to add the necessary URLs to your firewall exceptions.

Notes

Topology of services and components

Topology of services | Coveo for Sitecore 5

1: Pushing Sitecore documents to a Coveo index is a two-step process comprising a call to the amazonaws.com endpoint and another to the Coveo Push API endpoint (see Manage Batches of Items in a Push Source).

2: With Amazon planning to deprecate path-style URLs, the old s3.amazonaws.com URL was replaced with this new format in the Coveo for Sitecore December 2020 release.

3: In pre-November 2021 releases of Coveo for Sitecore, the usage analytics endpoint was platform-<REGION_CODE>.cloud.coveo.com/rest/ua or platform.cloud.coveo.com/rest/ua.

Note: The URLs may contain <REGION> and <REGION_CODE> portions, depending on the selected deployment region.

Validating routes #1-4 (from Sitecore to Coveo)

Source

Sitecore

Destination

  • platform-<REGION_CODE>.cloud.coveo.com

  • api-<REGION_CODE>.cloud.coveo.com/push

  • <BUCKET_NAME>.s3.<REGION>.amazonaws.com

  • analytics-<REGION_CODE>.cloud.coveo.com

Protocol

HTTPS

Port

443
Note

The URLs may contain <REGION> and <REGION_CODE> portions, depending on the selected deployment region.

Examples:

  • Coveo endpoint, US-East region: platform.cloud.coveo.com

  • Coveo endpoint, Austalia region: platform-au.cloud.coveo.com

  • Push API endpoint, Ireland region: api-eu.cloud.coveo.com/push

The routes are used for these purposes:

  • platform-<REGION_CODE>.cloud.coveo.com: To manage the Coveo resources such as creating sources, fields and performing search requests.

  • api-<REGION_CODE>.cloud.coveo.com/push: To push documents and permissions to Coveo. The full Push API URL value used by the code is set when activating Coveo for Sitecore or changing the Coveo organization your Sitecore instance is linked to.

  • <BUCKET_NAME>.s3.<REGION>.amazonaws.com: To push documents and permissions to Coveo using a Push API file container.

  • analytics-<REGION_CODE>.cloud.coveo.com: To send Coveo for Sitecore activity data to Coveo.

To validate the route

  1. On the Sitecore server, open a web browser and access each of the destinations mentioned above (e.g., https://platform-eu.cloud.coveo.com).

  2. You should be able to reach each URL.

Validating route #5 (from Sitecore to Sitecore through the load balancer)

Source

Sitecore

Destination

Load Balancer

Protocol

HTTPS

Port

80 (or 443)

The route is used by the FetchPageContent and HtmlContentInBodyWithRequestsProcessor processors to retrieve the page content.

To validate the route:

Important

If Sitecore is secure, the protocol is HTTPS and port is 443.

  1. From the Sitecore server, open a web browser and access http://<LOAD_BALANCER_HOSTNAME>/coveo/rest.

  2. You should get an output similar to this:

    37099717