Download Artifacts

The Download Artifacts action block enables you to deploy updates to your devices by specifying a path in JFrog Artifactory to a destination path on your device.

Overview

The Download Artifacts action block enables you to create a workflow that pulls artifacts from your Artifactory instance and deploys them to your edge devices. You can deploy one or multiple artifacts using a single action block.

Deployments using Artifactory consider the checksums of the files delivered. Therefore, the devices will pull only the diffs when downloading updates to files.

Prerequisites

  • JFrog Connect and JFrog Platform accounts. (You receive a JFrog Platform account automatically when you register for a JFrog Connect account.)

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

  • One or more files ready for deployment and stored in your Artifactory repository.

Drag the Action Block

To include the Download Artifacts action block in your update flow, do the following:

  1. Go to Updates in the left sidebar and click Create Update Flow.

  1. Drag the Download Artifacts action block and drop it in the workflow.

Configure the Action Block

Click the action block to open and configure it.

  1. Enter a name for the action block.

  2. Choose the JFrog Platform account where your artifacts are stored. If your account name does not appear in the list, click Add (+) to add yours to the list.

  1. Enter the Artifactory Path, for example, generic-repo/1.0/file.txt. You can also make all or part of the path a parameter. For example, you could make the version folder a parameter: generic-repo/{{version}}/file.text. Then you enter the version value when the actual deployment is run.

  1. If you want to deliver more than one file, click Add (+). Add an additional row for each additional file to deliver.

  1. Enter the Destination Path on Device. 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 block in the General Section.

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

  3. Save your action block configuration.

Artifactory Edge

If you want the action block to pull content from an Artifactory Edge account, complete the procedures in Link to Artifactory Edge.

On Failure and Rollback

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

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

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

  • Do Action: The action to do when this action block 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 how to build a workflow using a Download Release Bundle.

Last updated