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.
| Field | Description | Default | Validation |
|---|---|---|---|
|
DeprecatedEnvironmentConfiguration
EnvironmentConfiguration contains Environment-specific configurations details, to be used when generating Component/Application GitOps repository resources.
| Field | Description | Default | Validation |
|---|---|---|---|
|
An array of standard environment variables |
||
|
Target is used to reference a DeploymentTargetClaim for a target Environment. |
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.
EnvVarPair
EnvVarPair describes environment variables to use for the component
| Field | Description | Default | Validation |
|---|---|---|---|
|
Name is the environment variable name |
||
|
Value is the environment variable value |
EnvironmentTarget
EnvironmentTarget provides the configuration for a deployment target.
| Field | Description | Default | Validation |
|---|---|---|---|
|
IntegrationTestScenario
IntegrationTestScenario is the Schema for the integrationtestscenarios API
| Field | Description | Default | Validation |
|---|---|---|---|
|
|
||
|
|
||
|
Refer to Kubernetes API documentation for fields of |
||
IntegrationTestScenarioList
IntegrationTestScenarioList contains a list of IntegrationTestScenario
| Field | Description | Default | Validation |
|---|---|---|---|
|
|
||
|
|
||
|
Refer to Kubernetes API documentation for fields of |
||
|
IntegrationTestScenarioSpec
IntegrationTestScenarioSpec defines the desired state of IntegrationScenario
| Field | Description | Default | Validation |
|---|---|---|---|
|
Application that’s associated with the IntegrationTestScenario |
Pattern: |
|
|
Release Tekton Pipeline to execute |
||
|
Tekton Bundle where to find the pipeline |
||
|
Params to pass to the pipeline |
||
|
Environment that will be utilized by the test pipeline |
||
|
Contexts where this IntegrationTestScenario can be applied |
IntegrationTestScenarioStatus
IntegrationTestScenarioStatus defines the observed state of IntegrationTestScenario
| Field | Description | Default | Validation |
|---|---|---|---|
|
PipelineParameter
PipelineParameter contains the name and values of a Tekton Pipeline parameter
| Field | Description | Default | Validation |
|---|---|---|---|
|
|||
|
|||
|
TestContext
TestContext contains the name and values of a Test context
| Field | Description | Default | Validation |
|---|---|---|---|
|
|||
|
TestEnvironment
TestEnvironment contains the name and values of a Test environment
| Field | Description | Default | Validation |
|---|---|---|---|
|
|||
|
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.
| Field | Description | Default | Validation |
|---|---|---|---|
|
DeprecatedEnvironmentConfiguration
EnvironmentConfiguration contains Environment-specific configurations details, to be used when generating Component/Application GitOps repository resources.
| Field | Description | Default | Validation |
|---|---|---|---|
|
An array of standard environment variables |
||
|
Target is used to reference a DeploymentTargetClaim for a target Environment. |
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.
EnvVarPair
EnvVarPair describes environment variables to use for the component
| Field | Description | Default | Validation |
|---|---|---|---|
|
Name is the environment variable name |
||
|
Value is the environment variable value |
EnvironmentTarget
EnvironmentTarget provides the configuration for a deployment target.
| Field | Description | Default | Validation |
|---|---|---|---|
|
IntegrationTestScenario
IntegrationTestScenario is the Schema for the integrationtestscenarios API
| Field | Description | Default | Validation |
|---|---|---|---|
|
|
||
|
|
||
|
Refer to Kubernetes API documentation for fields of |
||
IntegrationTestScenarioList
IntegrationTestScenarioList contains a list of IntegrationTestScenario
| Field | Description | Default | Validation |
|---|---|---|---|
|
|
||
|
|
||
|
Refer to Kubernetes API documentation for fields of |
||
|
IntegrationTestScenarioSpec
IntegrationTestScenarioSpec defines the desired state of IntegrationScenario
| Field | Description | Default | Validation |
|---|---|---|---|
|
Application that’s associated with the IntegrationTestScenario |
Pattern: |
|
|
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 to pass to the pipeline |
||
|
Environment that will be utilized by the test pipeline |
||
|
Contexts where this IntegrationTestScenario can be applied |
IntegrationTestScenarioStatus
IntegrationTestScenarioStatus defines the observed state of IntegrationTestScenario
| Field | Description | Default | Validation |
|---|---|---|---|
|
PipelineParameter
PipelineParameter contains the name and values of a Tekton Pipeline parameter
| Field | Description | Default | Validation |
|---|---|---|---|
|
|||
|
|||
|
ResolverParameter
ResolverParameter contains the name and values used to identify the referenced Tekton resource
| Field | Description | Default | Validation |
|---|---|---|---|
|
|||
|
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 is the name of the resolver that should perform resolution of the referenced Tekton resource, such as "git" or "bundle".. |
||
|
Params contains the parameters used to identify the |
TestContext
TestContext contains the name and values of a Test context
| Field | Description | Default | Validation |
|---|---|---|---|
|
|||
|
TestEnvironment
TestEnvironment contains the name and values of a Test environment
| Field | Description | Default | Validation |
|---|---|---|---|
|
|||
|
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
| Field | Description | Default | Validation |
|---|---|---|---|
|
Name is the name of the ComponentBranch (typically the branch name like "main", "v1", etc.) |
||
|
LastPromotedImage is the latest "good" container image for this ComponentBranch. |
||
|
LastPromotedCommit is the git commit SHA of the last promoted image. |
||
|
LastBuildTime is the timestamp when the last build was completed. |
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.
| Field | Description | Default | Validation |
|---|---|---|---|
|
|
||
|
|
||
|
Refer to Kubernetes API documentation for fields of |
||
|
|||
|
ComponentGroupList
ComponentGroupList contains a list of ComponentGroups
| Field | Description | Default | Validation |
|---|---|---|---|
|
|
||
|
|
||
|
Refer to Kubernetes API documentation for fields of |
||
|
ComponentGroupSpec
ComponentGroupSpec defines the desired state of ComponentGroup
| Field | Description | Default | Validation |
|---|---|---|---|
|
Components is a list of Components (name and branch) that belong to the ComponentGroup. |
||
|
Dependents is a list of ComponentGroup names that are dependent on this ComponentGroup. |
||
|
TestGraph describes the desired order in which tests associated with the ComponentGroup should be executed. |
||
|
SnapshotCreator is an optional field that allows custom logic for Snapshot creation. |
ComponentGroupStatus
ComponentGroupStatus defines the observed state of ComponentGroup
| Field | Description | Default | Validation |
|---|---|---|---|
|
Conditions is an array of the ComponentGroup’s status conditions |
ComponentReference
ComponentReference references a Component and its specific branch/version
| Field | Description | Default | Validation |
|---|---|---|---|
|
Name is the name of the Component |
Pattern: |
|
|
ComponentBranch references the ComponentBranch for this Component. |
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 |
|---|---|---|---|
|
|
||
|
|
||
|
Refer to Kubernetes API documentation for fields of |
||
IntegrationTestScenarioList
IntegrationTestScenarioList contains a list of IntegrationTestScenarios
| Field | Description | Default | Validation |
|---|---|---|---|
|
|
||
|
|
||
|
Refer to Kubernetes API documentation for fields of |
||
|
IntegrationTestScenarioSpec
IntegrationTestScenarioSpec defines the desired state of IntegrationScenario
| Field | Description | Default | Validation |
|---|---|---|---|
|
Application that’s associated with the IntegrationTestScenario |
Pattern: |
|
|
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 to pass to the pipeline |
||
|
Contexts where this IntegrationTestScenario can be applied, for specific component for example |
||
|
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 |
|---|---|---|---|
|
PipelineParameter
PipelineParameter contains the name and values of a Tekton Pipeline parameter, used by IntegrationTestScenarioSpec Params
| Field | Description | Default | Validation |
|---|---|---|---|
|
|||
|
|||
|
ResolverParameter
ResolverParameter contains the name and values used to identify the referenced Tekton resource
| Field | Description | Default | Validation |
|---|---|---|---|
|
|||
|
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 is the name of the resolver that should perform resolution of the referenced Tekton resource, such as "git" or "bundle".. |
||
|
Params contains the parameters used to identify the |
||
|
ResourceKind defines the kind of resource being resolved. It can either |
SnapshotCreatorSpec
SnapshotCreatorSpec defines custom logic for creating snapshots. This is reserved for future implementation and should not be used yet.
| Field | Description | Default | Validation |
|---|---|---|---|
|
TaskRef references a Tekton Task that will create the Snapshot CR. |
TaskRef
TaskRef references a Tekton Task using a resolver
| Field | Description | Default | Validation |
|---|---|---|---|
|
Resolver is the name of the resolver (e.g., "git", "bundle") |
||
|
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 |
|---|---|---|---|
|
|||
|
TestGraphNode
TestGraphNode represents a node in the test serialization graph
| Field | Description | Default | Validation |
|---|---|---|---|
|
Name is the name of the IntegrationTestScenario |
||
|
OnFail defines how to behave if this IntegrationTestScenario fails. |
run |
Enum: [run skip] |