Configure a Sitecore xDB Cloud connection

Last updated Thursday, October 12, 2017 in xDB Cloud for Developer

Note

If you signed up for xDB Cloud before July 21st 2016, but are only starting to use it now, you must follow the instructions in the xDB Cloud 2.0 configuration guide instead.

To run Sitecore services in the cloud, you connect to Azure via different servers. Sitecore xDB Cloud Edition is a Sitecore service that can run Sitecore xDB in the cloud.

If you are upgrading from Sitecore Experience Platform (Sitecore XP) version 7.5 to 8.0, you must first upgrade your Sitecore Experience Database (xDB) set before you configure the client. To configure Sitecore XP, see the Sitecore xDB configuration topics. If you are running Sitecore XP 8.0, go to http://dev.sitecore.net or http://support.sitecore.net for further support.

Note

Sitecore Support Service will continue to support existing customers who are currently using the 7.5 version of Sitecore. However new subscriptions for 7.5 will not be supported.

Configure the Sitecore xDB Cloud client

Before you configure the Sitecore xDB Cloud client, you must:

Important

Sitecore provides the Processing and Reporting servers by default (indicated by *), so you do not need to configure them.

Configuration file

Folder

Server

Enable

Disable

Sitecore.Cloud.Xdb.config

(disabled by default)

App_Config/Include/xDBCloud

CM

Picture 1

CD

Picture 2

Processing*

Picture 3

Reporting*

Picture 4

Sitecore.ContentSearch.Cloud.Index.Analytics.config

(disabled by default)

App_Config/Include/xDBCloud

CM

Picture 12

CD

Picture 11

Processing*

Picture 6

Reporting*

Picture 5

Sitecore.ContentSearch.Cloud.DefaultIndexConfiguration.config

(disabled by default)

App_Config/Include/xDBCloud

CM

Picture 10

CD

Picture 9

Processing*

Picture 7

Reporting*

Picture 8

To enable the xDB Cloud service on your Sitecore instance:

  1. Make sure you are running Sitecore XP version 8.0 or later. To check which version you are running:
    • Go to Website\sitecore\shell\sitecore.version.xml
    • Go to the Content Editor, System menu, and right-click License Details.

    All_xDBCloud_LicenseDetails_Screenshot

  2. In the folder that contains your Sitecore installation, open the XdbCloud folder (Website/App_Config/Include/XdbCloud).
  3. In the text editor, open the Sitecore.Cloud.Xdb.config.disabled configuration file.
  4. Change the Sitecore.Cloud.Xdb.DeploymentID setting to a value that uniquely identifies your xDB instance in conjunction with your license ID, (this can be any alpha-numeric string).
  5. Go to the Sitecore.Cloud.Xdb file, in the setting <setting name="Sitecore.Cloud.Xdb.DeploymentType" value="Prod" /> ensure the value is Prod.

    Important

    The setting Sitecore.Cloud.Xdb.DeploymentType is depreciated and is removed from the Sitecore.Xdb.Cloud file in future releases.

  6. Set the region to <setting name="Sitecore.Cloud.Xdb.DeploymentRegion" value="Your preferred data center" />

    For example:

    <setting name="Sitecore.Cloud.Xdb.DeploymentRegion" value="North Europe" />

    For the supported values of the compatible data center locations, see the xDB Cloud Service compatibility tables.

    Important

    After you configure Sitecore to use xDB Cloud and before you run Sitecore for the first time, you must update to the newest Sitecore Experience Platform client that includes the location setting, and specify your preferred deployment region for your region setting. After you have specified the region, for example "North Europe" Sitecore will always automatically look for that location.

    The region setting is available with the Sitecore xDB Cloud update support package

  7. Enable the following configuration files by removing the .disabled extension from the name:
    • Sitecore.Cloud.Xdb.config.disabled
    • Sitecore.ContentSearch.Cloud.Index.Analytics.config.disable
    • Sitecore.ContentSearch.Cloud.DefaultIndexConfiguration.config.disabled
  8. To ensure that the connection was successful, when your installation has finished, open the log files and search for xDB Cloud.
    • If the installation was successful, the log files contain the following message: INFO xDB Cloud – Initialization completed successfully.
    • If the installation was not successful, the log files contain an error reference code and a message outlining what went wrong. Email support.sitecore.net and remember to quote the error reference code.

Note

Most customers purchase Sitecore products and services through a certified Sitecore partner. Because Sitecore does not directly offer customized development, design, and implementation services, you should continue to use your Sitecore partner for help with integration. If you do not currently have a certified Sitecore partner, contact your local Sitecore office who will direct you to a Sitecore partner in your area.

Firewall configuration

To update and configure your Sitecore xDB Cloud connection, you must also configure your firewall. Connect to the Discovery Service through discovery.xdb.cloud.sitecore.net. Sitecore xDB Cloud connects through multiple separate endpoints, for example, an endpoint for MongoDB, an endpoint for the reporting service, and an endpoint for the discovery service.

Additional endpoints may appear as the service expands. These services run on highly available pools of compute hosts. By design, the hosts are not set with static IPs because hosts are swapped in and out of the pool on a regular basis to ensure maximum availability. This means that switching IPs is expected behavior – Microsoft has a helpful list of IP ranges that are currently in use and updated regularly.

All Sitecore cloud services are run in Azure Data Centers and all hosts use the wildcard domain address: *.cloud.sitecore.net

Important

You also need to open specific ports for Mongo communication. The ports vary from customer to customer, therefore you should contact support.sitecore.net to obtain your personalized Mongo ports.

Send feedback about the documentation to docsite@sitecore.net.