Only allow lesser arch builds for certain OPM versions

This commit introduces a new configuration variable named
`IIB_BINARY_IMAGE_LESS_ARCHES_ALLOWED_VERSIONS` which, when set, defines
a list of OPM versions that are allowed to proceed building index images
for lesser arches than the defaults, using the supported values from the
configured binary image.

It also updates the existing unit-tests

Refers to CLOUDDST-28638

Signed-off-by: Jonathan Gangi <jgangi@redhat.com>

Assisted-by: Cursor/Gemini

Author: JAVGan

README.md

@@ -199,6 +199,10 @@ The custom configuration options for the REST API are listed below:
   to another dictionary mapping ocp_version label to a binary image pull specification.
   This is useful in setting up customized binary image for different index image images thus
   reducing complexity for the end user. This defaults to `{}`.
+* `IIB_BINARY_IMAGE_LESS_ARCHES_ALLOWED_VERSIONS` - an optional `list(<str>)` to specify the OPM
+  versions which are allowed to build index images with lesser arches than the configured 
+  on `iib_supported_archs`. When a certain version is set it will allow building only to the
+  available arches supported by the binary image.
 * `IIB_INDEX_TO_GITLAB_PUSH_MAP` - the mapping, `dict(<str>:<str>)`, to specify which index
   images (keys) which should have its catalog pushed into a GitLab repository (value). This defaults to {}.
 * `IIB_GRAPH_MODE_INDEX_ALLOW_LIST` - the list of index image pull specs on which using the

iib/web/api_v1.py

@@ -106,6 +106,7 @@ def _get_rm_args(
         flask.current_app.config['IIB_BINARY_IMAGE_CONFIG'],
         payload.get('build_tags', []),
         flask.current_app.config['IIB_INDEX_TO_GITLAB_PUSH_MAP'],
+        flask.current_app.config['IIB_BINARY_IMAGE_LESS_ARCHES_ALLOWED_VERSIONS'],
     ]
 
 
@@ -140,6 +141,7 @@ def _get_add_args(
         payload.get('graph_update_mode'),
         payload.get('check_related_images', False),
         flask.current_app.config['IIB_INDEX_TO_GITLAB_PUSH_MAP'],
+        flask.current_app.config['IIB_BINARY_IMAGE_LESS_ARCHES_ALLOWED_VERSIONS'],
     ]
 
 
@@ -758,6 +760,7 @@ def patch_request(request_id: int) -> Tuple[flask.Response, int]:
         'source_from_index_resolved',
         'target_index_resolved',
         'index_to_gitlab_push_map',
+        'binary_image_less_arches_allowed_versions',
     )
     start_time = time.time()
     for key in image_keys:
@@ -900,6 +903,7 @@ def regenerate_bundle() -> Tuple[flask.Response, int]:
         payload.get('bundle_replacements', dict()),
         flask.current_app.config['IIB_INDEX_TO_GITLAB_PUSH_MAP'],
         flask.current_app.config['IIB_REGENERATE_BUNDLE_REPO_KEY'],
+        flask.current_app.config['IIB_BINARY_IMAGE_LESS_ARCHES_ALLOWED_VERSIONS'],
     ]
     safe_args = _get_safe_args(args, payload)
 
@@ -970,6 +974,7 @@ def regenerate_bundle_batch() -> Tuple[flask.Response, int]:
                 build_request.get('bundle_replacements', dict()),
                 flask.current_app.config['IIB_INDEX_TO_GITLAB_PUSH_MAP'],
                 flask.current_app.config['IIB_REGENERATE_BUNDLE_REPO_KEY'],
+                flask.current_app.config['IIB_BINARY_IMAGE_LESS_ARCHES_ALLOWED_VERSIONS'],
             ]
             safe_args = _get_safe_args(args, build_request)
             error_callback = failed_request_callback.s(request.id)
@@ -1176,6 +1181,7 @@ def create_empty_index() -> Tuple[flask.Response, int]:
         payload.get('labels'),
         flask.current_app.config['IIB_BINARY_IMAGE_CONFIG'],
         flask.current_app.config['IIB_INDEX_TO_GITLAB_PUSH_MAP'],
+        flask.current_app.config['IIB_BINARY_IMAGE_LESS_ARCHES_ALLOWED_VERSIONS'],
     ]
     safe_args = _get_safe_args(args, payload)
     error_callback = failed_request_callback.s(request.id)
@@ -1337,6 +1343,7 @@ def fbc_operations() -> Tuple[flask.Response, int]:
         flask.current_app.config['IIB_BINARY_IMAGE_CONFIG'],
         flask.current_app.config['IIB_INDEX_TO_GITLAB_PUSH_MAP'],
         request._used_fbc_fragment,  # Pass the legacy flag to the worker
+        flask.current_app.config['IIB_BINARY_IMAGE_LESS_ARCHES_ALLOWED_VERSIONS'],
     ]
     safe_args = _get_safe_args(args, payload)
     error_callback = failed_request_callback.s(request.id)

iib/web/config.py

@@ -20,6 +20,7 @@ class Config(object):
     IIB_ADDITIONAL_LOGGERS: List[str] = []
     IIB_AWS_S3_BUCKET_NAME: Optional[str] = None
     IIB_BINARY_IMAGE_CONFIG: Dict[str, Dict[str, str]] = {}
+    IIB_BINARY_IMAGE_LESS_ARCHES_ALLOWED_VERSIONS: List[str] = []
     IIB_INDEX_TO_GITLAB_PUSH_MAP: Dict[str, str] = {}
     IIB_REGENERATE_BUNDLE_REPO_KEY: str = 'regenerate-bundle'
     IIB_GRAPH_MODE_INDEX_ALLOW_LIST: List[str] = []

iib/workers/tasks/build_add_deprecations.py

@@ -3,7 +3,7 @@
 import json
 import logging
 import tempfile
-from typing import Dict, Optional, Set
+from typing import Dict, List, Optional, Set
 
 from iib.common.common_utils import get_binary_versions
 from iib.common.tracing import instrument_tracing
@@ -55,6 +55,7 @@ def handle_add_deprecations_request(
     build_tags: Optional[Set[str]] = None,
     binary_image_config: Optional[Dict[str, Dict[str, str]]] = None,
     overwrite_from_index_token: Optional[str] = None,
+    binary_image_less_arches_allowed_versions: Optional[List[str]] = None,
 ) -> None:
     """
     Add a deprecation schema to index image.
@@ -74,6 +75,8 @@ def handle_add_deprecations_request(
     :param list build_tags: List of tags which will be applied to intermediate index images.
     :param dict binary_image_config: the dict of config required to identify the appropriate
         ``binary_image`` to use.
+    :param list binary_image_less_arches_allowed_versions: list of versions of the binary image
+        that are allowed to build for less arches. Defaults to ``None``.
     """
     _cleanup()
     set_request_state(request_id, 'in_progress', 'Resolving the index images')
@@ -87,6 +90,7 @@ def handle_add_deprecations_request(
             operator_package=operator_package,
             deprecation_schema=deprecation_schema,
             binary_image_config=binary_image_config,
+            binary_image_less_arches_allowed_versions=binary_image_less_arches_allowed_versions,
         ),
     )
 

iib/workers/tasks/build_containerized_add.py

@@ -77,6 +77,7 @@ def handle_containerized_add_request(
     graph_update_mode: Optional[str] = None,
     check_related_images: bool = False,
     index_to_gitlab_push_map: Optional[Dict[str, str]] = None,
+    binary_image_less_arches_allowed_versions: Optional[List[str]] = None,
     username: Optional[str] = None,
 ) -> None:
     """
@@ -108,6 +109,8 @@ def handle_containerized_add_request(
         in the index.
     :param dict index_to_gitlab_push_map: the dict mapping index images (keys) to GitLab repos
         (values) in order to push their catalogs into GitLab.
+    :param list binary_image_less_arches_allowed_versions: list of versions of the binary image
+        that are allowed to build for less arches. Defaults to ``None``.
     :raises IIBError: if the index image build fails.
     """
     reset_docker_config()
@@ -134,6 +137,7 @@ def handle_containerized_add_request(
             bundles=bundles,
             distribution_scope=distribution_scope,
             binary_image_config=binary_image_config,
+            binary_image_less_arches_allowed_versions=binary_image_less_arches_allowed_versions,
         ),
     )
     from_index_resolved = prebuild_info['from_index_resolved']

iib/workers/tasks/build_containerized_create_empty_index.py

@@ -4,7 +4,7 @@
 import shutil
 import tempfile
 from pathlib import Path
-from typing import Dict, Optional
+from typing import Dict, Optional, List
 
 from iib.common.common_utils import get_binary_versions
 from iib.common.tracing import instrument_tracing
@@ -122,6 +122,7 @@ def handle_containerized_create_empty_index_request(
     labels: Optional[Dict[str, str]] = None,
     binary_image_config: Optional[Dict[str, Dict[str, str]]] = None,
     index_to_gitlab_push_map: Optional[Dict[str, str]] = None,
+    binary_image_less_arches_allowed_versions: Optional[List[str]] = None,
 ) -> None:
     """
     Coordinate the work needed to create empty index using containerized workflow.
@@ -151,6 +152,7 @@ def handle_containerized_create_empty_index_request(
             _binary_image=binary_image,
             from_index=from_index,
             binary_image_config=binary_image_config,
+            binary_image_less_arches_allowed_versions=binary_image_less_arches_allowed_versions,
         ),
     )
 

iib/workers/tasks/build_containerized_fbc_operations.py

@@ -60,6 +60,7 @@ def handle_containerized_fbc_operation_request(
     binary_image_config: Optional[Dict[str, Dict[str, str]]] = None,
     index_to_gitlab_push_map: Optional[Dict[str, str]] = None,
     used_fbc_fragment: bool = False,
+    binary_image_less_arches_allowed_versions: Optional[List[str]] = None,
 ) -> None:
     """
     Add fbc fragments to an fbc index image.
@@ -77,6 +78,8 @@ def handle_containerized_fbc_operation_request(
         (values) in order to push their catalogs into GitLab.
     :param bool used_fbc_fragment: flag indicating if the original request used fbc_fragment
         (single) instead of fbc_fragments (array). Used for backward compatibility.
+    :param list binary_image_less_arches_allowed_versions: list of versions of the binary image
+        that are allowed to build for less arches. Defaults to ``None``.
     """
     reset_docker_config()
     set_request_state(request_id, 'in_progress', 'Resolving the fbc fragments')
@@ -98,6 +101,7 @@ def handle_containerized_fbc_operation_request(
             fbc_fragments=fbc_fragments,
             distribution_scope=distribution_scope,
             binary_image_config=binary_image_config,
+            binary_image_less_arches_allowed_versions=binary_image_less_arches_allowed_versions,
         ),
     )
 

iib/workers/tasks/build_containerized_merge.py

@@ -75,6 +75,7 @@ def handle_containerized_merge_request(
     graph_update_mode: Optional[str] = None,
     ignore_bundle_ocp_version: Optional[bool] = False,
     index_to_gitlab_push_map: Optional[Dict[str, str]] = None,
+    binary_image_less_arches_allowed_versions: Optional[List[str]] = None,
     parallel_threads: int = 5,
 ) -> None:
     """
@@ -121,6 +122,7 @@ def handle_containerized_merge_request(
                 target_index=target_index,
                 distribution_scope=distribution_scope,
                 binary_image_config=binary_image_config,
+                binary_image_less_arches_allowed_versions=binary_image_less_arches_allowed_versions,
             ),
         )
 

iib/workers/tasks/build_containerized_regenerate_bundle.py

@@ -4,7 +4,7 @@
 import tempfile
 import textwrap
 from pathlib import Path
-from typing import Any, Dict, Optional
+from typing import Any, Dict, List, Optional
 
 import ruamel.yaml
 
@@ -68,6 +68,7 @@ def handle_containerized_regenerate_bundle_request(
     registry_auths: Optional[Dict[str, Any]] = None,
     bundle_replacements: Optional[Dict[str, str]] = None,
     index_to_gitlab_push_map: Optional[Dict[str, str]] = None,
+    binary_image_less_arches_allowed_versions: Optional[List[str]] = None,
     regenerate_bundle_repo_key: str = 'regenerate-bundle',
 ) -> None:
     """
@@ -84,6 +85,8 @@ def handle_containerized_regenerate_bundle_request(
       (values) in order to push their catalogs into GitLab.
     :param str regenerate_bundle_repo_key: the key to look up the actual repo URL from
       index_to_gitlab_push_map, defaults to ``regenerate-bundle``.
+    :param list binary_image_less_arches_allowed_versions: list of versions of the binary image
+        that are allowed to build for less arches. Defaults to ``None``.
     :raises IIBError: if the regenerate bundle image build fails.
     """
     bundle_replacements = bundle_replacements or {}

iib/workers/tasks/build_containerized_rm.py

@@ -63,6 +63,7 @@ def handle_containerized_rm_request(
     binary_image_config: Optional[Dict[str, Dict[str, str]]] = None,
     build_tags: Optional[List[str]] = None,
     index_to_gitlab_push_map: Optional[Dict[str, str]] = None,
+    binary_image_less_arches_allowed_versions: Optional[List[str]] = None,
 ) -> None:
     """
     Coordinate the work needed to remove the input operators using containerized workflow.
@@ -90,6 +91,8 @@ def handle_containerized_rm_request(
     :param list build_tags: List of tags which will be applied to intermediate index images.
     :param dict index_to_gitlab_push_map: the dict mapping index images (keys) to GitLab repos
         (values) in order to remove their catalogs from GitLab.
+    :param list binary_image_less_arches_allowed_versions: list of versions of the binary image
+        that are allowed to build for less arches. Defaults to ``None``.
     :raises IIBError: if the index image build fails.
     """
     reset_docker_config()
@@ -105,6 +108,7 @@ def handle_containerized_rm_request(
             add_arches=add_arches,
             distribution_scope=distribution_scope,
             binary_image_config=binary_image_config,
+            binary_image_less_arches_allowed_versions=binary_image_less_arches_allowed_versions,
         ),
     )