Skip to main content

MirrorPolicy

Title: MirrorPolicy

Typeobject
RequiredNo
Additional propertiesNot allowed
PropertyPatternTypeDeprecatedDefinitionTitle/Description
+ apiVersionNoconstNo-Apiversion
+ kindNoconstNo-Kind
+ metadataNoobjectNoIn #/$defs/MetadataMetadata
+ specNoobjectNoIn #/$defs/SpecSpec

1. Property apiVersion

Title: Apiversion

Typeconst
RequiredYes

Description: API version; pinned to houba.io/v1alpha1.

Specific value: "houba.io/v1alpha1"

2. Property kind

Title: Kind

Typeconst
RequiredYes

Description: Resource kind; always MirrorPolicy.

Specific value: "MirrorPolicy"

3. Property metadata

Title: Metadata

Typeobject
RequiredYes
Additional propertiesNot allowed
Defined in#/$defs/Metadata

Description: Policy metadata (name, labels).

PropertyPatternTypeDeprecatedDefinitionTitle/Description
+ nameNostringNo-Name
- labelsNoobjectNo-Labels

3.1. Property name

Title: Name

Typestring
RequiredYes

Description: Policy name; stamped as io.houba.policy and used for collision checks.

3.2. Property labels

Title: Labels

Typeobject
RequiredNo
Additional propertiesEach additional property must conform to the schema

Description: Free-form labels (not stamped).

PropertyPatternTypeDeprecatedDefinitionTitle/Description
- NostringNo--

3.2.1. Property additionalProperties

Typestring
RequiredNo

4. Property spec

Title: Spec

Typeobject
RequiredYes
Additional propertiesNot allowed
Defined in#/$defs/Spec

Description: Policy specification.

PropertyPatternTypeDeprecatedDefinitionTitle/Description
+ artifactTypeNoenum (of string)NoIn #/$defs/ArtifactTypeArtifactType
+ sourceNoobjectNoIn #/$defs/SourceSource
- deletionModeNoCombinationNo-Policy-level deletion mode; `null` ⇒ defer to the destination/global cascade.
- defaultsNoCombinationNo-Defaults inherited by every import.
+ importsNoarrayNo-Imports

4.1. Property artifactType

Title: ArtifactType

Typeenum (of string)
RequiredYes
Defined in#/$defs/ArtifactType

Description: Artifact kind: image | helmChart | generic.

Must be one of:

  • "image"
  • "helmChart"
  • "generic"

4.2. Property source

Title: Source

Typeobject
RequiredYes
Additional propertiesNot allowed
Defined in#/$defs/Source

Description: Upstream source registry + repository.

PropertyPatternTypeDeprecatedDefinitionTitle/Description
+ registryNostringNo-Registry
+ repositoryNostringNo-Repository

4.2.1. Property registry

Title: Registry

Typestring
RequiredYes

Description: Source registry host, e.g. docker.io.

4.2.2. Property repository

Title: Repository

Typestring
RequiredYes

Description: Source repository, e.g. library/redis.

4.3. Property deletionMode

Typecombining
RequiredNo
Additional propertiesAny type allowed
Defaultnull

Description: Policy-level deletion mode; null ⇒ defer to the destination/global cascade.

Any of(Option)
DeletionMode
item 1

4.3.1. Property DeletionMode

Title: DeletionMode

Typeenum (of string)
RequiredNo
Defined in#/$defs/DeletionMode

Must be one of:

  • "purge"
  • "mark"

4.3.2. Property item 1

Typenull
RequiredNo

4.4. Property defaults

Typecombining
RequiredNo
Additional propertiesAny type allowed
Defaultnull

Description: Defaults inherited by every import.

Any of(Option)
Defaults
item 1

4.4.1. Property Defaults

Title: Defaults

Typeobject
RequiredNo
Additional propertiesNot allowed
Defined in#/$defs/Defaults
PropertyPatternTypeDeprecatedDefinitionTitle/Description
- destinationsNoCombinationNo-Destinations
- transformNoCombinationNo-Transform
- archiveNoCombinationNo-Default retention policy for every import.
- tagsNoCombinationNo-Default tag-selection rules for every import.
- platformsNoCombinationNo-Platforms
- ownersNoCombinationNo-Owners
- vendorNoCombinationNo-Vendor
4.4.1.1. Property destinations

Title: Destinations

Typecombining
RequiredNo
Additional propertiesAny type allowed
Defaultnull

Description: Default destinations for every import.

Any of(Option)
item 0
item 1
4.4.1.1.1. Property item 0
Typearray
RequiredNo
Array restrictions
Min itemsN/A
Max itemsN/A
Items unicityFalse
Additional itemsFalse
Tuple validationSee below
Each item of this array must beDescription
Destination-
4.4.1.1.1.1. Destination

Title: Destination

Typeobject
RequiredNo
Additional propertiesNot allowed
Defined in#/$defs/Destination
PropertyPatternTypeDeprecatedDefinitionTitle/Description
- registryNoCombinationNo-Registry
+ projectNostringNo-Project
+ repositoryNostringNo-Repository
4.4.1.1.1.1.1. Property registry

Title: Registry

Typecombining
RequiredNo
Additional propertiesAny type allowed
Defaultnull

Description: Logical registry name from the roster; may be omitted iff exactly one registry is configured.

Any of(Option)
item 0
item 1
4.4.1.1.1.1.1.1. Property item 0
Typestring
RequiredNo
4.4.1.1.1.1.1.2. Property item 1
Typenull
RequiredNo
4.4.1.1.1.1.2. Property project

Title: Project

Typestring
RequiredYes

Description: Destination project / namespace.

4.4.1.1.1.1.3. Property repository

Title: Repository

Typestring
RequiredYes

Description: Destination repository.

4.4.1.1.2. Property item 1
Typenull
RequiredNo
4.4.1.2. Property transform

Title: Transform

Typecombining
RequiredNo
Additional propertiesAny type allowed
Defaultnull

Description: Default transform steps for every import.

Any of(Option)
item 0
item 1
4.4.1.2.1. Property item 0
Typearray
RequiredNo
Array restrictions
Min itemsN/A
Max itemsN/A
Items unicityFalse
Additional itemsFalse
Tuple validationSee below
Each item of this array must beDescription
TransformStep-
4.4.1.2.1.1. TransformStep
Typecombining
RequiredNo
Additional propertiesAny type allowed
Defined in#/$defs/TransformStep
One of(Option)
item 0
item 1
item 2
4.4.1.2.1.1.1. Property item 0
Typeobject
RequiredNo
Additional propertiesNot allowed
PropertyPatternTypeDeprecatedDefinitionTitle/Description
+ injectCANoobjectNo-_InjectCAParams
4.4.1.2.1.1.1.1. Property injectCA

Title: _InjectCAParams

Typeobject
RequiredYes
Additional propertiesNot allowed
PropertyPatternTypeDeprecatedDefinitionTitle/Description
+ certsNoarray of stringNo-Certs
4.4.1.2.1.1.1.1.1. Property certs

Title: Certs

Typearray of string
RequiredYes
Array restrictions
Min items1
Max itemsN/A
Items unicityFalse
Additional itemsFalse
Tuple validationSee below
Each item of this array must beDescription
certs items-
4.4.1.2.1.1.1.1.1.1. certs items
Typestring
RequiredNo
4.4.1.2.1.1.2. Property item 1
Typeobject
RequiredNo
Additional propertiesNot allowed
PropertyPatternTypeDeprecatedDefinitionTitle/Description
+ rewritePackageSourcesNoobjectNo-_RewritePackageSourcesParams
4.4.1.2.1.1.2.1. Property rewritePackageSources

Title: _RewritePackageSourcesParams

Typeobject
RequiredYes
Additional propertiesNot allowed
PropertyPatternTypeDeprecatedDefinitionTitle/Description
+ mirrorNostringNo-Mirror
4.4.1.2.1.1.2.1.1. Property mirror

Title: Mirror

Typestring
RequiredYes
Restrictions
Min length1
4.4.1.2.1.1.3. Property item 2
Typeobject
RequiredNo
Additional propertiesNot allowed
PropertyPatternTypeDeprecatedDefinitionTitle/Description
+ setTimezoneNoobjectNo-_SetTimezoneParams
4.4.1.2.1.1.3.1. Property setTimezone

Title: _SetTimezoneParams

Typeobject
RequiredYes
Additional propertiesNot allowed
PropertyPatternTypeDeprecatedDefinitionTitle/Description
+ zoneNostringNo-Zone
4.4.1.2.1.1.3.1.1. Property zone

Title: Zone

Typestring
RequiredYes
Restrictions
Min length1
4.4.1.2.2. Property item 1
Typenull
RequiredNo
4.4.1.3. Property archive
Typecombining
RequiredNo
Additional propertiesAny type allowed
Defaultnull

Description: Default retention policy for every import.

Any of(Option)
Archive
item 1
4.4.1.3.1. Property Archive

Title: Archive

Typeobject
RequiredNo
Additional propertiesNot allowed
Defined in#/$defs/Archive
PropertyPatternTypeDeprecatedDefinitionTitle/Description
- keepNoCombinationNo-Keep
- olderThanDaysNoCombinationNo-Olderthandays
4.4.1.3.1.1. Property keep

Title: Keep

Typecombining
RequiredNo
Additional propertiesAny type allowed
Defaultnull

Description: Retain the N most-recently-imported tags of each stream.

Any of(Option)
item 0
item 1
4.4.1.3.1.1.1. Property item 0
Typeinteger
RequiredNo
4.4.1.3.1.1.2. Property item 1
Typenull
RequiredNo
4.4.1.3.1.2. Property olderThanDays

Title: Olderthandays

Typecombining
RequiredNo
Additional propertiesAny type allowed
Defaultnull

Description: Of the surplus, only mark tags older than this many days (both conditions hold).

Any of(Option)
item 0
item 1
4.4.1.3.1.2.1. Property item 0
Typeinteger
RequiredNo
4.4.1.3.1.2.2. Property item 1
Typenull
RequiredNo
4.4.1.3.2. Property item 1
Typenull
RequiredNo
4.4.1.4. Property tags
Typecombining
RequiredNo
Additional propertiesAny type allowed
Defaultnull

Description: Default tag-selection rules for every import.

Any of(Option)
TagSelection
item 1
4.4.1.4.1. Property TagSelection

Title: TagSelection

Typeobject
RequiredNo
Additional propertiesNot allowed
Defined in#/$defs/TagSelection
PropertyPatternTypeDeprecatedDefinitionTitle/Description
- includeRegexNoCombinationNo-Includeregex
- excludeRegexNoarray of stringNo-Excluderegex
- semverOnlyNobooleanNo-Semveronly
- namesNoarray of stringNo-Names
- aliasesNoarray of stringNo-Aliases
4.4.1.4.1.1. Property includeRegex

Title: Includeregex

Typecombining
RequiredNo
Additional propertiesAny type allowed
Defaultnull

Description: Only tags matching this regex are selected (applied before excludes).

Any of(Option)
item 0
item 1
4.4.1.4.1.1.1. Property item 0
Typestring
RequiredNo
4.4.1.4.1.1.2. Property item 1
Typenull
RequiredNo
4.4.1.4.1.2. Property excludeRegex

Title: Excluderegex

Typearray of string
RequiredNo

Description: Tags matching any of these regexes are dropped.

Array restrictions
Min itemsN/A
Max itemsN/A
Items unicityFalse
Additional itemsFalse
Tuple validationSee below
Each item of this array must beDescription
excludeRegex items-
4.4.1.4.1.2.1. excludeRegex items
Typestring
RequiredNo
4.4.1.4.1.3. Property semverOnly

Title: Semveronly

Typeboolean
RequiredNo
Defaulttrue

Description: Keep only tags parseable as semver (drops latest, date tags, …).

4.4.1.4.1.4. Property names

Title: Names

Typearray of string
RequiredNo

Description: Explicit tag names to always include.

Array restrictions
Min itemsN/A
Max itemsN/A
Items unicityFalse
Additional itemsFalse
Tuple validationSee below
Each item of this array must beDescription
names items-
4.4.1.4.1.4.1. names items
Typestring
RequiredNo
4.4.1.4.1.5. Property aliases

Title: Aliases

Typearray of string
RequiredNo

Description: Moving-tag alias templates (e.g. {major}.{minor}, latest) re-pointed every run.

Array restrictions
Min itemsN/A
Max itemsN/A
Items unicityFalse
Additional itemsFalse
Tuple validationSee below
Each item of this array must beDescription
aliases items-
4.4.1.4.1.5.1. aliases items
Typestring
RequiredNo
4.4.1.4.2. Property item 1
Typenull
RequiredNo
4.4.1.5. Property platforms

Title: Platforms

Typecombining
RequiredNo
Additional propertiesAny type allowed
Defaultnull

Description: Default platforms for every import.

Any of(Option)
item 0
item 1
4.4.1.5.1. Property item 0
Typearray of string
RequiredNo
Array restrictions
Min itemsN/A
Max itemsN/A
Items unicityFalse
Additional itemsFalse
Tuple validationSee below
Each item of this array must beDescription
item 0 items-
4.4.1.5.1.1. item 0 items
Typestring
RequiredNo
4.4.1.5.2. Property item 1
Typenull
RequiredNo
4.4.1.6. Property owners

Title: Owners

Typecombining
RequiredNo
Additional propertiesAny type allowed
Defaultnull

Description: Default owners (Backstage entity refs) for every import.

Any of(Option)
item 0
item 1
4.4.1.6.1. Property item 0
Typearray of string
RequiredNo
Array restrictions
Min itemsN/A
Max itemsN/A
Items unicityFalse
Additional itemsFalse
Tuple validationSee below
Each item of this array must beDescription
item 0 items-
4.4.1.6.1.1. item 0 items
Typestring
RequiredNo
4.4.1.6.2. Property item 1
Typenull
RequiredNo
4.4.1.7. Property vendor

Title: Vendor

Typecombining
RequiredNo
Additional propertiesAny type allowed
Defaultnull

Description: Default vendor for every import, stamped as org.opencontainers.image.vendor (the rebuilding organization).

Any of(Option)
item 0
item 1
4.4.1.7.1. Property item 0
Typestring
RequiredNo
4.4.1.7.2. Property item 1
Typenull
RequiredNo

4.4.2. Property item 1

Typenull
RequiredNo

4.5. Property imports

Title: Imports

Typearray
RequiredYes

Description: One or more import profiles (at least one).

Array restrictions
Min items1
Max itemsN/A
Items unicityFalse
Additional itemsFalse
Tuple validationSee below
Each item of this array must beDescription
ImportProfile-

4.5.1. ImportProfile

Title: ImportProfile

Typeobject
RequiredNo
Additional propertiesNot allowed
Defined in#/$defs/ImportProfile
PropertyPatternTypeDeprecatedDefinitionTitle/Description
+ nameNostringNo-Name
+ tagsNoobjectNoSame as TagSelectionTagSelection
- destinationsNoCombinationNo-Destinations
- transformNoCombinationNo-Transform
- archiveNoCombinationNo-Retention policy (overrides defaults).
- platformsNoCombinationNo-Platforms
- variantsNoCombinationNo-Variants
- ownersNoCombinationNo-Owners
- vendorNoCombinationNo-Vendor
4.5.1.1. Property name

Title: Name

Typestring
RequiredYes

Description: Import name; part of the three-level policy/import/variant identity in the stamp.

4.5.1.2. Property tags

Title: TagSelection

Typeobject
RequiredYes
Additional propertiesNot allowed
Same definition asTagSelection

Description: Tag-selection rules for this import.

4.5.1.3. Property destinations

Title: Destinations

Typecombining
RequiredNo
Additional propertiesAny type allowed
Defaultnull

Description: Destinations (overrides defaults).

Any of(Option)
item 0
item 1
4.5.1.3.1. Property item 0
Typearray
RequiredNo
Array restrictions
Min itemsN/A
Max itemsN/A
Items unicityFalse
Additional itemsFalse
Tuple validationSee below
Each item of this array must beDescription
Destination-
4.5.1.3.1.1. Destination

Title: Destination

Typeobject
RequiredNo
Additional propertiesNot allowed
Same definition asDestination
4.5.1.3.2. Property item 1
Typenull
RequiredNo
4.5.1.4. Property transform

Title: Transform

Typecombining
RequiredNo
Additional propertiesAny type allowed
Defaultnull

Description: Transform steps (overrides defaults).

Any of(Option)
item 0
item 1
4.5.1.4.1. Property item 0
Typearray
RequiredNo
Array restrictions
Min itemsN/A
Max itemsN/A
Items unicityFalse
Additional itemsFalse
Tuple validationSee below
Each item of this array must beDescription
TransformStep-
4.5.1.4.1.1. TransformStep
Typecombining
RequiredNo
Additional propertiesAny type allowed
Same definition asspec_defaults_anyOf_i0_transform_anyOf_i0_items
4.5.1.4.2. Property item 1
Typenull
RequiredNo
4.5.1.5. Property archive
Typecombining
RequiredNo
Additional propertiesAny type allowed
Defaultnull

Description: Retention policy (overrides defaults).

Any of(Option)
Archive
item 1
4.5.1.5.1. Property Archive

Title: Archive

Typeobject
RequiredNo
Additional propertiesNot allowed
Same definition asArchive
4.5.1.5.2. Property item 1
Typenull
RequiredNo
4.5.1.6. Property platforms

Title: Platforms

Typecombining
RequiredNo
Additional propertiesAny type allowed
Defaultnull

Description: Platforms (overrides defaults).

Any of(Option)
item 0
item 1
4.5.1.6.1. Property item 0
Typearray of string
RequiredNo
Array restrictions
Min itemsN/A
Max itemsN/A
Items unicityFalse
Additional itemsFalse
Tuple validationSee below
Each item of this array must beDescription
item 0 items-
4.5.1.6.1.1. item 0 items
Typestring
RequiredNo
4.5.1.6.2. Property item 1
Typenull
RequiredNo
4.5.1.7. Property variants

Title: Variants

Typecombining
RequiredNo
Additional propertiesAny type allowed
Defaultnull

Description: Variants to fan this import into.

Any of(Option)
item 0
item 1
4.5.1.7.1. Property item 0
Typearray
RequiredNo
Array restrictions
Min itemsN/A
Max itemsN/A
Items unicityFalse
Additional itemsFalse
Tuple validationSee below
Each item of this array must beDescription
Variant-
4.5.1.7.1.1. Variant

Title: Variant

Typeobject
RequiredNo
Additional propertiesNot allowed
Defined in#/$defs/Variant
PropertyPatternTypeDeprecatedDefinitionTitle/Description
+ nameNostringNo-Name
- suffixNostringNo-Suffix
- transformNoCombinationNo-Transform
4.5.1.7.1.1.1. Property name

Title: Name

Typestring
RequiredYes

Description: Variant name.

4.5.1.7.1.1.2. Property suffix

Title: Suffix

Typestring
RequiredNo
Default""

Description: Tag suffix appended for this variant, e.g. -eu.

4.5.1.7.1.1.3. Property transform

Title: Transform

Typecombining
RequiredNo
Additional propertiesAny type allowed
Defaultnull

Description: Per-variant transform; null ⇒ inherit the resolved transform.

Any of(Option)
item 0
item 1
4.5.1.7.1.1.3.1. Property item 0
Typearray
RequiredNo
Array restrictions
Min itemsN/A
Max itemsN/A
Items unicityFalse
Additional itemsFalse
Tuple validationSee below
Each item of this array must beDescription
TransformStep-
4.5.1.7.1.1.3.1.1. TransformStep
Typecombining
RequiredNo
Additional propertiesAny type allowed
Same definition asspec_defaults_anyOf_i0_transform_anyOf_i0_items
4.5.1.7.1.1.3.2. Property item 1
Typenull
RequiredNo
4.5.1.7.2. Property item 1
Typenull
RequiredNo
4.5.1.8. Property owners

Title: Owners

Typecombining
RequiredNo
Additional propertiesAny type allowed
Defaultnull

Description: Owners as Backstage entity refs (stamped as io.houba.owners).

Any of(Option)
item 0
item 1
4.5.1.8.1. Property item 0
Typearray of string
RequiredNo
Array restrictions
Min itemsN/A
Max itemsN/A
Items unicityFalse
Additional itemsFalse
Tuple validationSee below
Each item of this array must beDescription
item 0 items-
4.5.1.8.1.1. item 0 items
Typestring
RequiredNo
4.5.1.8.2. Property item 1
Typenull
RequiredNo
4.5.1.9. Property vendor

Title: Vendor

Typecombining
RequiredNo
Additional propertiesAny type allowed
Defaultnull

Description: Vendor (overrides defaults), stamped as org.opencontainers.image.vendor.

Any of(Option)
item 0
item 1
4.5.1.9.1. Property item 0
Typestring
RequiredNo
4.5.1.9.2. Property item 1
Typenull
RequiredNo