Skip to content

Commit 1bf8bf3

Browse files
doc: Update legacy cli docs (Supersedes #723) (#724)
Update OCM CLI documentation for new release in folder content_versioned/version-legacy --------- Signed-off-by: Frederic Wilhelm <frederic.wilhelm@sap.com> Co-authored-by: ocmbot[bot] <125909804+ocmbot[bot]@users.noreply.github.com>
1 parent b9f8abd commit 1bf8bf3

File tree

11 files changed

+72
-13
lines changed

11 files changed

+72
-13
lines changed

.github/config/wordlist.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -132,6 +132,7 @@ fluxvaluessource
132132
foldername
133133
forwardspec
134134
frontend
135+
fulcio
135136
gapped
136137
gav
137138
getinexpensivecontentversionidentity
@@ -307,6 +308,7 @@ reconciledversion
307308
reconciler
308309
refcount
309310
referencesconfig
311+
rekor
310312
relativeocireference
311313
releaser
312314
replicatedrepositoryurl

content_versioned/version-legacy/docs/reference/ocm-cli/_index.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -309,6 +309,26 @@ The value can be a simple type or a JSON/YAML string for complex values
309309
the backend and descriptor updated will be persisted on AddVersion
310310
or closing a provided existing component version.
311311

312+
- <code>ocm.software/ocm/api/ocm/extensions/attrs/maxworkers</code> [<code>maxworkers</code>]: *integer* or *"auto"*
313+
314+
Specifies the maximum number of concurrent workers to use for resource and source,
315+
as well as reference transfer operations.
316+
317+
Supported values:
318+
- A positive integer: use exactly that number of workers.
319+
- The string "auto": automatically use the number of logical CPU cores.
320+
- Zero or omitted: fall back to single-worker mode (1). This is the default.
321+
This mode guarantees deterministic ordering of operations.
322+
323+
Precedence:
324+
1. Attribute set in the current OCM context.
325+
2. Environment variable OCM_TRANSFER_WORKER_COUNT.
326+
3. Default value (1).
327+
328+
WARNING: This is an experimental feature and may cause unexpected behavior
329+
depending on workload concurrency. Values above 1 may result in non-deterministic
330+
transfer ordering.
331+
312332
- <code>ocm.software/ocm/oci/preferrelativeaccess</code> [<code>preferrelativeaccess</code>]: *bool*
313333

314334
If an artifact blob is uploaded to the technical repository
@@ -317,6 +337,12 @@ The value can be a simple type or a JSON/YAML string for complex values
317337

318338
- <code>ocm.software/signing/sigstore</code> [<code>sigstore</code>]: *sigstore config* Configuration to use for sigstore based signing.
319339

340+
341+
Configuration applies to <code>sigstore</code> (legacy) and <code>sigstore-v2</code> signing algorithms.
342+
The algorithms affect how signatures are stored in Rekor:
343+
- <code>sigstore</code>: stores only public key in Rekor entry (non-compliant Sigstore Bundle spec).
344+
- <code>sigstore-v2</code>: stores Fulcio certificate in Rekor entry (compliant Sigstore Bundle spec).
345+
320346
The following fields are used.
321347
- *<code>fulcioURL</code>* *string* default is https://fulcio.sigstore.dev
322348
- *<code>rekorURL</code>* *string* default is https://rekor.sigstore.dev

content_versioned/version-legacy/docs/reference/ocm-cli/add/add_componentversions.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -207,9 +207,6 @@ The uploader name may be a path expression with the following possibilities:
207207

208208
sub namespace of the form <code>&lt;plugin name>/&lt;handler></code>
209209

210-
- <code>plugin/jfrog/JFrogHelm</code>:
211-
upload artifacts to JFrog HELM repositories by using the JFrog REST API.
212-
213210

214211

215212
See [ocm ocm-uploadhandlers]({{< relref "docs/reference/ocm-cli/help/ocm-uploadhandlers.md" >}}) for further details on using

content_versioned/version-legacy/docs/reference/ocm-cli/download/download_artifacts.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ ocm download artifacts [<options>] {<artifact>}
2020
--dirtree extract as effective filesystem content
2121
-h, --help help for artifacts
2222
--layers ints extract dedicated layers
23+
--oci-layout download as OCI Image Layout (blobs in blobs/<algorithm>/<encoded>)
2324
-O, --outfile string output file or directory
2425
--repo string repository name or spec
2526
-t, --type string archive format (directory, tar, tgz) (default "directory")
@@ -29,10 +30,14 @@ ocm download artifacts [<options>] {<artifact>}
2930

3031

3132
Download artifacts from an OCI registry. The result is stored in
32-
artifact set format, without the repository part
33+
artifact set format, without the repository part.
3334

3435
The files are named according to the artifact repository name.
3536

37+
By default, blobs are stored in OCM artifact set format (blobs/<algorithm>.<encoded>).
38+
Use --oci-layout to store blobs in OCI Image Layout format (blobs/<algorithm>/<encoded>)
39+
for compatibility with tools that expect the OCI Image Layout Specification.
40+
3641

3742
If the repository/registry option is specified, the given names are interpreted
3843
relative to the specified registry using the syntax
@@ -74,6 +79,15 @@ dedicated layers, only. Option <code>--dirtree</code> expects the artifact to
7479
be a layered filesystem (for example OCI Image) and provided the effective
7580
filesystem content.
7681

82+
Option <code>--oci-layout</code> changes the blob storage structure in the downloaded
83+
artifact. Without this option, blobs are stored in a flat directory at
84+
<code>blobs/&lt;algorithm&gt;.&lt;encoded&gt;</code> (e.g., <code>blobs/sha256.abc123...</code>).
85+
With this option, blobs are stored in a nested directory structure at
86+
<code>blobs/&lt;algorithm&gt;/&lt;encoded&gt;</code> (e.g., <code>blobs/sha256/abc123...</code>)
87+
as specified by the OCI Image Layout Specification
88+
(see <a href="https://github.com/opencontainers/image-spec/blob/main/image-layout.md">
89+
https://github.com/opencontainers/image-spec/blob/main/image-layout.md</a>).
90+
7791

7892
The <code>--type</code> option accepts a file format for the
7993
target archive to use. It is only evaluated if the target

content_versioned/version-legacy/docs/reference/ocm-cli/download/download_cli.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ ocm download cli [<options>] [<component> {<name> { <key>=<value> }}]
1919
```
2020
-c, --constraints constraints version constraint
2121
-h, --help help for cli
22+
--oci-layout download OCI artifacts in OCI Image Layout format (blobs/<algorithm>/<encoded>)
2223
-O, --outfile string output file or directory
2324
-p, --path lookup executable in PATH
2425
--repo string repository name or spec

content_versioned/version-legacy/docs/reference/ocm-cli/download/download_resources.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ ocm download resources [<options>] <component> {<name> { <key>=<value> }}
2525
-h, --help help for resources
2626
--latest restrict component versions to latest
2727
--lookup stringArray repository name or spec for closure lookup fallback
28+
--oci-layout download OCI artifacts in OCI Image Layout format (blobs/<algorithm>/<encoded>)
2829
-O, --outfile string output file or directory
2930
-r, --recursive follow component reference nesting
3031
--repo string repository name or spec

content_versioned/version-legacy/docs/reference/ocm-cli/help/attributes.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -207,6 +207,26 @@ OCM library:
207207
the backend and descriptor updated will be persisted on AddVersion
208208
or closing a provided existing component version.
209209

210+
- <code>ocm.software/ocm/api/ocm/extensions/attrs/maxworkers</code> [<code>maxworkers</code>]: *integer* or *"auto"*
211+
212+
Specifies the maximum number of concurrent workers to use for resource and source,
213+
as well as reference transfer operations.
214+
215+
Supported values:
216+
- A positive integer: use exactly that number of workers.
217+
- The string "auto": automatically use the number of logical CPU cores.
218+
- Zero or omitted: fall back to single-worker mode (1). This is the default.
219+
This mode guarantees deterministic ordering of operations.
220+
221+
Precedence:
222+
1. Attribute set in the current OCM context.
223+
2. Environment variable OCM_TRANSFER_WORKER_COUNT.
224+
3. Default value (1).
225+
226+
WARNING: This is an experimental feature and may cause unexpected behavior
227+
depending on workload concurrency. Values above 1 may result in non-deterministic
228+
transfer ordering.
229+
210230
- <code>ocm.software/ocm/oci/preferrelativeaccess</code> [<code>preferrelativeaccess</code>]: *bool*
211231

212232
If an artifact blob is uploaded to the technical repository
@@ -215,6 +235,12 @@ OCM library:
215235

216236
- <code>ocm.software/signing/sigstore</code> [<code>sigstore</code>]: *sigstore config* Configuration to use for sigstore based signing.
217237

238+
239+
Configuration applies to <code>sigstore</code> (legacy) and <code>sigstore-v2</code> signing algorithms.
240+
The algorithms affect how signatures are stored in Rekor:
241+
- <code>sigstore</code>: stores only public key in Rekor entry (non-compliant Sigstore Bundle spec).
242+
- <code>sigstore-v2</code>: stores Fulcio certificate in Rekor entry (compliant Sigstore Bundle spec).
243+
218244
The following fields are used.
219245
- *<code>fulcioURL</code>* *string* default is https://fulcio.sigstore.dev
220246
- *<code>rekorURL</code>* *string* default is https://rekor.sigstore.dev

content_versioned/version-legacy/docs/reference/ocm-cli/help/ocm-uploadhandlers.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -90,9 +90,6 @@ The following handler names are possible:
9090

9191
sub namespace of the form <code>&lt;plugin name>/&lt;handler></code>
9292

93-
- <code>plugin/jfrog/JFrogHelm</code>:
94-
upload artifacts to JFrog HELM repositories by using the JFrog REST API.
95-
9693

9794

9895
See [ocm ocm-uploadhandlers]({{< relref "docs/reference/ocm-cli/help/ocm-uploadhandlers.md" >}}) for further details on using

content_versioned/version-legacy/docs/reference/ocm-cli/sign/sign_componentversions.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -122,6 +122,7 @@ The following signing types are supported with option <code>--algorithm</code>:
122122
- <code>rsa-signingservice</code>
123123
- <code>rsapss-signingservice</code>
124124
- <code>sigstore</code>
125+
- <code>sigstore-v2</code>
125126

126127

127128
The following normalization modes are supported with option <code>--normalization</code>:

content_versioned/version-legacy/docs/reference/ocm-cli/transfer/transfer_commontransportarchive.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -159,9 +159,6 @@ The uploader name may be a path expression with the following possibilities:
159159

160160
sub namespace of the form <code>&lt;plugin name>/&lt;handler></code>
161161

162-
- <code>plugin/jfrog/JFrogHelm</code>:
163-
upload artifacts to JFrog HELM repositories by using the JFrog REST API.
164-
165162

166163

167164
See [ocm ocm-uploadhandlers]({{< relref "docs/reference/ocm-cli/help/ocm-uploadhandlers.md" >}}) for further details on using

0 commit comments

Comments
 (0)