CD Pipeline Operator API
Packages:
v2.edp.epam.com/v1
Resource Types:
CDPipelineβ
β© ParentCDPipeline is the Schema for the cdpipelines API.
Name | Type | Description | Required |
---|---|---|---|
apiVersion | string | v2.edp.epam.com/v1 | true |
kind | string | CDPipeline | true |
metadata | object | Refer to the Kubernetes API documentation for the fields of the metadata field. | true |
spec | object | CDPipelineSpec defines the desired state of CDPipeline. | false |
status | object | CDPipelineStatus defines the observed state of CDPipeline. | false |
CDPipeline.specβ
β© ParentCDPipelineSpec defines the desired state of CDPipeline.
Name | Type | Description | Required |
---|---|---|---|
applications | []string | A list of applications included in CDPipeline. | true |
deploymentType | string | Which type of kind will be deployed e.g. Container, Custom | true |
inputDockerStreams | []string | A list of docker streams | true |
name | string | Name of CD pipeline | true |
applicationsToPromote | []string | A list of applications which will promote after successful release. | false |
CDPipeline.statusβ
β© ParentCDPipelineStatus defines the observed state of CDPipeline.
Name | Type | Description | Required |
---|---|---|---|
action | string | The last Action was performed. | true |
available | boolean | This flag indicates neither CDPipeline are initialized and ready to work. Defaults to false. | true |
last_time_updated | string | Information when the last time the action were performed. Format: date-time | true |
result | enum | A result of an action which were performed.
Enum: success, error | true |
status | string | Specifies a current status of CDPipeline. | true |
username | string | Name of user who made a last change. | true |
value | string | Specifies a current state of CDPipeline. | true |
detailed_message | string | Detailed information regarding action result
which were performed | false |
Stageβ
β© ParentStage is the Schema for the stages API.
Name | Type | Description | Required |
---|---|---|---|
apiVersion | string | v2.edp.epam.com/v1 | true |
kind | string | Stage | true |
metadata | object | Refer to the Kubernetes API documentation for the fields of the metadata field. | true |
spec | object | StageSpec defines the desired state of Stage.
NOTE: for deleting the stage use stages order - delete only the latest stage. | false |
status | object | StageStatus defines the observed state of Stage. | false |
Stage.specβ
β© ParentStageSpec defines the desired state of Stage. NOTE: for deleting the stage use stages order - delete only the latest stage.
Name | Type | Description | Required |
---|---|---|---|
cdPipeline | string | Name of CD pipeline which this Stage will be linked to. | true |
description | string | A description of a stage. | true |
name | string | Name of a stage. | true |
order | integer | 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 |
triggerType | string | Stage deployment trigger type. E.g. Manual, Auto | true |
cleanTemplate | string | CleanTemplate specifies a name of Tekton TriggerTemplate which will be used for cleaning resources. | false |
clusterName | string | 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 |
namespace | string | Namespace where the application will be deployed. | false |
source | object | Specifies a source of a pipeline library which will run release Default: map[type:default] | false |
triggerTemplate | string | 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]β
β© ParentQualityGate defines a single quality for a release.
Name | Type | Description | Required |
---|---|---|---|
qualityGateType | string | A type of quality gate, e.g. "Manual", "Autotests" | true |
stepName | string | Specifies a name of particular | true |
autotestName | string | A name of autotests to run with quality gate | false |
branchName | string | A branch name to use from autotests repository | false |
Stage.spec.sourceβ
β© ParentSpecifies a source of a pipeline library which will run release
Name | Type | Description | Required |
---|---|---|---|
library | object | A reference to a non default source library | false |
type | string | Type of pipeline library, e.g. default, library Default: default | false |
Stage.spec.source.libraryβ
β© ParentA reference to a non default source library
Name | Type | Description | Required |
---|---|---|---|
branch | string | Branch which should be used for a library | false |
name | string | A name of a library | false |