Migrate a Tenant with Federation

This scenario describes migration of Federation state when moving a tenant between regions using the Artifactory Federation Service (RTFS).

Prerequisites:

Platform administrative access on both source and target regions
RTFS available and healthy in source and target regions
Tenant migration workflow in progress
Access Federation established between source and target JFrog Platform Deployments (JPDs) through a Circle of Trust

How Tenant Move Works

Tenant migration uses the RTFS TenantMove service to export Federation state, including repository configurations, member lists, mirror modes, and member states, from the source region and import it into the target region. This ensures that Federation topology is preserved after the tenant moves.

%%{init: {'theme': 'base', 'themeVariables': {'actorBkg': '#41b375', 'actorBorder': '#389b65', 'actorTextColor': '#ffffff', 'signalColor': '#8e9aaf', 'signalTextColor': '#333333', 'noteBkgColor': '#ffffff', 'noteBorderColor': '#41b375'}}}%%
sequenceDiagram
    participant Admin
    participant Source as Source Region RTFS
    participant Target as Target Region RTFS

    Admin->>Source: 1. Export Federation state
    Note over Source: Waits for grace period<br/>to capture in-flight events
    Source-->>Admin: Export complete
    Admin->>Target: 2. Import Federation state
    Target-->>Admin: Import status
    Admin->>Target: 3. Check import status
    Note over Target: Status: NOT_STARTED → IN_PROGRESS → COMPLETED
    Admin->>Target: 4. Verify health

Procedure

To migrate a tenant with Federation:

Export Federation State from Source Region: Export captures the current Federation state, including all Federated repository configurations, member details such as URLs, mirror modes, and enabled status, and member state information. The export process waits for the configured grace period (rtfs.tenant.move.export.lag.offset.grace.period.min) before finalizing, allowing in-flight events to be captured.
Import Federation State into Target Region: Import the exported state into the target region. RTFS creates the Federation topology in the target region based on the exported data.
Monitor Import Status: Track the import progress. The import transitions through the following statuses.

Status Description
NOT_STARTED Import has not begun.
IN_PROGRESS Import is currently running.
COMPLETED Import finished successfully.
FAILED Import encountered an error. Check RTFS logs for details.
Verify Health: After import completes, verify that all Federation members are healthy in the Federation Dashboard. Members may initially appear in PENDING_FS state and require a Full Sync to reconcile content with the new region.

Status	Description
`NOT_STARTED`	Import has not begun.
`IN_PROGRESS`	Import is currently running.
`COMPLETED`	Import finished successfully.
`FAILED`	Import encountered an error. Check RTFS logs for details.

Key Parameters

The following table describes the key configuration parameter for tenant migration.

Parameter	Default	Description
`rtfs.tenant.move.export.lag.offset.grace.period.min`	10	Grace period in minutes before export finalization. Captures in-flight events to minimize data loss during migration.

Frequently Asked Questions

This section provides answers to frequently asked questions.

plusFAQs

Q: How does tenant migration work with Federation?

A: RTFS exports Federation state, including repository configurations and member details, from the source region and imports it into the target region. See How Tenant Move Works for the full flow.

Q: What happens to Federation members after a tenant migration import completes?

A: Members may initially appear in PENDING_FS state and require a Full Sync to reconcile content with the new region before they're fully healthy.

Q: What's the difference between the export and import steps in tenant migration?

A: Export captures the current Federation state from the source region after waiting for the configured grace period. Import creates the Federation topology in the target region from that exported data.

Q: What do I need before migrating a tenant with Federation?

A: You need platform administrative access on both regions, a healthy RTFS instance in each region, and Access Federation established between the source and target JPDs through a Circle of Trust.