1.2 Creating imagesets

Creating ImageSets for mirroring¶

Let's browse the catalog to determine what we want to download using oc mirror

Tip

Some of these commands take time, and by default they print to stdout and to the .oc-mirror.log file in your current working directory.

This handy little one-liner will dump all available operators and their corresponding catalogs and store them in text files for a specific version. This will take some time to run initially, but saves a bunch of time in the long run

Source: Allens Repository with more helpful scripts and configs

for i in $(oc-mirror list operators --catalogs --version=4.17 | grep registry); do $(oc-mirror list operators --catalog=$i --version=4.17 > $(echo $i | cut -b 27- | rev | cut -b 7- | rev).txt); done

You can also use the catalog-fetcher.sh script in the docs repository that will save operator names and default channels to their corresponding txt files. Same thing as the one-liner above just with a bit more control.

wget https://raw.githubusercontent.com/yojoshb/disco-docs/refs/heads/main/_scripts/catalog-fetcher.sh

Using oc mirror list releases to list platform releases and versions

# Output OpenShift release versions
oc mirror list releases

# Output all OpenShift release channels list for a release
oc mirror list releases --version=4.17

# List all OpenShift versions in a specified channel
oc mirror list releases --channel=stable-4.17

# List all OpenShift channels for a specific version
oc mirror list releases --channels --version=4.17

# List OpenShift channels for a specific version and one or more release architecture. 
# Valid architectures: amd64 (default), arm64, ppc64le, s390x, multi.
oc mirror list releases --channels --version=4.17 --filter-by-archs amd64,arm64,ppc64le,s390x,multi

Using oc mirror list operators to list available operator catalog content and versions

# List available operator catalog release versions
oc mirror list operators

# Output default operator catalogs for OpenShift release 4.17
oc mirror list operators --catalogs --version=4.17

# List all operator packages in a catalog
oc mirror list operators --catalog=catalog-name

# List all channels in an operator package
oc mirror list operators --catalog=catalog-name --package=package-name

# List all available versions for a specified operator in a channel
oc mirror list operators --catalog=catalog-name --package=operator-name --channel=channel-name

Create a imageset configuration file to define what you want to mirror. You can add comments to this file if you would like as the file can get quite busy. You can name the file anything you want as long as the yaml formatting is correct e.g. 4.17-imageset-config.yaml.

Be aware of yaml formatting, line indentation matters
- Red Hat Doc examples
- The example below is for OpenShift 4.17 stable, with the lvms-operator to use node attached disks for persistent storage and the cincinnati-operator to make cluster updating easier using OSUS consuming graph data pulled from Red Hat.
- You can look at several imageset-config.yaml examples here in this document
Example: imageset-config.yaml
```
kind: ImageSetConfiguration
apiVersion: mirror.openshift.io/v2alpha1

mirror:
  platform:
    architectures:
    - amd64 # (1)!
    channels:
    - type: ocp
      name: stable-4.17 # (2)!
    graph: true # (3)! 

  operators:
  - catalog: registry.redhat.io/redhat/redhat-operator-index:v4.17 # (4)!
    packages:

    - name: lvms-operator # (5)!
      defaultChannel: stable-4.17 # (6)!
      channels:
      - name: stable-4.17 # (7)!

    - name: cincinnati-operator # (8)!

  additionalImages: # (9)!
  - name: registry.redhat.io/ubi8/ubi:latest
  - name: registry.redhat.io/openshift4/ose-must-gather:latest

  helm: {} # (10)!
```
1. Defines what architecture platform images we want to download: This will help decrease the size of the mirrored content
2. Defines what version we want to download: OCP version 4.17 stable channel
3. Graph data needed for the cincinnati operator
4. Operator catalog we want to download from
5. Operator that we want to download
6. Some operators will need a defaultChannel specified. This is because there may be a newer defaultChannel available, you can (but generally shouldn't) mix and match operator versions. oc-mirror will tell you if it's required when attempting to mirror the data
7. Version/Channel for said operators
8. Only has one channel so just take the latest version
9. Any additional images to bring with us, RHEL UBI's are always nice to have for testing, ose-must-gather is for gathering extra logs in the event a must gather is used for support or general debugging
10. Any additional helm charts, these are non-operator application deployment bundles more or less. This example we aren't specifying anything so it's blank. You can also omit the entire stanza