feat(trait): deprecate prometheus trait

Favour Camel Monitor Operator to perform that level of monitoring instead

Author: squakez

docs/modules/ROOT/pages/observability/monitoring.adoc

@@ -1,14 +1,16 @@
 [[monitoring]]
-= Camel K Monitoring
+= Camel K Operator Monitoring
 
-The Camel K monitoring architecture relies on https://prometheus.io[Prometheus] and the eponymous operator.
+The Camel K Operator monitoring architecture relies on https://prometheus.io[Prometheus] and the eponymous operator.
 
 The https://prometheus-operator.dev[Prometheus Operator] serves to make running Prometheus on top of Kubernetes as easy as possible, while preserving Kubernetes-native configuration options.
 
+NOTE: the Camel K Integration monitoring part is deprecated in favour of xref:observability/dashboard.adoc[Camel Dashboard].
+
 [[prerequisites]]
 == Prerequisites
 
-To take full advantage of the Camel K monitoring capabilities, it is recommended to have a Prometheus Operator instance, that can be configured to integrate the Camel K operator and integrations.
+To take full advantage of the Camel K operator monitoring capabilities, it is recommended to have a Prometheus Operator instance, that can be configured to integrate the Camel K operator and integrations.
 
 [[kubernetes]]
 === Kubernetes
@@ -22,7 +24,7 @@ Alternatively, you can quickly deploy the Prometheus operator by running:
 $ kubectl apply -f https://raw.githubusercontent.com/prometheus-operator/prometheus-operator/main/bundle.yaml
 ----
 
-WARNING: Beware this installs the operator in the `default` namespace. You must download the file locally and replace the `namespace` fields to deploy the resources into another namespace. This also installs the version from the `main` branch, which you can change in the URL by choosing a stable release version.
+NOTE: the above script installs the operator in the `default` namespace. You must download the file locally and replace the `namespace` fields to deploy the resources into another namespace. This also installs the version from the `main` branch, which you can change in the URL by choosing a stable release version.
 
 Then, you can create a `Prometheus` resource, that the operator will use as configuration to deploy a managed Prometheus instance:
 

docs/modules/ROOT/pages/observability/monitoring/integration.adoc

@@ -1,7 +1,7 @@
 [[integration-monitoring]]
 = Camel K Integration Monitoring
 
-NOTE: The Camel K monitoring architecture relies on https://prometheus.io[Prometheus] and the eponymous operator. Make sure you've checked the xref:observability/monitoring.adoc#prerequisites[Camel K monitoring prerequisites].
+WARNING: The Camel K Integration monitoring part is deprecated. Use instead xref:observability/dashboard.adoc[Camel Dashboard] project to provide a deeper level of monitoring to your Camel applications.
 
 [[instrumentation]]
 == Instrumentation

docs/modules/ROOT/pages/observability/monitoring/operator.adoc

@@ -1,7 +1,9 @@
 [[operator-monitoring]]
 = Camel K Operator Monitoring
 
-NOTE: The Camel K monitoring architecture relies on https://prometheus.io[Prometheus] and the eponymous operator. Make sure you've checked the xref:observability/monitoring.adoc#prerequisites[Camel K monitoring prerequisites].
+In this chapter we provide some example how to provide a monitoring based on Prometheus for your Camel K operator main metrics.
+
+WARNING: this is a guide that mostly depends on Prometheus. The goal is to provide some basic example more than an exhaustive guide. Please, refer to Prometheus documentation for a full production configuration.
 
 [[installation]]
 == Installation

docs/modules/ROOT/partials/apis/camel-k-crds.adoc

@@ -2498,7 +2498,9 @@ A human-readable message indicating details about the transition.
 |
 
 
-Pods collect health and conditions information from the owned PODs
+DeprecatedPods collect health and conditions information from the owned PODs
+
+Deprecated: may be removed in future releases.
 
 
 |===
@@ -5107,7 +5109,7 @@ PluginProperties -- .
 * <<#_camel_apache_org_v1_IntegrationCondition, IntegrationCondition>>
 * <<#_camel_apache_org_v1_PipeCondition, PipeCondition>>
 
-
+Deprecated: may be removed in future releases.
 
 [cols="2,2a",options="header"]
 |===
@@ -9057,7 +9059,7 @@ Deprecated: no longer in use.
 * <<#_camel_apache_org_v1_Traits, Traits>>
 
 WARNING: The Pod trait is **deprecated** and will removed in future release versions:
-use InitContainers trait istead.
+use InitContainers trait instead.
 
 The pod trait allows the customization of the Integration pods.
 It applies the `PodSpecTemplate` struct contained in the Integration `.spec.podTemplate` field,
@@ -9089,6 +9091,9 @@ by using the `integration` container name.
 
 * <<#_camel_apache_org_v1_Traits, Traits>>
 
+WARNING: The Prometheus trait is **deprecated** and will removed in future release versions:
+use Camel Monitor operator (https://camel-tooling.github.io/camel-dashboard/docs/installation-guide/advanced/operator/) instead.
+
 The Prometheus trait configures a Prometheus-compatible endpoint. It also creates a `PodMonitor` resource,
 so that the endpoint can be scraped automatically, when using the Prometheus operator.
 

docs/modules/traits/pages/pod.adoc

@@ -6,7 +6,7 @@
 // End of autogenerated code - DO NOT EDIT! (badges)
 // Start of autogenerated code - DO NOT EDIT! (description)
 WARNING: The Pod trait is **deprecated** and will removed in future release versions:
-use InitContainers trait istead.
+use InitContainers trait instead.
 
 The pod trait allows the customization of the Integration pods.
 It applies the `PodSpecTemplate` struct contained in the Integration `.spec.podTemplate` field,

docs/modules/traits/pages/prometheus.adoc

@@ -1,8 +1,13 @@
 = Prometheus Trait
 
 // Start of autogenerated code - DO NOT EDIT! (badges)
+[.badges]
+[.badge-key]##Deprecated since##[.badge-unsupported]##2.11.0##
 // End of autogenerated code - DO NOT EDIT! (badges)
 // Start of autogenerated code - DO NOT EDIT! (description)
+WARNING: The Prometheus trait is **deprecated** and will removed in future release versions:
+use Camel Monitor operator (https://camel-tooling.github.io/camel-dashboard/docs/installation-guide/advanced/operator/) instead.
+
 The Prometheus trait configures a Prometheus-compatible endpoint. It also creates a `PodMonitor` resource,
 so that the endpoint can be scraped automatically, when using the Prometheus operator.
 

e2e/common/traits/health_test.go

@@ -107,13 +107,13 @@ func TestHealthTrait(t *testing.T) {
 					if c.Status != corev1.ConditionFalse {
 						return false
 					}
-					if len(c.Pods) != 3 {
+					if len(c.DeprecatedPods) != 3 {
 						return false
 					}
 
 					var r *v1.HealthCheckResponse
 
-					for _, pod := range c.Pods {
+					for _, pod := range c.DeprecatedPods {
 						for h := range pod.Health {
 							if pod.Health[h].Name == "camel-routes" {
 								r = &pod.Health[h]
@@ -201,15 +201,15 @@ func TestHealthTrait(t *testing.T) {
 					if c.Status != corev1.ConditionFalse {
 						return false
 					}
-					if len(c.Pods) != 1 {
+					if len(c.DeprecatedPods) != 1 {
 						return false
 					}
 
 					var r *v1.HealthCheckResponse
 
-					for h := range c.Pods[0].Health {
-						if c.Pods[0].Health[h].Name == "camel-routes" {
-							r = &c.Pods[0].Health[h]
+					for h := range c.DeprecatedPods[0].Health {
+						if c.DeprecatedPods[0].Health[h].Name == "camel-routes" {
+							r = &c.DeprecatedPods[0].Health[h]
 						}
 					}
 
@@ -288,15 +288,15 @@ func TestHealthTrait(t *testing.T) {
 					if c.Status != corev1.ConditionFalse {
 						return false
 					}
-					if len(c.Pods) != 1 {
+					if len(c.DeprecatedPods) != 1 {
 						return false
 					}
 
 					var r *v1.HealthCheckResponse
 
-					for h := range c.Pods[0].Health {
-						if c.Pods[0].Health[h].Name == "camel-routes" {
-							r = &c.Pods[0].Health[h]
+					for h := range c.DeprecatedPods[0].Health {
+						if c.DeprecatedPods[0].Health[h].Name == "camel-routes" {
+							r = &c.DeprecatedPods[0].Health[h]
 						}
 					}
 
@@ -374,15 +374,15 @@ func TestHealthTrait(t *testing.T) {
 					if c.Status != corev1.ConditionFalse {
 						return false
 					}
-					if len(c.Pods) != 1 {
+					if len(c.DeprecatedPods) != 1 {
 						return false
 					}
 
 					var r *v1.HealthCheckResponse
 
-					for h := range c.Pods[0].Health {
-						if c.Pods[0].Health[h].Name == "never-ready" {
-							r = &c.Pods[0].Health[h]
+					for h := range c.DeprecatedPods[0].Health {
+						if c.DeprecatedPods[0].Health[h].Name == "never-ready" {
+							r = &c.DeprecatedPods[0].Health[h]
 						}
 					}
 
@@ -426,15 +426,15 @@ func TestHealthTrait(t *testing.T) {
 					if c.Status != corev1.ConditionFalse {
 						return false
 					}
-					if len(c.Pods) != 1 {
+					if len(c.DeprecatedPods) != 1 {
 						return false
 					}
 
 					var r *v1.HealthCheckResponse
 
-					for h := range c.Pods[0].Health {
-						if c.Pods[0].Health[h].Name == "never-ready" && c.Pods[0].Health[h].Status == "DOWN" {
-							r = &c.Pods[0].Health[h]
+					for h := range c.DeprecatedPods[0].Health {
+						if c.DeprecatedPods[0].Health[h].Name == "never-ready" && c.DeprecatedPods[0].Health[h].Status == "DOWN" {
+							r = &c.DeprecatedPods[0].Health[h]
 						}
 					}
 

e2e/support/test_support.go

@@ -748,14 +748,14 @@ func HealthCheckResponse(podRegexp string, healthName string) func(*v1.Integrati
 			return nil
 		}
 
-		for p := range c.Pods {
-			if re.MatchString(c.Pods[p].Name) {
+		for p := range c.DeprecatedPods {
+			if re.MatchString(c.DeprecatedPods[p].Name) {
 				continue
 			}
 
-			for h := range c.Pods[p].Health {
-				if c.Pods[p].Health[h].Name == healthName {
-					return &c.Pods[p].Health[h]
+			for h := range c.DeprecatedPods[p].Health {
+				if c.DeprecatedPods[p].Health[h].Name == healthName {
+					return &c.DeprecatedPods[p].Health[h]
 				}
 			}
 

helm/camel-k/crds/camel-k-crds.yaml

@@ -22518,9 +22518,12 @@ spec:
                         the transition.
                       type: string
                     pods:
-                      description: Pods collect health and conditions information
-                        from the owned PODs
+                      description: |-
+                        DeprecatedPods collect health and conditions information from the owned PODs
+
+                        Deprecated: may be removed in future releases.
                       items:
+                        description: 'Deprecated: may be removed in future releases.'
                         properties:
                           condition:
                             description: PodCondition contains details for the current
@@ -37786,6 +37789,7 @@ spec:
                       description: Pods collect health and conditions information
                         from the owned PODs
                       items:
+                        description: 'Deprecated: may be removed in future releases.'
                         properties:
                           condition:
                             description: PodCondition contains details for the current

pkg/apis/camel/v1/integration_types.go

@@ -307,8 +307,10 @@ type IntegrationCondition struct {
 	Reason string `json:"reason,omitempty"`
 	// A human-readable message indicating details about the transition.
 	Message string `json:"message,omitempty"`
-	// Pods collect health and conditions information from the owned PODs
-	Pods []PodCondition `json:"pods,omitempty"`
+	// DeprecatedPods collect health and conditions information from the owned PODs
+	//
+	// Deprecated: may be removed in future releases.
+	DeprecatedPods []PodCondition `json:"pods,omitempty"`
 }
 
 // PodSpecTemplate represent a template used to deploy an Integration `Pod`.
@@ -349,6 +351,7 @@ type PodSpec struct {
 	SecurityContext corev1.PodSecurityContext `json:"securityContext,omitempty" protobuf:"bytes,34,opt,name=securityContext"`
 }
 
+// Deprecated: may be removed in future releases.
 type PodCondition struct {
 	Name      string                `json:"name,omitempty"   yaml:"name,omitempty"`
 	Condition corev1.PodCondition   `json:"condition"        yaml:"condition"`