chore: Add deprecation notes to customStateCheck

api-version-compatibility-config.yaml

@@ -20,3 +20,5 @@ operator.kyma-project.io_moduletemplates.yaml:
     v1beta1:
       - .spec.properties.target
       - .spec.required[]|select(.=="target")
+    v1beta2:
+      - .spec.properties.customStateCheck.description

api/v1beta2/moduletemplate_types.go

@@ -109,6 +109,7 @@ type ModuleTemplateSpec struct {
 	// +kubebuilder:pruning:PreserveUnknownFields
 	Descriptor machineryruntime.RawExtension `json:"descriptor"`
 
+	// CustomStateCheck is deprecated.
 	CustomStateCheck []*CustomStateCheck `json:"customStateCheck,omitempty"`
 }
 

config/crd/bases/operator.kyma-project.io_moduletemplates.yaml

@@ -163,6 +163,7 @@ spec:
                 pattern: ^[a-z]+$
                 type: string
               customStateCheck:
+                description: CustomStateCheck is deprecated.
                 items:
                   properties:
                     jsonPath:

docs/technical-reference/api/moduleTemplate-cr.md

@@ -49,6 +49,8 @@ If not specified, the **namespace** of the resource mentioned in **.spec.data**
 
 ### **.spec.customStateCheck**
 
+> **CAUTION:** This field is deprecated and will be removed in the future. 
+
 The `.spec.customStateCheck` field in Kyma Lifecycle Manager is primarily designed for third-party modules. For non-Kyma modules, the `status.state` might not be present, which the Lifecycle Manager relies on to determine the module state. This field enables users to define custom fields in the module Custom Resource (CR) that can be mapped to valid states supported by Lifecycle Manager.
 
 Imagine a scenario where a module's health is indicated by `status.health` in its CR. In such cases, users can employ the customStateCheck configuration to map the health states to Lifecycle Manager states.