DeleteImageSetConfiguration parameters

To remove images with the oc-mirror plugin v2, you must use a DeleteImageSetConfiguration.yaml configuration file that defines which images to delete from the mirror registry. The following table lists the available parameters for the DeleteImageSetConfiguration resource.

Table 24. DeleteImageSetConfiguration parameters
Parameter Description Values

apiVersion

The API version for the DeleteImageSetConfiguration content.

String Example: mirror.openshift.io/v2alpha1

delete

The configuration of the image set to delete.

Object

delete.additionalImages

The additional images configuration of the delete image set.

Array of objects Example:

additionalImages:
  - name: registry.redhat.io/ubi8/ubi:latest

delete.additionalImages.name

The tag or digest of the image to delete.

String Example: registry.redhat.io/ubi8/ubi:latest

delete.operators

The Operators configuration of the delete image set.

Array of objects Example:

operators:
  - catalog: registry.redhat.io/redhat/redhat-operator-index:{product-version}
    packages:
      - name: elasticsearch-operator
        minVersion: '2.4.0'

delete.operators.catalog

The Operator catalog to include in the delete image set.

String Example: registry.redhat.io/redhat/redhat-operator-index:v4.15

delete.operators.full

When true, deletes the full catalog, Operator package, or Operator channel.

Boolean The default value is false

delete.operators.packages

Operator packages configuration

Array of objects Example:

operators:
  - catalog: registry.redhat.io/redhat/redhat-operator-index:{product-version}
    packages:
      - name: elasticsearch-operator
        minVersion: '5.2.3-31'

delete.operators.packages.name

The Operator package name to include in the delete image set.

String Example: elasticsearch-operator

delete.operators.packages.channels

Operator package channel configuration

Object

delete.operators.packages.channels.name

The Operator channel name, unique within a package, to include in the delete image set.

String Example: fast or stable-v4.15

delete.operators.packages.channels.maxVersion

The highest version of the Operator to delete within the selected channel.

String Example: 5.2.3-31

delete.operators.packages.channels.minVersion

The lowest version of the Operator to delete within the selection in which it exists.

String Example: 5.2.3-31

delete.operators.packages.maxVersion

The highest version of the Operator to delete across all channels in which it exists.

String Example: 5.2.3-31

delete.operators.packages.minVersion

The lowest version of the Operator to delete across all channels in which it exists.

String Example: 5.2.3-31

delete.platform

The platform configuration of the image set

Object

delete.platform.architectures

The architecture of the platform release payload to delete.

Array of strings Example:

architectures:
  - amd64
  - arm64
  - multi
  - ppc64le
  - s390x

The default value is amd64

delete.platform.channels

The platform channel configuration of the image set.

Array of objects

Example:

channels:
  - name: stable-4.12
  - name: stable-4.20

delete.platform.channels.full

When true, sets the minVersion to the first release in the channel and the maxVersion to the last release in the channel.

Boolean The default value is false

delete.platform.channels.name

Name of the release channel

String Example: stable-4.15

delete.platform.channels.minVersion

The minimum version of the referenced platform to be deleted.

String Example: 4.12.6

delete.platform.channels.maxVersion

The highest version of the referenced platform to be deleted.

String Example: 4.15.1

delete.platform.channels.shortestPath

Toggles between deleting the shortest path and deleting the full range.

Boolean The default value is false

delete.platform.channels.type

Type of the platform to be deleted

String Example: ocp or okd The default is ocp

delete.platform.graph

Determines whether the OSUS graph is deleted as well on the mirror registry as well.

Boolean The default value is false

↑ Up: ImageSet configuration parameters for oc-mirror plugin v2 | ⌂ Home: Red Hat build of MicroShift | Next: Mirror from mirror to mirror →