Install the Artifactory Federation Service

The Artifactory Federation Service (RTFS) is used for the timely of huge synchronization volumes of artifact metadata between customer sites.

The Artifactory Federation Service (RTFS) is used for the timely synchronization of huge volumes of artifact metadata between customer sites.

❗️

Important

The Artifactory Federation Service requires:

  • Artifactory 7.104 or later.
  • RTFS is not supported for native installations below version 7.111.
  • PostgreSQL 13 or later. Support for other databases is under consideration.

For more information, see the Artifactory Federation Service.

❗️

Important

Self-hosted customers who wish to become early adopters of this service are asked to contact JFrog so that we can evaluate your needs and guide you through the migration process.

Please note that the current version of the Artifactory Federation Service does not support the use of self-signed certificates or certificates signed by a custom Certificate Authority (CA). Self-hosted customers must use certificates signed by a trusted CA when setting up their Federation.

Enable Artifactory Federation Service

The Artifactory Federation Service can be enabled only through native installations (such as Docker, Docker Compose, Windows, RPM, Linux, and Debian) or via Helm installation for Kubernetes. By default, this service is disabled.

  1. Enable Artifactory Federation service in Artifactory by updating the Artifactory system.yaml file:

    rtfs:
      enabled: true

    For HA Installations

    You must enable Artifactory Federation microservice in all Artifactory nodes.

    For Helm Installations

    Add the above section to the custom-values.yaml file and run the Helm upgrade command.

  2. Restart Artifactory.

  3. Verify if the Artifactory Federation Service is up and running:

    • For self-hosted versions 7.111.12 and later or 7.117.5 and later:

      GET http://<JFROG_PLATFORM_URL>/rtfs/api/v1/system/liveness

    • For earlier self-hosted versions:

      GET http://<JFROG_PLATFORM_URL>/artifactory/service/rtfs/api/v1/system/liveness

    A 200 response indicates the presence of Artifactory Federation Service.

  4. [Users with existing Federated repositories] Migrate your existing Federated repositories (including configurations, states, and events) to the new service. For more information, see Migrate to the Artifactory Federation Service.



📘

Federation over Bridge

RTFS supports federation over JFrog Bridge for secure communication between SaaS and self-managed environments without VPN. For details, see Federation with Secure Private Link (Bridge).