component-descriptor-ocm-v3-schema.yaml

$id: 'https://gardener.cloud/schemas/component-descriptor-ocm-v3alpha1'
$schema: 'https://json-schema.org/draft/2020-12/schema'
description: 'OCM Component Descriptor v3 schema'
$defs:
  meta:
    type: 'object'
    description: 'component version metadata'
    required:
      - 'name'
      - 'version'
    additionalProperties: false
    properties:
      name:
        $ref: '#/$defs/componentName'
      version:
        $ref: '#/$defs/relaxedSemver'
      labels:
        $ref: '#/$defs/labels'
      provider:
        $ref: '#/$defs/provider'
      creationTime:
        type: string
        format: date-time

  merge:
    type: 'object'
    properties:
      algorithm:
        pattern: '^[a-z][a-z0-9/_-]+$'
      config: { }
    additionalProperties: false
  labels:
    type: 'array'
    items:
      $ref: '#/$defs/label'
  label:
    type: 'object'
    required:
      - 'name'
      - 'value'
    properties:
      name:
        type: string
      value: {}
      version:
        pattern: '^v[0-9]+$'
      signing:
        type: 'boolean'
      merge:
        $ref: '#/$defs/merge'
    additionalProperties: false

  componentName:
    type: 'string'
    maxLength: 255
    pattern: '^[a-z][-a-z0-9]*([.][a-z][-a-z0-9]*)*[.][a-z]{2,}(/[a-z][-a-z0-9_]*([.][a-z][-a-z0-9_]*)*)+$'

  identityAttributeKey:
    minLength: 2
    pattern: '^[a-z0-9]([-_+a-z0-9]*[a-z0-9])?$'

  relaxedSemver:
    # taken from semver.org and adjusted to allow an optional leading 'v', major-only, and major.minor-only
    # this means the following strings are all valid relaxedSemvers:
    # 1.2.3
    # 1.2.3-foo+bar
    # v1.2.3
    # v1.2.3-foo+bar
    # 1.2
    # 1
    # v1
    # v1.2
    # v1-foo+bar
    pattern: '^[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-]+)*))?$'
    type: 'string'

  identityAttribute:
    type: 'object'
    propertyNames: { $ref: '#/$defs/identityAttributeKey' }

  repositoryContext:
    type: 'object'
    required:
      - 'type'
    properties:
      type:
        type: 'string'

  access:
    type: 'object'
    description: 'base type for accesses (for extensions)'
    required:
      - 'type'

  sourceDefinition:
    type: 'object'
    required:
      - name
      - version
      - type
      - access
    properties:
      name:
        type: 'string'
        $ref: '#/$defs/identityAttributeKey'
      extraIdentity:
        $ref: '#/$defs/identityAttribute'
      version:
        $ref: '#/$defs/relaxedSemver'
      type:
        type: 'string'
      labels:
        $ref: '#/$defs/labels'
      access:
        $ref: '#/$defs/access'

  digestSpec:
    type: 'object'
    required:
      - hashAlgorithm
      - normalisationAlgorithm
      - value
    additionalProperties: false
    properties:
      hashAlgorithm:
        type: string
      normalisationAlgorithm:
        type: string
      value:
        type: string

  timestampSpec:
    type: object
    properties:
      value:
        type: string
      time:
        type: string
        format: date-time

  signatureSpec:
    type: 'object'
    required:
      - algorithm
      - value
      - mediaType
    additionalProperties: false
    properties:
      algorithm:
        type: string
      value:
        type: string
      mediaType:
        description: 'The media type of the signature value'
        type: string

  signature:
    type: 'object'
    required:
      - name
      - digest
      - signature
    additionalProperties: false
    properties:
      name:
        type: string
      digest:
        $ref: '#/$defs/digestSpec'
      signature:
        $ref: '#/$defs/signatureSpec'
      timestamp:
        $ref: '#/$defs/timestampSpec'

  nestedDigestSpec:
    type: 'object'
    required:
      - name
      - digest
    properties:
      name:
        type: string
      version:
        type: string
      extraIdentity:
        $ref: '#/$defs/identityAttribute'
      digest:
        $ref: '#/$defs/digestSpec'

  nestedComponentDigests:
    type: 'object'
    required:
      - name
      - version
      - digest
      - resourceDigests
    additionalProperties: false
    properties:
      name:
        $ref: '#/$defs/componentName'
      version:
        $ref: '#/$defs/relaxedSemver'
      digest:
        $ref: '#/$defs/digestSpec'
      resourceDigests:
        type: 'array'
        items:
          $ref: '#/$defs/nestedDigestSpec'

  srcRef:
    type: 'object'
    description: 'a reference to a (component-local) source'
    additionalProperties: false
    properties:
      identitySelector:
        $ref: '#/$defs/identityAttribute'
      labels:
        $ref: '#/$defs/labels'

  reference:
    type: 'object'
    description: 'a reference to a component'
    required:
      - 'name'
      - 'componentName'
      - 'version'
    additionalProperties: false
    properties:
      componentName:
        $ref: '#/$defs/componentName'
      name:
        type: 'string' # actually: component-type w/ special restrictions
        $ref: '#/$defs/identityAttributeKey'
      extraIdentity:
        $ref: '#/$defs/identityAttribute'
      version:
        $ref: '#/$defs/relaxedSemver'
      labels:
        $ref: '#/$defs/labels'
      digest:
        oneOf:
          - type: 'null'
          - $ref: '#/$defs/digestSpec'

  resourceDefinition:
    type: 'object'
    description: 'base type for resources'
    required:
      - 'name'
      - 'version' # for local resources, this must match component's version
      - 'type'
      - 'relation'
      - 'access'
    properties:
      name:
        type: 'string'
        $ref: '#/$defs/identityAttributeKey'
      extraIdentity:
        $ref: '#/$defs/identityAttribute'
      version:
        $ref: '#/$defs/relaxedSemver'
      type:
        type: 'string'
      srcRefs:
        type: 'array'
        items:
          $ref: '#/$defs/srcRef'
      relation:
        type: 'string'
        enum: ['local', 'external']
      labels:
        $ref: '#/$defs/labels'
      access:
        $ref: '#/$defs/access'
      digest:
        oneOf:
          - type: 'null'
          - $ref: '#/$defs/digestSpec'

  provider:
    type: 'object'
    required:
      - 'name'
    additionalProperties: false
    properties:
      name:
        type: 'string'
      labels:
        $ref: '#/$defs/labels'

  spec:
    type: 'object'
    description: 'specification of the content of a component versiont'
    additionalProperties: false
    properties:
      sources:
        type: 'array'
        items:
          $ref: '#/$defs/sourceDefinition'
      references:
        type: 'array'
        items:
          $ref: '#/$defs/reference'
      resources:
        type: 'array'
        items:
          $ref: '#/$defs/resourceDefinition'

type: 'object'
required:
  - 'apiVersion'
  - 'kind'
  - 'metadata'
  - 'spec'
properties:
  apiVersion:
    type: 'string'
    enum: [ 'ocm.gardener.cloud/v3alpha1', 'ocm.software/v3alpha1' ]
  kind:
    type: 'string'
    const: 'ComponentVersion'
  metadata:
    $ref: '#/$defs/meta'
  repositoryContexts:
    type: 'array'
    items:
      $ref: '#/$defs/repositoryContext' # currently, we only allow this one
  spec:
    $ref: '#/$defs/spec'
  signatures:
    type: 'array'
    items:
      $ref: '#/$defs/signature'
  nestedDigests:
    type: 'array'
    items:
      $ref: '#/$defs/nestedComponentDigests'