v1alpha1

Reference information for lifecycle.keptn.sh/v1alpha1

Packages

lifecycle.keptn.sh/v1alpha1

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

Resource Types

ConfigMapReference

Appears in:

Field Description
name string

EvaluationStatus

Appears in:

Field Description
evaluationDefinitionName string
status KeptnState
evaluationName string
startTime Time
endTime Time

EvaluationStatusItem

Appears in:

Field Description
value string
status KeptnState
message string

FunctionReference

Appears in:

Field Description
name string

FunctionSpec

Appears in:

Field Description
functionRef FunctionReference
inline Inline
httpRef HttpReference
configMapRef ConfigMapReference
parameters TaskParameters
secureParameters SecureParameters

FunctionStatus

Appears in:

Field Description
configMap string INSERT ADDITIONAL STATUS FIELD - define observed state of cluster Important: Run “make” to regenerate code after modifying this file

HttpReference

Appears in:

Field Description
url string

Inline

Appears in:

Field Description
code string

KeptnApp

KeptnApp is the Schema for the keptnapps API

Appears in:

Field Description
apiVersion string lifecycle.keptn.sh/v1alpha1
kind string KeptnApp
metadata ObjectMeta Refer to Kubernetes API documentation for fields of metadata.
spec KeptnAppSpec
status KeptnAppStatus

KeptnAppList

KeptnAppList contains a list of KeptnApp

Field Description
apiVersion string lifecycle.keptn.sh/v1alpha1
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
workloads KeptnWorkloadRef array
preDeploymentTasks string array
postDeploymentTasks string array
preDeploymentEvaluations string array
postDeploymentEvaluations string array

KeptnAppStatus

KeptnAppStatus defines the observed state of KeptnApp

Appears in:

Field Description
currentVersion string

KeptnAppVersion

KeptnAppVersion is the Schema for the keptnappversions API

Appears in:

Field Description
apiVersion string lifecycle.keptn.sh/v1alpha1
kind string KeptnAppVersion
metadata ObjectMeta Refer to Kubernetes API documentation for fields of metadata.
spec KeptnAppVersionSpec
status KeptnAppVersionStatus

KeptnAppVersionList

KeptnAppVersionList contains a list of KeptnAppVersion

Field Description
apiVersion string lifecycle.keptn.sh/v1alpha1
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
workloads KeptnWorkloadRef array
preDeploymentTasks string array
postDeploymentTasks string array
preDeploymentEvaluations string array
postDeploymentEvaluations string array
appName string
previousVersion string
traceId object (keys:string, values:string)

KeptnAppVersionStatus

KeptnAppVersionStatus defines the observed state of KeptnAppVersion

Appears in:

Field Description
preDeploymentStatus KeptnState
postDeploymentStatus KeptnState
preDeploymentEvaluationStatus KeptnState
postDeploymentEvaluationStatus KeptnState
workloadOverallStatus KeptnState
workloadStatus WorkloadStatus array
currentPhase string
preDeploymentTaskStatus TaskStatus array
postDeploymentTaskStatus TaskStatus array
preDeploymentEvaluationTaskStatus EvaluationStatus array
postDeploymentEvaluationTaskStatus EvaluationStatus array
phaseTraceIDs object (keys:string, values:object)
status KeptnState
startTime Time
endTime Time

KeptnEvaluation

KeptnEvaluation is the Schema for the keptnevaluations API

Appears in:

Field Description
apiVersion string lifecycle.keptn.sh/v1alpha1
kind string KeptnEvaluation
metadata ObjectMeta Refer to Kubernetes API documentation for fields of metadata.
spec KeptnEvaluationSpec
status KeptnEvaluationStatus

KeptnEvaluationDefinition

KeptnEvaluationDefinition is the Schema for the keptnevaluationdefinitions API

Appears in:

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

KeptnEvaluationDefinitionList

KeptnEvaluationDefinitionList contains a list of KeptnEvaluationDefinition

Field Description
apiVersion string lifecycle.keptn.sh/v1alpha1
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
source string
objectives Objective array

KeptnEvaluationList

KeptnEvaluationList contains a list of KeptnEvaluation

Field Description
apiVersion string lifecycle.keptn.sh/v1alpha1
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/v1alpha1
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/v1alpha1
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
secretName string

KeptnEvaluationSpec

KeptnEvaluationSpec defines the desired state of KeptnEvaluation

Appears in:

Field Description
workload string
workloadVersion string
appName string
appVersion string
evaluationDefinition string
retries integer
retryInterval Duration
failAction string
checkType CheckType

KeptnEvaluationStatus

KeptnEvaluationStatus defines the observed state of KeptnEvaluation

Appears in:

Field Description
retryCount integer
evaluationStatus object (keys:string, values:EvaluationStatusItem)
overallStatus KeptnState
startTime Time
endTime Time

KeptnTask

KeptnTask is the Schema for the keptntasks API

Appears in:

Field Description
apiVersion string lifecycle.keptn.sh/v1alpha1
kind string KeptnTask
metadata ObjectMeta Refer to Kubernetes API documentation for fields of metadata.
spec KeptnTaskSpec
status KeptnTaskStatus

KeptnTaskDefinition

KeptnTaskDefinition is the Schema for the keptntaskdefinitions API

Appears in:

Field Description
apiVersion string lifecycle.keptn.sh/v1alpha1
kind string KeptnTaskDefinition
metadata ObjectMeta Refer to Kubernetes API documentation for fields of metadata.
spec KeptnTaskDefinitionSpec
status KeptnTaskDefinitionStatus

KeptnTaskDefinitionList

KeptnTaskDefinitionList contains a list of KeptnTaskDefinition

Field Description
apiVersion string lifecycle.keptn.sh/v1alpha1
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 FunctionSpec

KeptnTaskDefinitionStatus

KeptnTaskDefinitionStatus defines the observed state of KeptnTaskDefinition

Appears in:

Field Description
function FunctionStatus INSERT ADDITIONAL STATUS FIELD - define observed state of cluster Important: Run “make” to regenerate code after modifying this file

KeptnTaskList

KeptnTaskList contains a list of KeptnTask

Field Description
apiVersion string lifecycle.keptn.sh/v1alpha1
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
workload string
workloadVersion string
app string
appVersion string
taskDefinition string
context TaskContext
parameters TaskParameters
secureParameters SecureParameters
checkType CheckType

KeptnTaskStatus

KeptnTaskStatus defines the observed state of KeptnTask

Appears in:

Field Description
jobName string
status KeptnState
message string
startTime Time
endTime Time

KeptnWorkload

KeptnWorkload is the Schema for the keptnworkloads API

Appears in:

Field Description
apiVersion string lifecycle.keptn.sh/v1alpha1
kind string KeptnWorkload
metadata ObjectMeta Refer to Kubernetes API documentation for fields of metadata.
spec KeptnWorkloadSpec
status KeptnWorkloadStatus

KeptnWorkloadInstance

KeptnWorkloadInstance is the Schema for the keptnworkloadinstances API

Appears in:

Field Description
apiVersion string lifecycle.keptn.sh/v1alpha1
kind string KeptnWorkloadInstance
metadata ObjectMeta Refer to Kubernetes API documentation for fields of metadata.
spec KeptnWorkloadInstanceSpec
status KeptnWorkloadInstanceStatus

KeptnWorkloadInstanceList

KeptnWorkloadInstanceList contains a list of KeptnWorkloadInstance

Field Description
apiVersion string lifecycle.keptn.sh/v1alpha1
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
version string
preDeploymentTasks string array
postDeploymentTasks string array
preDeploymentEvaluations string array
postDeploymentEvaluations string array
resourceReference ResourceReference
workloadName string
previousVersion string
traceId object (keys:string, values:string)

KeptnWorkloadInstanceStatus

KeptnWorkloadInstanceStatus defines the observed state of KeptnWorkloadInstance

Appears in:

Field Description
preDeploymentStatus KeptnState
deploymentStatus KeptnState
preDeploymentEvaluationStatus KeptnState
postDeploymentEvaluationStatus KeptnState
postDeploymentStatus KeptnState
preDeploymentTaskStatus TaskStatus array
postDeploymentTaskStatus TaskStatus array
preDeploymentEvaluationTaskStatus EvaluationStatus array
postDeploymentEvaluationTaskStatus EvaluationStatus array
startTime Time
endTime Time
currentPhase string
phaseTraceIDs object (keys:string, values:object)
status KeptnState

KeptnWorkloadList

KeptnWorkloadList contains a list of KeptnWorkload

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

KeptnWorkloadRef

Appears in:

Field Description
name string
version string

KeptnWorkloadSpec

KeptnWorkloadSpec defines the desired state of KeptnWorkload

Appears in:

Field Description
app string
version string
preDeploymentTasks string array
postDeploymentTasks string array
preDeploymentEvaluations string array
postDeploymentEvaluations string array
resourceReference ResourceReference

KeptnWorkloadStatus

KeptnWorkloadStatus defines the observed state of KeptnWorkload

Appears in:

Field Description
currentVersion string

Objective

Appears in:

Field Description
name string
query string
evaluationTarget string

ResourceReference

Appears in:

Field Description
uid UID
kind string
name string

SecureParameters

Appears in:

Field Description
secret string

TaskContext

Appears in:

Field Description
workloadName string
appName string
appVersion string
workloadVersion string
taskType string
objectType string

TaskParameters

Appears in:

Field Description
map object (keys:string, values:string)

TaskStatus

Appears in:

Field Description
taskDefinitionName string
status KeptnState
taskName string
startTime Time
endTime Time

WorkloadStatus

Appears in:

Field Description
workload KeptnWorkloadRef
status KeptnState
Last modified 2023-11-03: docs: release 0.9.0 (#2396) (fef5826)