API Reference

Packages

• appstudio.redhat.com/v1alpha1

appstudio.redhat.com/v1alpha1

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

Resource Types

• IntegrationTestScenario
• IntegrationTestScenarioList

DeploymentTargetClaimConfig

DeploymentTargetClaimConfig specifies the DeploymentTargetClaim details for a given Environment.

Appears in:

• EnvironmentTarget

Field	Description
claimName string

DeprecatedEnvironmentConfiguration

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

Appears in:

• TestEnvironment

Field	Description
env EnvVarPair array	Env 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.

EnvVarPair

EnvVarPair describes environment variables to use for the component

Appears in:

• DeprecatedEnvironmentConfiguration

Field	Description
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:

• DeprecatedEnvironmentConfiguration

Field	Description
deploymentTargetClaim DeploymentTargetClaimConfig

IntegrationTestScenario

IntegrationTestScenario is the Schema for the integrationtestscenarios API

Appears in:

• IntegrationTestScenarioList

Field	Description
apiVersion string	appstudio.redhat.com/v1alpha1
kind string	IntegrationTestScenario
metadata ObjectMeta	Refer to Kubernetes API documentation for fields of metadata.
spec IntegrationTestScenarioSpec

IntegrationTestScenarioList

IntegrationTestScenarioList contains a list of IntegrationTestScenario

Field	Description
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:

• IntegrationTestScenario

Field	Description
application string	Application that’s associated with the IntegrationTestScenario
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

PipelineParameter

PipelineParameter contains the name and values of a Tekton Pipeline parameter

Appears in:

• IntegrationTestScenarioSpec

Field	Description
name string
value string
values string array

TestContext

TestContext contains the name and values of a Test context

Appears in:

• IntegrationTestScenarioSpec

Field	Description
name string
description string

TestEnvironment

TestEnvironment contains the name and values of a Test environment

Appears in:

• IntegrationTestScenarioSpec

Field	Description
name string
type DeprecatedEnvironmentType
configuration DeprecatedEnvironmentConfiguration