Skip to content

v1beta1

Reference information for lifecycle.keptn.sh/v1beta1

Packages

lifecycle.keptn.sh/v1beta1

Package v1beta1 contains API Schema definitions for the lifecycle v1beta1 API group

Resource Types

AutomountServiceAccountTokenSpec

Appears in: - KeptnTaskDefinitionSpec

Field Description Default Optional Validation
type boolean x

CheckType

Underlying type: string

Appears in: - KeptnEvaluationSpec - KeptnTaskSpec

ConfigMapReference

Appears in: - RuntimeSpec

Field Description Default Optional Validation
name string Name is the name of the referenced ConfigMap. ✓

ContainerSpec

Appears in: - KeptnTaskDefinitionSpec

DeploymentTaskSpec

Appears in: - KeptnAppContextSpec - KeptnAppVersionSpec

Field Description Default Optional Validation
preDeploymentTasks string array PreDeploymentTasks is a list of all tasks to be performed during the pre-deployment phase of the KeptnApp.
The items of this list refer to the names of KeptnTaskDefinitions
located in the same namespace as the KeptnApp, or in the Keptn namespace.		 x
postDeploymentTasks string array PostDeploymentTasks is a list of all tasks to be performed during the post-deployment phase of the KeptnApp.
The items of this list refer to the names of KeptnTaskDefinitions
located in the same namespace as the KeptnApp, or in the Keptn namespace.		 x
preDeploymentEvaluations string array PreDeploymentEvaluations is a list of all evaluations to be performed
during the pre-deployment phase of the KeptnApp.
The items of this list refer to the names of KeptnEvaluationDefinitions
located in the same namespace as the KeptnApp, or in the Keptn namespace.		 x
postDeploymentEvaluations string array PostDeploymentEvaluations is a list of all evaluations to be performed
during the post-deployment phase of the KeptnApp.
The items of this list refer to the names of KeptnEvaluationDefinitions
located in the same namespace as the KeptnApp, or in the Keptn namespace.		 x
promotionTasks string array PromotionTasks is a list of all tasks to be performed during the promotion phase of the KeptnApp.
The items of this list refer to the names of KeptnTaskDefinitions
located in the same namespace as the KeptnApp, or in the Keptn namespace.		 x

EvaluationStatusItem

Appears in: - KeptnEvaluationStatus

Field Description Default Optional Validation
value string Value represents the value of the KeptnMetric being evaluated. x
status string Status indicates the status of the objective being evaluated. x
message string Message contains additional information about the evaluation of an objective.
This can include explanations about why an evaluation has failed (e.g. due to a missed objective),
or if there was any error during the evaluation of the objective.		 ✓

FailureConditions

FailureConditions represent the failure conditions (number of retries and retry interval) for the evaluation to be considered as failed

Appears in: - KeptnEvaluationDefinitionSpec - KeptnEvaluationSpec

Field Description Default Optional Validation
retries integer Retries indicates how many times the KeptnEvaluation can be attempted in the case of an error or
missed evaluation objective, before considering the KeptnEvaluation to be failed.		 10 ✓
retryInterval Duration RetryInterval specifies the interval at which the KeptnEvaluation is retried in the case of an error
or a missed objective.		 5s ✓ Pattern: ^0|([0-9]+(\.[0-9]+)?(ns|us|µs|ms|s|m|h))+$
Type: string

FunctionReference

Appears in: - RuntimeSpec

Field Description Default Optional Validation
name string Name is the name of the referenced KeptnTaskDefinition. ✓

FunctionStatus

Appears in: - KeptnTaskDefinitionStatus

Field Description Default Optional Validation
configMap string ConfigMap indicates the ConfigMap in which the function code is stored. ✓

HttpReference

Appears in: - RuntimeSpec

Field Description Default Optional Validation
url string Url is the URL containing the code of the function. ✓

Inline

Appears in: - RuntimeSpec

Field Description Default Optional Validation
code string Code contains the code of the function. ✓

ItemStatus

Appears in: - KeptnAppVersionStatus - KeptnWorkloadVersionStatus

Field Description Default Optional Validation
definitionName string DefinitionName is the name of the EvaluationDefinition/TaskDefinition ✓
status string Pending ✓
name string Name is the name of the Evaluation/Task ✓
startTime Time StartTime represents the time at which the Item (Evaluation/Task) started. ✓
endTime Time EndTime represents the time at which the Item (Evaluation/Task) started. ✓

KeptnApp

KeptnApp is the Schema for the keptnapps API

Appears in: - KeptnAppList

Field Description Default Optional Validation
apiVersion string lifecycle.keptn.sh/v1beta1
kind string KeptnApp
metadata ObjectMeta Refer to Kubernetes API documentation about metadata. ✓
spec KeptnAppSpec Spec describes the desired state of the KeptnApp. ✓
status KeptnAppStatus Status describes the current state of the KeptnApp. ✓

KeptnAppContext

KeptnAppContext is the Schema for the keptnappcontexts API

Appears in: - KeptnAppContextList

Field Description Default Optional Validation
apiVersion string lifecycle.keptn.sh/v1beta1
kind string KeptnAppContext
metadata ObjectMeta Refer to Kubernetes API documentation about metadata. x
spec KeptnAppContextSpec x
status KeptnAppContextStatus x

KeptnAppContextList

KeptnAppContextList contains a list of KeptnAppContext

Field Description Default Optional Validation
apiVersion string lifecycle.keptn.sh/v1beta1
kind string KeptnAppContextList
metadata ListMeta x
items KeptnAppContext array x

KeptnAppContextSpec

KeptnAppContextSpec defines the desired state of KeptnAppContext

Appears in: - KeptnAppContext - KeptnAppVersionSpec

Field Description Default Optional Validation
preDeploymentTasks string array PreDeploymentTasks is a list of all tasks to be performed during the pre-deployment phase of the KeptnApp.
The items of this list refer to the names of KeptnTaskDefinitions
located in the same namespace as the KeptnApp, or in the Keptn namespace.		 x
postDeploymentTasks string array PostDeploymentTasks is a list of all tasks to be performed during the post-deployment phase of the KeptnApp.
The items of this list refer to the names of KeptnTaskDefinitions
located in the same namespace as the KeptnApp, or in the Keptn namespace.		 x
preDeploymentEvaluations string array PreDeploymentEvaluations is a list of all evaluations to be performed
during the pre-deployment phase of the KeptnApp.
The items of this list refer to the names of KeptnEvaluationDefinitions
located in the same namespace as the KeptnApp, or in the Keptn namespace.		 x
postDeploymentEvaluations string array PostDeploymentEvaluations is a list of all evaluations to be performed
during the post-deployment phase of the KeptnApp.
The items of this list refer to the names of KeptnEvaluationDefinitions
located in the same namespace as the KeptnApp, or in the Keptn namespace.		 x
promotionTasks string array PromotionTasks is a list of all tasks to be performed during the promotion phase of the KeptnApp.
The items of this list refer to the names of KeptnTaskDefinitions
located in the same namespace as the KeptnApp, or in the Keptn namespace.		 x
metadata object (keys:string, values:string) Metadata contains additional key-value pairs for contextual information. ✓
spanLinks string array SpanLinks are links to OpenTelemetry span IDs for tracking. These links establish relationships between spans across different services, enabling distributed tracing.
For more information on OpenTelemetry span links, refer to the documentation: https://opentelemetry.io/docs/concepts/signals/traces/#span-links		 ✓

KeptnAppContextStatus

KeptnAppContextStatus defines the observed state of KeptnAppContext

Appears in: - KeptnAppContext

Field Description Default Optional Validation
status string unused field ✓

KeptnAppCreationRequest

KeptnAppCreationRequest is the Schema for the keptnappcreationrequests API

Appears in: - KeptnAppCreationRequestList

Field Description Default Optional Validation
apiVersion string lifecycle.keptn.sh/v1beta1
kind string KeptnAppCreationRequest
metadata ObjectMeta Refer to Kubernetes API documentation about metadata. ✓
spec KeptnAppCreationRequestSpec Spec describes the desired state of the KeptnAppCreationRequest. ✓
status string Status describes the current state of the KeptnAppCreationRequest. ✓

KeptnAppCreationRequestList

KeptnAppCreationRequestList contains a list of KeptnAppCreationRequest

Field Description Default Optional Validation
apiVersion string lifecycle.keptn.sh/v1beta1
kind string KeptnAppCreationRequestList
metadata ListMeta ✓
items KeptnAppCreationRequest array x

KeptnAppCreationRequestSpec

KeptnAppCreationRequestSpec defines the desired state of KeptnAppCreationRequest

Appears in: - KeptnAppCreationRequest

Field Description Default Optional Validation
appName string AppName is the name of the KeptnApp the KeptnAppCreationRequest should create if no user-defined object with that name is found. x

KeptnAppList

KeptnAppList contains a list of KeptnApp

Field Description Default Optional Validation
apiVersion string lifecycle.keptn.sh/v1beta1
kind string KeptnAppList
metadata ListMeta ✓
items KeptnApp array x

KeptnAppSpec

KeptnAppSpec defines the desired state of KeptnApp

Appears in: - KeptnApp - KeptnAppVersionSpec

Field Description Default Optional Validation
version string Version defines the version of the application. For automatically created KeptnApps,
the version is a function of all KeptnWorkloads that are part of the KeptnApp.		 x
revision integer Revision can be modified to trigger another deployment of a KeptnApp of the same version.
This can be used for restarting a KeptnApp which failed to deploy,
e.g. due to a failed preDeploymentEvaluation/preDeploymentTask.		 1 ✓
workloads KeptnWorkloadRef array Workloads is a list of all KeptnWorkloads that are part of the KeptnApp. ✓

KeptnAppStatus

KeptnAppStatus defines the observed state of KeptnApp

Appears in: - KeptnApp

Field Description Default Optional Validation
currentVersion string CurrentVersion indicates the version that is currently deployed or being reconciled. ✓

KeptnAppVersion

KeptnAppVersion is the Schema for the keptnappversions API

Appears in: - KeptnAppVersionList

Field Description Default Optional Validation
apiVersion string lifecycle.keptn.sh/v1beta1
kind string KeptnAppVersion
metadata ObjectMeta Refer to Kubernetes API documentation about metadata. ✓
spec KeptnAppVersionSpec Spec describes the desired state of the KeptnAppVersion. ✓
status KeptnAppVersionStatus Status describes the current state of the KeptnAppVersion. ✓

KeptnAppVersionList

KeptnAppVersionList contains a list of KeptnAppVersion

Field Description Default Optional Validation
apiVersion string lifecycle.keptn.sh/v1beta1
kind string KeptnAppVersionList
metadata ListMeta ✓
items KeptnAppVersion array x

KeptnAppVersionSpec

KeptnAppVersionSpec defines the desired state of KeptnAppVersion

Appears in: - KeptnAppVersion

Field Description Default Optional Validation
preDeploymentTasks string array PreDeploymentTasks is a list of all tasks to be performed during the pre-deployment phase of the KeptnApp.
The items of this list refer to the names of KeptnTaskDefinitions
located in the same namespace as the KeptnApp, or in the Keptn namespace.		 x
postDeploymentTasks string array PostDeploymentTasks is a list of all tasks to be performed during the post-deployment phase of the KeptnApp.
The items of this list refer to the names of KeptnTaskDefinitions
located in the same namespace as the KeptnApp, or in the Keptn namespace.		 x
preDeploymentEvaluations string array PreDeploymentEvaluations is a list of all evaluations to be performed
during the pre-deployment phase of the KeptnApp.
The items of this list refer to the names of KeptnEvaluationDefinitions
located in the same namespace as the KeptnApp, or in the Keptn namespace.		 x
postDeploymentEvaluations string array PostDeploymentEvaluations is a list of all evaluations to be performed
during the post-deployment phase of the KeptnApp.
The items of this list refer to the names of KeptnEvaluationDefinitions
located in the same namespace as the KeptnApp, or in the Keptn namespace.		 x
promotionTasks string array PromotionTasks is a list of all tasks to be performed during the promotion phase of the KeptnApp.
The items of this list refer to the names of KeptnTaskDefinitions
located in the same namespace as the KeptnApp, or in the Keptn namespace.		 x
metadata object (keys:string, values:string) Metadata contains additional key-value pairs for contextual information. ✓
spanLinks string array SpanLinks are links to OpenTelemetry span IDs for tracking. These links establish relationships between spans across different services, enabling distributed tracing.
For more information on OpenTelemetry span links, refer to the documentation: https://opentelemetry.io/docs/concepts/signals/traces/#span-links		 ✓
version string Version defines the version of the application. For automatically created KeptnApps,
the version is a function of all KeptnWorkloads that are part of the KeptnApp.		 x
revision integer Revision can be modified to trigger another deployment of a KeptnApp of the same version.
This can be used for restarting a KeptnApp which failed to deploy,
e.g. due to a failed preDeploymentEvaluation/preDeploymentTask.		 1 ✓
workloads KeptnWorkloadRef array Workloads is a list of all KeptnWorkloads that are part of the KeptnApp. ✓
appName string AppName is the name of the KeptnApp. x
previousVersion string PreviousVersion is the version of the KeptnApp that has been deployed prior to this version. ✓
traceId object (keys:string, values:string) TraceId contains the OpenTelemetry trace ID. ✓

KeptnAppVersionStatus

KeptnAppVersionStatus defines the observed state of KeptnAppVersion

Appears in: - KeptnAppVersion

Field Description Default Optional Validation
preDeploymentStatus string PreDeploymentStatus indicates the current status of the KeptnAppVersion's PreDeployment phase. Pending ✓
postDeploymentStatus string PostDeploymentStatus indicates the current status of the KeptnAppVersion's PostDeployment phase. Pending ✓
promotionStatus string PromotionStatus indicates the current status of the KeptnAppVersion's Promotion phase. Pending ✓
preDeploymentEvaluationStatus string PreDeploymentEvaluationStatus indicates the current status of the KeptnAppVersion's PreDeploymentEvaluation phase. Pending ✓
postDeploymentEvaluationStatus string PostDeploymentEvaluationStatus indicates the current status of the KeptnAppVersion's PostDeploymentEvaluation phase. Pending ✓
workloadOverallStatus string WorkloadOverallStatus indicates the current status of the KeptnAppVersion's Workload deployment phase. Pending ✓
workloadStatus WorkloadStatus array WorkloadStatus contains the current status of each KeptnWorkload that is part of the KeptnAppVersion. ✓
currentPhase string CurrentPhase indicates the current phase of the KeptnAppVersion. ✓
preDeploymentTaskStatus ItemStatus array PreDeploymentTaskStatus indicates the current state of each preDeploymentTask of the KeptnAppVersion. ✓
postDeploymentTaskStatus ItemStatus array PostDeploymentTaskStatus indicates the current state of each postDeploymentTask of the KeptnAppVersion. ✓
promotionTaskStatus ItemStatus array PromotionTaskStatus indicates the current state of each promotionTask of the KeptnAppVersion. ✓
preDeploymentEvaluationTaskStatus ItemStatus array PreDeploymentEvaluationTaskStatus indicates the current state of each preDeploymentEvaluation of the KeptnAppVersion. ✓
postDeploymentEvaluationTaskStatus ItemStatus array PostDeploymentEvaluationTaskStatus indicates the current state of each postDeploymentEvaluation of the KeptnAppVersion. ✓
phaseTraceIDs MapCarrier PhaseTraceIDs contains the trace IDs of the OpenTelemetry spans of each phase of the KeptnAppVersion. ✓
status string Status represents the overall status of the KeptnAppVersion. Pending ✓
startTime Time StartTime represents the time at which the deployment of the KeptnAppVersion started. ✓
endTime Time EndTime represents the time at which the deployment of the KeptnAppVersion finished. ✓

KeptnEvaluation

KeptnEvaluation is the Schema for the keptnevaluations API

Appears in: - KeptnEvaluationList

Field Description Default Optional Validation
apiVersion string lifecycle.keptn.sh/v1beta1
kind string KeptnEvaluation
metadata ObjectMeta Refer to Kubernetes API documentation about metadata. ✓
spec KeptnEvaluationSpec Spec describes the desired state of the KeptnEvaluation. ✓
status KeptnEvaluationStatus Status describes the current state of the KeptnEvaluation. ✓

KeptnEvaluationDefinition

KeptnEvaluationDefinition is the Schema for the keptnevaluationdefinitions API

Appears in: - KeptnEvaluationDefinitionList

Field Description Default Optional Validation
apiVersion string lifecycle.keptn.sh/v1beta1
kind string KeptnEvaluationDefinition
metadata ObjectMeta Refer to Kubernetes API documentation about metadata. ✓
spec KeptnEvaluationDefinitionSpec Spec describes the desired state of the KeptnEvaluationDefinition. ✓
status string unused field ✓

KeptnEvaluationDefinitionList

KeptnEvaluationDefinitionList contains a list of KeptnEvaluationDefinition

Field Description Default Optional Validation
apiVersion string lifecycle.keptn.sh/v1beta1
kind string KeptnEvaluationDefinitionList
metadata ListMeta ✓
items KeptnEvaluationDefinition array x

KeptnEvaluationDefinitionSpec

KeptnEvaluationDefinitionSpec defines the desired state of KeptnEvaluationDefinition

Appears in: - KeptnEvaluationDefinition

Field Description Default Optional Validation
objectives Objective array Objectives is a list of objectives that have to be met for a KeptnEvaluation referencing this
KeptnEvaluationDefinition to be successful.		 x
retries integer Retries indicates how many times the KeptnEvaluation can be attempted in the case of an error or
missed evaluation objective, before considering the KeptnEvaluation to be failed.		 10 ✓
retryInterval Duration RetryInterval specifies the interval at which the KeptnEvaluation is retried in the case of an error
or a missed objective.		 5s ✓ Pattern: ^0|([0-9]+(\.[0-9]+)?(ns|us|µs|ms|s|m|h))+$
Type: string

KeptnEvaluationList

KeptnEvaluationList contains a list of KeptnEvaluation

Field Description Default Optional Validation
apiVersion string lifecycle.keptn.sh/v1beta1
kind string KeptnEvaluationList
metadata ListMeta ✓
items KeptnEvaluation array x

KeptnEvaluationSpec

KeptnEvaluationSpec defines the desired state of KeptnEvaluation

Appears in: - KeptnEvaluation

Field Description Default Optional Validation
workload string Workload defines the KeptnWorkload for which the KeptnEvaluation is done. ✓
workloadVersion string WorkloadVersion defines the version of the KeptnWorkload for which the KeptnEvaluation is done. x
appName string AppName defines the KeptnApp for which the KeptnEvaluation is done. ✓
appVersion string AppVersion defines the version of the KeptnApp for which the KeptnEvaluation is done. ✓
evaluationDefinition string EvaluationDefinition refers to the name of the KeptnEvaluationDefinition
which includes the objectives for the KeptnEvaluation.
The KeptnEvaluationDefinition can be
located in the same namespace as the KeptnEvaluation, or in the Keptn namespace.		 x
checkType string Type indicates whether the KeptnEvaluation is part of the pre- or postDeployment phase. ✓
retries integer Retries indicates how many times the KeptnEvaluation can be attempted in the case of an error or
missed evaluation objective, before considering the KeptnEvaluation to be failed.		 10 ✓
retryInterval Duration RetryInterval specifies the interval at which the KeptnEvaluation is retried in the case of an error
or a missed objective.		 5s ✓ Pattern: ^0|([0-9]+(\.[0-9]+)?(ns|us|µs|ms|s|m|h))+$
Type: string

KeptnEvaluationStatus

KeptnEvaluationStatus defines the observed state of KeptnEvaluation

Appears in: - KeptnEvaluation

Field Description Default Optional Validation
retryCount integer RetryCount indicates how many times the KeptnEvaluation has been attempted already. 0 x
evaluationStatus object (keys:string, values:EvaluationStatusItem) EvaluationStatus describes the status of each objective of the KeptnEvaluationDefinition
referenced by the KeptnEvaluation.		 x
overallStatus string OverallStatus describes the overall status of the KeptnEvaluation. The Overall status is derived
from the status of the individual objectives of the KeptnEvaluationDefinition
referenced by the KeptnEvaluation.		 Pending x
startTime Time StartTime represents the time at which the KeptnEvaluation started. ✓
endTime Time EndTime represents the time at which the KeptnEvaluation finished. ✓

KeptnMetricReference

Appears in: - Objective

Field Description Default Optional Validation
name string Name is the name of the referenced KeptnMetric. x
namespace string Namespace is the namespace where the referenced KeptnMetric is located. ✓

KeptnState

Underlying type: string

KeptnState is a string containing current Phase state (Progressing/Succeeded/Failed/Unknown/Pending/Deprecated/Warning)

Appears in: - EvaluationStatusItem - ItemStatus - KeptnAppVersionStatus - KeptnEvaluationStatus - KeptnTaskStatus - KeptnWorkloadVersionStatus - WorkloadStatus

KeptnTask

KeptnTask is the Schema for the keptntasks API

Appears in: - KeptnTaskList

Field Description Default Optional Validation
apiVersion string lifecycle.keptn.sh/v1beta1
kind string KeptnTask
metadata ObjectMeta Refer to Kubernetes API documentation about metadata. ✓
spec KeptnTaskSpec Spec describes the desired state of the KeptnTask. ✓
status KeptnTaskStatus Status describes the current state of the KeptnTask. ✓

KeptnTaskDefinition

KeptnTaskDefinition is the Schema for the keptntaskdefinitions API

Appears in: - KeptnTaskDefinitionList

Field Description Default Optional Validation
apiVersion string lifecycle.keptn.sh/v1beta1
kind string KeptnTaskDefinition
metadata ObjectMeta Refer to Kubernetes API documentation about metadata. ✓
spec KeptnTaskDefinitionSpec Spec describes the desired state of the KeptnTaskDefinition. ✓
status KeptnTaskDefinitionStatus Status describes the current state of the KeptnTaskDefinition. ✓

KeptnTaskDefinitionList

KeptnTaskDefinitionList contains a list of KeptnTaskDefinition

Field Description Default Optional Validation
apiVersion string lifecycle.keptn.sh/v1beta1
kind string KeptnTaskDefinitionList
metadata ListMeta ✓
items KeptnTaskDefinition array x

KeptnTaskDefinitionSpec

KeptnTaskDefinitionSpec defines the desired state of KeptnTaskDefinition

Appears in: - KeptnTaskDefinition

Field Description Default Optional Validation
function RuntimeSpec Deprecated
Function contains the definition for the function that is to be executed in KeptnTasks.		 ✓
python RuntimeSpec Python contains the definition for the python function that is to be executed in KeptnTasks. ✓
deno RuntimeSpec Deno contains the definition for the Deno function that is to be executed in KeptnTasks. ✓
container ContainerSpec Container contains the definition for the container that is to be used in Job. ✓
retries integer Retries specifies how many times a job executing the KeptnTaskDefinition should be restarted in the case
of an unsuccessful attempt.		 10 ✓
timeout Duration Timeout specifies the maximum time to wait for the task to be completed successfully.
If the task does not complete successfully within this time frame, it will be
considered to be failed.		 5m ✓ Pattern: ^0|([0-9]+(\.[0-9]+)?(ns|us|µs|ms|s|m|h))+$
Type: string
serviceAccount ServiceAccountSpec ServiceAccount specifies the service account to be used in jobs to authenticate with the Kubernetes API and access cluster resources. ✓
automountServiceAccountToken AutomountServiceAccountTokenSpec AutomountServiceAccountToken allows to enable K8s to assign cluster API credentials to a pod, if set to false
the pod will decline the service account		 ✓
ttlSecondsAfterFinished integer TTLSecondsAfterFinished controller makes a job eligible to be cleaned up after it is finished.
The timer starts when the status shows up to be Complete or Failed.		 300 ✓
imagePullSecrets LocalObjectReference array ImagePullSecrets is an optional field to specify the names of secrets to use for pulling container images ✓

KeptnTaskDefinitionStatus

KeptnTaskDefinitionStatus defines the observed state of KeptnTaskDefinition

Appears in: - KeptnTaskDefinition

Field Description Default Optional Validation
function FunctionStatus Function contains status information of the function definition for the task. ✓

KeptnTaskList

KeptnTaskList contains a list of KeptnTask

Field Description Default Optional Validation
apiVersion string lifecycle.keptn.sh/v1beta1
kind string KeptnTaskList
metadata ListMeta ✓
items KeptnTask array x

KeptnTaskSpec

KeptnTaskSpec defines the desired state of KeptnTask

Appears in: - KeptnTask

Field Description Default Optional Validation
taskDefinition string TaskDefinition refers to the name of the KeptnTaskDefinition
which includes the specification for the task to be performed.
The KeptnTaskDefinition can be
located in the same namespace as the KeptnTask, or in the Keptn namespace.		 x
context TaskContext Context contains contextual information about the task execution. ✓
parameters TaskParameters Parameters contains parameters that will be passed to the job that executes the task. ✓
secureParameters SecureParameters SecureParameters contains secure parameters that will be passed to the job that executes the task.
These will be stored and accessed as secrets in the cluster.		 ✓
checkType string Type indicates whether the KeptnTask is part of the pre- or postDeployment phase. ✓
retries integer Retries indicates how many times the KeptnTask can be attempted in the case of an error
before considering the KeptnTask to be failed.		 10 ✓
timeout Duration Timeout specifies the maximum time to wait for the task to be completed successfully.
If the task does not complete successfully within this time frame, it will be
considered to be failed.		 5m ✓ Pattern: ^0|([0-9]+(\.[0-9]+)?(ns|us|µs|ms|s|m|h))+$
Type: string

KeptnTaskStatus

KeptnTaskStatus defines the observed state of KeptnTask

Appears in: - KeptnTask

Field Description Default Optional Validation
jobName string JobName is the name of the Job executing the Task. ✓
status string Status represents the overall state of the KeptnTask. Pending ✓
message string Message contains information about unexpected errors encountered during the execution of the KeptnTask. ✓
startTime Time StartTime represents the time at which the KeptnTask started. ✓
endTime Time EndTime represents the time at which the KeptnTask finished. ✓
reason string Reason contains more information about the reason for the last transition of the Job executing the KeptnTask. ✓

KeptnWorkload

KeptnWorkload is the Schema for the keptnworkloads API

Appears in: - KeptnWorkloadList

Field Description Default Optional Validation
apiVersion string lifecycle.keptn.sh/v1beta1
kind string KeptnWorkload
metadata ObjectMeta Refer to Kubernetes API documentation about metadata. ✓
spec KeptnWorkloadSpec Spec describes the desired state of the KeptnWorkload. ✓
status KeptnWorkloadStatus Status describes the current state of the KeptnWorkload. ✓

KeptnWorkloadList

KeptnWorkloadList contains a list of KeptnWorkload

Field Description Default Optional Validation
apiVersion string lifecycle.keptn.sh/v1beta1
kind string KeptnWorkloadList
metadata ListMeta ✓
items KeptnWorkload array x

KeptnWorkloadRef

KeptnWorkloadRef refers to a KeptnWorkload that is part of a KeptnApp

Appears in: - KeptnAppSpec - KeptnAppVersionSpec - WorkloadStatus

Field Description Default Optional Validation
name string Name is the name of the KeptnWorkload. x
version string Version is the version of the KeptnWorkload. x

KeptnWorkloadSpec

KeptnWorkloadSpec defines the desired state of KeptnWorkload

Appears in: - KeptnWorkload - KeptnWorkloadVersionSpec

Field Description Default Optional Validation
app string AppName is the name of the KeptnApp containing the KeptnWorkload. x
version string Version defines the version of the KeptnWorkload. x
preDeploymentTasks string array PreDeploymentTasks is a list of all tasks to be performed during the pre-deployment phase of the KeptnWorkload.
The items of this list refer to the names of KeptnTaskDefinitions
located in the same namespace as the KeptnApp, or in the Keptn namespace.		 ✓
postDeploymentTasks string array PostDeploymentTasks is a list of all tasks to be performed during the post-deployment phase of the KeptnWorkload.
The items of this list refer to the names of KeptnTaskDefinitions
located in the same namespace as the KeptnWorkload, or in the Keptn namespace.		 ✓
preDeploymentEvaluations string array PreDeploymentEvaluations is a list of all evaluations to be performed
during the pre-deployment phase of the KeptnWorkload.
The items of this list refer to the names of KeptnEvaluationDefinitions
located in the same namespace as the KeptnWorkload, or in the Keptn namespace.		 ✓
postDeploymentEvaluations string array PostDeploymentEvaluations is a list of all evaluations to be performed
during the post-deployment phase of the KeptnWorkload.
The items of this list refer to the names of KeptnEvaluationDefinitions
located in the same namespace as the KeptnWorkload, or in the Keptn namespace.		 ✓
resourceReference ResourceReference ResourceReference is a reference to the Kubernetes resource
(Deployment, DaemonSet, StatefulSet or ReplicaSet) the KeptnWorkload is representing.		 x
metadata object (keys:string, values:string) Metadata contains additional key-value pairs for contextual information. ✓

KeptnWorkloadStatus

KeptnWorkloadStatus defines the observed state of KeptnWorkload

Appears in: - KeptnWorkload

Field Description Default Optional Validation
currentVersion string CurrentVersion indicates the version that is currently deployed or being reconciled. ✓

KeptnWorkloadVersion

KeptnWorkloadVersion is the Schema for the keptnworkloadversions API

Appears in: - KeptnWorkloadVersionList

Field Description Default Optional Validation
apiVersion string lifecycle.keptn.sh/v1beta1
kind string KeptnWorkloadVersion
metadata ObjectMeta Refer to Kubernetes API documentation about metadata. ✓
spec KeptnWorkloadVersionSpec Spec describes the desired state of the KeptnWorkloadVersion. ✓
status KeptnWorkloadVersionStatus Status describes the current state of the KeptnWorkloadVersion. ✓

KeptnWorkloadVersionList

KeptnWorkloadVersionList contains a list of KeptnWorkloadVersion

Field Description Default Optional Validation
apiVersion string lifecycle.keptn.sh/v1beta1
kind string KeptnWorkloadVersionList
metadata ListMeta ✓
items KeptnWorkloadVersion array x

KeptnWorkloadVersionSpec

KeptnWorkloadVersionSpec defines the desired state of KeptnWorkloadVersion

Appears in: - KeptnWorkloadVersion

Field Description Default Optional Validation
app string AppName is the name of the KeptnApp containing the KeptnWorkload. x
version string Version defines the version of the KeptnWorkload. x
preDeploymentTasks string array PreDeploymentTasks is a list of all tasks to be performed during the pre-deployment phase of the KeptnWorkload.
The items of this list refer to the names of KeptnTaskDefinitions
located in the same namespace as the KeptnApp, or in the Keptn namespace.		 ✓
postDeploymentTasks string array PostDeploymentTasks is a list of all tasks to be performed during the post-deployment phase of the KeptnWorkload.
The items of this list refer to the names of KeptnTaskDefinitions
located in the same namespace as the KeptnWorkload, or in the Keptn namespace.		 ✓
preDeploymentEvaluations string array PreDeploymentEvaluations is a list of all evaluations to be performed
during the pre-deployment phase of the KeptnWorkload.
The items of this list refer to the names of KeptnEvaluationDefinitions
located in the same namespace as the KeptnWorkload, or in the Keptn namespace.		 ✓
postDeploymentEvaluations string array PostDeploymentEvaluations is a list of all evaluations to be performed
during the post-deployment phase of the KeptnWorkload.
The items of this list refer to the names of KeptnEvaluationDefinitions
located in the same namespace as the KeptnWorkload, or in the Keptn namespace.		 ✓
resourceReference ResourceReference ResourceReference is a reference to the Kubernetes resource
(Deployment, DaemonSet, StatefulSet or ReplicaSet) the KeptnWorkload is representing.		 x
metadata object (keys:string, values:string) Metadata contains additional key-value pairs for contextual information. ✓
workloadName string WorkloadName is the name of the KeptnWorkload. x
previousVersion string PreviousVersion is the version of the KeptnWorkload that has been deployed prior to this version. ✓
traceId object (keys:string, values:string) TraceId contains the OpenTelemetry trace ID. ✓

KeptnWorkloadVersionStatus

KeptnWorkloadVersionStatus defines the observed state of KeptnWorkloadVersion

Appears in: - KeptnWorkloadVersion

Field Description Default Optional Validation
preDeploymentStatus string PreDeploymentStatus indicates the current status of the KeptnWorkloadVersion's PreDeployment phase. Pending ✓
deploymentStatus string DeploymentStatus indicates the current status of the KeptnWorkloadVersion's Deployment phase. Pending ✓
preDeploymentEvaluationStatus string PreDeploymentEvaluationStatus indicates the current status of the KeptnWorkloadVersion's PreDeploymentEvaluation phase. Pending ✓
postDeploymentEvaluationStatus string PostDeploymentEvaluationStatus indicates the current status of the KeptnWorkloadVersion's PostDeploymentEvaluation phase. Pending ✓
postDeploymentStatus string PostDeploymentStatus indicates the current status of the KeptnWorkloadVersion's PostDeployment phase. Pending ✓
preDeploymentTaskStatus ItemStatus array PreDeploymentTaskStatus indicates the current state of each preDeploymentTask of the KeptnWorkloadVersion. ✓
postDeploymentTaskStatus ItemStatus array PostDeploymentTaskStatus indicates the current state of each postDeploymentTask of the KeptnWorkloadVersion. ✓
preDeploymentEvaluationTaskStatus ItemStatus array PreDeploymentEvaluationTaskStatus indicates the current state of each preDeploymentEvaluation of the KeptnWorkloadVersion. ✓
postDeploymentEvaluationTaskStatus ItemStatus array PostDeploymentEvaluationTaskStatus indicates the current state of each postDeploymentEvaluation of the KeptnWorkloadVersion. ✓
startTime Time StartTime represents the time at which the deployment of the KeptnWorkloadVersion started. ✓
endTime Time EndTime represents the time at which the deployment of the KeptnWorkloadVersion finished. ✓
currentPhase string CurrentPhase indicates the current phase of the KeptnWorkloadVersion. This can be:
- PreDeploymentTasks
- PreDeploymentEvaluations
- Deployment
- PostDeploymentTasks
- PostDeploymentEvaluations		 ✓
phaseTraceIDs MapCarrier PhaseTraceIDs contains the trace IDs of the OpenTelemetry spans of each phase of the KeptnWorkloadVersion ✓
status string Status represents the overall status of the KeptnWorkloadVersion. Pending ✓
appContextMetadata object (keys:string, values:string) AppContextMetadata contains metadata from the related KeptnAppVersion. ✓
deploymentStartTime Time DeploymentStartTime represents the start time of the deployment phase ✓

Objective

Appears in: - KeptnEvaluationDefinitionSpec

Field Description Default Optional Validation
keptnMetricRef KeptnMetricReference KeptnMetricRef references the KeptnMetric that should be evaluated. x
evaluationTarget string EvaluationTarget specifies the target value for the references KeptnMetric.
Needs to start with either '<' or '>', followed by the target value (e.g. '<10').		 x

PhaseTraceID

Underlying type: MapCarrier

PhaseTraceID is a map storing TraceIDs of OpenTelemetry spans in lifecycle phases

Appears in: - KeptnAppVersionStatus - KeptnWorkloadVersionStatus

ResourceReference

ResourceReference represents the parent resource of Workload

Appears in: - KeptnWorkloadSpec - KeptnWorkloadVersionSpec

Field Description Default Optional Validation
uid string x
kind string x
name string x

RuntimeSpec

Appears in: - KeptnTaskDefinitionSpec

Field Description Default Optional Validation
functionRef FunctionReference FunctionReference allows to reference another KeptnTaskDefinition which contains the source code of the
function to be executes for KeptnTasks based on this KeptnTaskDefinition. This can be useful when you have
multiple KeptnTaskDefinitions that should execute the same logic, but each with different parameters.		 ✓
inline Inline Inline allows to specify the code that should be executed directly in the KeptnTaskDefinition, as a multi-line
string.		 ✓
httpRef HttpReference HttpReference allows to point to an HTTP URL containing the code of the function. ✓
configMapRef ConfigMapReference ConfigMapReference allows to reference a ConfigMap containing the code of the function.
When referencing a ConfigMap, the code of the function must be available as a value of the 'code' key
of the referenced ConfigMap.		 ✓
parameters TaskParameters Parameters contains parameters that will be passed to the job that executes the task as env variables. ✓
secureParameters SecureParameters SecureParameters contains secure parameters that will be passed to the job that executes the task.
These will be stored and accessed as secrets in the cluster.		 ✓
cmdParameters string CmdParameters contains parameters that will be passed to the command ✓

SecureParameters

Appears in: - KeptnTaskSpec - RuntimeSpec

Field Description Default Optional Validation
secret string Secret contains the parameters that will be made available to the job
executing the KeptnTask via the 'SECRET_DATA' environment variable.
The 'SECRET_DATA' environment variable's content will the same as value of the 'SECRET_DATA'
key of the referenced secret.		 ✓

ServiceAccountSpec

Appears in: - KeptnTaskDefinitionSpec

Field Description Default Optional Validation
name string x

TaskContext

Appears in: - KeptnTaskSpec

Field Description Default Optional Validation
workloadName string WorkloadName the name of the KeptnWorkload the KeptnTask is being executed for. ✓
appName string AppName the name of the KeptnApp the KeptnTask is being executed for. ✓
appVersion string AppVersion the version of the KeptnApp the KeptnTask is being executed for. ✓
workloadVersion string WorkloadVersion the version of the KeptnWorkload the KeptnTask is being executed for. ✓
taskType string TaskType indicates whether the KeptnTask is part of the pre- or postDeployment phase. ✓
objectType string ObjectType indicates whether the KeptnTask is being executed for a KeptnApp or KeptnWorkload. ✓
metadata object (keys:string, values:string) Metadata contains additional key-value pairs for contextual information. ✓

TaskParameters

Appears in: - KeptnTaskSpec - RuntimeSpec

Field Description Default Optional Validation
map object (keys:string, values:string) Inline contains the parameters that will be made available to the job
executing the KeptnTask via the 'DATA' environment variable.
The 'DATA' environment variable's content will be a json
encoded string containing all properties of the map provided.		 ✓

WorkloadStatus

Appears in: - KeptnAppVersionStatus

Field Description Default Optional Validation
workload KeptnWorkloadRef Workload refers to a KeptnWorkload that is part of the KeptnAppVersion. ✓
status string Status indicates the current status of the KeptnWorkload. Pending ✓