From 1308477d94a98703575e719936302bbe5db4fa80 Mon Sep 17 00:00:00 2001 From: Josh Everett Date: Tue, 17 Dec 2024 07:53:05 -0500 Subject: [PATCH] feat(STONEINTG-1002): Multi arch build requirements Add blurb about pullspec requirements for triggering ITS. Signed-off-by: Josh Everett --- .../modules/ROOT/pages/how-tos/testing/integration/adding.adoc | 3 +++ docs/modules/ROOT/pages/how-tos/testing/integration/index.adoc | 2 +- 2 files changed, 4 insertions(+), 1 deletion(-) diff --git a/docs/modules/ROOT/pages/how-tos/testing/integration/adding.adoc b/docs/modules/ROOT/pages/how-tos/testing/integration/adding.adoc index 69996e4b..7774e2ba 100644 --- a/docs/modules/ROOT/pages/how-tos/testing/integration/adding.adoc +++ b/docs/modules/ROOT/pages/how-tos/testing/integration/adding.adoc @@ -2,6 +2,9 @@ In {ProductName}, you can add integration tests to verify that the individual components of your application integrate correctly, forming a complete and functional application. {ProductName} runs these integration tests on the container images of components before their release. ++ +NOTE: Starting an integration test is dependant on the results of a successful build pipeline providing some required information about an image, details on these requirements can be found link:https://github.com/konflux-ci/architecture/blob/main/architecture/integration-service.md#image-extraction-details[here]. In the case of multi-arch builds, an OCI index that maps to the relevant artifacts is used. + .Prerequisites * You have created an application in {ProductName}. diff --git a/docs/modules/ROOT/pages/how-tos/testing/integration/index.adoc b/docs/modules/ROOT/pages/how-tos/testing/integration/index.adoc index e90a6bfa..bb2761c1 100644 --- a/docs/modules/ROOT/pages/how-tos/testing/integration/index.adoc +++ b/docs/modules/ROOT/pages/how-tos/testing/integration/index.adoc @@ -4,7 +4,7 @@ This document covers the integration tests that {ProductName} triggers after com Integration tests ensure that all built components conform to some set of requirements. xref:how-tos/testing/integration/adding.adoc[Adding an integration test] is as simple as providing a reference to a git repository and the path to the Tekton pipeline that defines the test. -After a successful build pipeline, a snapshot is created with the just-produced component and the remaining component references from the application's Global Candidate List. The configured integration test scenarios are then run against this snapshot. If you need to run the snapshots through custom checks, you can also xref:how-tos/testing/integration/creating.adoc[create your own integration tests]. +After a successful build pipeline, a snapshot is created with the just-produced component and the remaining component references from the application's Global Candidate List. The configured integration test scenarios are then run against this snapshot. Note that in order for integration tests to successfully run, the service requires a valid pullspec for the components. If you need to run the snapshots through custom checks, you can also xref:how-tos/testing/integration/creating.adoc[create your own integration tests]. The integration service provides users with the ability to reset their component’s Global Candidate List to a desired state with a manually created `override`. You can xref:how-tos/testing/integration/creating.adoc[create an override snapshot] and provide a valid container image for a component to reset the component’s Global Candidate List.