From 70b160e3ba79ee5d2b4f0901e25308d99d8580ba Mon Sep 17 00:00:00 2001 From: michaelbe-jfrog <142221216+michaelbe-jfrog@users.noreply.github.com> Date: Thu, 24 Aug 2023 15:31:51 +0300 Subject: [PATCH] Updating CLI doc to emphasize v1 (#2151) --- documentation/CLI-for-JFrog-Distribution.md | 72 ++++++++++----------- 1 file changed, 36 insertions(+), 36 deletions(-) diff --git a/documentation/CLI-for-JFrog-Distribution.md b/documentation/CLI-for-JFrog-Distribution.md index 0aa69a781..fab7885d5 100644 --- a/documentation/CLI-for-JFrog-Distribution.md +++ b/documentation/CLI-for-JFrog-Distribution.md @@ -1,4 +1,4 @@ -JFrog CLI : CLI for JFrog Distribution +JFrog CLI: CLI for JFrog Distribution ====================================== @@ -25,11 +25,11 @@ The following sections describe the commands available in the JFrog CLI for use ### Creating or updating an unsigned Release Bundle -This commands creates and updates an unsigned Release Bundle on JFrog Distribution. +This command creates and updates an unsigned Release Bundle v1 on JFrog Distribution. --- **Note** -> This commands require version 2.0 or higher of[JFrog Distribution](https://jfrog-staging-external.fluidtopics.net/r/help/Software-Distribution-Distribution). +> This commands require version 2.0 or higher of [JFrog Distribution](https://jfrog-staging-external.fluidtopics.net/r/help/Software-Distribution-Distribution). --- | | | @@ -40,58 +40,58 @@ This commands creates and updates an unsigned Release Bundle on JFrog Distributi | --server-id | \[Optional\]

Artifactory server ID configured using the config command. | | --spec | \[Optional\]

Path to a file spec. For more details, please refer to[Using File Specs](https://www.jfrog.com/confluence/display/CLI/CLI+for+JFrog+Artifactory#CLIforJFrogArtifactory-UsingFileSpecs). | | --spec-vars | \[Optional\]

List of variables in the form of "key1=value1;key2=value2;..." to be replaced in the File Spec. In the File Spec, the variables should be used as follows: ${key1}. | -| --target-props | \[Optional\]

The list of properties, in the form of key1=value1;key2=value2,..., to be added to the artifacts after distribution of the release bundle. | -| --target | \[Optional\]

The target path for distributed artifacts on the edge node. If not specified, the artifacts will have the same path and name on the edge node, as on the source Artifactory server. For flexibility in specifying the distribution path, you can include [placeholders](https://www.jfrog.com/confluence/display/CLI/CLI+for+JFrog+Artifactory#CLIforJFrogArtifactory-UsingPlaceholders) in the form of {1}, {2} which are replaced by corresponding tokens in the pattern path that are enclosed in parenthesis. | +| --target-props | \[Optional\]

The list of properties, in the form of key1=value1;key2=value2,..., to be added to the artifacts after distribution of the Release Bundle v1. | +| --target | \[Optional\]

The target path for distributed artifacts on the Edge node. If not specified, the artifacts will have the same path and name on the Edge node as on the source Artifactory server. For flexibility in specifying the distribution path, you can include [placeholders](https://www.jfrog.com/confluence/display/CLI/CLI+for+JFrog+Artifactory#CLIforJFrogArtifactory-UsingPlaceholders) in the form of {1}, {2} which are replaced by corresponding tokens in the pattern path that are enclosed in parenthesis. | | --dry-run | \[Default: false\]

Set to true to disable communication with JFrog Distribution. | -| --sign | \[Default: false\]

If set to true, automatically signs the release bundle version. | +| --sign | \[Default: false\]

If set to true, automatically signs the Release Bundle version. | | --passphrase | \[Optional\]

The passphrase for the signing key. | -| --desc | \[Optional\]

Description of the release bundle. | -| --release-notes-path | \[Optional\]

Path to a file describes the release notes for the release bundle version. | +| --desc | \[Optional\]

Description of the Release Bundle. | +| --release-notes-path | \[Optional\]

Path to a file describes the release notes for the Release Bundle version. | | --release-notes-syntax | \[Default: plain_text\]

The syntax for the release notes. Can be one of _markdown_, _asciidoc_, or _plain_text_. | -| --exclusions | \[Optional\]

A list of Semicolon-separated exclude path patterns, to be excluded from the Release Bundle. Allows using wildcards. | -| --repo | \[Optional\]

A repository name at source Artifactory to store release bundle artifacts in. If not provided, Artifactory will use the default one. | +| --exclusions | \[Optional\]

A list of semicolon-separated exclude path patterns to be excluded from the Release Bundle. Allows using wildcards. | +| --repo | \[Optional\]

A repository name at source Artifactory in which to store Release Bundle artifacts. If not provided, Artifactory will use the default one. | | --insecure-tls | \[Default: false\]

Set to true to skip TLS certificates verification. | -| --detailed-summary | \[Default: false\]

Set to true to return the SHA256 value of the release bundle manifest. | +| --detailed-summary | \[Default: false\]

Set to true to return the SHA256 value of the Release Bundle manifest. | | Command arguments | | -| release bundle name | The name of the release bundle. | -| release bundle version | The release bundle version. | -| pattern | Specifies the source path in Artifactory, from which the artifacts should be bundled, in the following format: <repository name>/<repository path>. You can use wildcards to specify multiple artifacts. This argument should not be sent along with the _--spec_ option. | +| release bundle name | The name of the Release Bundle. | +| release bundle version | The Release Bundle version. | +| pattern | Specifies the source path in Artifactory from which the artifacts should be bundled, in the following format: <repository name>/<repository path>. You can use wildcards to specify multiple artifacts. This argument should not be sent along with the _--spec_ option. | ##### Examples ##### Example 1 -Create a release bundle with name myApp and version 1.0.0. The release bundle will include the files defined in the File Spec specified by the --spec option. +Create a Release Bundle v1 with the name myApp and version 1.0.0. The Release Bundle will include the files defined in the File Spec specified by the --spec option. jf ds rbc --spec=/path/to/rb-spec.json myApp 1.0.0 ##### Example 2 -Create a release bundle with name myApp and version 1.0.0. The release bundle will include the files defined in the File Spec specified by the --spec option. GPG sign the release bundle after it is created. +Create a Release Bundle v1 with the name myApp and version 1.0.0. The Release Bundle will include the files defined in the File Spec specified by the --spec option. GPG signs the Release Bundle after it is created. jf ds rbc --spec=/path/to/rb-spec.json --sign myApp 1.0.0 ##### Example 3 -Update the release bundle with name myApp and version 1.0.0. The release bundle will include the files defined in the File Spec specified by the --spec option. +Update the Release Bundle v1 with the name myApp and version 1.0.0. The Release Bundle will include the files defined in the File Spec specified by the --spec option. jf ds rbu --spec=/path/to/rb-spec.json myApp 1.0.0 ##### Example 4 -Update the release bundle with name myApp and version 1.0.0. The release bundle will include all the zip files inside the zip folder, located at the root of the _my-local-repo_ repository. +Update the Release Bundle v1 with the name myApp and version 1.0.0. The Release Bundle will include all the zip files inside the zip folder, located at the root of the _my-local-repo_ repository. jf ds rbu myApp 1.0.0 "my-local-repo/zips/*.zip" ##### Example 5 -Update the release bundle with name myApp and version 1.0.0. The release bundle will include all the zip files inside the zip folder, located at the root of the _my-local-repo_ repository. The files will be distributed on the Edge Node to the _target-zips_ folder, under the root of the _my-target-repo_ repository. +Update the Release Bundle v1 with the name myApp and version 1.0.0. The Release Bundle will include all the zip files inside the zip folder, located at the root of the _my-local-repo_ repository. The files will be distributed to the Edge node to the _target-zips_ folder, under the root of the _my-target-repo_ repository. jf ds rbu myApp 1.0.0 "my-local-repo/zips/*.zip" --target my-target-repo/target-zips/ ##### Example 6 -This example uses [placeholders](https://www.jfrog.com/confluence/display/CLI/CLI+for+JFrog+Artifactory#CLIforJFrogArtifactory-UsingPlaceholders). It creates the release bundle with name myApp and version 1.0.0. The release bundle will include all the zip files inside the zip folder, located at the root of the _my-local-repo_ repository. The files will be distributed on the Edge Node to the _target-zips_ folder, under the root of the _my-target-repo_ repository. In addition, the distributed files will be renamed on the Edge Node, by adding _-target_ to the name of each file. +This example uses [placeholders](https://www.jfrog.com/confluence/display/CLI/CLI+for+JFrog+Artifactory#CLIforJFrogArtifactory-UsingPlaceholders). It creates a Release Bundle v1 with the name myApp and version 1.0.0. The Release Bundle will include all the zip files inside the zip folder, located at the root of the _my-local-repo_ repository. The files will be distributed to the Edge node to the _target-zips_ folder, under the root of the _my-target-repo_ repository. In addition, the distributed files will be renamed on the Edge node, by adding _-target_ to the name of each file. jf ds rbc myApp 1.0.0 "my-local-repo/zips/(*).zip" --target "my-target-repo/target-zips/{1}-target.zip" @@ -111,28 +111,28 @@ This command GPG signs an existing Release Bundle on JFrog Distribution. | Command options | | | --server-id | \[Optional\]

Artifactory server ID configured using the config command. | | --passphrase | \[Optional\]

The passphrase for the signing key. | -| --repo | \[Optional\]

A repository name at source Artifactory to store release bundle artifacts in. If not provided, Artifactory will use the default one. | +| --repo | \[Optional\]

A repository name at source Artifactory to store Release Bundle artifacts in. If not provided, Artifactory will use the default one. | | --insecure-tls | \[Default: false\]

Set to true to skip TLS certificates verification. | -| --detailed-summary | \[Default: false\]

Set to true to return the SHA256 value of the release bundle manifest. | +| --detailed-summary | \[Default: false\]

Set to true to return the SHA256 value of the Release Bundle manifest. | | Command arguments | | -| release bundle name | The name of the release bundle. | -| release bundle version | The release bundle version. | +| release bundle name | The name of the Release Bundle. | +| release bundle version | The Release Bundle version. | ##### Examples ##### Example 1 -GPG sign the release bundle with name myApp and version 1.0.0. +GPG signs the Release Bundle v1 with the name myApp and version 1.0.0. jf ds rbs --passphrase="<passphrase>" myApp 1.0.0 ### Distributing a Release Bundle -This command distributes a release bundle to the Edge Nodes. +This command distributes a Release Bundle v1 to the Edge nodes. --- **Note** -> These commands require version 2.0 or higher of[JFrog Distribution](https://www.jfrog.com/confluence/display/JFROG/JFrog+Distribution). +> These commands require version 2.0 or higher of [JFrog Distribution](https://www.jfrog.com/confluence/display/JFROG/JFrog+Distribution). --- | | | @@ -151,14 +151,14 @@ This command distributes a release bundle to the Edge Nodes. | --country-codes | \[Default: *\]

Semicolon-separated list of wildcard filters for site country codes. | | --insecure-tls | \[Default: false\]

Set to true to skip TLS certificates verification. | | Command arguments | | -| release bundle name | The name of the release bundle. | -| release bundle version | The release bundle version. | +| release bundle name | The name of the Release Bundle. | +| release bundle version | The Release Bundle version. | ##### Examples ##### Example 1 -Distribute the release bundle with name myApp and version 1.0.0. Use the distribution rules defined in the specified file. +Distribute the Release Bundle v1 with the name myApp and version 1.0.0. Use the distribution rules defined in the specified file. jf ds rbd --dist-rules=/path/to/dist-rules.json myApp 1.0.0 @@ -166,7 +166,7 @@ Distribute the release bundle with name myApp and version 1.0.0. Use the distrib ### Deleting a Release Bundle -This command deletes a Release Bundle from the Edge Nodes and optionally from Distribution as well. +This command deletes a Release Bundle v1 from the Edge nodes and optionally from Distribution as well. --- **Note** @@ -186,24 +186,24 @@ This command deletes a Release Bundle from the Edge Nodes and optionally from Di | --site | \[Default: *\]

Wildcard filter for site name. | | --city | \[Default: *\]

Wildcard filter for site city name. | | --country-codes | \[Default: *\]

Semicolon-separated list of wildcard filters for site country codes. | -| --delete-from-dist | \[Default: false\]

Set to true to delete release bundle version in JFrog Distribution itself after deletion is complete in the specified Edge nodes. | +| --delete-from-dist | \[Default: false\]

Set to true to delete the Release Bundle version in JFrog Distribution itself after deletion is complete in the specified Edge nodes. | | --quiet | \[Default: false\]

Set to true to skip the delete confirmation message. | | --insecure-tls | \[Default: false\]

Set to true to skip TLS certificates verification. | | Command arguments | | -| release bundle name | The name of the release bundle. | -| release bundle version | The release bundle version. | +| release bundle name | The name of the Release Bundle. | +| release bundle version | The Release Bundle version. | ##### Examples ##### Example 1 -Delete the release bundle with name myApp and version 1.0.0 from the Edge Nodes only, according to the definition in the distribution rules file. +Delete the Release Bundle v1 with the name myApp and version 1.0.0 from the Edge nodes only, according to the definition in the distribution rules file. jf ds rbdel --dist-rules=/path/to/dist-rules.json myApp 1.0.0 ##### Example 2 -Delete the release bundle with name myApp and version 1.0.0 from the Edge Nodes, according to the definition in the distribution rules file. The release bundle will also be deleted from the Distribution service itself. +Delete the Release Bundle v1 with the name myApp and version 1.0.0 from the Edge nodes, according to the definition in the distribution rules file. The Release Bundle will also be deleted from the Distribution service itself. jf ds rbdel --delete-from-dist --dist-rules=/path/to/dist-rules.json myApp 1.0.0