diff --git a/component-descriptor-v2.html b/component-descriptor-v2.html index 32bc0071..b77f6f8a 100644 --- a/component-descriptor-v2.html +++ b/component-descriptor-v2.html @@ -1 +1 @@ - Schema Docs
Type: object

Gardener Component Descriptor v2 schema

root meta
Type: object

component descriptor metadata

root meta schemaVersion
Type: string

root component
Type: object

a component

root component name
Type: string
Must match regular expression: ^[a-z0-9.\-]+[.][a-z][a-z]+/[-a-z0-9/_.]*$

Must be at most 255 characters long

root component version
Type: string
Must match regular expression: ^[v]?(0|[1-9]\d*)(?:\.(0|[1-9]\d*))?(?:\.(0|[1-9]\d*))?(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$

root component provider
Type: string

root component labels
Type: array
No Additional Items

Each item of this array must be:

root component labels label
Type: object

The following properties are required:

  • name
  • value

root component sources
Type: array
No Additional Items

Each item of this array must be:

root component sources sourceDefinition
Type: object

root component sources sources items name
Type: string
Must match regular expression: ^[a-z0-9]([-_+a-z0-9]*[a-z0-9])?$

Must be at least 2 characters long

root component sources sources items type
Type: string

root component sources sources items labels
Type: array
No Additional Items

Each item of this array must be:

root component sources sources items labels label
Type: object
Same definition as component_labels_items

root component sources sources items access

root component sources sources items access anyOf access
Type: object

base type for accesses (for extensions)

The following properties are required:

  • type
root component sources sources items access anyOf githubAccess
Type: object

root component sources sources items access anyOf item 1 type
Type: enum (of string)

Must be one of:

  • "github"

root component sources sources items access anyOf httpAccess
Type: object

root component sources sources items access anyOf item 2 type
Type: enum (of string)

Must be one of:

  • "http"

root component componentReferences
Type: array
No Additional Items

Each item of this array must be:

root component componentReferences componentReference
Type: object

a reference to a component

root component resources
Type: array
No Additional Items

Each item of this array must be:

root component resources resources items

root component resources resources items anyOf resourceType
Type: object

base type for resources

root component resources resources items anyOf item 0 srcRefs
Type: array
No Additional Items

Each item of this array must be:

root component resources resources items anyOf item 0 srcRefs srcRef
Type: object

a reference to a (component-local) source

root component resources resources items anyOf item 0 relation
Type: enum (of string)

Must be one of:

  • "local"
  • "external"

root component resources resources items anyOf item 0 labels
Type: array
No Additional Items

Each item of this array must be:

root component resources resources items anyOf item 0 labels label
Type: object
Same definition as component_labels_items

root component resources resources items anyOf item 0 access

root component resources resources items anyOf item 0 access anyOf access
Type: object

base type for accesses (for extensions)

Same definition as component_sources_items_access_anyOf_i0
root component resources resources items anyOf item 0 access anyOf ociBlobAccess
Type: object

The following properties are required:

  • layer

root component resources resources items anyOf item 0 access anyOf item 1 type
Type: enum (of string)

Must be one of:

  • "ociBlob"

root component resources resources items anyOf item 0 access anyOf item 1 ref
Type: string

A oci reference to the manifest

root component resources resources items anyOf item 0 access anyOf item 1 mediaType
Type: string

The media type of the object this access refers to

root component resources resources items anyOf item 0 access anyOf item 1 digest
Type: string

The digest of the targeted content

root component resources resources items anyOf item 0 access anyOf item 1 size
Type: number

The size in bytes of the blob
root component resources resources items anyOf item 0 access anyOf localFilesystemBlobAccess
Type: object

root component resources resources items anyOf item 0 access anyOf item 2 type
Type: enum (of string)

Must be one of:

  • "localFilesystemBlob"

root component resources resources items anyOf item 0 access anyOf item 2 filename
Type: string

filename of the blob that is located in the "blobs" directory
root component resources resources items anyOf item 0 access anyOf localOciBlobAccess
Type: object

The following properties are required:

  • filename

root component resources resources items anyOf item 0 access anyOf item 3 type
Type: enum (of string)

Must be one of:

  • "localOciBlob"

root component resources resources items anyOf item 0 access anyOf item 3 digest
Type: string

digest of the layer within the current component descriptor
root component resources resources items anyOf ociImageResource
Type: object

root component resources resources items anyOf item 1 type
Type: enum (of string)

Must be one of:

  • "ociImage"

root component resources resources items anyOf item 1 labels
Type: array
No Additional Items

Each item of this array must be:

root component resources resources items anyOf item 1 labels label
Type: object
Same definition as component_labels_items

root component resources resources items anyOf item 1 access
Type: object

root component resources resources items anyOf item 1 access type
Type: enum (of string)

Must be one of:

  • "ociRegistry"

root component resources resources items anyOf genericResource
Type: object

root component resources resources items anyOf item 2 type
Type: enum (of string)

Must be one of:

  • "generic"

root component resources resources items anyOf item 2 labels
Type: array
No Additional Items

Each item of this array must be:

root component resources resources items anyOf item 2 labels label
Type: object
Same definition as component_labels_items

root component resources resources items anyOf item 2 access
Type: object

root component resources resources items anyOf item 2 access type
Type: enum (of string)

Must be one of:

  • "generic"

root signatures
Type: array
No Additional Items

Each item of this array must be:

root signatures signature
Type: object

root signatures signatures items name
Type: string

root signatures signatures items signature
Type: object

root signatures signatures items signature mediaType
Type: string

The media type of the signature value
\ No newline at end of file + Schema Docs
Type: object

Gardener Component Descriptor v2 schema

root meta
Type: object

component descriptor metadata

root meta schemaVersion
Type: string

root component
Type: object

a component

root component name
Type: string
Must match regular expression: ^[a-z0-9.\-]+[.][a-z][a-z]+/[-a-z0-9/_.]*$

Must be at most 255 characters long

root component version
Type: string
Must match regular expression: ^[v]?(0|[1-9]\d*)(?:\.(0|[1-9]\d*))?(?:\.(0|[1-9]\d*))?(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$

root component provider
Type: string

root component labels
Type: array
No Additional Items

Each item of this array must be:

root component labels label
Type: object

The following properties are required:

  • name
  • value

root component sources
Type: array
No Additional Items

Each item of this array must be:

root component sources sourceDefinition
Type: object

root component sources sources items name
Type: string
Must match regular expression: ^[a-z0-9]([-_+a-z0-9]*[a-z0-9])?$

Must be at least 2 characters long

root component sources sources items type
Type: string

root component sources sources items labels
Type: array
No Additional Items

Each item of this array must be:

root component sources sources items labels label
Type: object
Same definition as component_labels_items

root component sources sources items access

root component sources sources items access anyOf access
Type: object

base type for accesses (for extensions)

The following properties are required:

  • type
root component sources sources items access anyOf githubAccess
Type: object

root component sources sources items access anyOf item 1 type
Type: enum (of string)

Must be one of:

  • "github"

root component sources sources items access anyOf httpAccess
Type: object

root component sources sources items access anyOf item 2 type
Type: enum (of string)

Must be one of:

  • "http"

root component componentReferences
Type: array
No Additional Items

Each item of this array must be:

root component componentReferences componentReference
Type: object

a reference to a component

root component resources
Type: array
No Additional Items

Each item of this array must be:

root component resources resources items

root component resources resources items anyOf resourceType
Type: object

base type for resources

root component resources resources items anyOf item 0 srcRefs
Type: array
No Additional Items

Each item of this array must be:

root component resources resources items anyOf item 0 srcRefs srcRef
Type: object

a reference to a (component-local) source

root component resources resources items anyOf item 0 relation
Type: enum (of string)

Must be one of:

  • "local"
  • "external"

root component resources resources items anyOf item 0 labels
Type: array
No Additional Items

Each item of this array must be:

root component resources resources items anyOf item 0 labels label
Type: object
Same definition as component_labels_items

root component resources resources items anyOf item 0 access

root component resources resources items anyOf item 0 access anyOf access
Type: object

base type for accesses (for extensions)

Same definition as component_sources_items_access_anyOf_i0
root component resources resources items anyOf item 0 access anyOf ociBlobAccess
Type: object

The following properties are required:

  • layer

root component resources resources items anyOf item 0 access anyOf item 1 type
Type: enum (of string)

Must be one of:

  • "ociBlob"

root component resources resources items anyOf item 0 access anyOf item 1 ref
Type: string

A oci reference to the manifest

root component resources resources items anyOf item 0 access anyOf item 1 mediaType
Type: string

The media type of the object this access refers to

root component resources resources items anyOf item 0 access anyOf item 1 digest
Type: string

The digest of the targeted content

root component resources resources items anyOf item 0 access anyOf item 1 size
Type: number

The size in bytes of the blob
root component resources resources items anyOf item 0 access anyOf localFilesystemBlobAccess
Type: object

root component resources resources items anyOf item 0 access anyOf item 2 type
Type: enum (of string)

Must be one of:

  • "localFilesystemBlob"

root component resources resources items anyOf item 0 access anyOf item 2 filename
Type: string

filename of the blob that is located in the "blobs" directory
root component resources resources items anyOf item 0 access anyOf localOciBlobAccess
Type: object

The following properties are required:

  • filename

root component resources resources items anyOf item 0 access anyOf item 3 type
Type: enum (of string)

Must be one of:

  • "localOciBlob"

root component resources resources items anyOf item 0 access anyOf item 3 digest
Type: string

digest of the layer within the current component descriptor
root component resources resources items anyOf ociImageResource
Type: object

root component resources resources items anyOf item 1 type
Type: enum (of string)

Must be one of:

  • "ociImage"

root component resources resources items anyOf item 1 labels
Type: array
No Additional Items

Each item of this array must be:

root component resources resources items anyOf item 1 labels label
Type: object
Same definition as component_labels_items

root component resources resources items anyOf item 1 access
Type: object

root component resources resources items anyOf item 1 access type
Type: enum (of string)

Must be one of:

  • "ociRegistry"

root component resources resources items anyOf genericResource
Type: object

root component resources resources items anyOf item 2 type
Type: enum (of string)

Must be one of:

  • "generic"

root component resources resources items anyOf item 2 labels
Type: array
No Additional Items

Each item of this array must be:

root component resources resources items anyOf item 2 labels label
Type: object
Same definition as component_labels_items

root component resources resources items anyOf item 2 access
Type: object

root component resources resources items anyOf item 2 access type
Type: enum (of string)

Must be one of:

  • "generic"

root signatures
Type: array
No Additional Items

Each item of this array must be:

root signatures signature
Type: object

root signatures signatures items name
Type: string

root signatures signatures items signature
Type: object

root signatures signatures items signature mediaType
Type: string

The media type of the signature value
\ No newline at end of file