api.md

API Reference

Packages:

• v2.edp.epam.com/v1
• v2.edp.epam.com/v1alpha1

v2.edp.epam.com/v1

Resource Types:

• CDStageDeploy

• CodebaseBranch

• CodebaseImageStream

• Codebase

• GitServer

• JiraIssueMetadata

• JiraServer

• QuickLink

CDStageDeploy

^{↩ Parent}

CDStageDeploy is the Schema for the CDStageDeployments API.

Name	Type	Description	Required
apiVersion	string	v2.edp.epam.com/v1	true
kind	string	CDStageDeploy	true
metadata	object	Refer to the Kubernetes API documentation for the fields of the `metadata` field.	true
spec	object	CDStageDeploySpec defines the desired state of CDStageDeploy.	false
status	object	CDStageDeployStatus defines the observed state of CDStageDeploy. Default: map[status:pending]	false

CDStageDeploy.spec

^{↩ Parent}

CDStageDeploySpec defines the desired state of CDStageDeploy.

Name	Type	Description	Required
pipeline	string	Name of related pipeline	true
stage	string	Name of related stage	true
tag	object	Specifies a latest available tag	true
strategy	string	TriggerType specifies a strategy for auto-deploy. Default: Auto	false
tags	[]object	A list of available tags. Deprecated: Use tag instead.	false

CDStageDeploy.spec.tag

^{↩ Parent}

Specifies a latest available tag

Name	Type	Description	Required
codebase	string		true
tag	string		true

CDStageDeploy.spec.tags[index]

^{↩ Parent}

Name	Type	Description	Required
codebase	string		true
tag	string		true

CDStageDeploy.status

^{↩ Parent}

CDStageDeployStatus defines the observed state of CDStageDeploy.

Name	Type	Description	Required
message	string	Descriptive message for current status.	false
status	enum	Specifies a current status of CDStageDeploy. Enum: failed, running, pending, completed, in-queue Default: pending	false

CodebaseBranch

^{↩ Parent}

CodebaseBranch is the Schema for the CodebaseBranches API.

Name	Type	Description	Required
apiVersion	string	v2.edp.epam.com/v1	true
kind	string	CodebaseBranch	true
metadata	object	Refer to the Kubernetes API documentation for the fields of the `metadata` field.	true
spec	object	CodebaseBranchSpec defines the desired state of CodebaseBranch.	false
status	object	CodebaseBranchStatus defines the observed state of CodebaseBranch.	false

CodebaseBranch.spec

^{↩ Parent}

CodebaseBranchSpec defines the desired state of CodebaseBranch.

Name	Type	Description	Required
branchName	string	Name of a branch.	true
codebaseName	string	Name of Codebase associated with.	true
fromCommit	string	The new branch will be created starting from the selected commit hash.	true
release	boolean	Flag if branch is used as "release" branch.	true
pipelines	map[string]string	Pipelines is a map of pipelines related to the branch.	false
version	string		false

CodebaseBranch.status

^{↩ Parent}

CodebaseBranchStatus defines the observed state of CodebaseBranch.

Name	Type	Description	Required
action	string	The last Action was performed.	true
failureCount	integer	Amount of times, operator fail to serve with existing CR. Format: int64	true
lastTimeUpdated	string	Information when the last time the action were performed. Format: date-time	true
result	enum	A result of an action which were performed. - "success": action where performed successfully; - "error": error has occurred; Enum: success, error	true
status	string	Specifies a current status of CodebaseBranch.	true
username	string	Name of user who made a last change.	true
value	string	Specifies a current state of CodebaseBranch.	true
build	string		false
detailedMessage	string	Detailed information regarding action result which were performed	false
git	string	Specifies a status of action for git.	false
lastSuccessfulBuild	string		false
versionHistory	[]string		false

CodebaseImageStream

^{↩ Parent}

CodebaseImageStream is the Schema for the CodebaseImageStreams API.

Name	Type	Description	Required
apiVersion	string	v2.edp.epam.com/v1	true
kind	string	CodebaseImageStream	true
metadata	object	Refer to the Kubernetes API documentation for the fields of the `metadata` field.	true
spec	object	CodebaseImageStreamSpec defines the desired state of CodebaseImageStream.	false
status	object	CodebaseImageStreamStatus defines the observed state of CodebaseImageStream.	false

CodebaseImageStream.spec

^{↩ Parent}

CodebaseImageStreamSpec defines the desired state of CodebaseImageStream.

Name	Type	Description	Required
codebase	string	Name of Codebase associated with.	true
imageName	string	Docker container name without tag, e.g. registry-name/path/name.	true
tags	[]object	A list of docker image tags available for ImageName and their creation date.	false

CodebaseImageStream.spec.tags[index]

^{↩ Parent}

Name	Type	Description	Required
created	string		true
name	string		true

CodebaseImageStream.status

^{↩ Parent}

CodebaseImageStreamStatus defines the observed state of CodebaseImageStream.

Name	Type	Description	Required
failureCount	integer	Amount of times, operator fail to serve with existing CR. Format: int64	true
detailed_message	string	Detailed information regarding action result which were performed	false

Codebase

^{↩ Parent}

Codebase is the Schema for the Codebases API.

Name	Type	Description	Required
apiVersion	string	v2.edp.epam.com/v1	true
kind	string	Codebase	true
metadata	object	Refer to the Kubernetes API documentation for the fields of the `metadata` field.	true
spec	object	CodebaseSpec defines the desired state of Codebase.	false
status	object	CodebaseStatus defines the observed state of Codebase.	false

Codebase.spec

^{↩ Parent}

CodebaseSpec defines the desired state of Codebase.

Name	Type	Description	Required
buildTool	string	A build tool which is used on codebase.	true
defaultBranch	string	Name of default branch.	true
emptyProject	boolean	A flag indicating how project should be provisioned. Default: false	true
framework	string	A framework used in codebase.	true
gitServer	string	A name of git server which will be used as VCS. Example: "gerrit".	true
gitUrlPath	string	A relative path for git repository. Should start from /. Example: /company/api-app.	true
lang	string	Programming language used in codebase.	true
strategy	enum	integration strategy for a codebase, e.g. clone, import, etc. Enum: create, clone, import	true
type	string	Type of codebase. E.g. application, autotest or library.	true
versioning	object		true
branchToCopyInDefaultBranch	string	While we clone new codebase we can select specific branch to clone. Selected branch will become a default branch for a new codebase (e.g. master, main).	false
ciTool	string	A name of tool which should be used as CI. Default: tekton	false
commitMessagePattern	string		false
deploymentScript	string	Default: helm-chart	false
description	string	A short description of codebase.	false
disablePutDeployTemplates	boolean	Controller must skip step "put deploy templates" in action chain.	false
jiraIssueMetadataPayload	string		false
jiraServer	string		false
repository	object		false
testReportFramework	string		false
ticketNamePattern	string		false

Codebase.spec.versioning

^{↩ Parent}

Name	Type	Description	Required
type	string		true
startFrom	string	StartFrom is required when versioning type is not default.	false

Codebase.spec.repository

^{↩ Parent}

Name	Type	Description	Required
url	string		true

Codebase.status

^{↩ Parent}

CodebaseStatus defines the observed state of Codebase.

Name	Type	Description	Required
action	string	The last Action was performed.	true
available	boolean	This flag indicates neither Codebase are initialized and ready to work. Defaults to false.	true
failureCount	integer	Amount of times, operator fail to serve with existing CR. Format: int64	true
git	string	Specifies a status of action for git.	true
lastTimeUpdated	string	Information when the last time the action were performed. Format: date-time	true
result	enum	A result of an action which were performed. - "success": action where performed successfully; - "error": error has occurred; Enum: success, error	true
status	string	Specifies a current status of Codebase.	true
username	string	Name of user who made a last change.	true
value	string	Specifies a current state of Codebase.	true
detailedMessage	string	Detailed information regarding action result which were performed	false
gitWebUrl	string	Stores GitWebUrl of codebase.	false
webHookID	integer	Stores ID of webhook which was created for a codebase. Deprecated: Because the webhook id can be more than just an integer. Use WebHookRef instead.	false
webHookRef	string	WebHookRef stores unique reference to webhook which was created for a codebase.	false

GitServer

^{↩ Parent}

GitServer is the Schema for the gitservers API.

Name	Type	Description	Required
apiVersion	string	v2.edp.epam.com/v1	true
kind	string	GitServer	true
metadata	object	Refer to the Kubernetes API documentation for the fields of the `metadata` field.	true
spec	object	GitServerSpec defines the desired state of GitServer.	false
status	object	GitServerStatus defines the observed state of GitServer.	false

GitServer.spec

^{↩ Parent}

GitServerSpec defines the desired state of GitServer.

Name	Type	Description	Required
gitHost	string		true
httpsPort	integer	Format: int32	true
nameSshKeySecret	string		true
sshPort	integer	Format: int32	true
gitProvider	enum	GitProvider is a git provider type. It can be gerrit, github or gitlab. Default value is gerrit. Enum: gerrit, gitlab, github, bitbucket Default: github	false
gitUser	string	GitUser is a user name for git server. Default: git	false
skipWebhookSSLVerification	boolean	SkipWebhookSSLVerification is a flag to skip webhook tls verification.	false
webhookUrl	string	WebhookUrl is a URL for webhook that will be created in the git provider. If not set, a new EventListener and Ingress will be created and used for webhooks.	false

GitServer.status

^{↩ Parent}

GitServerStatus defines the observed state of GitServer.

Name	Type	Description	Required
connected	boolean	Connected shows if operator is connected to git server.	false
error	string	Error represents error message if something went wrong.	false
status	string	Status indicates the current status of the GitServer. Possible values are: ok, failed.	false

JiraIssueMetadata

^{↩ Parent}

JiraIssueMetadata is the Schema for the JiraIssueMetadatas API.

Name	Type	Description	Required
apiVersion	string	v2.edp.epam.com/v1	true
kind	string	JiraIssueMetadata	true
metadata	object	Refer to the Kubernetes API documentation for the fields of the `metadata` field.	true
spec	object	JiraIssueMetadataSpec defines the desired state of JiraIssueMetadata.	false
status	object	JiraIssueMetadataStatus defines the observed state of JiraIssueMetadata.	false

JiraIssueMetadata.spec

^{↩ Parent}

JiraIssueMetadataSpec defines the desired state of JiraIssueMetadata.

Name	Type	Description	Required
codebaseName	string	Name of Codebase associated with.	true
commits	[]string		false
payload	string	JSON payload	false
tickets	[]string		false

JiraIssueMetadata.status

^{↩ Parent}

JiraIssueMetadataStatus defines the observed state of JiraIssueMetadata.

Name	Type	Description	Required
failureCount	integer	Amount of times, operator fail to serve with existing CR. Format: int64	true
last_time_updated	string	Information when the last time the action were performed. Format: date-time	true
status	string	Specifies a current status of JiraIssueMetadata.	true
detailed_message	string	Detailed information regarding action result which were performed	false

JiraServer

^{↩ Parent}

JiraServer is the Schema for the JiraServers API.

Name	Type	Description	Required
apiVersion	string	v2.edp.epam.com/v1	true
kind	string	JiraServer	true
metadata	object	Refer to the Kubernetes API documentation for the fields of the `metadata` field.	true
spec	object	JiraServerSpec defines the desired state of JiraServer.	false
status	object	JiraServerStatus defines the observed state of JiraServer.	false

JiraServer.spec

^{↩ Parent}

JiraServerSpec defines the desired state of JiraServer.

Name	Type	Description	Required
apiUrl	string		true
credentialName	string		true
rootUrl	string		true

JiraServer.status

^{↩ Parent}

JiraServerStatus defines the observed state of JiraServer.

Name	Type	Description	Required
available	boolean	This flag indicates neither JiraServer 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
status	string	Specifies a current status of JiraServer.	true
detailed_message	string	Detailed information regarding action result which were performed	false

QuickLink

^{↩ Parent}

QuickLink is the Schema for the quicklinks API.

Name	Type	Description	Required
apiVersion	string	v2.edp.epam.com/v1	true
kind	string	QuickLink	true
metadata	object	Refer to the Kubernetes API documentation for the fields of the `metadata` field.	true
spec	object	QuickLinkSpec defines the desired state of QuickLink.	false
status	object	QuickLinkStatus defines the observed state of QuickLink.	false

QuickLink.spec

^{↩ Parent}

QuickLinkSpec defines the desired state of QuickLink.

Name	Type	Description	Required
icon	string	Icon is a base64 encoded SVG icon of the component.	true
type	enum	Type is a quicklink type. It can be default or system. Default value is default. Enum: default, system Default: default	true
url	string	Url specifies a link to the component. Default:	true
visible	boolean	Visible specifies whether a component is visible. The default value is true. Default: true	true

v2.edp.epam.com/v1alpha1

Resource Types:

• Template

Template

^{↩ Parent}

Template is the Schema for the templates API.

Name	Type	Description	Required
apiVersion	string	v2.edp.epam.com/v1alpha1	true
kind	string	Template	true
metadata	object	Refer to the Kubernetes API documentation for the fields of the `metadata` field.	true
spec	object	TemplateSpec defines the desired state of Template.	false
status	object	TemplateStatus defines the observed state of Template.	false

Template.spec

^{↩ Parent}

TemplateSpec defines the desired state of Template.

Name	Type	Description	Required
buildTool	string	The build tool used to build the component from the template.	true
description	string	The description of the template.	true
displayName	string	The name of the template.	true
framework	string	The framework used to build the component from the template.	true
language	string	The programming language used to build the component from the template.	true
source	string	A repository containing the source code for the template.	true
type	string	The type of the template, e.g application, library, autotest, infrastructure, etc.	true
version	string	Version is the version of the template.	true
category	string	Category is the category of the template.	false
icon	[]object	The icon for this template.	false
keywords	[]string	A list of keywords describing the template.	false
maintainers	[]object	A list of organizational entities maintaining the Template.	false
maturity	enum	The level of maturity the template has achieved at this version. Options include planning, pre-alpha, alpha, beta, stable, mature, inactive, and deprecated. Enum: planning, pre-alpha, alpha, beta, stable, mature, inactive, deprecated	false
minEDPVersion	string	MinEDPVersion is the minimum EDP version that this template is compatible with.	false

Template.spec.icon[index]

^{↩ Parent}

Name	Type	Description	Required
base64data	string	A base64 encoded PNG, JPEG or SVG image.	true
mediatype	string	The media type of the image. E.g image/svg+xml, image/png, image/jpeg.	true

Template.spec.maintainers[index]

^{↩ Parent}

Name	Type	Description	Required
email	string		true
name	string		true