Glossary

JFrog Connect glossary of terms and concepts

The glossary provides brief descriptions of key concepts and terms used in JFrog Connect.

Access Scoping

A method integrated into JFrog Connect's Registry configuration to ensure that only intended artifacts are distributed from Artifactory or Artifactory Edge registries. It involves defining which Artifactory Projects, Artifactory Environments, and Connect Fleets are included in the scope. See Registry, Add Artifactory Access Scope.

Access Token

A credential required to use the JFrog Connect REST API. The user-scoped token (API v2) provides access according to the user role (admin or non-admin) defined for the user in the JFrog Platform.

The resource-scoped token (API v2), also known as a device details token or a custom token, has permissions that are customized for a specific purpose. For example, the token allows access only to certain resources and functions. See Connect API Reference.

Connect Agent

Software installed on a connected device that communicates with the JFrog Connect service. Connect Agent’s functions include facilitating software deployments based on defined flows. It also enables remote access and control commands, configuring device firewall rules, and retrieving logs and data files. The agent is fleet-linked, allowing for different configuration settings per fleet. See Connect Agent.

Deployment

An object in JFrog Connect that associates an flow with a specific group or subset of devices and defines the triggering for the software update. Deployments implement the update flows and can be created via the web UI or the API. Deployment configuration includes selecting devices, setting a deployment tag and version, and scheduling. See Deploy Software.

Deployment Tag

A feature in JFrog Connect used to identify the specific set of software in a deployment. A deployment tag serves as another method for grouping devices. By setting a deployment tag and version during a deployment, you can associate the software update with the target devices, facilitating tracking of which software and version are running on a specific device. See Set Deployment Tag and Version.

Device

An endpoint hardware unit (any connected device, such as an edge or IoT device) running a compatible operating system and the JFrog Connect Agent to connect to the JFrog Connect service. Devices are the fundamental units managed by the platform and are registered to a single fleet. Devices can be organized using fleets, groups, tags, and deployment tags. See Architecture Overview, Connect Agent.

Fleet

The primary organizational unit in JFrog Connect used to group and manage devices, and create associated configurations such as groups, registries, update flows, and user permissions. Fleets provide entirely separate environments for users and devices, enabling differentiation based on product, location, or use case. See Organize Your Account, Create Fleet.

Flow (or Update Flow)

A completely customizable approach to software deployments (also called updates) defined in JFrog Connect as a set of steps. A flow represents a reusable procedure or set of steps for deploying software updates to devices. Flows can be built in the web UI or with the API by arranging individual steps in sequence. Flows can be parameterized, making them flexible templates, reusable across different deployments, versions, content, or device groups. See Create Update Flow.

Group

An organizational unit within a fleet used to segment the account into manageable subsets. Fleets are created with default Test and Production groups. Devices must be assigned to groups during registration or afterwards via the UI or API. Groups can be organized into a two-level hierarchy. See Organize Your Account, Create Groups.

Fleet Key

A unique lowercase alphanumeric string (2 to 32 characters, starting with a letter) that identifies a fleet. It is used to group objects belonging to the same fleet, such as in the audit log. The Fleet Key is a required path parameter in many API v2 calls. See Create Fleet.

Step

A discreet task that serves as a fundamental building block within a JFrog Connect update flow. Steps are carried out in sequence within a flow to perform the software update. A flow may include many steps. Each step is based on a step type that is configured for its specific purpose in the flow. See Create Update Flow.

Step Type

A template for a step in an update flow. When a step type is chosen for a step in an update flow, its parameters are configured with values that are specifically for the purpose of that update flow. A few examples of step types include:

• Run Script: Runs a bash script on a device.

• Download Artifact: Distributes artifacts from JFrog Artifactory.

• Deploy Docker Image: Deploys a Docker container image.

Each step type can be configured with an On Failure policy, which defines what happens if the step fails during a deployment. See Step Types.

Update Parameter

Variables defined within an Update Flow that allow specific values (like file paths, version numbers, or configuration details) to be provided at the time a deployment is created. Parameterization enhances the reusability of flows by making them adaptable to different deployment scenarios without modification. See Update Parameters.