Integration Test API Reference

appstudio.redhat.com/v1alpha1

Package v1alpha1 contains API Schema definitions for the appstudio v1alpha1 API group

DeploymentTargetClaimConfig

DeploymentTargetClaimConfig specifies the DeploymentTargetClaim details for a given Environment.

Appears In:
Field Description Default Validation

claimName string

DeprecatedEnvironmentConfiguration

EnvironmentConfiguration contains Environment-specific configurations details, to be used when generating Component/Application GitOps repository resources.

Appears In:
Field Description Default Validation

env EnvVarPair array

An array of standard environment variables

Target is used to reference a DeploymentTargetClaim for a target Environment.
The Environment controller uses the referenced DeploymentTargetClaim to access its bounded
DeploymentTarget with cluster credential secret.

DeprecatedEnvironmentType

Underlying type: string

DEPRECATED: EnvironmentType should no longer be used, and has no replacement. - It’s original purpose was to indicate whether an environment is POC/Non-POC, but these data were ultimately not required.

Appears In:

EnvVarPair

EnvVarPair describes environment variables to use for the component

Field Description Default Validation

name string

Name is the environment variable name

value string

Value is the environment variable value

EnvironmentTarget

EnvironmentTarget provides the configuration for a deployment target.

Field Description Default Validation

deploymentTargetClaim DeploymentTargetClaimConfig

IntegrationTestScenario

IntegrationTestScenario is the Schema for the integrationtestscenarios API

Field Description Default Validation

apiVersion string

appstudio.redhat.com/v1alpha1

kind string

IntegrationTestScenario

metadata ObjectMeta

Refer to Kubernetes API documentation for fields of metadata.

IntegrationTestScenarioList

IntegrationTestScenarioList contains a list of IntegrationTestScenario

Field Description Default Validation

apiVersion string

appstudio.redhat.com/v1alpha1

kind string

IntegrationTestScenarioList

metadata ListMeta

Refer to Kubernetes API documentation for fields of metadata.

IntegrationTestScenarioSpec

IntegrationTestScenarioSpec defines the desired state of IntegrationScenario

Field Description Default Validation

application string

Application that’s associated with the IntegrationTestScenario

Pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$

pipeline string

Release Tekton Pipeline to execute

bundle string

Tekton Bundle where to find the pipeline

params PipelineParameter array

Params to pass to the pipeline

environment TestEnvironment

Environment that will be utilized by the test pipeline

contexts TestContext array

Contexts where this IntegrationTestScenario can be applied

IntegrationTestScenarioStatus

IntegrationTestScenarioStatus defines the observed state of IntegrationTestScenario

Field Description Default Validation

conditions Condition array

PipelineParameter

PipelineParameter contains the name and values of a Tekton Pipeline parameter

Field Description Default Validation

name string

value string

values string array

TestContext

TestContext contains the name and values of a Test context

Field Description Default Validation

name string

description string

TestEnvironment

TestEnvironment contains the name and values of a Test environment

Field Description Default Validation

name string

appstudio.redhat.com/v1beta1

Package v1beta1 contains API Schema definitions for the appstudio v1beta1 API group

DeploymentTargetClaimConfig

DeploymentTargetClaimConfig specifies the DeploymentTargetClaim details for a given Environment.

Appears In:
Field Description Default Validation

claimName string

DeprecatedEnvironmentConfiguration

EnvironmentConfiguration contains Environment-specific configurations details, to be used when generating Component/Application GitOps repository resources.

Appears In:
Field Description Default Validation

env EnvVarPair array

An array of standard environment variables

Target is used to reference a DeploymentTargetClaim for a target Environment.
The Environment controller uses the referenced DeploymentTargetClaim to access its bounded
DeploymentTarget with cluster credential secret.

DeprecatedEnvironmentType

Underlying type: string

DEPRECATED: EnvironmentType should no longer be used, and has no replacement. - It’s original purpose was to indicate whether an environment is POC/Non-POC, but these data were ultimately not required.

Appears In:

EnvVarPair

EnvVarPair describes environment variables to use for the component

Field Description Default Validation

name string

Name is the environment variable name

value string

Value is the environment variable value

EnvironmentTarget

EnvironmentTarget provides the configuration for a deployment target.

Field Description Default Validation

deploymentTargetClaim DeploymentTargetClaimConfig

IntegrationTestScenario

IntegrationTestScenario is the Schema for the integrationtestscenarios API

Field Description Default Validation

apiVersion string

appstudio.redhat.com/v1beta1

kind string

IntegrationTestScenario

metadata ObjectMeta

Refer to Kubernetes API documentation for fields of metadata.

IntegrationTestScenarioList

IntegrationTestScenarioList contains a list of IntegrationTestScenario

Field Description Default Validation

apiVersion string

appstudio.redhat.com/v1beta1

kind string

IntegrationTestScenarioList

metadata ListMeta

Refer to Kubernetes API documentation for fields of metadata.

IntegrationTestScenarioSpec

IntegrationTestScenarioSpec defines the desired state of IntegrationScenario

Field Description Default Validation

application string

Application that’s associated with the IntegrationTestScenario

Pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$

resolverRef ResolverRef

Tekton Resolver where to store the Tekton resolverRef trigger Tekton pipeline used to refer to a Pipeline or Task in a remote location like a git repo.

params PipelineParameter array

Params to pass to the pipeline

environment TestEnvironment

Environment that will be utilized by the test pipeline

contexts TestContext array

Contexts where this IntegrationTestScenario can be applied

IntegrationTestScenarioStatus

IntegrationTestScenarioStatus defines the observed state of IntegrationTestScenario

Field Description Default Validation

conditions Condition array

PipelineParameter

PipelineParameter contains the name and values of a Tekton Pipeline parameter

Field Description Default Validation

name string

value string

values string array

ResolverParameter

ResolverParameter contains the name and values used to identify the referenced Tekton resource

Appears In:
Field Description Default Validation

name string

value string

ResolverRef

Tekton Resolver where to store the Tekton resolverRef trigger Tekton pipeline used to refer to a Pipeline or Task in a remote location like a git repo.

Field Description Default Validation

resolver string

Resolver is the name of the resolver that should perform resolution of the referenced Tekton resource, such as "git" or "bundle"..

params ResolverParameter array

Params contains the parameters used to identify the
referenced Tekton resource. Example entries might include
"repo" or "path" but the set of params ultimately depends on
the chosen resolver.

TestContext

TestContext contains the name and values of a Test context

Field Description Default Validation

name string

description string

TestEnvironment

TestEnvironment contains the name and values of a Test environment

Field Description Default Validation

name string

appstudio.redhat.com/v1beta2

Package v1beta2 contains API Schema definitions for the appstudio v1beta2 API group

ComponentBranchReference

ComponentBranchReference contains information about a Component’s branch and its latest promoted image

Appears In:
Field Description Default Validation

name string

Name is the name of the ComponentBranch (typically the branch name like "main", "v1", etc.)
This will reference the ComponentBranch CRD once it’s implemented.

lastPromotedImage string

LastPromotedImage is the latest "good" container image for this ComponentBranch.
This is part of the Global Candidate List (GCL) tracking.
Example: quay.io/sampleorg/first-component@sha256:1b29…​

lastPromotedCommit string

LastPromotedCommit is the git commit SHA of the last promoted image.
Example: 6a7c81802e785aa869f82301afe61f4e9775772b

lastBuildTime Time

LastBuildTime is the timestamp when the last build was completed.
Format: RFC3339 (e.g., "2025-08-13T12:00:00Z")

ComponentGroup

ComponentGroup is the Schema for the componentgroups API. ComponentGroup serves as the replacement for the Application CR in the new application/component model. It groups Components together for testing and releasing, supports test serialization, ComponentGroup dependencies, and tracks the Global Candidate List (GCL) for each Component.

Appears In:
Field Description Default Validation

apiVersion string

appstudio.redhat.com/v1beta2

kind string

ComponentGroup

metadata ObjectMeta

Refer to Kubernetes API documentation for fields of metadata.

ComponentGroupList

ComponentGroupList contains a list of ComponentGroups

Field Description Default Validation

apiVersion string

appstudio.redhat.com/v1beta2

kind string

ComponentGroupList

metadata ListMeta

Refer to Kubernetes API documentation for fields of metadata.

items ComponentGroup array

ComponentGroupSpec

ComponentGroupSpec defines the desired state of ComponentGroup

Appears In:
Field Description Default Validation

components ComponentReference array

Components is a list of Components (name and branch) that belong to the ComponentGroup.
This is the source of truth for logical groupings of versioned Components.

dependents string array

Dependents is a list of ComponentGroup names that are dependent on this ComponentGroup.
When a snapshot is created for this ComponentGroup, snapshots will also be created for all dependents.

testGraph object (keys:string, values:TestGraphNode)

TestGraph describes the desired order in which tests associated with the ComponentGroup should be executed.
If not specified, all tests will run in parallel.
The map key is the test scenario name, and the value is a list of parent test scenarios it depends on.

snapshotCreator SnapshotCreatorSpec

SnapshotCreator is an optional field that allows custom logic for Snapshot creation.
This field is reserved for future implementation and should not be used yet.

ComponentGroupStatus

ComponentGroupStatus defines the observed state of ComponentGroup

Appears In:
Field Description Default Validation

conditions Condition array

Conditions is an array of the ComponentGroup’s status conditions

ComponentReference

ComponentReference references a Component and its specific branch/version

Appears In:
Field Description Default Validation

name string

Name is the name of the Component

Pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$

componentBranch ComponentBranchReference

ComponentBranch references the ComponentBranch for this Component.
The ComponentBranch CRD will be implemented by the build team as part of STONEBLD-3604.
For now, this contains the branch name and GCL (Global Candidate List) information.

IntegrationTestScenario

IntegrationTestScenario is the Schema for the integrationtestscenarios API, holds a definiton for integration test with specified attributes like pipeline reference, application and environment. It is a test template triggered after successful creation of a snapshot.

Field Description Default Validation

apiVersion string

appstudio.redhat.com/v1beta2

kind string

IntegrationTestScenario

metadata ObjectMeta

Refer to Kubernetes API documentation for fields of metadata.

IntegrationTestScenarioList

IntegrationTestScenarioList contains a list of IntegrationTestScenarios

Field Description Default Validation

apiVersion string

appstudio.redhat.com/v1beta2

kind string

IntegrationTestScenarioList

metadata ListMeta

Refer to Kubernetes API documentation for fields of metadata.

IntegrationTestScenarioSpec

IntegrationTestScenarioSpec defines the desired state of IntegrationScenario

Field Description Default Validation

application string

Application that’s associated with the IntegrationTestScenario

Pattern: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$

resolverRef ResolverRef

Tekton Resolver where to store the Tekton resolverRef trigger Tekton pipeline used to refer to a Pipeline or Task in a remote location like a git repo.

params PipelineParameter array

Params to pass to the pipeline

contexts TestContext array

Contexts where this IntegrationTestScenario can be applied, for specific component for example

dependents string array

List of IntegrationTestScenario which are blocked by the successful completion of this IntegrationTestScenario

IntegrationTestScenarioStatus

IntegrationTestScenarioStatus defines the observed state of IntegrationTestScenario described by conditions

Field Description Default Validation

conditions Condition array

PipelineParameter

PipelineParameter contains the name and values of a Tekton Pipeline parameter, used by IntegrationTestScenarioSpec Params

Field Description Default Validation

name string

value string

values string array

ResolverParameter

ResolverParameter contains the name and values used to identify the referenced Tekton resource

Appears In:
Field Description Default Validation

name string

value string

ResolverRef

Tekton Resolver where to store the Tekton resolverRef trigger Tekton pipeline used to refer to a Pipeline or Task in a remote location like a git repo.

Field Description Default Validation

resolver string

Resolver is the name of the resolver that should perform resolution of the referenced Tekton resource, such as "git" or "bundle"..

params ResolverParameter array

Params contains the parameters used to identify the
referenced Tekton resource. Example entries might include
"repo" or "path" but the set of params ultimately depends on
the chosen resolver.

resourceKind string

ResourceKind defines the kind of resource being resolved. It can either
be "pipeline" or "pipelinerun" but defaults to "pipeline" if no value is
set

SnapshotCreatorSpec

SnapshotCreatorSpec defines custom logic for creating snapshots. This is reserved for future implementation and should not be used yet.

Appears In:
Field Description Default Validation

taskRef TaskRef

TaskRef references a Tekton Task that will create the Snapshot CR.
This field is reserved for future use.

TaskRef

TaskRef references a Tekton Task using a resolver

Appears In:
Field Description Default Validation

resolver string

Resolver is the name of the resolver (e.g., "git", "bundle")

params ResolverParameter array

Params contains the parameters used to identify the referenced Task

TestContext

TestContext contains the name and values of a Test context, used by IntegrationTestScenarioSpec Contexts

Field Description Default Validation

name string

description string

TestGraphNode

TestGraphNode represents a node in the test serialization graph

Appears In:
Field Description Default Validation

name string

Name is the name of the IntegrationTestScenario

onFail string

OnFail defines how to behave if this IntegrationTestScenario fails.
Options: "run" (default) - continue running dependent tests, "skip" - skip dependent tests

run

Enum: [run skip]