rename to observabilityTimeout

Signed-off-by: odubajDT <[email protected]>

.github/scripts/.helm-tests/default/result.yaml

@@ -2050,20 +2050,20 @@ spec:
                 description: CloudEventsEndpoint can be used to set the endpoint where
                   Cloud Events should be posted by the lifecycle operator
                 type: string
-              deploymentTimeout:
-                default: 5m
-                description: |-
-                  DeploymentTimeout specifies the maximum time to wait for the deployment to be in Running state.
-                  If the workload does not deploy successfully within this time frame, it will be
-                  considered as failed.
-                pattern: ^0|([0-9]+(\.[0-9]+)?(ns|us|µs|ms|s|m|h))+$
-                type: string
               keptnAppCreationRequestTimeoutSeconds:
                 default: 30
                 description: |-
                   KeptnAppCreationRequestTimeoutSeconds is used to set the interval in which automatic app discovery
                   searches for workload to put into the same auto-generated KeptnApp
                 type: integer
+              observabilityTimeout:
+                default: 5m
+                description: |-
+                  ObservabilityTimeout specifies the maximum time to observe the deployment phase of KeptnWorkload.
+                  If the workload does not deploy successfully within this time frame, it will be
+                  considered as failed.
+                pattern: ^0|([0-9]+(\.[0-9]+)?(ns|us|µs|ms|s|m|h))+$
+                type: string
             type: object
           status:
             description: unused field

.github/scripts/.helm-tests/lifecycle-only/result.yaml

@@ -1996,20 +1996,20 @@ spec:
                 description: CloudEventsEndpoint can be used to set the endpoint where
                   Cloud Events should be posted by the lifecycle operator
                 type: string
-              deploymentTimeout:
-                default: 5m
-                description: |-
-                  DeploymentTimeout specifies the maximum time to wait for the deployment to be in Running state.
-                  If the workload does not deploy successfully within this time frame, it will be
-                  considered as failed.
-                pattern: ^0|([0-9]+(\.[0-9]+)?(ns|us|µs|ms|s|m|h))+$
-                type: string
               keptnAppCreationRequestTimeoutSeconds:
                 default: 30
                 description: |-
                   KeptnAppCreationRequestTimeoutSeconds is used to set the interval in which automatic app discovery
                   searches for workload to put into the same auto-generated KeptnApp
                 type: integer
+              observabilityTimeout:
+                default: 5m
+                description: |-
+                  ObservabilityTimeout specifies the maximum time to observe the deployment phase of KeptnWorkload.
+                  If the workload does not deploy successfully within this time frame, it will be
+                  considered as failed.
+                pattern: ^0|([0-9]+(\.[0-9]+)?(ns|us|µs|ms|s|m|h))+$
+                type: string
             type: object
           status:
             description: unused field

.github/scripts/.helm-tests/lifecycle-with-certs/result.yaml

@@ -2025,20 +2025,20 @@ spec:
                 description: CloudEventsEndpoint can be used to set the endpoint where
                   Cloud Events should be posted by the lifecycle operator
                 type: string
-              deploymentTimeout:
-                default: 5m
-                description: |-
-                  DeploymentTimeout specifies the maximum time to wait for the deployment to be in Running state.
-                  If the workload does not deploy successfully within this time frame, it will be
-                  considered as failed.
-                pattern: ^0|([0-9]+(\.[0-9]+)?(ns|us|µs|ms|s|m|h))+$
-                type: string
               keptnAppCreationRequestTimeoutSeconds:
                 default: 30
                 description: |-
                   KeptnAppCreationRequestTimeoutSeconds is used to set the interval in which automatic app discovery
                   searches for workload to put into the same auto-generated KeptnApp
                 type: integer
+              observabilityTimeout:
+                default: 5m
+                description: |-
+                  ObservabilityTimeout specifies the maximum time to observe the deployment phase of KeptnWorkload.
+                  If the workload does not deploy successfully within this time frame, it will be
+                  considered as failed.
+                pattern: ^0|([0-9]+(\.[0-9]+)?(ns|us|µs|ms|s|m|h))+$
+                type: string
             type: object
           status:
             description: unused field

docs/docs/reference/api-reference/options/v1alpha1/index.md

@@ -67,6 +67,6 @@ _Appears in:_
 | `keptnAppCreationRequestTimeoutSeconds` _integer_ | KeptnAppCreationRequestTimeoutSeconds is used to set the interval in which automatic app discovery searches for workload to put into the same auto-generated KeptnApp |30| ✓ |
 | `cloudEventsEndpoint` _string_ | CloudEventsEndpoint can be used to set the endpoint where Cloud Events should be posted by the lifecycle operator || ✓ |
 | `blockDeployment` _boolean_ | BlockDeployment is used to block the deployment of the application until the pre-deployment tasks and evaluations succeed |true| ✓ |
-| `deploymentTimeout` _[Duration](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#duration-v1-meta)_ | DeploymentTimeout specifies the maximum time to wait for the deployment to be in Running state. If the workload does not deploy successfully within this time frame, it will be considered as failed. |5m| ✓ |
+| `observabilityTimeout` _[Duration](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#duration-v1-meta)_ | ObservabilityTimeout specifies the maximum time to observe the deployment phase of KeptnWorkload. If the workload does not deploy successfully within this time frame, it will be considered as failed. |5m| ✓ |
 
 

docs/docs/reference/crd-reference/config.md

@@ -18,6 +18,7 @@ spec:
   keptnAppCreationRequestTimeoutSeconds: <#-seconds>
   cloudEventsEndpoint: <endpoint>
   blockDeployment: true | false
+  observabilityTimeout: <duration>
 ```
 
 ## Fields
@@ -48,6 +49,13 @@ spec:
       even if the pre-deployment tasks and/or evaluations fail.
       For more information see the
       [non-blocking deployment section](../../components/lifecycle-operator/keptn-non-blocking.md).
+    * **observabilityTimeout** -- specifies the maximum time
+      to observe the deployment phase of
+      [KeptnWorkload](../api-reference/lifecycle/v1beta1/index.md).
+      The value supplied should specify the unit of measurement;
+      for example, `5m` indicates 5 minutes and `1h` indicates 1 hour.
+      If the workload is not deployed successfully within this time frame,
+      it is considered to be failed.
 
 ## Usage
 
@@ -73,6 +81,7 @@ spec:
   keptnAppCreationRequestTimeoutSeconds: 40
   cloudEventsEndpoint: 'http://endpoint.com'
   blockDeployment: false
+  observabilityTimeout: 10m
 ```
 
 ## Files

lifecycle-operator/apis/options/v1alpha1/keptnconfig_types.go

@@ -48,14 +48,14 @@ type KeptnConfigSpec struct {
 	// +optional
 	BlockDeployment bool `json:"blockDeployment,omitempty"`
 
-	// DeploymentTimeout specifies the maximum time to wait for the deployment to be in Running state.
+	// ObservabilityTimeout specifies the maximum time to observe the deployment phase of KeptnWorkload.
 	// If the workload does not deploy successfully within this time frame, it will be
 	// considered as failed.
 	// +kubebuilder:default:="5m"
 	// +kubebuilder:validation:Pattern="^0|([0-9]+(\\.[0-9]+)?(ns|us|µs|ms|s|m|h))+$"
 	// +kubebuilder:validation:Type:=string
 	// +optional
-	DeploymentTimeout metav1.Duration `json:"deploymentTimeout,omitempty"`
+	ObservabilityTimeout metav1.Duration `json:"observabilityTimeout,omitempty"`
 }
 
 // +kubebuilder:object:root=true

lifecycle-operator/chart/templates/keptnconfig-crd.yaml

@@ -61,20 +61,20 @@ spec:
                 description: CloudEventsEndpoint can be used to set the endpoint where
                   Cloud Events should be posted by the lifecycle operator
                 type: string
-              deploymentTimeout:
-                default: 5m
-                description: |-
-                  DeploymentTimeout specifies the maximum time to wait for the deployment to be in Running state.
-                  If the workload does not deploy successfully within this time frame, it will be
-                  considered as failed.
-                pattern: ^0|([0-9]+(\.[0-9]+)?(ns|us|µs|ms|s|m|h))+$
-                type: string
               keptnAppCreationRequestTimeoutSeconds:
                 default: 30
                 description: |-
                   KeptnAppCreationRequestTimeoutSeconds is used to set the interval in which automatic app discovery
                   searches for workload to put into the same auto-generated KeptnApp
                 type: integer
+              observabilityTimeout:
+                default: 5m
+                description: |-
+                  ObservabilityTimeout specifies the maximum time to observe the deployment phase of KeptnWorkload.
+                  If the workload does not deploy successfully within this time frame, it will be
+                  considered as failed.
+                pattern: ^0|([0-9]+(\.[0-9]+)?(ns|us|µs|ms|s|m|h))+$
+                type: string
             type: object
           status:
             description: unused field

lifecycle-operator/config/crd/bases/options.keptn.sh_keptnconfigs.yaml

@@ -53,20 +53,20 @@ spec:
                 description: CloudEventsEndpoint can be used to set the endpoint where
                   Cloud Events should be posted by the lifecycle operator
                 type: string
-              deploymentTimeout:
-                default: 5m
-                description: |-
-                  DeploymentTimeout specifies the maximum time to wait for the deployment to be in Running state.
-                  If the workload does not deploy successfully within this time frame, it will be
-                  considered as failed.
-                pattern: ^0|([0-9]+(\.[0-9]+)?(ns|us|µs|ms|s|m|h))+$
-                type: string
               keptnAppCreationRequestTimeoutSeconds:
                 default: 30
                 description: |-
                   KeptnAppCreationRequestTimeoutSeconds is used to set the interval in which automatic app discovery
                   searches for workload to put into the same auto-generated KeptnApp
                 type: integer
+              observabilityTimeout:
+                default: 5m
+                description: |-
+                  ObservabilityTimeout specifies the maximum time to observe the deployment phase of KeptnWorkload.
+                  If the workload does not deploy successfully within this time frame, it will be
+                  considered as failed.
+                pattern: ^0|([0-9]+(\.[0-9]+)?(ns|us|µs|ms|s|m|h))+$
+                type: string
             type: object
           status:
             description: unused field

lifecycle-operator/config/samples/options_v1alpha1_keptnconfig.yaml

@@ -12,3 +12,5 @@ metadata:
 spec:
   OTelCollectorUrl: 'otel-collector:4317'
   keptnAppCreationRequestTimeoutSeconds: 30
+  blockDeployment: true
+  observabilityTimeout: 5m