Cloud customer?
Start for Free >
Upgrade in MyJFrog >
What's New in Cloud >

Search





Overview 

A Federation is a collection of repositories of Federated type in different JPDs that are automatically configured for full bi-directional replication. Once you have set up Federation, changes made to artifacts on one site will be automatically synchronized to the other federated sites using bi-directional mirroring.

Supported Number of Repositories in the Federation

A Federation can include up to 10 repositories.

You can perform the following Federated repository procedures:

Adding Federated Members to an Existing Federation

You are required to run the Federated Repository Full Sync REST API, when adding a remote Federated member to an existing Federated repository. This applies also when adding a converted local repository to a Federated repository.




Setting Up a Federated Repository

Prerequisites

  • Enable a Circle-of-Trust

    SaaS Customers

    For JFrog Enterprise/ Enterprise+ SaaS customers, please contact JFrog support to enable Circle-of-Trust between your instances.

  • Platform Deployments (JPDs) clocks must be synchronized
    If the federated repository artifacts are simultaneously updated on two (or more) member federated repositories, the update that is registered last will overwrite the other update(s). Therefore, to ensure consistent, predictable and trackable behavior of the system as a whole, the server clocks of all the machines running a federated members must be synchronized.

  • Configure the Custom Base URL in the General Setting of the Administration module. The Base URL supports detecting member JFrog Deployments (JPDs) in your organization.

    Applies to Self-Hosted Deployment

    Custom Base URL is relevant to Self-Hosted deployments and not applicable in SaaS.

    Changing the BaseURL in a Federated Repository Environment

    You cannot modify the Base URL if you have Federated repositories set up with remote mirroring .
    Therefore, you first need to remove the remote members from the Federation and click Save.
    After changing the base URL, proceed to set up the Federated repositories with the original Federated members. For all the remote members to be populated with new settings, it is recommended to wait for a short period of a time, between removing the remote members and changing the base URL.

Using the UI

  1. From the Administration module, navigate to Repositories | Repositories.
  2. Click Add Repository and select Federated Repository.

  3. Configure the Basic and Advanced repository settings similarly to configuring a Local Repository.
    Note that it is mandatory to assign a Repository Key that will be added as the prefix to the Federated repository and displayed on all the sites.

  4. In the Federation tab, proceed to add the repositories located on other JPDs to the Federation.

  5. Click Add Repository.

  6. In the Add Repositories dialog, add the repositories to the Federation using one of these methods:
    • Deployments: If you have JFrog Mission Control installed, the repositories on the remote JFrog Platform Deployments will automatically be populated. If the repository with the identical name doesn't exist on the remote JFrog Platform Deployment, proceed to click Create New to duplicate this repository.
    • URL: Manually add a predefined URL path to the repository. If the repository does not exist on the remote JFrog Platform Deployment, it will be created automatically according to the following sytax.

      <BASE_URL>/artifactory/<repository_name> //For example, http://<ip address>:8082/artifactory/fed117
  7. Click Save.
    You will be routed back to the Basic tab.
  8. Click Create Federated Repository.
  9. Click Save.

Using the REST API

The dedicated Federated Repository JSON file is application/vnd.org.jfrog.artifactory.repositories.FederatedRepositoryConfiguration+json

The following repository REST APIs support working with Federated repositories:


Pausing/ Resuming Federated Synchronization

You can pause and resume synchornization of the artifacts from your source Federated repository to the other member repositories.


Removing Repositories from the Federation

Admins on any of the federated members can remove themselves and other members from the Federation. Note that you can delete the initial repository and the Federation will continue to function between the remaining federated members.

  1. From the Administration module, click Repositories | Repositories and click the Federated tab to view a list of Federations.
  2. Select the Federation repository from the list and click the Federation tab.
  3. Click the x located on the top right of the repository.

Converting a Local Repository to a Federated Repository

Using the REST API

You can convert a local repository to a Federated repository using the Convert Local Repository to a Federated Repository REST API.

You can convert an existing local repository to a Federated repository by clicking Convert in the Local repository Advanced tab.

  1. In the Repositories tab under the Administration module, select a local repository in the Local Repository list.
  2. Click the Advanced tab and in the Convert to Federated repository section, click Convert.
    `
    The Convert to Federated Repository dialog opens.
  3. Click Convert.
  4. Run the full sync using the Federated Repository Full Sync REST API.
    The Local repository is moved to the Federated tab.

Converted Local Repositories Remain Federated

Removing the repository from the Federation does not automatically revert the repository to a local repository. Removing a repository from the Federation simply disconnects the bi-directional sync; however, the repository still remains Federated.


Working with Federated Artifacts

Once you have created the Federation, the Federated repositories are automatically displayed in your Artifact browser.

Any of the CRUD actions that you perform are automatically applied on the member Federated repositories. Users can perform actions according to their permission sets. The logic is applied according to the last action performed on the Artifact by any of the users in the Federation.


  • No labels
Copyright © 2021 JFrog Ltd.