Skip to main content
Version: 3.9.0

CD Pipeline Operator API

Packages:

v2.edp.epam.com/v1

Resource Types:

CDPipeline​

↩ Parent

CDPipeline is the Schema for the cdpipelines API.

NameTypeDescriptionRequired
apiVersionstringv2.edp.epam.com/v1true
kindstringCDPipelinetrue
metadataobjectRefer to the Kubernetes API documentation for the fields of the metadata field.true
specobject

CDPipelineSpec defines the desired state of CDPipeline.

false
statusobject

CDPipelineStatus defines the observed state of CDPipeline.

false

CDPipeline.spec​

↩ Parent

CDPipelineSpec defines the desired state of CDPipeline.

NameTypeDescriptionRequired
applications[]string

A list of applications included in CDPipeline.

true
deploymentTypestring

Which type of kind will be deployed e.g. Container, Custom

true
inputDockerStreams[]string

A list of docker streams

true
namestring

Name of CD pipeline

true
applicationsToPromote[]string

A list of applications which will promote after successful release.

false

CDPipeline.status​

↩ Parent

CDPipelineStatus defines the observed state of CDPipeline.

NameTypeDescriptionRequired
actionstring

The last Action was performed.

true
availableboolean

This flag indicates neither CDPipeline are initialized and ready to work. Defaults to false.

true
last_time_updatedstring

Information when the last time the action were performed.


Format: date-time

true
resultenum

A result of an action which were performed.

  • "success": action where performed successfully;
  • "error": error has occurred;

Enum: success, error

true
statusstring

Specifies a current status of CDPipeline.

true
usernamestring

Name of user who made a last change.

true
valuestring

Specifies a current state of CDPipeline.

true
detailed_messagestring

Detailed information regarding action result which were performed

false

Stage​

↩ Parent

Stage is the Schema for the stages API.

NameTypeDescriptionRequired
apiVersionstringv2.edp.epam.com/v1true
kindstringStagetrue
metadataobjectRefer to the Kubernetes API documentation for the fields of the metadata field.true
specobject

StageSpec defines the desired state of Stage. NOTE: for deleting the stage use stages order - delete only the latest stage.

false
statusobject

StageStatus defines the observed state of Stage.

false

Stage.spec​

↩ Parent

StageSpec defines the desired state of Stage. NOTE: for deleting the stage use stages order - delete only the latest stage.

NameTypeDescriptionRequired
cdPipelinestring

Name of CD pipeline which this Stage will be linked to.

true
descriptionstring

A description of a stage.

true
namestring

Name of a stage.

true
orderinteger

The order to lay out Stages. The order should start from 0, and the next stages should use +1 for the order.

true
qualityGates[]object

A list of quality gates to be processed

true
triggerTypestring

Stage deployment trigger type. E.g. Manual, Auto

true
clusterNamestring

Specifies a name of cluster where the application will be deployed. Default value is "in-cluster" which means that application will be deployed in the same cluster where CD Pipeline is running.


Default: in-cluster

false
namespacestring

Namespace where the application will be deployed.

false
sourceobject

Specifies a source of a pipeline library which will run release


Default: map[type:default]

false
triggerTemplatestring

Specifies a name of Tekton TriggerTemplate which will be used as a blueprint for deployment pipeline. Default value is "deploy" which means that default TriggerTemplate will be used. The default TriggerTemplate is delivered using edp-tekton helm chart.


Default: deploy

false

Stage.spec.qualityGates[index]​

↩ Parent

QualityGate defines a single quality for a release.

NameTypeDescriptionRequired
qualityGateTypestring

A type of quality gate, e.g. "Manual", "Autotests"

true
stepNamestring

Specifies a name of particular

true
autotestNamestring

A name of autotests to run with quality gate

false
branchNamestring

A branch name to use from autotests repository

false

Stage.spec.source​

↩ Parent

Specifies a source of a pipeline library which will run release

NameTypeDescriptionRequired
libraryobject

A reference to a non default source library

false
typestring

Type of pipeline library, e.g. default, library


Default: default

false

Stage.spec.source.library​

↩ Parent

A reference to a non default source library

NameTypeDescriptionRequired
branchstring

Branch which should be used for a library

false
namestring

A name of a library

false

Stage.status​

↩ Parent

StageStatus defines the observed state of Stage.

NameTypeDescriptionRequired
actionstring

The last Action was performed.

true
availableboolean

This flag indicates neither Stage are initialized and ready to work. Defaults to false.

true
last_time_updatedstring

Information when the last time the action were performed.


Format: date-time

true
resultenum

A result of an action which were performed.

  • "success": action where performed successfully;
  • "error": error has occurred;

Enum: success, error

true
statusstring

Specifies a current status of Stage.

true
usernamestring

Name of user who made a last change.

true
valuestring

Specifies a current state of Stage.

true
detailed_messagestring

Detailed information regarding action result which were performed

false
shouldBeHandledboolean

Should update of status be handled. Defaults to false.

false

v2.edp.epam.com/v1alpha1

Resource Types:

CDPipeline​

↩ Parent

CDPipeline is the Schema for the cdpipelines API.

NameTypeDescriptionRequired
apiVersionstringv2.edp.epam.com/v1alpha1true
kindstringCDPipelinetrue
metadataobjectRefer to the Kubernetes API documentation for the fields of the metadata field.true
specobject

CDPipelineSpec defines the desired state of CDPipeline.

false
statusobject

CDPipelineStatus defines the observed state of CDPipeline.

false

CDPipeline.spec​

↩ Parent

CDPipelineSpec defines the desired state of CDPipeline.

NameTypeDescriptionRequired
applications[]string

A list of applications included in CDPipeline.

true
deploymentTypestring

Which type of kind will be deployed e.g. Container, Custom

true
inputDockerStreams[]string

A list of docker streams

true
namestring

Name of CD pipeline

true
applicationsToPromote[]string

A list of applications which will promote after successful release.

false

CDPipeline.status​

↩ Parent

CDPipelineStatus defines the observed state of CDPipeline.

NameTypeDescriptionRequired
actionstring

The last Action was performed.

true
availableboolean

This flag indicates neither CDPipeline are initialized and ready to work. Defaults to false.

true
last_time_updatedstring

Information when the last time the action were performed.


Format: date-time

true
resultenum

A result of an action which were performed.

  • "success": action where performed successfully;
  • "error": error has occurred;

Enum: success, error

true
statusstring

Specifies a current status of CDPipeline.

true
usernamestring

Name of user who made a last change.

true
valuestring

Specifies a current state of CDPipeline.

true
detailed_messagestring

Detailed information regarding action result which were performed

false

Stage​

↩ Parent

Stage is the Schema for the stages API.

NameTypeDescriptionRequired
apiVersionstringv2.edp.epam.com/v1alpha1true
kindstringStagetrue
metadataobjectRefer to the Kubernetes API documentation for the fields of the metadata field.true
specobject

StageSpec defines the desired state of Stage.

false
statusobject

StageStatus defines the observed state of Stage.

false

Stage.spec​

↩ Parent

StageSpec defines the desired state of Stage.

NameTypeDescriptionRequired
cdPipelinestring

Name of CD pipeline which this Stage will be linked to.

true
descriptionstring

A description of a stage.

true
namestring

Name of a stage.

true
orderinteger

The order to lay out Stages

true
qualityGates[]object

A list of quality gates to be processed

true
sourceobject

Specifies a source of a pipeline library which will run release

true
triggerTypestring

Stage provisioning trigger type. E.g. Manual, Auto

true

Stage.spec.qualityGates[index]​

↩ Parent

QualityGate defines a single quality for a release.

NameTypeDescriptionRequired
qualityGateTypestring

A type of quality gate, e.g. "Manual", "Autotests"

true
stepNamestring

Specifies a name of particular

true
autotestNamestring

A name of autotests to run with quality gate

false
branchNamestring

A branch name to use from autotests repository

false

Stage.spec.source​

↩ Parent

Specifies a source of a pipeline library which will run release

NameTypeDescriptionRequired
typestring

Type of pipeline library, e.g. default, library

true
libraryobject

A reference to a non default source library

false

Stage.spec.source.library​

↩ Parent

A reference to a non default source library

NameTypeDescriptionRequired
branchstring

Branch which should be used for a library

false
namestring

A name of a library

false

Stage.status​

↩ Parent

StageStatus defines the observed state of Stage.

NameTypeDescriptionRequired
actionstring

The last Action was performed.

true
availableboolean

This flag indicates neither Stage are initialized and ready to work. Defaults to false.

true
last_time_updatedstring

Information when the last time the action were performed.


Format: date-time

true
resultenum

A result of an action which were performed.

  • "success": action where performed successfully;
  • "error": error has occurred;

Enum: success, error

true
statusstring

Specifies a current status of Stage.

true
usernamestring

Name of user who made a last change.

true
valuestring

Specifies a current state of Stage.

true
detailed_messagestring

Detailed information regarding action result which were performed

false
shouldBeHandledboolean

Should update of status be handled. Defaults to false.

false