Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .github/config/wordlist.txt
Original file line number Diff line number Diff line change
Expand Up @@ -136,3 +136,4 @@ wget
whitespace
whitespaces
yaml
OCIImageLayer
6 changes: 3 additions & 3 deletions doc/01-model/04-example.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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
Expand Down
8 changes: 4 additions & 4 deletions doc/02-processing/04-signing-examples.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
20 changes: 10 additions & 10 deletions doc/04-extensions/02-access-types/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
6 changes: 4 additions & 2 deletions doc/04-extensions/02-access-types/github.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
# gitHub — Git Commit hosted by GitHub
# GitHub — Git Commit hosted by GitHub

## Synopsis

```text
type: gitHub/v1
type: GitHub[/VERSION]
Comment thread
morri-son marked this conversation as resolved.
```

Legacy type names `gitHub` and `github` are supported as backward-compatible aliases.

## Description

Access to a commit in a Git repository.
Expand Down
8 changes: 5 additions & 3 deletions doc/04-extensions/02-access-types/helm.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
6 changes: 4 additions & 2 deletions doc/04-extensions/02-access-types/localblob.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
6 changes: 4 additions & 2 deletions doc/04-extensions/02-access-types/npm.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
10 changes: 8 additions & 2 deletions doc/04-extensions/02-access-types/ociartifact.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,18 @@
# ociArtifactArtifact hosted in OCI Repository
# OCIImageImage 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.
Expand Down
6 changes: 4 additions & 2 deletions doc/04-extensions/02-access-types/ociblob.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
27 changes: 25 additions & 2 deletions doc/04-extensions/02-access-types/s3.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
# s3 — Blob hosted in S3 Blob Store
# S3 — Blob hosted in S3 Blob Store

Check failure on line 1 in doc/04-extensions/02-access-types/s3.md

View workflow job for this annotation

GitHub Actions / Lint Markdown

Headings must start at the beginning of the line

doc/04-extensions/02-access-types/s3.md:1:1 MD023/heading-start-left Headings must start at the beginning of the line [Context: " # S3 — Blob hosted in S3 Blo..."] https://github.com/DavidAnson/markdownlint/blob/v0.38.0/doc/md023.md

## 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.
Expand Down Expand Up @@ -39,3 +41,24 @@

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`.
6 changes: 4 additions & 2 deletions doc/04-extensions/02-access-types/wget.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
Loading