Skip to content

Improve the performance and validation of validate-fbc task #1953

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
arewm merged 2 commits into from
Feb 20, 2025
Merged

Improve the performance and validation of validate-fbc task #1953

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7da41b5
Reduce the resources required for the validate-fbc task
arewm Feb 18, 2025
bbef1d4
improve validation handling for FBC
arewm Feb 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 34 additions & 22 deletions task/validate-fbc/0.1/validate-fbc.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ spec:
name: workdir
steps:
- name: inspect-image
image: quay.io/konflux-ci/konflux-test:v1.4.15@sha256:23a7e8c745a037da283f18f5e5108598efeaeb5263d599411b6c4a25c42c6f94
image: quay.io/konflux-ci/konflux-test:v1.4.16@sha256:c0e83dbc73921cc990994420d656c80a705da38feb2cdd57b5e8c4e4245ce703
# per https://kubernetes.io/docs/concepts/containers/images/#imagepullpolicy-defaulting
# the cluster will set imagePullPolicy to IfNotPresent
workingDir: /var/workdir/inspect-image
Expand Down Expand Up @@ -205,7 +205,7 @@ spec:
exit 0
fi
- name: extract-and-validate
image: quay.io/konflux-ci/konflux-test:v1.4.15@sha256:23a7e8c745a037da283f18f5e5108598efeaeb5263d599411b6c4a25c42c6f94
image: quay.io/konflux-ci/konflux-test:v1.4.16@sha256:c0e83dbc73921cc990994420d656c80a705da38feb2cdd57b5e8c4e4245ce703
# per https://kubernetes.io/docs/concepts/containers/images/#imagepullpolicy-defaulting
# the cluster will set imagePullPolicy to IfNotPresent
workingDir: /var/workdir/extract-and-validate
Expand All @@ -216,9 +216,9 @@ spec:
- SETFCAP
computeResources:
limits:
memory: 8Gi
memory: 6Gi
Comment thread
arewm marked this conversation as resolved.
requests:
memory: 8Gi
memory: 6Gi
cpu: 10m
script: |
#!/usr/bin/env bash
Expand Down Expand Up @@ -255,7 +255,17 @@ spec:

if [[ "${allowed}" == false ]]; then
echo "Base image ${base_image_with_digest} is not allowed for the file based catalog image. Allowed images: " "${ALLOWED_BASE_IMAGES[@]}"
note="Step extract-and-validate failed: Base image ${base_image_with_digest} is not allowed for the file based catalog image. For details, check Tekton task logs"
note="Step extract-and-validate failed: Base image ${base_image_with_digest} is not allowed for the file based catalog image. For details, check Tekton task logs."
TEST_OUTPUT=$(make_result_json -r FAILURE -f 1 -t "$note")
echo "${TEST_OUTPUT}" | tee "$(results.TEST_OUTPUT.path)"
exit 0
fi

status=0
OCP_VER_FROM_BASE=$(get_ocp_version_from_fbc_fragment "$image_with_digest") || status=$?
if [ $status -ne 0 ]; then
echo "!FAILURE! - Could not get OCP version. See https://konflux-ci.dev/architecture/ADR/0026-specifying-ocp-targets-for-fbc.html for defining the parent image."
note="Step extract-and-validate failed: Could not get the OCP version from the base. For details, check Tekton task logs."
TEST_OUTPUT=$(make_result_json -r FAILURE -f 1 -t "$note")
echo "${TEST_OUTPUT}" | tee "$(results.TEST_OUTPUT.path)"
exit 0
Expand Down Expand Up @@ -371,7 +381,6 @@ spec:
# examines the base image tag to derive the target OCP version
# assumes this is in the form
# image-path:[v]major-digits.minor-digits[@sha...]
OCP_VER_FROM_BASE=$(get_ocp_version_from_fbc_fragment "$image_with_digest")
# extracts major digits and filters out any leading alphabetic characters, for e.g. 'v4' --> '4'
OCP_VER_MAJOR=$(echo "${OCP_VER_FROM_BASE}" | cut -d '.' -f 1 | sed "s/^[a-zA-Z]*//")
OCP_VER_MINOR=$(echo "${OCP_VER_FROM_BASE}" | cut -d '.' -f 2)
Expand Down Expand Up @@ -431,29 +440,32 @@ spec:
# Get the new related images that are being added so that we can check them for validity
echo "Rendering target index and finding unreleased related images."
status=0
get_unreleased_fbc_related_images -i "$image_with_digest" > /shared/related-images.json || status=$?
related_images=$(get_unreleased_fbc_related_images -i "$image_with_digest") || status=$?
if [ $status -ne 0 ]; then
get_unreleased_fbc_related_images -i "$image_with_digest"
echo "!FAILURE! - Could not get related images."
note="Step extract-and-validate failed: Could not fetch related images. Make sure you have catalog.yaml or catalog.json formatted correctly in your file-based catalog (FBC) fragment image."
failure_num=$((failure_num + 1))
TESTPASSED=false
fi
else
echo -n "$related_images" > /shared/related-images.json

# A while loop executed in a subshell so we will check for failure based
# on whether /tmp/failedimages exists.
echo -e "Related images detected:\n$(jq -cr '.[]' /shared/related-images.json )."
echo "Testing related images for validity"
# cycle through those related images and show outputs
jq -cr '.[]' /shared/related-images.json | while read -r image; do
if ! skopeo inspect --no-tags "docker://${image}" 2>/dev/null; then
echo "Skopeo inspect failed on related image: ${image}." | tee -a /tmp/failedimages
fi
done

# A while loop executed in a subshell so we will check for failure based
# on whether /tmp/failedimages exists.
echo -e "Related images detected:\n$(jq -cr '.[]' /shared/related-images.json )."
echo "Testing related images for validity"
# cycle through those related images and show outputs
jq -cr '.[]' /shared/related-images.json | while read -r image; do
if ! skopeo inspect --no-tags "docker://${image}" 2>/dev/null; then
echo "Skopeo inspect failed on related image: ${image}." | tee -a /tmp/failedimages
if [ -s /tmp/failedimages ]; then
note="Step extract-and-validate failed: Command skopeo inspect could not inspect images. For details, check Tekton task log."
failure_num=$((failure_num + 1))
TESTPASSED=false
fi
done

if [ -s /tmp/failedimages ]; then
note="Step extract-and-validate failed: Command skopeo inspect could not inspect images. For details, check Tekton task log."
failure_num=$((failure_num + 1))
TESTPASSED=false
fi

if [ $TESTPASSED == false ]; then
Expand Down