HomeDev GuideAPI Reference
Dev GuideAPI ReferenceUser GuideGitHubNuGetDev CommunitySubmit a ticketLog In
GitHubNuGetDev CommunitySubmit a ticket

DXP environments

Explains the environments in Optimizely Digital Experience Platform (DXP) and their usage. The environments are used for publishing and testing code, content and databases, and to prepare for final deployment to a production site.

Depending on your DXP setup and products included, you will have two or more environments between which deployment is done. You can deploy to Integration, Preproduction, and Production yourself. See Deploying and DXP self-deployment guide.

Environment usage

The following scenarios are typical for the environments. The number of environments is based on the specific cloud package in your solution.

  • Integration – Partners and customers deploy the full solution, as daily builds or continuous releases. You can validate initial integrations with external systems, perform functional testing, and add initial content for a first-time deployment. The integration environment has fixed configuration and no automatic scaling. Cloudflare cache and its Polish feature are bypassed with the hostname *inte.dxcloud.episerver.net.
  • Preproduction – Used to test production deployment, and verify performance and operational functionality. You also can use it for UAT, load testing, or approved penetration testing. Preproduction scales automatically.
  • Production – The live environment where website users perform authoring of content, using the Optimizely content publishing flow or projects; website visitors can access public content. The Production environment scales automatically.

Optimizely Search & Navigation and DXP

Optimizely Search & Navigation is included in Optimizely DXP. Each of the environments can exist in a multisite setup, and each will have their own Search & Navigation index. In a multisite scenario, the sites share the same index, but each individual site has their own partition of the index, and a shared partition for shared content.

📘

Note

A Production environment continuously updates the Search & Navigation index from the indexing job. However, for other environments and only after you change conventions, you must manually index when needed so as not to impact the Production environment.

Environment-specific configurations

When you deploy to a Production environment, ensure that the correct configurations are applied. See Environment configurations about how to set up environment-specific configurations.

🚧

Important

Make sure you never use credentials, tokens, or endpoints from a Preproduction environment in a Production environment.

Deployment environments

📘

Note

These Additional Deployment Environment features are currently only applicable to those provisioned on or after July 20, 2022.

You can use Additional Deployment Environments (ADEs) to add more environments to the standard set of environments (integration, preproduction, production) in Optimizely Content Management System (CMS) and Optimizely Customized Commerce.

Benefits

ADEs support:

  • The deployment API
  • Content sync from other environments
  • Quality of life features in the paasportal (such as database exports, application logs and purging CDN cache)

ADEs give you more flexibility during deployment since they allow an indefinite number of deployment environments. You can also reuse these environments for other purposes.

Use ADEs

You can direct deploy using ADEs. Follow these steps:

  1. Add API credentials to the ADEs. Go to API > Add API Credentials and select the ADE(s).
  2. Upload the NuGet package.
  3. Set the TargetEnvironment to the ADE.
  4. Start the DirectDeploy. Start-EpiDeployment -DeploymentPackage cms.app.1.0.0.nupkg -TargetEnvironment ADE1
  5. Go to Deployments and see the confirmation.

You can also copy content from one environment to the ADE. Follow these steps:

  1. Go to Deployments.
  2. Click Copy Content.
  3. Select the Target Environment. Start-EpiDeployment -SourceEnvironment Production -TargetEnvironment ADE1 -IncludeBlob -IncludeDb
  4. Click Start Now.

Use the Troubleshoot tab to further tweak your ADEs.

  • Restart Site
  • Clear cache using CDN Cache
  • Export Database
  • View Application Logs through Log Stream or a download link.

Other Resources