Skip to main content
Version: 3.9.0

Annotations and Labels

KubeRocketCI uses labels to interact with various resources in a Kubernetes cluster. This guide details the resources, annotations, and labels used by the platform to streamline operations, enhance monitoring, and enforce governance.

Labels​

The table below contains all the labels used in KubeRocketCI:

Label KeyTarget ResourcesPossible ValuesDescription
app.edp.epam.com/secret-typeSecretsjira, nexus, sonar, defectdojo, dependency-track,repositoryIdentifies the type of the secret.
app.edp.epam.com/integration-secretSecretstrueIndicates if the secret is used for integration.
app.edp.epam.com/codebasePipelineRun<codebase_name>Identifies the codebase associated with the PipelineRun.
app.edp.epam.com/codebasebranchPipelineRun<codebase_name>-<branch_name>Identifies the codebase branch associated with the PipelineRun.
app.edp.epam.com/pipelinePipelineRun, Taskrun<environment_name>Used by the KubeRocketCI to display autotests status(on Deploy environment)
app.edp.epam.com/pipelinetypePipelineRun, TaskrunautotestRunner, build, review, deployIdentifies the type of the Pipeline.
app.edp.epam.com/parentPipelineRunPipelineRun<cd-pipeline-autotest-runner-name>Used by the KubeRocketCI to display autotests status(on Deploy environment)
app.edp.epam.com/stagePipelineRun, Taskrun<stage_name>Used by the KubeRocketCI to display autotests status(on Deploy environment)
app.edp.epam.com/branchPipelineRun<branch_name>Identifies the branch associated with the PipelineRun.
app.edp.epam.com/codebaseTypeCodebasesystem,applicationIdentify the type of the codebase.
app.edp.epam.com/systemTypeCodebasegitopsIdentify system repositories.
app.edp.epam.com/gitServerIngress<gitServer_name>Identifies the ingress associated with the GitServer.
app.edp.epam.com/cdpipelinePipelineRun, Taskrun<cdpipeline>Identify cd pipeline associated with the PipelineRun
app.edp.epam.com/cdstagePipelineRun, Taskrun<cd_stage_name>Identify cd stage associated with the PipelineRun

Labels Usage in Secrets​

The table below shows what labels are used by specific secrets:

Secret NameLabels
ci-argocdapp.edp.epam.com/integration-secret=true
app.edp.epam.com/secret-type=argocd
ci-defectdojoapp.edp.epam.com/integration-secret=true
app.edp.epam.com/secret-type=defectdojo
ci-dependency-trackapp.edp.epam.com/integration-secret=true
app.edp.epam.com/secret-type=dependency-track
ci-jiraapp.edp.epam.com/secret-type=jira
ci-nexusapp.edp.epam.com/integration-secret=true
app.edp.epam.com/secret-type=nexus
ci-sonarqubeapp.edp.epam.com/integration-secret=true
app.edp.epam.com/secret-type=sonar
gerrit-ciuser-sshkeyapp.edp.epam.com/secret-type=repository
kaniko-docker-configapp.edp.epam.com/integration-secret=true
app.edp.epam.com/secret-type=registry
regcredapp.edp.epam.com/integration-secret=true
app.edp.epam.com/secret-type=registry

Labels Usage in Tekton Pipeline Runs​

The table below displays what labels are used in specific Tekton pipelines:

PipelineRunLabels
review-pipelineapp.edp.epam.com/codebase: <codebase_name>
app.edp.epam.com/codebasebranch: <codebase_name>-<branch_name>
app.edp.epam.com/pipelinetype: review
build-pipelineapp.edp.epam.com/codebase: <codebase_name>
app.edp.epam.com/codebasebranch: <codebase_name>-<branch_name>
app.edp.epam.com/pipelinetype: build
autotest-runner-pipelineapp.edp.epam.com/pipeline: <pipeline_name>
app.edp.epam.com/pipelinetype: autotestRunner
app.edp.epam.com/stage: <stage>
autotest-pipelineapp.edp.epam.com/branch: <branch>
app.edp.epam.com/codebase: <codebase_name>
app.edp.epam.com/parentPipelineRun: <cd_pipeline>-<stage>
app.edp.epam.com/pipeline: <cd_pipeline>
app.edp.epam.com/stage: <stage>
deployapp.edp.epam.com/cdpipeline: <cd_pipeline>
app.edp.epam.com/cdstage: <cd_stage_name>
app.edp.epam.com/pipelinetype: deploy

Pipeline Usage Example​

To demonstrate label usage in the Tekton pipelines, find below some KubeRocketCI resource examples:

Codebase specification
metadata:
...
name: demo
...
spec:
...
defaultBranch: main
type: application
framework: react
lang: javascript
...
CD Pipeline specification
spec:
...
applications:
- demo
inputDockerStreams:
- demo-main
name: mypipe
...
Stage specification
spec:
...
cdPipeline: mypipe
name: dev
namespace: edp-delivery-ms-delivery-dev-mypipe-dev
qualityGates:
- autotestName: autotests
branchName: master
qualityGateType: autotests
stepName: autotest
...

The table below shows all the pipelines associated with the demo codebase:

Pipeline NameTypeLabels
gerrit-npm-react-app-reviewReviewapp.edp.epam.com/codebase: demo
app.edp.epam.com/codebasebranch: demo-main
app.edp.epam.com/pipelinetype: review
gerrit-npm-react-app-build-defaultBuildapp.edp.epam.com/codebase: demo
app.edp.epam.com/codebasebranch: demo-main
app.edp.epam.com/pipelinetype: build
autotest-runnerDeployapp.edp.epam.com/pipeline: mypipe
app.edp.epam.com/pipelinetype: autotestRunner
app.edp.epam.com/stage: dev
autotests-gradle, autotests-mavenDeployapp.edp.epam.com/branch: master
app.edp.epam.com/codebase: autotests
app.edp.epam.com/parentPipelineRun: mypipe-dev-hash
app.edp.epam.com/pipeline: mypipe
app.edp.epam.com/stage: dev
deployDeployapp.edp.epam.com/cdpipeline: deploy
app.edp.epam.com/cdstage: deploy-dev
app.edp.epam.com/pipelinetype: deploy

The list of all the tasks associated with the demo codebase is presented below:

Task NameLabels
init-autotestapp.edp.epam.com/pipeline: mypipe
app.edp.epam.com/pipelinetype: autotestRunner
app.edp.epam.com/stage: dev
run-autotestapp.edp.epam.com/branch: master
app.edp.epam.com/codebase: autotests
app.edp.epam.com/parentPipelineRun: mypipe-dev-hash
app.edp.epam.com/pipeline: mypipe
app.edp.epam.com/stage: dev
wait-for-autotestsapp.edp.epam.com/pipeline: mypipe
app.edp.epam.com/pipelinetype: autotestRunner
app.edp.epam.com/stage: dev
promote-imagesapp.edp.epam.com/pipeline: mypipe
app.edp.epam.com/pipelinetype: autotestRunner
app.edp.epam.com/stage: dev