Integration Test API Reference

Packages

appstudio.redhat.com/v1alpha1

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

Resource Types

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

Environment is an array of standard environment variables

target EnvironmentTarget

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

Appears In:
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.

Appears In:
Field Description Default Validation

deploymentTargetClaim DeploymentTargetClaimConfig

IntegrationTestScenario

IntegrationTestScenario is the Schema for the integrationtestscenarios API

Appears In:
Field Description Default Validation

apiVersion string

appstudio.redhat.com/v1alpha1

kind string

IntegrationTestScenario

metadata ObjectMeta

Refer to Kubernetes API documentation for fields of metadata.

spec IntegrationTestScenarioSpec

status IntegrationTestScenarioStatus

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.

items IntegrationTestScenario array

IntegrationTestScenarioSpec

IntegrationTestScenarioSpec defines the desired state of IntegrationScenario

Appears In:
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

Appears In:
Field Description Default Validation

conditions Condition array

PipelineParameter

PipelineParameter contains the name and values of a Tekton Pipeline parameter

Appears In:
Field Description Default Validation

name string

value string

values string array

TestContext

TestContext contains the name and values of a Test context

Appears In:
Field Description Default Validation

name string

description string

TestEnvironment

TestEnvironment contains the name and values of a Test environment

Appears In:
Field Description Default Validation

name string

type DeprecatedEnvironmentType

configuration DeprecatedEnvironmentConfiguration

appstudio.redhat.com/v1beta1

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

Resource Types

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

Environment is an array of standard environment variables

target EnvironmentTarget

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

Appears In:
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.

Appears In:
Field Description Default Validation

deploymentTargetClaim DeploymentTargetClaimConfig

IntegrationTestScenario

IntegrationTestScenario is the Schema for the integrationtestscenarios API

Appears In:
Field Description Default Validation

apiVersion string

appstudio.redhat.com/v1beta1

kind string

IntegrationTestScenario

metadata ObjectMeta

Refer to Kubernetes API documentation for fields of metadata.

spec IntegrationTestScenarioSpec

status IntegrationTestScenarioStatus

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.

items IntegrationTestScenario array

IntegrationTestScenarioSpec

IntegrationTestScenarioSpec defines the desired state of IntegrationScenario

Appears In:
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

Appears In:
Field Description Default Validation

conditions Condition array

PipelineParameter

PipelineParameter contains the name and values of a Tekton Pipeline parameter

Appears In:
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.

Appears In:
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

Appears In:
Field Description Default Validation

name string

description string

TestEnvironment

TestEnvironment contains the name and values of a Test environment

Appears In:
Field Description Default Validation

name string

type DeprecatedEnvironmentType

configuration DeprecatedEnvironmentConfiguration

appstudio.redhat.com/v1beta2

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

Resource Types

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.

Appears In:
Field Description Default Validation

apiVersion string

appstudio.redhat.com/v1beta2

kind string

IntegrationTestScenario

metadata ObjectMeta

Refer to Kubernetes API documentation for fields of metadata.

spec IntegrationTestScenarioSpec

status IntegrationTestScenarioStatus

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.

items IntegrationTestScenario array

IntegrationTestScenarioSpec

IntegrationTestScenarioSpec defines the desired state of IntegrationScenario

Appears In:
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

Appears In:
Field Description Default Validation

conditions Condition array

PipelineParameter

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

Appears In:
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.

Appears In:
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

TestContext

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

Appears In:
Field Description Default Validation

name string

description string