Download Release Bundle

A release bundle groups together the contents that make up your release and provides the bill of materials for the release. For example, you can group together the different build artifacts, such as Docker images, that make up your release. The group of files can then be deployed as a single unit to your IoT devices.

A release bundle plays a central role in the distribution flow. It specifies the different files, packages, and metadata that comprise a release, and is created and managed in JFrog Distribution. Since all the files specified in a release bundle are required in order to keep the release coherent, a release bundle is immutable.

JFrog Connect supports Release Bundles v1 and v2.

Download Release Bundle Action

The Download Release Bundle action enables you to deploy a versioned package of software artifacts to your edge devices. In addition, a release bundle has the ability to deploy Docker images using the Docker Compose engine.

Prerequisites

• Connect Agent 6.0 or later and at least one device registered.

• A release bundle that is ready for deployment.

Drag the Action

To include the Download Release Bundle action in your update flow, do the following:

1. Go to Deployment in the left menu and click Create Update Flow..

2. Drag the Download Release Bundle action and drop it in the workflow.

Configure the Action

Click the action to open and configure it.

1. Enter a name for the action.

2. Enter your JFrog Registry in the dropdown box. If the registry does not appear in the list, go to Add JFrog Registry to add yours to the list. Then return to this configuration and the added registry will appear in the list.

1. Enter a Name for your release bundle and the Version of the release bundle that you used in Artifactory.

1. Enter the Device Destination Path. This is where the release bundle will be installed on the edge devices. The directory on the device must exist beforehand, otherwise, the update will fail. Connect does not automatically create directories when deploying updates. You may create a folder using the Run Command action in the General Section.

2. (Optional) If you have one or more files in your release bundle that need to go to different paths on the edge device, mark Release Bundle Artifact Path. Then specify the Release Bundle Path and the Device Destination Path for each file.

1. (Optional) If your release bundle includes Docker images, mark Docker Compose, then specify the Release Bundle Path and the Device Destination Path for the Docker Compose YAML file.

1. Configure your On Failure policy and instructions for rolling back, if necessary.

2. Save your action configuration.

Artifactory Edge

If you want the action to pull content from an Artifactory Edge account, complete the procedure in Add JFrog Registry, and then choose that registry as your JFrog Registry in Step 2 above.

On Failure and Rollback

For your On Failure policy, choose the actions for Connect to do in case the Download Release Bundle action fails.

• Continue Update Flow: If the Download Release Bundle action fails, Connect will simply continue with the next action block in the update workflow.

• Run General Rollback: The action and the entire update workflow are rolled back.

• Do Action: The action to do when this action is rolled back. In this case, the action is to revert all files.

Revert all Files

As a general precaution, Connect Agent creates a backup of the relevant device folder in a temporary location. If a rollback is required, the agent restores the folder to its initial state.

Free Memory Requirement

In order to enable Rollback functionality, your device's free memory must be greater than the update size. To calculate the amount of free memory required, use the relationship below:

Free Memory Required > Current Folder Size + Update Size + 10MB

What’s Next?

Learn more about Update Parameters and find out how they might be useful for your Release Bundles workflow.