Dev Guide
Dev GuideUser GuideGitHubNuGetDevCommunityDoc feedbackLog In

Manage app deployment regions

You can deploy your Optimizely Connect Platform (OCP) app regionally to North America, Europe, and Asia Pacific.

You can deploy Optimizely Connect Platform (OCP) applications in multiple regions. Today, the platform is built in North America (US), Europe (EU), and Australia (AU).

Manage app deployments in the app.yml file under availability.

OCP is currently available in the following regions:

  • US – United States (required)
  • EU – Europe
  • AU – Australia

You can also check available regions with ocp availability list command:

$ ocp availability list

Name        Description
au          Australia
eu          Europe
us          United States

Below is an example of the meta section from an app.yml file:

meta:
  app_id: klaviyo_collect
  display_name: Klaviyo Collect
  version: 0.1.0
  vendor: zaius
  summary: Collect Data From Klaviyo
  support_url: https://www.optimizely.com
  contact_email: [email protected]
  categories:
    - Marketing
  availability:
   - us

Below are some examples of how you can implement regional availability of your app:

##This deploys to the US only:
availability:
- us

##This deploys to the EU only:
availability:
- eu

##This deploys to both US and EU:
availability:
- us
- eu

##This deploys the app to all current available and future deployment regions:
availability:
- all

Environmental differences between regions in the .env file

Automatic deployment

If your app is tagged with -all, OCP automatically deploys your app to new regions as they become available.

Tagging your app with explicit deployment regions prevents this action and ensures your app is only deployed to the regions you have specified.

Specific region requirements

Your app may require specific configuration for different regions.

If you use the -all availability tag, you can only configure a single .env file for your app to be used in each region.

If you use the specific region tags, you can then specify a specific .env file for use with your apps in each region. For example, in a -us and -eu deployment model, you have a .env.us and a .env.eu file.

Common region-specific use cases

.env files commonly hold secret data for use by an app at startup, such as API keys for data exchange. It is common that different applications running in different regions require a different set of API keys by region.

Specifying your respective .env files for each given region is done by modifying the .env file extension in your apps to env.us or .env.eu. When you publish your app for the different regional availabilities, OCP determines the correct configuration from each one of the respective .env files.