Release API Reference

appstudio.redhat.com/v1alpha1

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

AttributionInfo

AttributionInfo defines the observed state of the release attribution.

Appears In:
Field Description Default Validation

author string

Author is the username that the release is attributed to

standingAuthorization boolean

StandingAuthorization indicates whether the release is attributed through a ReleasePlan

CollectorItem

CollectorItem represents all the information about an specific collector which will be executed in the CollectorsPipeline.

Appears In:
Field Description Default Validation

name string

Name of the collector

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

timeout integer

Timeout in seconds for the collector to execute

type string

Type is the type of collector to be used

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

params Param array

Params is a slice of parameters for a given collector

Collectors

Collectors holds the list of collectors to be executed as part of the release workflow along with the ServiceAccount to be used in the PipelineRun.

Field Description Default Validation

items CollectorItem array

Items is the list of Collectors to be executed as part of the release workflow

serviceAccountName string

ServiceAccountName is the ServiceAccount to use during the execution of the Collectors Pipeline

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

CollectorsInfo

CollectorsInfo defines the observed state of the release collectors.

Appears In:
Field Description Default Validation

managedCollectorsProcessing PipelineInfo

ManagedCollectorsProcessing contains information about the release managed collectors processing

tenantCollectorsProcessing PipelineInfo

TenantCollectorsProcessing contains information about the release tenant collectors processing

EmptyDirOverrides

EmptyDirOverrides defines the values usually set in a PipelineRef using a git resolver.

Field Description Default Validation

url string

Url is the url to the git repo

revision string

Revision is the git revision where the Pipeline definition can be found

pathInRepo string

PathInRepo is the path within the git repository where the Pipeline definition can be found

MatchedReleasePlan

MatchedReleasePlan defines the relevant information for a matched ReleasePlan.

Field Description Default Validation

name string

Name contains the namespaced name of the ReleasePlan

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

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

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

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.

Field Description Default Validation

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

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

roleBinding string

RoleBinding contains the namespaced name of the roleBinding created for the managed Release PipelineRun
executed as part of this release

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

startTime Time

StartTime is the time when the Release processing started

Release

Release is the Schema for the releases API

Appears In:
Field Description Default Validation

apiVersion string

appstudio.redhat.com/v1alpha1

kind string

Release

metadata ObjectMeta

Refer to Kubernetes API documentation for fields of metadata.

status ReleaseStatus

ReleaseList

ReleaseList contains a list of Release

Field Description Default Validation

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

apiVersion string

appstudio.redhat.com/v1alpha1

kind string

ReleasePlan

metadata ObjectMeta

Refer to Kubernetes API documentation for fields of metadata.

ReleasePlanAdmission

ReleasePlanAdmission is the Schema for the ReleasePlanAdmissions API.

Field Description Default Validation

apiVersion string

appstudio.redhat.com/v1alpha1

kind string

ReleasePlanAdmission

metadata ObjectMeta

Refer to Kubernetes API documentation for fields of metadata.

ReleasePlanAdmissionList

ReleasePlanAdmissionList contains a list of ReleasePlanAdmission.

Field Description Default Validation

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

applications string array

Applications is a list of references to applications to be released in the managed namespace

collectors Collectors

Collectors contains all the information of the collectors to be executed as part of the release workflow

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

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

origin string

Origin references where the release requests should come from

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

pipeline Pipeline

Pipeline contains all the information about the managed Pipeline

policy string

Policy to validate before releasing an artifact

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

ReleasePlanAdmissionStatus

ReleasePlanAdmissionStatus defines the observed state of ReleasePlanAdmission.

Appears In:
Field Description Default Validation

conditions Condition array

Conditions represent the latest available observations for the releasePlanAdmission

releasePlans MatchedReleasePlan array

ReleasePlan is a list of releasePlans matched to the ReleasePlanAdmission

ReleasePlanList

ReleasePlanList contains a list of ReleasePlan.

Field Description Default Validation

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

application string

Application is a reference to the application to be released in the managed namespace

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

collectors Collectors

Collectors contains all the information of the collectors to be executed as part of the release workflow

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

7

target string

Target references where to send the release requests

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

ReleasePlanStatus

ReleasePlanStatus defines the observed state of ReleasePlan.

Appears In:
Field Description Default Validation

conditions Condition array

Conditions represent the latest available observations for the releasePlan

releasePlanAdmission MatchedReleasePlanAdmission

ReleasePlanAdmission contains the information of the releasePlanAdmission this ReleasePlan is
matched to

ReleaseServiceConfig

ReleaseServiceConfig is the Schema for the releaseserviceconfigs API

Field Description Default Validation

apiVersion string

appstudio.redhat.com/v1alpha1

kind string

ReleaseServiceConfig

metadata ObjectMeta

Refer to Kubernetes API documentation for fields of metadata.

ReleaseServiceConfigList

ReleaseServiceConfigList contains a list of ReleaseServiceConfig

Field Description Default Validation

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

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.

EmptyDirOverrides EmptyDirOverrides array

VolumeOverrides is a map containing the volume type for specific Pipeline git refs

ReleaseServiceConfigStatus

ReleaseServiceConfigStatus defines the observed state of ReleaseServiceConfig.

Appears In:

ReleaseSpec

ReleaseSpec defines the desired state of Release.

Appears In:
Field Description Default Validation

snapshot string

Snapshot to be released

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

releasePlan string

ReleasePlan to use for this particular Release

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

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

ReleaseStatus

ReleaseStatus defines the observed state of Release.

Appears In:
Field Description Default Validation

artifacts RawExtension

Artifacts is an unstructured key used for storing all the artifacts generated by the managed Release Pipeline

attribution AttributionInfo

Attribution contains information about the entity authorizing the release

collectors RawExtension

Collectors is an unstructured key used for storing all the collectors results generated by the Collectors Pipeline

conditions Condition array

Conditions represent the latest available observations for the release

collectorsProcessing CollectorsInfo

CollectorsProcessing contains information about the release collectors processing

finalProcessing PipelineInfo

FinalProcessing contains information about the release final processing

managedProcessing PipelineInfo

ManagedProcessing contains information about the release managed processing

tenantProcessing PipelineInfo

TenantProcessing contains information about the release tenant processing

validation ValidationInfo

Validation contains information about the release validation

target string

Target references where this release is intended to be released to

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

automated boolean

Automated indicates whether the Release was created as part of an automated process or manually by an end-user

completionTime Time

CompletionTime is the time when a Release was completed

startTime Time

StartTime is the time when a Release started

expirationTime Time

ExpirationTime is the time when a Release can be purged

ValidationInfo

ValidationInfo defines the observed state of the release validation.

Appears In:
Field Description Default Validation

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