Distribute a Release Bundle v2 Version using the Platform UI

Release Bundle v2 versions are distributed from the version timeline.

📘

Subscription Information

This feature is supported with the Enterprise+ license.

To distribute a Release Bundle v2 version:

1. In the Platform module, select Artifactory > Release Lifecycle.

2. Click the name of the relevant Release Bundle. The Versions tab is displayed by default.

3. Click the name of the relevant Release Bundle version. The Version Timeline tab is displayed by default.

4. Click Actions and then select Distribute. The Distribute window is displayed.

5. In the Distribution Targets tab, select the desired distribution targets (e.g. Edge nodes).

   

📘

Note

A checkmark next to a grayed-out distribution target indicates that the target already contains the selected Release Bundle version. To redistribute the same Release Bundle version to that target, you must first delete the previous distribution, as described in Delete a Release Bundle (v2) from Multiple Edge Nodes.

✅

Tip

If no distribution targets are displayed, click the link provided in the window to see suggestions about the possible cause.

6. (optional) Select the Auto create missing repositories checkbox to have any missing repositories in the distribution targets created automatically. If this option is not selected and a missing repository is detected, distribution will fail.

📘

Note

By default, the repositories on the target will match those at the source. To change this behavior, see Configure Path Mapping from the Last Promotion.

7. Click Next to move to the Additional Settings tab.

8. (optional) Specify a list of input and output regex mapping pairs that define where the queried artifact is located and where it should be placed. Use this option if the path on the target is different than the source path.

   

   There are several options for defining path mappings:

   • You can define custom mapping pairs manually and click Add.

   • You can click Use Template to use one of the provided Path Mapping templates:

• If the Default Path Mapping by Last Promotion feature is enabled (requires Distribution 2.26.1 or higher), the repositories used for the most recent promotion of this Release Bundle version are provided as the default path mapping. If you do not want this path mapping definition, click the X to remove it.

  

❗️

Important

See Path Mapping Guidelines for Release Bundles v2 for important instructions and limitations regarding path mapping.

9. Click Distribute. The status of the distribution operation is displayed in the version timeline. There will be an entry in the timeline for each distribution target. For example, if you distribute the Release Bundle to 3 Edge nodes, three entries will be added to the timeline (one for each target).

⚠️

Warning

When JFrog Xray is used to scan Release Bundles for potential vulnerabilities and license violations, Xray will block promotion if the Release Bundle violates a Policy that has a blocking action defined. Scan results are shown in the timeline event (as shown below) and in the Xray tab of the dashboard.

For more information, see Scan Release Bundle v2 Versions with Xray.

📘

Note

If the distribution operation included multiple targets, and one or more targets did not receive the Release Bundle version successfully, users will still be able to download the artifacts from those targets that did receive it successfully.

✅

Tip

To view distribution details after the operation is complete, click the relevant event in the timeline. The Content tab shows the list of artifacts included in the distribution. The Path Mapping tab records the path mapping that was used between the source and target.

Configure Path Mapping from the Last Promotion

Starting with release 2.26.1, JFrog Distribution includes an option for defining a default path mapping when distributing or exporting a Release Bundle v2 version. This option can be enabled in the Distribution YAML file for all Release Bundle v2 distributions or via API for specific distribution operations, as described below.

When the default path mapping option is enabled, the default destination repositories from the last successful promotion, if one exists, will be displayed in the UI. You can use this mapping if desired, replace it with a mapping of your own, or leave the fields blank. If no such promotion has been performed, the path mapping fields in the UI are left blank, and the destination repositories will match those at the source, which is the default system behavior.

Enable Default Path Mapping

The option for defining a default path mapping is enabled as follows:

• YAML file: A new configuration parameter, default-path-mapping-by-last-promotion (default=false) has been introduced to support this feature at the system level. For more information, see Distribution Application Config YAML File.
• REST API: This feature can be enabled using an optional request parameter in the Distribute Release Bundle Version v2 API. This is useful for enabling the feature for specific requests, facilitating a gradual rollout of this feature.

📘

Note

If the optional request parameter is configured in the API (true or false), that setting overrides the configuration parameter in the YAML file.

Path Mapping Guidelines for Release Bundles v2

Observe the guidelines below when defining path mappings for distributed Release Bundle v2 versions to Edge nodes.

When the enhanced distribution engine is not activated or not available (before release 2.28.1)

• You can define path mapping only during the first distribution or export of a Release Bundle version.
• Each distribution target must use the same path mapping.
• Once a path mapping has been defined, it cannot be changed afterward.

When the enhanced distribution engine is available and activated (release 2.28.1 or later)

📘

Note

For more information about the enhanced distribution engine, see Distribution 2.28.1.

• Each distribution operation can have one defined path mapping.
• You can define different path mappings for each distribution target by executing multiple distribution operations.
• The path mapping functionality described above does not apply to exported archives in air-gap environments in the current version.
• Once you define path mappings to a target you cannot define a different set of path mappings for the same Release Bundle version to that target.
• You can use the REST API to redistribute a Release Bundle version to a target that already has that version provided the path mapping has not changed. If the path mapping has changed, you must first delete the Release Bundle version from the target before redistributing it. When using the platform UI, you must delete the Release Bundle version before redistributing it even when the path mapping has not changed.
• After activating the enhanced distribution engine, you must create a new version of Release Bundles that were distributed before activation before they can be redistributed.
• If the enhanced distribution engine is activated and later deactivated, you must create a new version of Release Bundles that were distributed during activation before they can be redistributed.
• Enhanced distribution features are available only when the source Artifactory and all Edge nodes have been upgraded to Artifactory 7.101.2 or later and Distribution 2.28.1 or later. If you try distributing a Release Bundle version to a mix of upgraded and non-upgraded Edge nodes, the operation will fail.

Stop a Distribution Operation in Progress

You can stop the distribution of a Release Bundle v2 version while it is in progress. Stopping the distribution aborts the operation.

To stop the distribution of a Release Bundle v2 version:

1. Initiate the distribution operation, as described in Distribute a Release Bundle v2 Version using the Platform UI. An entry is added to the timeline indicating the distribution operation is in progress.

2. Click the timeline entry to open the window that displays the content and current status of the operation.

3. In the Progress field at the top of the window, click the red stop icon. A confirmation window is displayed.

   

4. Click Stop Distribution. The status of the timeline entry changes to Abort in progress. When complete, the timeline indicates that the operation was canceled.