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

• Release
• ReleaseList
• ReleasePlan
• ReleasePlanAdmission
• ReleasePlanAdmissionList
• ReleasePlanList
• ReleaseServiceConfig
• ReleaseServiceConfigList

AttributionInfo

AttributionInfo defines the observed state of the release attribution.

Appears in:

• ReleaseStatus

Field	Description
author string	Author is the username that the release is attributed to
standingAuthorization boolean	StandingAuthorization indicates whether the release is attributed through a ReleasePlan

Collector

Collector represents a reference to a Collector to be executed as part of the release workflow.

Appears in:

• ReleasePlanAdmissionSpec
• ReleasePlanSpec

Field	Description
name string	Name of the collector
timeout integer	Timeout in seconds for the collector to execute
type string	Type is the type of collector to be used
params Param array	Params is a slice of parameters for a given collector

MatchedReleasePlan

MatchedReleasePlan defines the relevant information for a matched ReleasePlan.

Appears in:

• ReleasePlanAdmissionStatus

Field	Description
name string	Name contains the namespaced name of the ReleasePlan
active boolean	Active indicates whether the ReleasePlan is set to auto-release or not

MatchedReleasePlanAdmission

MatchedReleasePlanAdmission defines the relevant information for a matched ReleasePlanAdmission.

Appears in:

• ReleasePlanStatus

Field	Description
name string	Name contains the namespaced name of the releasePlanAdmission
active boolean	Active indicates whether the ReleasePlanAdmission is set to auto-release or not

Param

Param represents a parameter for a collector

Appears in:

• Collector

Field	Description
name string	Name is the name of the parameter
value string	Value is the value of the parameter

PipelineInfo

PipelineInfo defines the observed state of a release pipeline processing.

Appears in:

• ReleaseStatus

Field	Description
completionTime Time	CompletionTime is the time when the Release processing was completed
pipelineRun string	PipelineRun contains the namespaced name of the managed Release PipelineRun executed as part of this release
roleBinding string	RoleBinding contains the namespaced name of the roleBinding created for the managed Release PipelineRun executed as part of this release
startTime Time	StartTime is the time when the Release processing started

Release

Release is the Schema for the releases API

Appears in:

• ReleaseList

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

ReleaseList

ReleaseList contains a list of Release

Field	Description
apiVersion string	appstudio.redhat.com/v1alpha1
kind string	ReleaseList
metadata ListMeta	Refer to Kubernetes API documentation for fields of metadata.
items Release array

ReleasePlan

ReleasePlan is the Schema for the ReleasePlans API.

Appears in:

• ReleasePlanList

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

ReleasePlanAdmission

ReleasePlanAdmission is the Schema for the ReleasePlanAdmissions API.

Appears in:

• ReleasePlanAdmissionList

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

ReleasePlanAdmissionList

ReleasePlanAdmissionList contains a list of ReleasePlanAdmission.

Field	Description
apiVersion string	appstudio.redhat.com/v1alpha1
kind string	ReleasePlanAdmissionList
metadata ListMeta	Refer to Kubernetes API documentation for fields of metadata.
items ReleasePlanAdmission array

ReleasePlanAdmissionSpec

ReleasePlanAdmissionSpec defines the desired state of ReleasePlanAdmission.

Appears in:

• ReleasePlanAdmission

Field	Description
applications string array	Applications is a list of references to applications to be released in the managed namespace
collectors Collector array	Collectors is a list of data collectors to be executed as part of the release process
data RawExtension	Data is an unstructured key used for providing data for the managed Release Pipeline
environment string	Environment defines which Environment will be used to release the Application
origin string	Origin references where the release requests should come from
pipeline Pipeline	Pipeline contains all the information about the managed Pipeline
policy string	Policy to validate before releasing an artifact

ReleasePlanList

ReleasePlanList contains a list of ReleasePlan.

Field	Description
apiVersion string	appstudio.redhat.com/v1alpha1
kind string	ReleasePlanList
metadata ListMeta	Refer to Kubernetes API documentation for fields of metadata.
items ReleasePlan array

ReleasePlanSpec

ReleasePlanSpec defines the desired state of ReleasePlan.

Appears in:

• ReleasePlan

Field	Description
application string	Application is a reference to the application to be released in the managed namespace
collectors Collector array	Collectors is a list of data collectors to be executed as part of the release process
data RawExtension	Data is an unstructured key used for providing data for the managed Release Pipeline
tenantPipeline ParameterizedPipeline	TenantPipeline contains all the information about the tenant Pipeline
finalPipeline ParameterizedPipeline	FinalPipeline contains all the information about the final Pipeline
releaseGracePeriodDays integer	ReleaseGracePeriodDays is the number of days a Release should be kept This value is used to define the Release ExpirationTime
target string	Target references where to send the release requests

ReleaseServiceConfig

ReleaseServiceConfig is the Schema for the releaseserviceconfigs API

Appears in:

• ReleaseServiceConfigList

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

ReleaseServiceConfigList

ReleaseServiceConfigList contains a list of ReleaseServiceConfig

Field	Description
apiVersion string	appstudio.redhat.com/v1alpha1
kind string	ReleaseServiceConfigList
metadata ListMeta	Refer to Kubernetes API documentation for fields of metadata.
items ReleaseServiceConfig array

ReleaseServiceConfigSpec

ReleaseServiceConfigSpec defines the desired state of ReleaseServiceConfig.

Appears in:

• ReleaseServiceConfig

Field	Description
debug boolean	Debug is the boolean that specifies whether or not the Release Service should run in debug mode
defaultTimeouts TimeoutFields	DefaultTimeouts contain the default Tekton timeouts to be used in case they are not specified in the ReleasePlanAdmission resource.

ReleaseSpec

ReleaseSpec defines the desired state of Release.

Appears in:

• Release

Field	Description
snapshot string	Snapshot to be released
releasePlan string	ReleasePlan to use for this particular Release
data RawExtension	Data is an unstructured key used for providing data for the managed Release Pipeline
gracePeriodDays integer	GracePeriodDays is the number of days a Release should be kept This value is used to define the Release ExpirationTime

ValidationInfo

ValidationInfo defines the observed state of the release validation.

Appears in:

• ReleaseStatus

Field	Description
failedPostValidation boolean	FailedPostValidation indicates whether the Release was marked as invalid after being initially marked as valid
time Time	Time is the time when the Release was validated or when the validation state changed