v1alpha3

Reference information for lifecycle.keptn.sh/v1alpha3

Packages

lifecycle.keptn.sh/v1alpha3

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

Resource Types

ConfigMapReference

Appears in:

Field Description
name string Name is the name of the referenced ConfigMap.

ContainerSpec

Appears in:

Field Description
name string Name of the container specified as a DNS_LABEL. Each container in a pod must have a unique name (DNS_LABEL). Cannot be updated.
image string Container image name. More info: https://kubernetes.io/docs/concepts/containers/images This field is optional to allow higher level config management to default or override container images in workload controllers like Deployments and StatefulSets.
command string array Entrypoint array. Not executed within a shell. The container image’s ENTRYPOINT is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container’s environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. “$$(VAR_NAME)” will produce the string literal “$(VAR_NAME)”. Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
args string array Arguments to the entrypoint. The container image’s CMD is used if this is not provided. Variable references $(VAR_NAME) are expanded using the container’s environment. If a variable cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. “$$(VAR_NAME)” will produce the string literal “$(VAR_NAME)”. Escaped references will never be expanded, regardless of whether the variable exists or not. Cannot be updated. More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
workingDir string Container’s working directory. If not specified, the container runtime’s default will be used, which might be configured in the container image. Cannot be updated.
ports ContainerPort array List of ports to expose from the container. Not specifying a port here DOES NOT prevent that port from being exposed. Any port which is listening on the default “0.0.0.0” address inside a container will be accessible from the network. Modifying this array with strategic merge patch may corrupt the data. For more information See https://github.com/kubernetes/kubernetes/issues/108255. Cannot be updated.
envFrom EnvFromSource array List of sources to populate environment variables in the container. The keys defined within a source must be a C_IDENTIFIER. All invalid keys will be reported as an event when the container is starting. When a key exists in multiple sources, the value associated with the last source will take precedence. Values defined by an Env with a duplicate key will take precedence. Cannot be updated.
env EnvVar array List of environment variables to set in the container. Cannot be updated.
resources ResourceRequirements Compute Resources required by this container. Cannot be updated. More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/
volumeMounts VolumeMount array Pod volumes to mount into the container’s filesystem. Cannot be updated.
volumeDevices VolumeDevice array volumeDevices is the list of block devices to be used by the container.
livenessProbe Probe Periodic probe of container liveness. Container will be restarted if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
readinessProbe Probe Periodic probe of container service readiness. Container will be removed from service endpoints if the probe fails. Cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
startupProbe Probe StartupProbe indicates that the Pod has successfully initialized. If specified, no other probes are executed until this completes successfully. If this probe fails, the Pod will be restarted, just as if the livenessProbe failed. This can be used to provide different probe parameters at the beginning of a Pod’s lifecycle, when it might take a long time to load data or warm a cache, than during steady-state operation. This cannot be updated. More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes
lifecycle Lifecycle Actions that the management system should take in response to container lifecycle events. Cannot be updated.
terminationMessagePath string Optional: Path at which the file to which the container’s termination message will be written is mounted into the container’s filesystem. Message written is intended to be brief final status, such as an assertion failure message. Will be truncated by the node if greater than 4096 bytes. The total message length across all containers will be limited to 12kb. Defaults to /dev/termination-log. Cannot be updated.
terminationMessagePolicy TerminationMessagePolicy Indicate how the termination message should be populated. File will use the contents of terminationMessagePath to populate the container status message on both success and failure. FallbackToLogsOnError will use the last chunk of container log output if the termination message file is empty and the container exited with an error. The log output is limited to 2048 bytes or 80 lines, whichever is smaller. Defaults to File. Cannot be updated.
imagePullPolicy PullPolicy Image pull policy. One of Always, Never, IfNotPresent. Defaults to Always if :latest tag is specified, or IfNotPresent otherwise. Cannot be updated. More info: https://kubernetes.io/docs/concepts/containers/images#updating-images
securityContext SecurityContext SecurityContext defines the security options the container should be run with. If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext. More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/
stdin boolean Whether this container should allocate a buffer for stdin in the container runtime. If this is not set, reads from stdin in the container will always result in EOF. Default is false.
stdinOnce boolean Whether the container runtime should close the stdin channel after it has been opened by a single attach. When stdin is true the stdin stream will remain open across multiple attach sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the first client attaches to stdin, and then remains open and accepts data until the client disconnects, at which time stdin is closed and remains closed until the container is restarted. If this flag is false, a container processes that reads from stdin will never receive an EOF. Default is false
tty boolean Whether this container should allocate a TTY for itself, also requires ‘stdin’ to be true. Default is false.

EvaluationStatusItem

Appears in:

Field Description
value string Value represents the value of the KeptnMetric being evaluated.
status KeptnState Status indicates the status of the objective being evaluated.
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.

FunctionReference

Appears in:

Field Description
name string Name is the name of the referenced KeptnTaskDefinition.

FunctionStatus

Appears in:

Field Description
configMap string ConfigMap indicates the ConfigMap in which the function code is stored.

HttpReference

Appears in:

Field Description
url string Url is the URL containing the code of the function.

Inline

Appears in:

Field Description
code string Code contains the code of the function.

ItemStatus

Appears in:

Field Description
definitionName string DefinitionName is the name of the EvaluationDefinition/TaskDefinition
status KeptnState
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:

Field Description
apiVersion string lifecycle.keptn.sh/v1alpha3
kind string KeptnApp
metadata ObjectMeta Refer to Kubernetes API documentation for fields of metadata.
spec KeptnAppSpec Spec describes the desired state of the KeptnApp.
status KeptnAppStatus Status describes the current state of the KeptnApp.

KeptnAppCreationRequest

KeptnAppCreationRequest is the Schema for the keptnappcreationrequests API

Appears in:

Field Description
apiVersion string lifecycle.keptn.sh/v1alpha3
kind string KeptnAppCreationRequest
metadata ObjectMeta Refer to Kubernetes API documentation for fields of 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
apiVersion string lifecycle.keptn.sh/v1alpha3
kind string KeptnAppCreationRequestList
metadata ListMeta Refer to Kubernetes API documentation for fields of metadata.
items KeptnAppCreationRequest array

KeptnAppCreationRequestSpec

KeptnAppCreationRequestSpec defines the desired state of KeptnAppCreationRequest

Appears in:

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

KeptnAppList

KeptnAppList contains a list of KeptnApp

Field Description
apiVersion string lifecycle.keptn.sh/v1alpha3
kind string KeptnAppList
metadata ListMeta Refer to Kubernetes API documentation for fields of metadata.
items KeptnApp array

KeptnAppSpec

KeptnAppSpec defines the desired state of KeptnApp

Appears in:

Field Description
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.
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.
workloads KeptnWorkloadRef array Workloads is a list of all KeptnWorkloads that are part of the KeptnApp.
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.
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.
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.
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.

KeptnAppStatus

KeptnAppStatus defines the observed state of KeptnApp

Appears in:

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

KeptnAppVersion

KeptnAppVersion is the Schema for the keptnappversions API

Appears in:

Field Description
apiVersion string lifecycle.keptn.sh/v1alpha3
kind string KeptnAppVersion
metadata ObjectMeta Refer to Kubernetes API documentation for fields of 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
apiVersion string lifecycle.keptn.sh/v1alpha3
kind string KeptnAppVersionList
metadata ListMeta Refer to Kubernetes API documentation for fields of metadata.
items KeptnAppVersion array

KeptnAppVersionSpec

KeptnAppVersionSpec defines the desired state of KeptnAppVersion

Appears in:

Field Description
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.
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.
workloads KeptnWorkloadRef array Workloads is a list of all KeptnWorkloads that are part of the KeptnApp.
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.
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.
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.
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.
appName string AppName is the name of the KeptnApp.
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:

Field Description
preDeploymentStatus KeptnState PreDeploymentStatus indicates the current status of the KeptnAppVersion’s PreDeployment phase.
postDeploymentStatus KeptnState PostDeploymentStatus indicates the current status of the KeptnAppVersion’s PostDeployment phase.
preDeploymentEvaluationStatus KeptnState PreDeploymentEvaluationStatus indicates the current status of the KeptnAppVersion’s PreDeploymentEvaluation phase.
postDeploymentEvaluationStatus KeptnState PostDeploymentEvaluationStatus indicates the current status of the KeptnAppVersion’s PostDeploymentEvaluation phase.
workloadOverallStatus KeptnState WorkloadOverallStatus indicates the current status of the KeptnAppVersion’s Workload deployment phase.
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.
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 object (keys:string, values:object) PhaseTraceIDs contains the trace IDs of the OpenTelemetry spans of each phase of the KeptnAppVersion.
status KeptnState Status represents the overall status of the KeptnAppVersion.
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:

Field Description
apiVersion string lifecycle.keptn.sh/v1alpha3
kind string KeptnEvaluation
metadata ObjectMeta Refer to Kubernetes API documentation for fields of 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:

Field Description
apiVersion string lifecycle.keptn.sh/v1alpha3
kind string KeptnEvaluationDefinition
metadata ObjectMeta Refer to Kubernetes API documentation for fields of metadata.
spec KeptnEvaluationDefinitionSpec Spec describes the desired state of the KeptnEvaluationDefinition.
status string unused field

KeptnEvaluationDefinitionList

KeptnEvaluationDefinitionList contains a list of KeptnEvaluationDefinition

Field Description
apiVersion string lifecycle.keptn.sh/v1alpha3
kind string KeptnEvaluationDefinitionList
metadata ListMeta Refer to Kubernetes API documentation for fields of metadata.
items KeptnEvaluationDefinition array

KeptnEvaluationDefinitionSpec

KeptnEvaluationDefinitionSpec defines the desired state of KeptnEvaluationDefinition

Appears in:

Field Description
objectives Objective array Objectives is a list of objectives that have to be met for a KeptnEvaluation referencing this KeptnEvaluationDefinition to be successful.

KeptnEvaluationList

KeptnEvaluationList contains a list of KeptnEvaluation

Field Description
apiVersion string lifecycle.keptn.sh/v1alpha3
kind string KeptnEvaluationList
metadata ListMeta Refer to Kubernetes API documentation for fields of metadata.
items KeptnEvaluation array

KeptnEvaluationProvider

KeptnEvaluationProvider is the Schema for the keptnevaluationproviders API

Appears in:

Field Description
apiVersion string lifecycle.keptn.sh/v1alpha3
kind string KeptnEvaluationProvider
metadata ObjectMeta Refer to Kubernetes API documentation for fields of metadata.
spec KeptnEvaluationProviderSpec
status string unused field

KeptnEvaluationProviderList

KeptnEvaluationProviderList contains a list of KeptnEvaluationProvider

Field Description
apiVersion string lifecycle.keptn.sh/v1alpha3
kind string KeptnEvaluationProviderList
metadata ListMeta Refer to Kubernetes API documentation for fields of metadata.
items KeptnEvaluationProvider array

KeptnEvaluationProviderSpec

KeptnEvaluationProviderSpec defines the desired state of KeptnEvaluationProvider

Appears in:

Field Description
targetServer string
secretKeyRef SecretKeySelector

KeptnEvaluationSpec

KeptnEvaluationSpec defines the desired state of KeptnEvaluation

Appears in:

Field Description
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.
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.
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.
retryInterval Duration RetryInterval specifies the interval at which the KeptnEvaluation is retried in the case of an error or a missed objective.
failAction string
checkType CheckType Type indicates whether the KeptnEvaluation is part of the pre- or postDeployment phase.

KeptnEvaluationStatus

KeptnEvaluationStatus defines the observed state of KeptnEvaluation

Appears in:

Field Description
retryCount integer RetryCount indicates how many times the KeptnEvaluation has been attempted already.
evaluationStatus object (keys:string, values:EvaluationStatusItem) EvaluationStatus describes the status of each objective of the KeptnEvaluationDefinition referenced by the KeptnEvaluation.
overallStatus KeptnState 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.
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:

Field Description
name string Name is the name of the referenced KeptnMetric.
namespace string Namespace is the namespace where the referenced KeptnMetric is located.

KeptnTask

KeptnTask is the Schema for the keptntasks API

Appears in:

Field Description
apiVersion string lifecycle.keptn.sh/v1alpha3
kind string KeptnTask
metadata ObjectMeta Refer to Kubernetes API documentation for fields of 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:

Field Description
apiVersion string lifecycle.keptn.sh/v1alpha3
kind string KeptnTaskDefinition
metadata ObjectMeta Refer to Kubernetes API documentation for fields of 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
apiVersion string lifecycle.keptn.sh/v1alpha3
kind string KeptnTaskDefinitionList
metadata ListMeta Refer to Kubernetes API documentation for fields of metadata.
items KeptnTaskDefinition array

KeptnTaskDefinitionSpec

KeptnTaskDefinitionSpec defines the desired state of KeptnTaskDefinition

Appears in:

Field Description
function RuntimeSpec Deprecated Function contains the definition for the function that is to be executed in KeptnTasks based on the KeptnTaskDefinitions.
python RuntimeSpec Python contains the definition for the python function that is to be executed in KeptnTasks based on the KeptnTaskDefinitions.
deno RuntimeSpec Deno contains the definition for the Deno function that is to be executed in KeptnTasks based on the KeptnTaskDefinitions.
container ContainerSpec Container contains the definition for the container that is to be used in Job based on the KeptnTaskDefinitions.
retries integer Retries specifies how many times a job executing the KeptnTaskDefinition should be restarted in the case of an unsuccessful attempt.
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.

KeptnTaskDefinitionStatus

KeptnTaskDefinitionStatus defines the observed state of KeptnTaskDefinition

Appears in:

Field Description
function FunctionStatus Function contains status information of the function definition for the task.

KeptnTaskList

KeptnTaskList contains a list of KeptnTask

Field Description
apiVersion string lifecycle.keptn.sh/v1alpha3
kind string KeptnTaskList
metadata ListMeta Refer to Kubernetes API documentation for fields of metadata.
items KeptnTask array

KeptnTaskSpec

KeptnTaskSpec defines the desired state of KeptnTask

Appears in:

Field Description
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.
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 CheckType 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.
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.

KeptnTaskStatus

KeptnTaskStatus defines the observed state of KeptnTask

Appears in:

Field Description
jobName string JobName is the name of the Job executing the Task.
status KeptnState Status represents the overall state of the KeptnTask.
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:

Field Description
apiVersion string lifecycle.keptn.sh/v1alpha3
kind string KeptnWorkload
metadata ObjectMeta Refer to Kubernetes API documentation for fields of metadata.
spec KeptnWorkloadSpec Spec describes the desired state of the KeptnWorkload.
status KeptnWorkloadStatus Status describes the current state of the KeptnWorkload.

KeptnWorkloadInstance

KeptnWorkloadInstance is the Schema for the keptnworkloadinstances API

Appears in:

Field Description
apiVersion string lifecycle.keptn.sh/v1alpha3
kind string KeptnWorkloadInstance
metadata ObjectMeta Refer to Kubernetes API documentation for fields of metadata.
spec KeptnWorkloadInstanceSpec Spec describes the desired state of the KeptnWorkloadInstance.
status KeptnWorkloadInstanceStatus Status describes the current state of the KeptnWorkloadInstance.

KeptnWorkloadInstanceList

KeptnWorkloadInstanceList contains a list of KeptnWorkloadInstance

Field Description
apiVersion string lifecycle.keptn.sh/v1alpha3
kind string KeptnWorkloadInstanceList
metadata ListMeta Refer to Kubernetes API documentation for fields of metadata.
items KeptnWorkloadInstance array

KeptnWorkloadInstanceSpec

KeptnWorkloadInstanceSpec defines the desired state of KeptnWorkloadInstance

Appears in:

Field Description
app string AppName is the name of the KeptnApp containing the KeptnWorkload.
version string Version defines the version of the KeptnWorkload.
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.
workloadName string WorkloadName is the name of the KeptnWorkload.
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.

KeptnWorkloadInstanceStatus

KeptnWorkloadInstanceStatus defines the observed state of KeptnWorkloadInstance

Appears in:

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

KeptnWorkloadList

KeptnWorkloadList contains a list of KeptnWorkload

Field Description
apiVersion string lifecycle.keptn.sh/v1alpha3
kind string KeptnWorkloadList
metadata ListMeta Refer to Kubernetes API documentation for fields of metadata.
items KeptnWorkload array

KeptnWorkloadRef

KeptnWorkloadRef refers to a KeptnWorkload that is part of a KeptnApp

Appears in:

Field Description
name string Name is the name of the KeptnWorkload.
version string Version is the version of the KeptnWorkload.

KeptnWorkloadSpec

KeptnWorkloadSpec defines the desired state of KeptnWorkload

Appears in:

Field Description
app string AppName is the name of the KeptnApp containing the KeptnWorkload.
version string Version defines the version of the KeptnWorkload.
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.

KeptnWorkloadStatus

KeptnWorkloadStatus defines the observed state of KeptnWorkload

Appears in:

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

Objective

Appears in:

Field Description
keptnMetricRef KeptnMetricReference KeptnMetricRef references the KeptnMetric that should be evaluated.
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’).

ResourceReference

Appears in:

Field Description
uid UID
kind string
name string

RuntimeSpec

Appears in:

Field Description
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:

Field Description
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.

TaskContext

Appears in:

Field Description
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.

TaskParameters

Appears in:

Field Description
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:

Field Description
workload KeptnWorkloadRef Workload refers to a KeptnWorkload that is part of the KeptnAppVersion.
status KeptnState Status indicates the current status of the KeptnWorkload.
Last modified 2023-11-03: docs: release 0.9.0 (#2396) (fef5826)