@@ -27,12 +27,12 @@ To avoid this error, do not filter out the latest version of an Operator. If you
2727
2828|`apiVersion`
2929|The API version of the `ImageSetConfiguration` content.
30- |String
30+ |String
3131Example: `mirror.openshift.io/v2alpha1`
3232
3333|`archiveSize`
3434|The maximum size, in GiB, of each archive file within the image set.
35- |Integer
35+ |Integer
3636Example: `4`
3737
3838|`kubeVirtContainer`
@@ -58,7 +58,7 @@ mirror:
5858
5959|`mirror.additionalImages`
6060|The additional images configuration of the image set.
61- |Array of objects
61+ |Array of objects
6262
6363Example:
6464[source,yaml]
@@ -69,12 +69,12 @@ additionalImages:
6969
7070|`mirror.additionalImages.name`
7171|The tag or digest of the image to mirror.
72- |String
72+ |String
7373Example: `registry.redhat.io/ubi8/ubi:latest`
7474
7575|`mirror.blockedImages`
7676|List of images with a tag or digest (SHA) to block from mirroring.
77- |Array of strings
77+ |Array of strings
7878Example: `docker.io/library/alpine`
7979
8080|`mirror.helm`
@@ -133,17 +133,17 @@ repositories:
133133|String. For example: `podinfo` .
134134
135135|`mirror.helm.repositories.charts.imagePaths`
136- |The custom path of a container image inside of the helm chart.
136+ |The custom path of a container image inside of the helm chart.
137137+
138- [NOTE]
138+ [NOTE]
139139====
140140`oc-mirror` detects and mirrors container images from the helm chart by searching well-known paths. You can also specify custom paths using this field.
141141====
142142|Array of string. For example: `"- {.spec.template.spec.custom[*].image}"` .
143143
144144|`mirror.operators`
145145|The Operators configuration of the image set.
146- |Array of objects
146+ |Array of objects
147147
148148Example:
149149[source,yaml,subs="attributes+"]
@@ -157,17 +157,17 @@ operators:
157157
158158|`mirror.operators.catalog`
159159|The Operator catalog to include in the image set.
160- |String
160+ |String
161161Example: `registry.redhat.io/redhat/redhat-operator-index:v4.15`
162162
163163|`mirror.operators.full`
164164|When `true` , downloads the full catalog, Operator package, or Operator channel.
165- |Boolean
165+ |Boolean
166166The default value is `false` .
167167
168168|`mirror.operators.packages`
169169|The Operator packages configuration.
170- |Array of objects
170+ |Array of objects
171171
172172Example:
173173[source,yaml,subs="attributes+"]
@@ -181,7 +181,7 @@ operators:
181181
182182|`mirror.operators.packages.name`
183183|The Operator package name to include in the image set.
184- |String
184+ |String
185185Example: `elasticsearch-operator`
186186
187187|`mirror.operators.packages.channels`
@@ -190,39 +190,39 @@ Example: `elasticsearch-operator`
190190
191191|`mirror.operators.packages.channels.name`
192192|The Operator channel name, unique within a package, to include in the image set.
193- |String
193+ |String
194194Eample: `fast` or `stable-v4.15`
195195
196196|`mirror.operators.packages.channels.maxVersion`
197197|The highest version of the Operator mirror across all channels in which it exists.
198- |String
198+ |String
199199Example: `5.2.3-31`
200200
201201|`mirror.operators.packages.channels.minVersion`
202202|The lowest version of the Operator to mirror across all channels in which it exists
203- |String
203+ |String
204204Example: `5.2.3-31`
205205
206206|`mirror.operators.packages.maxVersion`
207207|The highest version of the Operator to mirror across all channels in which it exists.
208- |String
208+ |String
209209Example: `5.2.3-31`
210210
211211|`mirror.operators.packages.minVersion`
212212|The lowest version of the Operator to mirror across all channels in which it exists.
213- |String
213+ |String
214214Example: `5.2.3-31`
215215
216216|`mirror.operators.targetCatalog`
217217|An alternative name and optional namespace hierarchy to mirror the referenced catalog as
218- |String
218+ |String
219219Example: `my-namespace/my-operator-catalog`
220220
221221|`mirror.operators.targetCatalogSourceTemplate`
222222|Path on disk for a template to use to complete catalogSource custom resource generated by oc-mirror plugin v2.
223- |String
223+ |String
224224Example: `/tmp/catalog-source_template.yaml`
225- Example of a template file:
225+ Example of a template file:
226226[source,yaml]
227227----
228228apiVersion: operators.coreos.com/v1alpha1
@@ -240,7 +240,7 @@ spec:
240240
241241|`mirror.operators.targetTag`
242242|An alternative tag to append to the `targetName` or `targetCatalog` .
243- |String
243+ |String
244244Example: `v1`
245245
246246|`mirror.platform`
@@ -249,7 +249,7 @@ Example: `v1`
249249
250250|`mirror.platform.architectures`
251251|The architecture of the platform release payload to mirror.
252- |Array of strings
252+ |Array of strings
253253Example:
254254[source,yaml]
255255----
@@ -265,7 +265,7 @@ The default value is `amd64`. The value `multi` ensures that the mirroring is su
265265
266266|`mirror.platform.channels`
267267|The platform channel configuration of the image set.
268- |Array of objects
268+ |Array of objects
269269Example:
270270[source,yaml,subs="attributes+"]
271271----
@@ -276,39 +276,55 @@ channels:
276276
277277|`mirror.platform.channels.full`
278278|When `true` , sets the `minVersion` to the first release in the channel and the `maxVersion` to the last release in the channel.
279- |Boolean
279+ |Boolean
280280The default value is `false`
281281
282282|`mirror.platform.channels.name`
283283|Name of the release channel
284- |String
284+ |String
285285Example: `stable-4.15`
286286
287287|`mirror.platform.channels.minVersion`
288288|The minimum version of the referenced platform to be mirrored.
289- |String
289+ |String
290290Example: `4.12.6`
291291
292292|`mirror.platform.channels.maxVersion`
293293|The highest version of the referenced platform to be mirrored.
294- |String
294+ |String
295295Example: `4.15.1`
296296
297297|`mirror.platform.channels.shortestPath`
298298|Toggles shortest path mirroring or full range mirroring.
299- |Boolean
299+ |Boolean
300300The default value is `false`
301301
302302|`mirror.platform.channels.type`
303303|Type of the platform to be mirrored
304- |String
304+ |String
305305Example: `ocp` or `okd` . The default is `ocp` .
306306
307307|`mirror.platform.graph`
308308|Indicates whether the OSUS graph is added to the image set and subsequently published to the mirror.
309309|Boolean
310310The default value is `false`
311311
312+ |`mirror.operators.packages.defaultChannel`
313+ |Must be defined when excluding the default channel from the filtering.
314+ |Array of objects. For example:
315+
316+ [source,yaml]
317+ ----
318+ mirror:
319+ operators:
320+ - catalog: registry.redhat.io/redhat/redhat-operator-index:v4.19
321+ packages:
322+ - name: rhods-operator
323+ defaultChannel: fast
324+ channels:
325+ - name: fast
326+ ----
327+
312328|===
313329
314330
@@ -326,7 +342,7 @@ To use the oc-mirror plugin v2, you must have delete image set configuration fil
326342
327343|`apiVersion`
328344|The API version for the `DeleteImageSetConfiguration` content.
329- |String
345+ |String
330346Example: `mirror.openshift.io/v2alpha1`
331347
332348|`delete`
@@ -335,7 +351,7 @@ Example: `mirror.openshift.io/v2alpha1`
335351
336352|`delete.additionalImages`
337353|The additional images configuration of the delete image set.
338- |Array of objects
354+ |Array of objects
339355Example:
340356[source,yaml]
341357----
@@ -345,12 +361,12 @@ additionalImages:
345361
346362|`delete.additionalImages.name`
347363|The tag or digest of the image to delete.
348- |String
364+ |String
349365Example: `registry.redhat.io/ubi8/ubi:latest`
350366
351367|`delete.operators`
352368|The Operators configuration of the delete image set.
353- |Array of objects
369+ |Array of objects
354370Example:
355371[source,yaml]
356372----
@@ -363,17 +379,17 @@ operators:
363379
364380|`delete.operators.catalog`
365381|The Operator catalog to include in the delete image set.
366- |String
382+ |String
367383Example: `registry.redhat.io/redhat/redhat-operator-index:v4.15`
368384
369385|`delete.operators.full`
370386|When true, deletes the full catalog, Operator package, or Operator channel.
371- |Boolean
387+ |Boolean
372388The default value is `false`
373389
374390|`delete.operators.packages`
375391|Operator packages configuration
376- |Array of objects
392+ |Array of objects
377393Example:
378394[source,yaml]
379395----
@@ -386,7 +402,7 @@ operators:
386402
387403|`delete.operators.packages.name`
388404|The Operator package name to include in the delete image set.
389- |String
405+ |String
390406Example: `elasticsearch-operator`
391407
392408|`delete.operators.packages.channels`
@@ -395,27 +411,27 @@ Example: `elasticsearch-operator`
395411
396412|`delete.operators.packages.channels.name`
397413|The Operator channel name, unique within a package, to include in the delete image set.
398- |String
414+ |String
399415Example: `fast` or `stable-v4.15`
400416
401417|`delete.operators.packages.channels.maxVersion`
402418|The highest version of the Operator to delete within the selected channel.
403- |String
419+ |String
404420Example: `5.2.3-31`
405421
406422|`delete.operators.packages.channels.minVersion`
407423|The lowest version of the Operator to delete within the selection in which it exists.
408- |String
424+ |String
409425Example: `5.2.3-31`
410426
411427|`delete.operators.packages.maxVersion`
412428|The highest version of the Operator to delete across all channels in which it exists.
413- |String
429+ |String
414430Example: `5.2.3-31`
415431
416432|`delete.operators.packages.minVersion`
417433|The lowest version of the Operator to delete across all channels in which it exists.
418- |String
434+ |String
419435Example: `5.2.3-31`
420436
421437|`delete.platform`
@@ -440,7 +456,7 @@ The default value is `amd64`
440456
441457|`delete.platform.channels`
442458|The platform channel configuration of the image set.
443- |Array of objects
459+ |Array of objects
444460
445461Example:
446462[source,yaml,subs="attributes+"]
@@ -457,28 +473,28 @@ The default value is `false`
457473
458474|`delete.platform.channels.name`
459475|Name of the release channel
460- |String
476+ |String
461477Example: `stable-4.15`
462478
463479|`delete.platform.channels.minVersion`
464480|The minimum version of the referenced platform to be deleted.
465- |String
481+ |String
466482Example: `4.12.6`
467483
468484|`delete.platform.channels.maxVersion`
469485|The highest version of the referenced platform to be deleted.
470- |String
486+ |String
471487Example: `4.15.1`
472488
473489|`delete.platform.channels.shortestPath`
474490|Toggles between deleting the shortest path and deleting the full range.
475- |Boolean
491+ |Boolean
476492The default value is `false`
477493
478494|`delete.platform.channels.type`
479495|Type of the platform to be deleted
480- |String
481- Example: `ocp` or `okd`
496+ |String
497+ Example: `ocp` or `okd`
482498The default is `ocp`
483499
484500|`delete.platform.graph`
0 commit comments