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
- KeptnApp
- KeptnAppList
- KeptnAppVersion
- KeptnAppVersionList
- KeptnEvaluation
- KeptnEvaluationDefinition
- KeptnEvaluationDefinitionList
- KeptnEvaluationList
- KeptnTask
- KeptnTaskDefinition
- KeptnTaskDefinitionList
- KeptnTaskList
- KeptnWorkload
- KeptnWorkloadInstance
- KeptnWorkloadInstanceList
- KeptnWorkloadList
CheckType
Underlying type: string
Appears in: - KeptnEvaluationSpec - KeptnTaskSpec
ConfigMapReference
Appears in: - FunctionSpec
| Field | Description | Default | Optional | Validation |
|---|---|---|---|---|
name string |
✓ |
EvaluationStatus
Appears in: - KeptnAppVersionStatus - KeptnWorkloadInstanceStatus
| Field | Description | Default | Optional | Validation |
|---|---|---|---|---|
evaluationDefinitionName string |
✓ | |||
status string |
Pending | ✓ | ||
evaluationName string |
✓ | |||
startTime Time |
✓ | |||
endTime Time |
✓ |
EvaluationStatusItem
Appears in: - KeptnEvaluationStatus
| Field | Description | Default | Optional | Validation |
|---|---|---|---|---|
value string |
x | |||
status string |
x | |||
message string |
✓ |
FunctionReference
Appears in: - FunctionSpec
| Field | Description | Default | Optional | Validation |
|---|---|---|---|---|
name string |
✓ |
FunctionSpec
Appears in: - KeptnTaskDefinitionSpec
| Field | Description | Default | Optional | Validation |
|---|---|---|---|---|
functionRef FunctionReference |
✓ | |||
inline Inline |
✓ | |||
httpRef HttpReference |
✓ | |||
configMapRef ConfigMapReference |
✓ | |||
parameters TaskParameters |
✓ | |||
secureParameters SecureParameters |
✓ |
FunctionStatus
Appears in: - KeptnTaskDefinitionStatus
| Field | Description | Default | Optional | Validation |
|---|---|---|---|---|
configMap string |
✓ |
HttpReference
Appears in: - FunctionSpec
| Field | Description | Default | Optional | Validation |
|---|---|---|---|---|
url string |
✓ |
Inline
Appears in: - FunctionSpec
| Field | Description | Default | Optional | Validation |
|---|---|---|---|---|
code string |
✓ |
KeptnApp
KeptnApp is the Schema for the keptnapps API
Appears in: - KeptnAppList
| Field | Description | Default | Optional | Validation |
|---|---|---|---|---|
apiVersion string |
lifecycle.keptn.sh/v1alpha1 |
|||
kind string |
KeptnApp |
|||
metadata ObjectMeta |
Refer to Kubernetes API documentation about metadata. |
✓ | ||
spec KeptnAppSpec |
✓ | |||
status KeptnAppStatus |
✓ |
KeptnAppList
KeptnAppList contains a list of KeptnApp
| Field | Description | Default | Optional | Validation |
|---|---|---|---|---|
apiVersion string |
lifecycle.keptn.sh/v1alpha1 |
|||
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 |
x | |||
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: - KeptnApp
| Field | Description | Default | Optional | Validation |
|---|---|---|---|---|
currentVersion string |
✓ |
KeptnAppVersion
KeptnAppVersion is the Schema for the keptnappversions API
Appears in: - KeptnAppVersionList
| Field | Description | Default | Optional | Validation |
|---|---|---|---|---|
apiVersion string |
lifecycle.keptn.sh/v1alpha1 |
|||
kind string |
KeptnAppVersion |
|||
metadata ObjectMeta |
Refer to Kubernetes API documentation about metadata. |
✓ | ||
spec KeptnAppVersionSpec |
✓ | |||
status KeptnAppVersionStatus |
✓ |
KeptnAppVersionList
KeptnAppVersionList contains a list of KeptnAppVersion
| Field | Description | Default | Optional | Validation |
|---|---|---|---|---|
apiVersion string |
lifecycle.keptn.sh/v1alpha1 |
|||
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 |
|---|---|---|---|---|
version string |
x | |||
workloads KeptnWorkloadRef array |
✓ | |||
preDeploymentTasks string array |
✓ | |||
postDeploymentTasks string array |
✓ | |||
preDeploymentEvaluations string array |
✓ | |||
postDeploymentEvaluations string array |
✓ | |||
appName string |
x | |||
previousVersion string |
✓ | |||
traceId object (keys:string, values:string) |
✓ |
KeptnAppVersionStatus
KeptnAppVersionStatus defines the observed state of KeptnAppVersion
Appears in: - KeptnAppVersion
| Field | Description | Default | Optional | Validation |
|---|---|---|---|---|
preDeploymentStatus string |
Pending | ✓ | ||
postDeploymentStatus string |
Pending | ✓ | ||
preDeploymentEvaluationStatus string |
Pending | ✓ | ||
postDeploymentEvaluationStatus string |
Pending | ✓ | ||
workloadOverallStatus string |
Pending | ✓ | ||
workloadStatus WorkloadStatus array |
✓ | |||
currentPhase string |
✓ | |||
preDeploymentTaskStatus TaskStatus array |
✓ | |||
postDeploymentTaskStatus TaskStatus array |
✓ | |||
preDeploymentEvaluationTaskStatus EvaluationStatus array |
✓ | |||
postDeploymentEvaluationTaskStatus EvaluationStatus array |
✓ | |||
phaseTraceIDs MapCarrier |
✓ | |||
status string |
Pending | ✓ | ||
startTime Time |
✓ | |||
endTime Time |
✓ |
KeptnEvaluation
KeptnEvaluation is the Schema for the keptnevaluations API
Appears in: - KeptnEvaluationList
| Field | Description | Default | Optional | Validation |
|---|---|---|---|---|
apiVersion string |
lifecycle.keptn.sh/v1alpha1 |
|||
kind string |
KeptnEvaluation |
|||
metadata ObjectMeta |
Refer to Kubernetes API documentation about metadata. |
✓ | ||
spec KeptnEvaluationSpec |
✓ | |||
status KeptnEvaluationStatus |
✓ |
KeptnEvaluationDefinition
KeptnEvaluationDefinition is the Schema for the keptnevaluationdefinitions API
Appears in: - KeptnEvaluationDefinitionList
| Field | Description | Default | Optional | Validation |
|---|---|---|---|---|
apiVersion string |
lifecycle.keptn.sh/v1alpha1 |
|||
kind string |
KeptnEvaluationDefinition |
|||
metadata ObjectMeta |
Refer to Kubernetes API documentation about metadata. |
✓ | ||
spec KeptnEvaluationDefinitionSpec |
✓ | |||
status string |
unused field | ✓ |
KeptnEvaluationDefinitionList
KeptnEvaluationDefinitionList contains a list of KeptnEvaluationDefinition
| Field | Description | Default | Optional | Validation |
|---|---|---|---|---|
apiVersion string |
lifecycle.keptn.sh/v1alpha1 |
|||
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 |
|---|---|---|---|---|
source string |
x | |||
objectives Objective array |
x |
KeptnEvaluationList
KeptnEvaluationList contains a list of KeptnEvaluation
| Field | Description | Default | Optional | Validation |
|---|---|---|---|---|
apiVersion string |
lifecycle.keptn.sh/v1alpha1 |
|||
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 |
✓ | |||
workloadVersion string |
x | |||
appName string |
✓ | |||
appVersion string |
✓ | |||
evaluationDefinition string |
x | |||
retries integer |
10 | ✓ | ||
retryInterval Duration |
5s | ✓ | Pattern: ^0|([0-9]+(\.[0-9]+)?(ns|us|µs|ms|s|m|h))+$ Type: string |
|
failAction string |
✓ | |||
checkType string |
✓ |
KeptnEvaluationStatus
KeptnEvaluationStatus defines the observed state of KeptnEvaluation
Appears in: - KeptnEvaluation
| Field | Description | Default | Optional | Validation |
|---|---|---|---|---|
retryCount integer |
0 | x | ||
evaluationStatus object (keys:string, values:EvaluationStatusItem) |
x | |||
overallStatus string |
Pending | x | ||
startTime Time |
✓ | |||
endTime Time |
✓ |
KeptnState
Underlying type: string
KeptnState is a string containing current Phase state (Progressing/Succeeded/Failed/Unknown/Pending/Cancelled)
Appears in: - EvaluationStatus - EvaluationStatusItem - KeptnAppVersionStatus - KeptnEvaluationStatus - KeptnTaskStatus - KeptnWorkloadInstanceStatus - TaskStatus - WorkloadStatus
KeptnTask
KeptnTask is the Schema for the keptntasks API
Appears in: - KeptnTaskList
| Field | Description | Default | Optional | Validation |
|---|---|---|---|---|
apiVersion string |
lifecycle.keptn.sh/v1alpha1 |
|||
kind string |
KeptnTask |
|||
metadata ObjectMeta |
Refer to Kubernetes API documentation about metadata. |
✓ | ||
spec KeptnTaskSpec |
✓ | |||
status KeptnTaskStatus |
✓ |
KeptnTaskDefinition
KeptnTaskDefinition is the Schema for the keptntaskdefinitions API
Appears in: - KeptnTaskDefinitionList
| Field | Description | Default | Optional | Validation |
|---|---|---|---|---|
apiVersion string |
lifecycle.keptn.sh/v1alpha1 |
|||
kind string |
KeptnTaskDefinition |
|||
metadata ObjectMeta |
Refer to Kubernetes API documentation about metadata. |
✓ | ||
spec KeptnTaskDefinitionSpec |
✓ | |||
status KeptnTaskDefinitionStatus |
✓ |
KeptnTaskDefinitionList
KeptnTaskDefinitionList contains a list of KeptnTaskDefinition
| Field | Description | Default | Optional | Validation |
|---|---|---|---|---|
apiVersion string |
lifecycle.keptn.sh/v1alpha1 |
|||
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 FunctionSpec |
✓ |
KeptnTaskDefinitionStatus
KeptnTaskDefinitionStatus defines the observed state of KeptnTaskDefinition
Appears in: - KeptnTaskDefinition
| Field | Description | Default | Optional | Validation |
|---|---|---|---|---|
function FunctionStatus |
✓ |
KeptnTaskList
KeptnTaskList contains a list of KeptnTask
| Field | Description | Default | Optional | Validation |
|---|---|---|---|---|
apiVersion string |
lifecycle.keptn.sh/v1alpha1 |
|||
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 |
|---|---|---|---|---|
workload string |
x | |||
workloadVersion string |
x | |||
app string |
x | |||
appVersion string |
x | |||
taskDefinition string |
x | |||
context TaskContext |
x | |||
parameters TaskParameters |
✓ | |||
secureParameters SecureParameters |
✓ | |||
checkType string |
✓ |
KeptnTaskStatus
KeptnTaskStatus defines the observed state of KeptnTask
Appears in: - KeptnTask
| Field | Description | Default | Optional | Validation |
|---|---|---|---|---|
jobName string |
✓ | |||
status string |
Pending | ✓ | ||
message string |
✓ | |||
startTime Time |
✓ | |||
endTime Time |
✓ |
KeptnWorkload
KeptnWorkload is the Schema for the keptnworkloads API
Appears in: - KeptnWorkloadList
| Field | Description | Default | Optional | Validation |
|---|---|---|---|---|
apiVersion string |
lifecycle.keptn.sh/v1alpha1 |
|||
kind string |
KeptnWorkload |
|||
metadata ObjectMeta |
Refer to Kubernetes API documentation about metadata. |
✓ | ||
spec KeptnWorkloadSpec |
✓ | |||
status KeptnWorkloadStatus |
✓ |
KeptnWorkloadInstance
KeptnWorkloadInstance is the Schema for the keptnworkloadinstances API
Appears in: - KeptnWorkloadInstanceList
| Field | Description | Default | Optional | Validation |
|---|---|---|---|---|
apiVersion string |
lifecycle.keptn.sh/v1alpha1 |
|||
kind string |
KeptnWorkloadInstance |
|||
metadata ObjectMeta |
Refer to Kubernetes API documentation about metadata. |
✓ | ||
spec KeptnWorkloadInstanceSpec |
✓ | |||
status KeptnWorkloadInstanceStatus |
✓ |
KeptnWorkloadInstanceList
KeptnWorkloadInstanceList contains a list of KeptnWorkloadInstance
| Field | Description | Default | Optional | Validation |
|---|---|---|---|---|
apiVersion string |
lifecycle.keptn.sh/v1alpha1 |
|||
kind string |
KeptnWorkloadInstanceList |
|||
metadata ListMeta |
✓ | |||
items KeptnWorkloadInstance array |
x |
KeptnWorkloadInstanceSpec
KeptnWorkloadInstanceSpec defines the desired state of KeptnWorkloadInstance
Appears in: - KeptnWorkloadInstance
| Field | Description | Default | Optional | Validation |
|---|---|---|---|---|
app string |
x | |||
version string |
x | |||
preDeploymentTasks string array |
✓ | |||
postDeploymentTasks string array |
✓ | |||
preDeploymentEvaluations string array |
✓ | |||
postDeploymentEvaluations string array |
✓ | |||
resourceReference ResourceReference |
x | |||
workloadName string |
x | |||
previousVersion string |
✓ | |||
traceId object (keys:string, values:string) |
✓ |
KeptnWorkloadInstanceStatus
KeptnWorkloadInstanceStatus defines the observed state of KeptnWorkloadInstance
Appears in: - KeptnWorkloadInstance
| Field | Description | Default | Optional | Validation |
|---|---|---|---|---|
preDeploymentStatus string |
Pending | ✓ | ||
deploymentStatus string |
Pending | ✓ | ||
preDeploymentEvaluationStatus string |
Pending | ✓ | ||
postDeploymentEvaluationStatus string |
Pending | ✓ | ||
postDeploymentStatus string |
Pending | ✓ | ||
preDeploymentTaskStatus TaskStatus array |
✓ | |||
postDeploymentTaskStatus TaskStatus array |
✓ | |||
preDeploymentEvaluationTaskStatus EvaluationStatus array |
✓ | |||
postDeploymentEvaluationTaskStatus EvaluationStatus array |
✓ | |||
startTime Time |
✓ | |||
endTime Time |
✓ | |||
currentPhase string |
✓ | |||
phaseTraceIDs MapCarrier |
✓ | |||
status string |
Pending | ✓ |
KeptnWorkloadList
KeptnWorkloadList contains a list of KeptnWorkload
| Field | Description | Default | Optional | Validation |
|---|---|---|---|---|
apiVersion string |
lifecycle.keptn.sh/v1alpha1 |
|||
kind string |
KeptnWorkloadList |
|||
metadata ListMeta |
✓ | |||
items KeptnWorkload array |
x |
KeptnWorkloadRef
Appears in: - KeptnAppSpec - KeptnAppVersionSpec - WorkloadStatus
| Field | Description | Default | Optional | Validation |
|---|---|---|---|---|
name string |
x | |||
version string |
x |
KeptnWorkloadSpec
KeptnWorkloadSpec defines the desired state of KeptnWorkload
Appears in: - KeptnWorkload - KeptnWorkloadInstanceSpec
| Field | Description | Default | Optional | Validation |
|---|---|---|---|---|
app string |
x | |||
version string |
x | |||
preDeploymentTasks string array |
✓ | |||
postDeploymentTasks string array |
✓ | |||
preDeploymentEvaluations string array |
✓ | |||
postDeploymentEvaluations string array |
✓ | |||
resourceReference ResourceReference |
x |
KeptnWorkloadStatus
KeptnWorkloadStatus defines the observed state of KeptnWorkload
Appears in: - KeptnWorkload
| Field | Description | Default | Optional | Validation |
|---|---|---|---|---|
currentVersion string |
✓ |
Objective
Appears in: - KeptnEvaluationDefinitionSpec
| Field | Description | Default | Optional | Validation |
|---|---|---|---|---|
name string |
x | |||
query string |
x | |||
evaluationTarget string |
x |
PhaseTraceID
Underlying type: MapCarrier
PhaseTraceID is a map storing TraceIDs of OpenTelemetry spans in lifecycle phases
Appears in: - KeptnAppVersionStatus - KeptnWorkloadInstanceStatus
ResourceReference
ResourceReference represents the parent resource of Workload
Appears in: - KeptnWorkloadInstanceSpec - KeptnWorkloadSpec
| Field | Description | Default | Optional | Validation |
|---|---|---|---|---|
uid string |
x | |||
kind string |
x | |||
name string |
x |
SecureParameters
Appears in: - FunctionSpec - KeptnTaskSpec
| Field | Description | Default | Optional | Validation |
|---|---|---|---|---|
secret string |
✓ |
TaskContext
Appears in: - KeptnTaskSpec
| Field | Description | Default | Optional | Validation |
|---|---|---|---|---|
workloadName string |
x | |||
appName string |
x | |||
appVersion string |
x | |||
workloadVersion string |
x | |||
taskType string |
x | |||
objectType string |
x |
TaskParameters
Appears in: - FunctionSpec - KeptnTaskSpec
| Field | Description | Default | Optional | Validation |
|---|---|---|---|---|
map object (keys:string, values:string) |
✓ |
TaskStatus
Appears in: - KeptnAppVersionStatus - KeptnWorkloadInstanceStatus
| Field | Description | Default | Optional | Validation |
|---|---|---|---|---|
taskDefinitionName string |
✓ | |||
status string |
Pending | ✓ | ||
taskName string |
✓ | |||
startTime Time |
✓ | |||
endTime Time |
✓ |
WorkloadStatus
Appears in: - KeptnAppVersionStatus
| Field | Description | Default | Optional | Validation |
|---|---|---|---|---|
workload KeptnWorkloadRef |
✓ | |||
status string |
Pending | ✓ |