Install the JFrog Bridge (Self-Managed)

Enable secure communication between your JFrog Platform Deployment (JPD) and JFrog ML for Self-Managed systems.

For self-managed environments, setting up the JFrog Bridge is the mandatory first step to unlock AI/ML capabilities for your organization.

The following steps explain how to install the JFrog Bridge. For more information, see Manage Bridges.

Prerequisites

Before you install the JFrog Bridge, confirm the following:

  • You must have Platform Administrator privileges to verify that the JFrog Bridge has been installed.
    • To use AI/ML capabilities, your JFrog Platform must meet the following minimum version requirements:

      ProductMinimum Version
      Artifactory7.117.5
      Xray3.137.30
      Package Catalog1.34.6

When You Need a Self-Managed JFrog ML Cluster

A self-managed JFrog ML cluster (the data plane) is required only when you need data plane capabilities in your environment. If you do not need any of the capabilities in the following list, you do not need to install a self-managed cluster.

Install a self-managed cluster when you need to:

📘

Note

The JFrog Bridge is required for all self-managed AI/ML use cases. Install the JFrog Bridge using the steps in Install the Bridge even when you do not install a self-managed JFrog ML cluster.

Install the Bridge

Use the AI/ML setup workflow in the JFrog Platform to configure the JFrog Bridge client and generate the Helm command for your Kubernetes cluster.

To install the JFrog Bridge:

  1. Navigate to AI/ML.

  2. In the Internal Artifactory URL field, enter the URL that allows the Bridge client (running in your Kubernetes cluster) to communicate with your JFrog Platform Deployment (JPD).

    📘

    The JFrog Bridge should be installed where it has a network connection to Artifactory.

  3. In the Administration module, select Security > General and scroll down to Connection details.

  4. Copy the Join Key and download the values.yaml file.

  5. Copy the generated Helm command snippet and run it in the Kubernetes cluster where your JPD is installed.

    The following is an example complete Helm command snippet.

    helm repo add jfrog https://charts.jfrog.io/ && \\
    helm repo update && \\
    helm install jfrog-bridge jfrog/bridge --set jfrogUrl="<YOUR_JPD_URL>" --set tunnel.client.bridges.jfrogml.local.url="<YOUR_INTERNAL_ARTIFACTORY_URL>" --values values.yaml --set joinKey=<JOIN_KEY>
    

    Where:

    • The jfrogUrl parameter in the Helm command snippet will update automatically according to your base URL.
    • The tunnel.client.bridges.jfrogml.local.url parameter will update automatically according to the Internal Artifactory URL that you input.
    • The <JOIN_KEY>: The join key you copied from Connection details.
  6. Select the confirmation checkbox I've successfully installed the JFrog Bridge....

  7. Click Next.


Frequently Asked Questions

This section provides answers to frequently asked questions.

FAQs
Q: How do I install the JFrog Bridge in a self-managed environment?

A: Follow the steps in Install the Bridge: configure the Internal Artifactory URL, copy the join key from Connection details, and run the generated Helm command in your Kubernetes cluster.

Q: Do I need a self-managed JFrog ML cluster for every AI/ML use case?

A: No. Install a cluster only when you need the data plane capabilities listed in When You Need a Self-Managed JFrog ML Cluster. You must still install the JFrog Bridge for all self-managed AI/ML use cases.

Q: What JFrog Platform versions are required for AI/ML capabilities?

A: Your JFrog Platform must run on the Platform versions listed above under Prerequisites.

Q: What permissions do I need to verify JFrog Bridge installation?

A: You need Platform Administrator privileges to confirm the JFrog Bridge is installed. For ongoing Bridge management, see Manage Bridges.

Q: Can I use JFrog ML without installing a self-managed JFrog ML cluster?

A: Yes, when you do not need local data plane capabilities. You must still install the JFrog Bridge to connect your JFrog Platform to JFrog ML.

Related Topics