Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Export & Import release bundle docs #107

Merged
merged 10 commits into from
Apr 17, 2024
Original file line number Diff line number Diff line change
Expand Up @@ -330,3 +330,56 @@ Delete the distributions of release bundle named myApp with version 1.0.0 from e
Delete the distributions of the release bundle associated with project "proj" from the provided edge nodes. Run the command synchronously and skip the confirmation message.

jf rbd --dist-rules=/path/to/dist-rules.json --project="proj" --quiet --sync myApp 1.0.0

## Exporting Release Bundle Archive
EyalDelarea marked this conversation as resolved.
Show resolved Hide resolved
JFrog Distribution supports distributing your Release Bundles to remote Distribution Edge nodes within an Air Gap environment. This use case is mainly intended for organizations such as financial institutions and military installations that have two or more JFrog Artifactory instances that have no network connection between them.
EyalDelarea marked this conversation as resolved.
Show resolved Hide resolved

The procedure below describes how to export a Release Bundle v2 to a .zip file that can be transferred to a different Artifactory instance in an Air Gap environment.
EyalDelarea marked this conversation as resolved.
Show resolved Hide resolved


| | |
|------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------|
| Command-name | release-bundle-export |
| Abbreviation | rbe |
| Command arguments | |
| release bundle name | Name of the release bundle to distribute. |
EyalDelarea marked this conversation as resolved.
Show resolved Hide resolved
| release bundle version | Version of the release bundle to distribute.
EyalDelarea marked this conversation as resolved.
Show resolved Hide resolved
| target pattern | Specifies the local file system target download path
EyalDelarea marked this conversation as resolved.
Show resolved Hide resolved
| Command options | |
| --project | <p>[Optional]<br><br>Project key associated with the Release Bundle version.</p> |
| --server-id | <p>[Optional]<br><br>Platform server ID configured using the config command.</p> |
| mapping-pattern | <p>[Optional]<br><br> Specify a list of input regex mapping pairs that define where the queried artifact is located and where it should be placed after it is imported
| mapping-target | <p>[Optional]<br><br> Specify a list of output regex mapping pairs that define where the queried artifact is located and where it should be placed after it is imported

#### Example
Export release bundle named "myApp" and version 1.0.0

jf rbe myApp 1.0.0

#### Example
Download to a specific location

jf rbe myApp 1.0.0 /user/mybundle/


## Importing Release Bundle Archive
EyalDelarea marked this conversation as resolved.
Show resolved Hide resolved
Import a Release Bundle archive from a release bundle exported zip file.

Please note this functionality only works on Edge nodes within an Air Gap environment.
EyalDelarea marked this conversation as resolved.
Show resolved Hide resolved

| | |
|------------------------|----------------------------------------------------------------------------------|
| Command-name | release-bundle-import |
| Abbreviation | rbi |
| Command arguments | |
| path to archive | path to the release bundle archive on the filesystem |
EyalDelarea marked this conversation as resolved.
Show resolved Hide resolved
| Command options | |
| --project | <p>[Optional]<br><br>Project key associated with the Release Bundle version.</p> |
| --server-id | <p>[Optional]<br><br>Platform server ID configured using the config command.</p> |

#### Example
Export release bundle named "myExportedApp" and version 1.0.0
EyalDelarea marked this conversation as resolved.
Show resolved Hide resolved

jf rbi ./myExportedApp.zip


Loading