openshift/openshift-docs
1
0
Fork 0
mirror of https://github.com/openshift/openshift-docs.git synced 2026-02-05 12:46:18 +01:00
Code Issues Releases Activity

OSDOCS#13984: use opm CLI reference for oc-mirror v2

Browse Source
This commit is contained in:
xenolinux
2025-11-25 17:55:13 +05:30
committed by openshift-cherrypick-robot
parent fc6d8a0768
commit deaf5e41c4
2 changed files with 15 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
disconnected/about-installing-oc-mirror-v2.adoc
View File

@@ -139,6 +139,11 @@ include::modules/oc-mirror-operator-catalog-filtering.adoc[leveloffset=+1]
// Image set configuration parameters
include::modules/oc-mirror-imageset-config-parameters-v2.adoc[leveloffset=+1]
[role="_additional-resources"]
.Additional resources
* xref:../cli_reference/opm/cli-opm-ref.adoc#cli-opm-ref[opm CLI reference]
// Command reference for oc-mirror v2
include::modules/oc-mirror-command-reference-v2.adoc[leveloffset=+1]

19
modules/oc-mirror-imageset-config-parameters-v2.adoc
View File

@@ -1,7 +1,6 @@
// Module included in the following assemblies:
//
// * installing/disconnected_install/installing-mirroring-disconnected-v2.adoc
// * disconnected/about-installing-oc-mirror-v2.adoc
// * microshift_running_apps/microshift_operators//microshift-operators-oc-mirror.com
:_mod-docs-content-type: REFERENCE
@@ -12,11 +11,13 @@ The oc-mirror plugin v2 requires an image set configuration file that defines wh
[NOTE]
====
Using the `minVersion` and `maxVersion` properties to filter for a specific Operator version range can result in a multiple channel heads error. The error message states that there are `multiple channel heads`. This is because when the filter is applied, the update graph of the Operator is truncated.
* When selecting bundles for mirroring, the oc-mirror plugin v2 does not automatically detect group/version/kind (GVK) and bundle dependencies. You must explicitly specify the required Operators, their channels, and the Operator versions in the `ImageSetConfiguration` file. For more information, see "opm CLI reference".
OLM requires that every Operator channel contains versions that form an update graph with exactly one end point, that is, the latest version of the Operator. When the filter range is applied, that graph can turn into two or more separate graphs or a graph that has more than one end point.
* Using the `minVersion` and `maxVersion` properties to filter for a specific Operator version range can result in a multiple channel heads error. The error message states that there are `multiple channel heads`. This is because when the filter is applied, the update graph of the Operator is truncated.
To avoid this error, do not filter out the latest version of an Operator. If you still run into the error, depending on the Operator, either the `maxVersion` property must be increased or the `minVersion` property must be decreased. Because every Operator graph can be different, you might need to adjust these values until the error resolves.
* OLM requires that every Operator channel contains versions that form an update graph with exactly one end point, that is, the latest version of the Operator. When the filter range is applied, that graph can turn into two or more separate graphs or a graph that has more than one end point.
* To avoid this error, do not filter out the latest version of an Operator. If you still run into the error, depending on the Operator, either the `maxVersion` property must be increased or the `minVersion` property must be decreased. Because every Operator graph can be different, you might need to adjust these values until the error resolves.
====
.`ImageSetConfiguration` parameters
@@ -96,7 +97,7 @@ local:
path: /test/podinfo-5.0.0.tar.gz
----
|`mirror.helm.local.charts.imagePaths`
|`mirror.helm.local.charts.imagePaths`
|The custom path of a container image inside of the local helm chart.
+
[NOTE]
@@ -108,7 +109,7 @@ local:
====
Operand images, dynamically deployed by Operator controllers at runtime, are typically referenced by environment variables within the controller's deployment template. Before {product-title} 4.20, while `oc-mirror` could access these environment variables, it attempted to mirror all values, including non-image references, for example, log levels, leading to failures. With this update, you can mirror only the container images referenced in these environment variables.
====
|Array of string. For example: `"- {.spec.template.spec.custom[*].image}"`.
|Array of string. For example: `"- {.spec.template.spec.custom[*].image}"`.
|`mirror.helm.local.name`
|The name of the local helm chart to mirror.
@@ -162,7 +163,7 @@ repositories:
====
Operand images, dynamically deployed by Operator controllers at runtime, are typically referenced by environment variables within the controller's deployment template. Before {product-title} 4.20, while `oc-mirror` could access these environment variables, it attempted to mirror all values, including non-image references, for example, log levels, leading to failures. With this update, you can mirror only the container images referenced in these environment variables.
====
|Array of string. For example: `"- {.spec.template.spec.custom[*].image}"`.
|Array of string. For example: `"- {.spec.template.spec.custom[*].image}"`.
endif::microshift[]
|`mirror.operators`
@@ -527,4 +528,4 @@ The default is `ocp`
|Boolean
The default value is `false`
endif::microshift[]
|===
|===