Using data residency with Apigee hybrid

Overview

Data residency for Apigee meets compliance and regulatory requirements by allowing you to specify the geographic locations (regions) where Apigee data is stored. With data residency, selecting the control plane location ensures that all customer content is stored within the specified region.

For an overview of data residency for Apigee, see Introduction to data residency.

Data residency with Apigee hybrid

Starting with hybrid version 1.12, you can use Data residency with new Apigee hybrid installations. You cannot convert an existing installation to use data residency.

When creating your Apigee org

Creating your Apigee organization using data residency requires the following differences. See Step 2: Create an organization.

  • Control plane location: You need to specify the location where customer core content like proxy bundles are stored. For a list see Available Apigee API control plane regions.

    The control plane location is the location of the service endpoint location, for example us for United States.

    The following table lists available hosting jurisdictions and regions for the Apigee control plane.

    Americas

    Control plane hosting jurisdiction descriptionControl plane hosting jurisdiction nameDetails
    United Statesus (multiple regions in United States)Service endpoint: us-apigee.googleapis.com
    Canadaca (multiple regions in Canada)Service endpoint: ca-apigee.googleapis.com
    Consumer data region descriptionConsumer data region nameDetails
    Iowaus-central1leaf iconLow CO2
    Oregonus-west1leaf iconLow CO2
    Los Angelesus-west2
    Salt Lake Cityus-west3
    Las Vegasus-west4
    South Carolinaus-east1
    Northern Virginiaus-east4
    Columbusus-east5
    Dallasus-south1
    Montréalnorthamerica-northeast1leaf iconLow CO2
    Torontonorthamerica-northeast2leaf iconLow CO2

    Europe

    Control plane hosting jurisdiction descriptionControl plane hosting jurisdiction nameDetails
    European Unioneu (multiple regions in the European Union)Service endpoint: eu-apigee.googleapis.com
    Germanyde (multiple regions in Germany)Service endpoint: de-apigee.googleapis.com
    Francefr (single region europe-west9)Service endpoint: fr-apigee.googleapis.com
    Switzerlandch (single region europe-west6)Service endpoint: ch-apigee.googleapis.com
    Consumer data region descriptionConsumer data region nameDetails
    Belgiumeurope-west1leaf iconLow CO2
    Frankfurteurope-west3leaf iconLow CO2
    Netherlandseurope-west4
    Zuricheurope-west6leaf iconLow CO2
    Milaneurope-west8
    Pariseurope-west9leaf iconLow CO2
    Turineurope-west12
    Warsaweurope-central2
    Madrideurope-southwest1leaf iconLow CO2
    Finlandeurope-north1leaf iconLow CO2

    Asia-Pacific

    Control plane hosting jurisdiction descriptionControl plane hosting jurisdiction nameDetails
    Australiaau (multiple regions in Australia)Service endpoint: au-apigee.googleapis.com
    Indiain (multiple regions in India)Service endpoint: in-apigee.googleapis.com
    Japanjp (multiple regions in Japan)Service endpoint: jp-apigee.googleapis.com
    Consumer data region descriptionConsumer data region nameDetails
    Sydneyaustralia-southeast1
    Melbourneaustralia-southeast2
    Mumbaiasia-south1
    Delhiasia-south2
    Tokyoasia-northeast1
    Osakaasia-northeast2

    Middle East

    Control plane hosting juridiction descriptionControl plane hosting jurisdiction nameDetails
    Saudi Arabiasa (single region me-central2)Service endpoint: sa-apigee.googleapis.com
    Israelil (single region me-west1)Service endpoint: il-apigee.googleapis.com
    Consumer data region descriptionConsumer data region nameDetails
    Dammamme-central2
    Tel Avivme-west1
  • Consumer data region: You need to specify a region where API consumer data is stored. This must be a sub-region of the control plane region. For a list of available consumer data regions, see Apigee locations.
  • Billing type: You can only use data residency with paid subscription orgs.

When creating environments

When creating environments in and installation using data residency, you must create them in the control plane location. See Step 3: Create an environment group.

Overrides file adjustments

When using data residency, you must add the contractProvider configuration property to each overrides file and point it to the path for APIs in the control plane location. For example: 

 instanceID: "my_hybrid_example" namespace: apigee gcp: projectID: hybrid-example region: us-central1 k8sCluster: name: apigee-hybrid region: us-central1 org: hybrid-example contractProvider: https://us-apigee.googleapis.com

See Step 6: Create the overrides

When calling the Apigee APIs

When you make curl calls to Apigee APIs to perform tasks in your hybrid installation, you will need to call APIs from within the control plane location. For example:

curl -H "Authorization: Bearer $TOKEN" \ "https://$CONTROL_PLANE_LOCATION-apigee.googleapis.com/v1/organizations/$ORG_NAME/envgroups"

or

curl -H "Authorization: Bearer $TOKEN" \ "https://us-apigee.googleapis.com/v1/organizations/my-hybrid-org/envgroups"