diff --git a/.github/config/wordlist.txt b/.github/config/wordlist.txt index aa7ae54..34d274d 100644 --- a/.github/config/wordlist.txt +++ b/.github/config/wordlist.txt @@ -136,3 +136,4 @@ wget whitespace whitespaces yaml +OCIImageLayer diff --git a/doc/01-model/04-example.md b/doc/01-model/04-example.md index 9b0a304..c093e9c 100644 --- a/doc/01-model/04-example.md +++ b/doc/01-model/04-example.md @@ -30,7 +30,7 @@ component: relation: external # resource is provided by a different entity than the component access: # access information how to locate this resource imageReference: gcr.io/google_containers/echoserver:1.10 - type: ociArtifact + type: OCIImage digest: # digest of this resource used for signing hashAlgorithm: sha256 normalisationAlgorithm: ociArtifactDigest/v1 @@ -41,7 +41,7 @@ component: relation: local # resource is provided by the same entity as the component access: # access information how to locate this resource imageReference: ghcr.io/jensh007/ctf/github.com/open-component-model/ocmechoserver/echoserver:0.1.0 - type: ociArtifact + type: OCIImage digest: # digest of this resource used for signing hashAlgorithm: sha256 normalisationAlgorithm: ociArtifactDigest/v1 @@ -56,7 +56,7 @@ component: mediaType: application/vnd.toi.ocm.software.package.v1+yaml ref: ghcr.io/jensh007/ctf/component-descriptors/github.com/open-component-model/ocmechoserver size: 615 - type: ociBlob + type: OCIImageLayer localReference: sha256:57563cb451bb79eb1c4bf0e71c66fdad1daf44fe55e128f12eae5f7e5496a188 mediaType: application/vnd.toi.ocm.software.package.v1+yaml type: localBlob diff --git a/doc/02-processing/04-signing-examples.md b/doc/02-processing/04-signing-examples.md index bde6086..acc82f6 100644 --- a/doc/02-processing/04-signing-examples.md +++ b/doc/02-processing/04-signing-examples.md @@ -26,7 +26,7 @@ spec: version: 0.1.0 - access: imageReference: gcr.io/google_containers/echoserver:1.10 - type: ociArtifact + type: OCIImage name: image relation: external type: ociImage @@ -87,7 +87,7 @@ spec: version: 0.1.0 - access: imageReference: gcr.io/google_containers/echoserver:1.10 - type: ociArtifact + type: OCIImage digest: hashAlgorithm: SHA-256 normalisationAlgorithm: ociArtifactDigest/v1 @@ -127,7 +127,7 @@ spec: resources: - access: imageReference: gcr.io/google_containers/pause:3.2 - type: ociArtifact + type: OCIImage name: image relation: external type: ociImage @@ -175,7 +175,7 @@ spec: resources: - access: imageReference: gcr.io/google_containers/pause:3.2 - type: ociArtifact + type: OCIImage digest: hashAlgorithm: SHA-256 normalisationAlgorithm: ociArtifactDigest/v1 diff --git a/doc/04-extensions/02-access-types/README.md b/doc/04-extensions/02-access-types/README.md index 617f4b0..12fd23e 100644 --- a/doc/04-extensions/02-access-types/README.md +++ b/doc/04-extensions/02-access-types/README.md @@ -8,13 +8,13 @@ required to identify the blob and its location. The following access method types are centrally defined: -| TYPE NAME | DESCRIPTION | -|---------------------------------|-----------------------------------------------------| -| [`localBlob`](localblob.md) | an artifact stored along with the component version | -| [`ociArtifact`](ociartifact.md) | an artifact in a repository of an OCI registry | -| [`ociBlob`](ociblob.md) | a blob in a repository of an OCI registry | -| [`helm`](helm.md) | a Helm chart stored in a Helm Repository | -| [`gitHub`](github.md) | a commit in a GitHub-based Git repository | -| [`s3`](s3.md) | a blob stored in an AWS S3 bucket | -| [`npm`](npm.md) | a NodeJS package stored in an NPM repository | -| [`wget`](wget.md) | a blob stored on an HTTP server | +| TYPE NAME | DESCRIPTION | +|:---------------------------------|-----------------------------------------------------| +| [`LocalBlob`](localblob.md) | an artifact stored along with the component version | +| [`OCIImage`](ociartifact.md) | an artifact in a repository of an OCI registry | +| [`OCIImageLayer`](ociblob.md) | a blob in a repository of an OCI registry | +| [`Helm`](helm.md) | a Helm chart stored in a Helm Repository | +| [`GitHub`](github.md) | a commit in a GitHub-based Git repository | +| [`S3`](s3.md) | a blob stored in an AWS S3 bucket | +| [`NPM`](npm.md) | a NodeJS package stored in an NPM repository | +| [`Wget`](wget.md) | a blob stored on an HTTP server | diff --git a/doc/04-extensions/02-access-types/github.md b/doc/04-extensions/02-access-types/github.md index 223eb79..7a89165 100644 --- a/doc/04-extensions/02-access-types/github.md +++ b/doc/04-extensions/02-access-types/github.md @@ -1,11 +1,13 @@ -# gitHub — Git Commit hosted by GitHub +# GitHub — Git Commit hosted by GitHub ## Synopsis ```text -type: gitHub/v1 +type: GitHub[/VERSION] ``` +Legacy type names `gitHub` and `github` are supported as backward-compatible aliases. + ## Description Access to a commit in a Git repository. diff --git a/doc/04-extensions/02-access-types/helm.md b/doc/04-extensions/02-access-types/helm.md index 9c3eb56..bbbe079 100644 --- a/doc/04-extensions/02-access-types/helm.md +++ b/doc/04-extensions/02-access-types/helm.md @@ -1,12 +1,14 @@ -# helm — Helm Package in Helm Repository +# Helm — Helm Package in Helm Repository -*Synopsis:* +## Synopsis ```text -type: helm[/VERSION] +type: Helm[/VERSION] [ATTRIBUTES] ``` +Legacy type name `helm` is supported as a backward-compatible alias. + ## Description Access to a Helm chart in a Helm repository. diff --git a/doc/04-extensions/02-access-types/localblob.md b/doc/04-extensions/02-access-types/localblob.md index dbbe625..cda5ff5 100644 --- a/doc/04-extensions/02-access-types/localblob.md +++ b/doc/04-extensions/02-access-types/localblob.md @@ -1,12 +1,14 @@ -# localBlob — Blob Hosted in OCM Repository +# LocalBlob — Blob Hosted in OCM Repository ## Synopsis ```text -type: localBlob/[VERSION] +type: LocalBlob[/VERSION] [ATTRIBUTES] ``` +Legacy type name `localBlob` is supported as a backward-compatible alias. + ## Description Access to a resource blob stored along with the component descriptor. diff --git a/doc/04-extensions/02-access-types/npm.md b/doc/04-extensions/02-access-types/npm.md index c3392e7..2e04986 100644 --- a/doc/04-extensions/02-access-types/npm.md +++ b/doc/04-extensions/02-access-types/npm.md @@ -1,12 +1,14 @@ -# npm — Node Package Manager archive +# NPM — Node Package Manager archive ## Synopsis ```text -type: npm[/VERSION] +type: NPM[/VERSION] [ATTRIBUTES] ``` +Legacy type name `npm` is supported as a backward-compatible alias. + ## Description Access to an NodeJS package in an NPM registry. diff --git a/doc/04-extensions/02-access-types/ociartifact.md b/doc/04-extensions/02-access-types/ociartifact.md index 973b5d4..15b8c61 100644 --- a/doc/04-extensions/02-access-types/ociartifact.md +++ b/doc/04-extensions/02-access-types/ociartifact.md @@ -1,12 +1,18 @@ -# ociArtifact — Artifact hosted in OCI Repository +# OCIImage — Image hosted in OCI Repository ## Synopsis ```text -type: ociArtifact[/VERSION] +type: OCIImage[/VERSION] [ATTRIBUTES] ``` +The following legacy type names are supported as backward-compatible aliases: + +- `ociArtifact` +- `ociRegistry` +- `ociImage` + ## Description Access of an OCI artifact stored in an OCI registry. diff --git a/doc/04-extensions/02-access-types/ociblob.md b/doc/04-extensions/02-access-types/ociblob.md index a59f52b..30f8805 100644 --- a/doc/04-extensions/02-access-types/ociblob.md +++ b/doc/04-extensions/02-access-types/ociblob.md @@ -1,12 +1,14 @@ -# ociBlob — Blob hosted in OCI Repository +# OCIImageLayer — Blob hosted in OCI Repository ## Synopsis ```text -type: ociBlob[/VERSION] +type: OCIImageLayer[/VERSION] [ATTRIBUTES] ``` +Legacy type name `ociBlob` is supported as a backward-compatible alias. + ## Description Access of an OCI blob stored in an OCI repository. diff --git a/doc/04-extensions/02-access-types/s3.md b/doc/04-extensions/02-access-types/s3.md index 7839ec3..c9bb61a 100644 --- a/doc/04-extensions/02-access-types/s3.md +++ b/doc/04-extensions/02-access-types/s3.md @@ -1,12 +1,14 @@ -# s3 — Blob hosted in S3 Blob Store + # S3 — Blob hosted in S3 Blob Store ## Synopsis ```text -type: s3[/VERSION] +type: S3[/VERSION] [ATTRIBUTES] ``` +Legacy type name `s3` is supported as a backward-compatible alias. + ## Description Access to a blob stored in an S3 API compatible bucket. @@ -39,3 +41,24 @@ Attributes: The media type of the blob used to store the resource. It may add format information like `+tar` or `+gzip`. + +### v2 + +Attributes: + +- **`region`** (optional) *string* + + region identifier of the used store + +- **`bucketName`** *string* + + The name of the S3 bucket containing the blob + +- **`objectKey`** *string* + + The key of the desired blob + +- **`mediaType`** *string* + + The media type of the blob used to store the resource. It may add + format information like `+tar` or `+gzip`. diff --git a/doc/04-extensions/02-access-types/wget.md b/doc/04-extensions/02-access-types/wget.md index b8c099a..502bd65 100644 --- a/doc/04-extensions/02-access-types/wget.md +++ b/doc/04-extensions/02-access-types/wget.md @@ -1,12 +1,14 @@ -# wget — Blob hosted on an HTTP server +# Wget — Blob hosted on an HTTP server ## Synopsis ```text -type: wget[/VERSION] +type: Wget[/VERSION] [ATTRIBUTES] ``` +Legacy type name `wget` is supported as a backward-compatible alias. + ## Description Access to a blob stored on an HTTP server.