Overview
Federated repositories support seamless bi-directional synchronization of the artifacts and their metadata across different JFrog Platform Deployments.
The Federation is defined as a collection of Federated repositories from different JPDs: the change in one member of the Federation (artifacts or configuration) is automatically propagated to all members of the Federation. This allows for achieving full mirroring of the repositories across different JPDs.
The mirroring of artifacts metadata occurs instantly and therefore there is little to no-delay in the mirroring. The binary content is replicated on-demand and/or in the background, so it is not interrupting the working with the repository. Configuration changes are also synchronized across the repositories (some exclusions apply - settings that are relevant for specific JPD) based on the last change.
A local repository can be converted to Federated, which allows a smooth transition for customers that want to implement a mirroring strategy across different JPDs with the existing content.
To configure a Federated repository, in the Administration module, go to Repositories | Repositories and click Federated.
The following table describes the Federated repository parameters.
Basic Settings
Basic Setting | Description |
|---|---|
Package Type | The Package Type. This must be specified when the repository is created, and once set, cannot be changed. All Federation members must have the same Package Type. |
Repository Key | The Repository Key. This is a mandatory identifier for the repository and must be unique. It cannot begin with a number or contain spaces or special characters. For Federated repositories, we recommend using a |
Repository Layout | Sets the layout that the repository should use for storing and identifying modules. A recommended layout that corresponds to the package type defined is suggested, and index packages uploaded and calculate metadata accordingly. |
Public Description | A free text field that describes the content and purpose of the repository. |
Internal Description | A free text field to add additional notes about the repository. These are only visible to the administrator. |
Include and Exclude Patterns | The Include Patterns and the Exclude Patterns fields provide a way to filter out specific repositories when trying to resolve the location of different artifacts. In each field you can specify a list of Ant-like patterns to filter in and filter out artifact queries. Filtering works by subtracting the excluded patterns (default is none) from the included patterns (default is all). Example: Consider that the Include Patterns and Exclude Patterns for a repository are as follows: Include Patterns: In this case, the repository is searched for |
Enable Indexing in Xray | Enables indexing on the repository for security and compliance analysis. Available with JFrog Xray. |
Maven Repository Parameter (Local, Remote, and Federated Only) | Description |
|---|---|
Max Unique Snapshots | Specifies the maximum number of unique snapshots of the same artifact that should be stored. Once this number is reached and a new snapshot is uploaded, the oldest stored snapshot is removed automatically. Blank (default) indicates that there is no limit on the number of unique snapshots. |
Handle Releases | If set, Artifactory allows you to deploy release artifacts into this repository. |
Handle Snapshots | If set, Artifactory allows you to deploy snapshot artifacts into this repository. |
Advanced Settings
Advanceed Setting | Description |
|---|---|
Blacked out | If set, Artifactory ignores this repository when trying to resolve artifacts. The repository is also not available for download or deployment of artifacts. |
Allow content browsing | When set, allows Artifactory users to browse the internal contents of archives (for example, browsing specific Javadoc files from within a Javadoc archive). When archive browsing is allowed, strict content moderation should be employed to ensure malicious users do not upload content that may compromise security (e.g. cross-site scripting attacks) |
Enable CDN Download | Enables CDN Download requests to this repository will redirect the client to download the files directly from AWS CloudFront. Supported for Enterprise+ and Enterprise Licenses. For more information, see JFrog Cloud with CDN Distribution. |
Federated Repositories Setting | Description |
|---|---|
Convert to Federated Repository | Click Convert to convert the Local repository to a Federated repository. When you click Save and Close, the repository will automatically be moved to the Federated tab. |
Federated Settings
Federated Setting | Description |
|---|---|
Included Repositories | Lists the repositories included in the Federation Note that you need to define a Repository Key in the Basic tab, prior to setting up the Federation in the Federation tab. |
Deployments | If you have JFrog Mission Control installed, the list of Federated repositories on the included JFrog Platform Deployments will automatically be populated. |
URL | Manually add a path to the Federated repository (for instance, if no JFrog Mission Control is installed). The format: Requires assigning Base URL for Artifactory instance for each of the included JPDs. |