Configure Domains - BloomReach Experience - Open Source CMS

Configure Domains

This documentation applies to Bloomreach Cloud 2 only

Introduction

Goal

Direct incoming traffic for a domain to the appropriate environment and webapp.

Background

The domain configuration allows Bloomreach Cloud to direct incoming traffic for a domain name to the appropriate environment. This is very useful when using the blue-green deployment model. Changing the environment reference in Mission Control is sufficient to direct traffic to the other environment.

Prerequisites and Constraints

Before you can use a domain, an SSL certificate corresponding with the domain name needs to be configured by the Bloomreach Cloud team. Send your certificate to the Bloomreach Cloud team to have it installed in your stack.

In addition, the delivery tier must have a corresponding virtual host configuration for the domain name.

A domain consists of a name and an optional reference to an environment. The name is of the form {sub-domain (optional), domain, top-level domain}, for example: customer.com or www.customer.com. Multiple domains can refer to the same environment. BRC will select the appropriate SSL certificate by looking at the SANs inside the certificate matching with the domain name.

To allow end-users to access the CMS application, there must be a domain starting with 'cms', for example: cms.customer.com. This is the URL that users can use to access the CMS application.

For redirecting from the root domain to a subdomain, contact the Bloomreach Cloud team.

Instructions

Configure a New Domain

Obtain an SSL certificate for the domain you want to use and send it to the Bloomreach Cloud team to have it installed in your stack.

Create a CNAME record in your DNS server like: 

www.customer.com. 300 IN CNAME    www.customer.com.cdn.cloudflare.net

Configure a virtual host for the domain in the environment to which you want traffic for that domain to be directed.

Log in to Mission Control and navigate to Domains.

Click on the + button in the bottom right corner to add a domain.

Enter the domain name you want to use for the site application (for example, www.customer.com) and select the environment to which you want traffic for that domain to be directed.

Leave Source context path and Target context path at their default values unless you are running multiple site webapps (see below).

Click on Save.

Add the corresponding domain for the CMS application (for example, cms.customer.com).

Leave Source context path at its default value (/) and set Target context path to /cms.

Click on Save.

For customers that are using Bloomreach provided Cloudflare CDN;  when adding new custom domain like staging.customer.com please create a JIRA ticket for Bloomreach Cloud operations team to add this new custom domain to Cloudflare CDN.
Customers using a SPA/SSR should use their own CDN and do not need to reach out to Bloomreach.

Switch Domain Between Blue and Green Environments

Make sure the environment you want to switch the domain to has the corresponding virtual host configured.

Log in to Mission Control and navigate to Domains.

Select the domain you want to switch.

In the Environment dropdown, select the environment you want to switch to.

Click on Save.

Do the same for the corresponding domain for the CMS application.

Configure Domains for Multipe Site Webapps

In case of multiple site webapps running in one environment, for each additional site webapp, configure an additional domain and source and target context paths.

The configured source context path will be the path after the domain name in the URL browser clients should use to request the site.

The configured target context path will be the actual context path of the webapp.

The source should be either empty or the same as the target. By default, an empty source path (/) is mapped to the target path /site.

For example, if you add a second site webapp called webshop to the example above (cms.customer.com and www.customer.com), add another domain for www.customer.com but with source path webshop and target path webshop. This will make the webshop site webapp available at www.customer.com/webshop/.

Did you find this page helpful?
How could this documentation serve you better?
On this page
    Did you find this page helpful?
    How could this documentation serve you better?