Prerequisites for Federated Repositories
Verify subscription, version, clock sync, and trust requirements before setting up Federated repositories.
Before setting up Federated repositories, verify that your environment meets the following requirements.
Subscription Requirements
Federated repositories are supported with Enterprise X and Enterprise+ subscriptions with Artifactory versions 7.18.3 or later.
Artifactory Version Requirements
When using a version of Artifactory older than 7.49.6, you must verify that the same Artifactory version is installed in all the Artifactory instances hosting the members to be included in the Federation.
After all instances have been upgraded to Artifactory release 7.49.6, Artifactory includes multi-version support, which enables the members of a Federation to run different versions of Artifactory. For more information, see Multi-Version Support.
Clock Synchronization
If the Federated repository artifacts are simultaneously updated on two or more Federation members, the update that is registered last overwrites the other updates. To keep the behavior of the system consistent, predictable, and trackable, synchronize the server clocks of all machines running Federation members.
Custom Base URL
A Custom Base URL must be configured in the Administration module under General > Settings. The Base URL supports detecting member JFrog Platform Deployments (JPDs) in your organization.
Note
The Custom Base URL is relevant to self-managed deployments and not applicable in SaaS.
Note
In versions before Artifactory 7.55.1, you can't modify the Base URL if you have Federated repositories set up with remote mirroring. You must first remove the remote members from the Federation and click Save. This limitation no longer applies in versions 7.55.1 and later. For more information, see Change Base URL.
After changing the base URL, proceed to set up the Federated repositories again with the original Federated members. Wait a short period of time between removing the remote members and changing the base URL so all remote members are populated with the new settings.
Establishing Trust Between the JPDs
You must establish trust between the JPDs in your Federation. The options for enabling trust depend on whether you have a SaaS or a self-managed deployment.
SaaS Customers
If you're a JFrog Enterprise or Enterprise+ SaaS customer, set up a binding token to create bi-directional trust between the JPDs.
Self-Managed Customers
Choose from one of the following options:
- Set up bindings between relevant JPDs: Using binding tokens enables admins to create trust between managed JPDs once the JPDs have been added to the JFrog Mission Control instance, simplifying the setup across JPDs.
- Enable a Circle of Trust: Choose this option if you want to provide full access to the other JPDs. Access is granted automatically once you implement the Circle of Trust.
Note
Federated repositories that use binding tokens instead of a Circle of Trust require an enabled JFrog Mission Control microservice in their Artifactory since JFrog Mission Control creates the token.
Oracle RAC Support
Note
This section is relevant if you have a self-managed environment running Artifactory release 7.71.16 or later, or 7.77.8 or later.
If you use Oracle Real Application Clusters (RAC), configure the following Artifactory system property to support Federated repositories:
artifactory.oracle.node.events.sequence.is.no.cache=trueSetting this property to true enables a converter that fixes the Oracle node events sequence definition for RAC instances.
Pre-Setup Checklist
Before proceeding to create your first Federation, confirm:
- Subscription: Enterprise X or Enterprise+ active
- Artifactory version: 7.18.3 or later on all JPDs
- Clock synchronization: All JPD server clocks are synchronized
- Custom Base URL: Configured (self-managed only)
- Trust: Binding tokens or Circle of Trust established between JPDs
- Oracle RAC: System property configured (if applicable)
Next Steps
Frequently Asked Questions
This section provides answers to frequently asked questions.
FAQs
Q: What subscription do I need for Federated repositories?
A: Federated repositories require an Enterprise X or Enterprise+ subscription with Artifactory 7.18.3 or later. See Subscription Requirements for details.
Q: Do all Federation members need to run the same Artifactory version?
A: Only if you're running a version older than 7.49.6. Once every instance is upgraded to 7.49.6 or later, Artifactory's multi-version support allows Federation members to run different versions.
Q: How do I establish trust between JPDs before creating a Federation?
A: Set up a binding token for bi-directional trust, or enable a Circle of Trust for full access between JPDs. See Establishing Trust Between the JPDs for the SaaS and self-managed options.
Q: Is a Custom Base URL required for SaaS deployments?
A: No. The Custom Base URL requirement applies only to self-managed deployments and isn't applicable in SaaS.
Q: What do I need to configure if I use Oracle RAC?
A: Set the artifactory.oracle.node.events.sequence.is.no.cache system property to true to enable the converter that fixes the Oracle node events sequence definition for RAC instances.
Related Topics
Updated about 7 hours ago