Skip to content

Commit 5422cdd

Browse files
committed
Update distribution docs
Signed-off-by: Aviral Takkar <[email protected]>
1 parent 6410239 commit 5422cdd

File tree

2 files changed

+41
-36
lines changed

2 files changed

+41
-36
lines changed

docs/distribution/README.md

Lines changed: 40 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -303,19 +303,22 @@ The storage layout is represented as:
303303
└── link
304304
```
305305

306-
Push a signature artifact and an OCI index that contains a config property referencing the signature:
306+
Push a signature as blob and an OCI Artifact that contains a blobs property referencing the signature:
307307

308-
- signature index digest: `sha256:222ibbf80b44ce6be8234e6ff90a1ac34acbeb826903b02cfa0da11c82cb222i`
309-
- index json:
308+
- artifact digest: `sha256:222ibbf80b44ce6be8234e6ff90a1ac34acbeb826903b02cfa0da11c82cb222i`
309+
- artifact json:
310310
```json
311311
{
312312
"schemaVersion": 2,
313-
"mediaType": "application/vnd.oci.image.index.v2+json",
314-
"config": {
315-
"mediaType": "application/vnd.cncf.notary.config.v2+jwt",
313+
"mediaType": "application/vnd.oci.artifact.manifest.v1+json",
314+
"artifactType": "application/vnd.cncf.notary.v2",
315+
"blobs": [
316+
{
317+
"mediaType": "application/vnd.cncf.notary.signature.v2+jwt",
316318
"digest": "sha256:222cb130c152895905abe66279dd9feaa68091ba55619f5b900f2ebed38b222c",
317-
"size": 1906
318-
},
319+
"size": 2338
320+
}
321+
],
319322
"manifests": [
320323
{
321324
"mediaType": "application/vnd.oci.image.manifest.v1+json",
@@ -330,9 +333,9 @@ Push a signature artifact and an OCI index that contains a config property refer
330333
}
331334
```
332335

333-
Consistent with the current distribution implementation, on `PUT`, the index appears as a manifest revision.
336+
Consistent with the current distribution implementation, on `PUT`, the artifact appears as a manifest revision.
334337

335-
The Notary v2 prototype adds referrer metadata for the **wabbit-networks** signature:
338+
The prototype adds referrer metadata for the **wabbit-networks** signature:
336339

337340
```
338341
<root>
@@ -345,7 +348,7 @@ The Notary v2 prototype adds referrer metadata for the **wabbit-networks** signa
345348
├── 111ma2d22ae5ef400769fa51c84717264cd1520ac8d93dc071374c1be49a111m
346349
│ ├── link
347350
│ └── ref
348-
│ └── application/vnd.cncf.notary.config.v2+jwt
351+
│ └── digest(application/vnd.cncf.notary.v2)
349352
│ └── sha256
350353
│ └── 222cb130c152895905abe66279dd9feaa68091ba55619f5b900f2ebed38b222c
351354
│ └── link
@@ -355,33 +358,35 @@ The Notary v2 prototype adds referrer metadata for the **wabbit-networks** signa
355358
356359
Adding the **acme-rockets** signature:
357360
358-
- signature index digest: `sha256:333ic0c33ebc4a74a0a554c86ac2b28ddf3454a5ad9cf90ea8cea9f9e75c333i`
359-
- index json:
360-
361+
- artifact digest: `sha256:333ic0c33ebc4a74a0a554c86ac2b28ddf3454a5ad9cf90ea8cea9f9e75c333i`
362+
- artifact json:
361363
```json
362364
{
363-
"schemaVersion": 2,
364-
"mediaType": "application/vnd.oci.image.index.v2+json",
365-
"config": {
366-
"mediaType": "application/vnd.cncf.notary.config.v2+jwt",
367-
"digest": "sha256:333cc44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b785c333c",
368-
"size": 1906
369-
},
370-
"manifests": [
371-
{
372-
"mediaType": "application/vnd.oci.image.manifest.v1+json",
373-
"digest": "sha256:111ma2d22ae5ef400769fa51c84717264cd1520ac8d93dc071374c1be49a111m",
374-
"size": 7023,
375-
"platform": {
376-
"architecture": "ppc64le",
377-
"os": "linux"
378-
}
379-
}
380-
]
381-
}
365+
"schemaVersion": 2,
366+
"mediaType": "application/vnd.oci.artifact.manifest.v1+json",
367+
"artifactType": "application/vnd.cncf.notary.v2",
368+
"blobs": [
369+
{
370+
"mediaType": "application/vnd.cncf.notary.signature.v2+jwt",
371+
"digest": "sha256:333cc44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b785c333c",
372+
"size": 2338
373+
}
374+
],
375+
"manifests": [
376+
{
377+
"mediaType": "application/vnd.oci.image.manifest.v1+json",
378+
"digest": "sha256:111ma2d22ae5ef400769fa51c84717264cd1520ac8d93dc071374c1be49a111m",
379+
"size": 7023,
380+
"platform": {
381+
"architecture": "ppc64le",
382+
"os": "linux"
383+
}
384+
}
385+
]
386+
}
382387
```
383388

384-
The Notary v2 storage layout of 2 signature index objects:
389+
The storage layout of the two artifact referrer objects:
385390

386391
```
387392
<root>
@@ -394,7 +399,7 @@ The Notary v2 storage layout of 2 signature index objects:
394399
├── 111ma2d22ae5ef400769fa51c84717264cd1520ac8d93dc071374c1be49a111m
395400
│ ├── link
396401
│ └── ref
397-
│ └── application/vnd.cncf.notary.config.v2+jwt
402+
│ └── digest(application/vnd.cncf.notary.v2)
398403
│ └── sha256
399404
│ ├── 222cb130c152895905abe66279dd9feaa68091ba55619f5b900f2ebed38b222c
400405
│ │ └── link

docs/distribution/prototype-example.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -130,7 +130,7 @@ curl -s "http://$registry/v2/_ext/oci-artifacts/v1/$repo/manifests/$manifestDige
130130

131131
```shell
132132
# Retrieve signature digest from first artifact.
133-
signatureDigest=`curl -s "http://$registry/v2/_ext/oci-artifacts/v1/$repo/manifests/$manifestDigest/references?artifact-type=$artifactType" | jq -r '.links[0].manifest.blobs[0].digest'` && \
133+
signatureDigest=`curl -s "http://$registry/v2/_ext/oci-artifacts/v1/$repo/manifests/$manifestDigest/references?artifact-type=$artifactType" | jq -r '.references[0].manifest.blobs[0].digest'` && \
134134
retrievedSignatureFile="retrieved-signature.json" && \
135135
curl -s http://$registry/v2/$repo/blobs/$signatureDigest > $retrievedSignatureFile
136136

0 commit comments

Comments
 (0)