Last updated Jan 13, 2025

Setting up remotes for realm pinning

Using the capabilities discussed on this page may make your app not eligible for Runs on Atlassian.

Go to this page to know more about the Runs on Atlassian program. To know how to check if your app is eligible for Runs on Atlassian, go to the Forge CLI documentation.

Forge remote data residency - realm pinning is a Forge preview feature. Preview features are deemed stable; however, they remain under active development and may be subject to shorter deprecation windows. Preview features are suitable for early adopters in production environments.

We release preview features so partners and developers can study, test, and integrate them prior to General Availability (GA). For more information, see Forge release phases: EAP, Preview, and GA.

Forge remote data residency provides you with the flexibility to help meet data residency requirements by pinning remote endpoints to specific regions. This guide walks you through setting up realm pinning for remotes in your Forge apps.

What is realm pinning?

Realm pinning determines the selected geographic location of URLs defined as baseUrl during the initial installation of an app. If a customer pins their product to a specific region, the app selects the corresponding location from the manifest upon installation. Even if the product has not been pinned, the baseUrl defined for the region is still used during installation if the app supports the region where the product is provisioned.

Requirements for PINNED status

A PINNED status refers to the verification that an app's data is hosted in the same location as the product data. For PINNED status requirements, see Forge data residency.

Setup realm pinning in Forge remote

To manage data residency for remotes in Forge:

Configure the Manifest: Add a baseUrl with region-specific URLs (US, EU, AU, etc.) and include a storage attribute with inScopeEUD: true for data storage compliance.
```
1
2
  remotes:
    - key: remote-backend
      baseUrl:
        default: "https://backend.example.com"
        US: "https://us-backend.example.com"
        EU: "https://eu-backend.example.com"
      operations:
        - storage
      storage:
        inScopeEUD: true
```
If operations are not defined, storage and inScopeEUD will be treated as true. This means the remote will be considered to store in-scope End-User Data for data residency compliance purposes.
Help ensure compliance:
- Ensure all remotes storing in-scope End-User Data use the same regions to maintain consistent compliance. For example, if remote 1 uses us, eu, and au regions, all other remotes must include the same regions.
- If a remote only sends data out (egresses data), declare it using compute or fetch operations. For more information on operation, see Remotes properties.

Supported locations for realm pinning

Forge currently supports several regions for realm pinning to meet data residency requirements.

Global: In-scope data is hosted within realms determined by Atlassian: data may be moved between realms as needed.
EU: In-scope data is hosted within the Dublin AWS regions.
US: In-scope data is hosted within the US East and US West AWS regions.
AU: In-scope data is hosted within the Sydney AWS region.
DE: In-scope data is hosted within the Frankfurt AWS region.
SG: In-scope data is hosted within the Singapore AWS region
CA: In-scope data is hosted within the Canada AWS region
IN: In-scope data is hosted within the Mumbai AWS region
KR: In-scope data is hosted within the Seoul AWS region
JP: In-scope data is hosted within the Tokyo AWS region
GB: In-scope data is hosted within the London AWS region
CH: In-scope data is hosted within the Zurich AWS region

App version upgrades

Some actions required to set up data residency for remote storage will trigger a major version change. These include:

adding new regions
modifying or removing URLs
converting the baseUrl format
altering external paths

Ensure you review and plan for these changes.