Enable opentelemetry support for ETOS when deployed with Cluster spec (#401)

Add a new parameter to the cluster spec called openTelemetry where it
is possible to pass in an enpoint and whether the endpoint is insecure
or not. This is how we use opentelemetry so this is not a complete
solution, but something to start with.

ETOS does not deploy an opentelemetry collector, only passes the
environment variables that the services use to connect and we expect the
system engineers to deploy the collectors separately.

I also removed the extra configuration that we could pass to the suite
starter and suite runner since they are now redundant.

Author: t-persson

api/v1alpha1/cluster_types.go

@@ -67,6 +67,24 @@ type EventRepository struct {
 	Ingress Ingress `json:"ingress"`
 }
 
+// OpenTelemetry describes a deployment of an opentelemetry collector for ETOS to use.
+type OpenTelemetry struct {
+	// Enable opentelemetry support, adding the environment variables to services.
+	// +kubebuilder:default=false
+	// +optional
+	Enabled bool `json:"enabled"`
+
+	// Sets the OTEL_EXPORTER_OTLP_ENDPOINT environment variable
+	// +kubebuilder:default="http://localhost:4317"
+	// +optional
+	Endpoint string `json:"endpoint"`
+
+	// Sets the OTEL_EXPORTER_OTLP_INSECURE environment variable
+	// +kubebuilder:default="true"
+	// +optional
+	Insecure string `json:"insecure"`
+}
+
 // MessageBus describes the deployment of messagesbuses for ETOS.
 type MessageBus struct {
 	// +optional
@@ -121,18 +139,12 @@ type ETOSSuiteStarterConfig struct {
 	// +kubebuilder:default="3600"
 	// +optional
 	TTL string `json:"ttl,omitempty"`
-	// +kubebuilder:default=""
-	// +optional
-	ObservabilityConfigmapName string `json:"observabilityConfigmapName,omitempty"`
 	// +kubebuilder:default="300"
 	// +optional
 	GracePeriod string `json:"gracePeriod,omitempty"`
 	// +kubebuilder:default=""
 	// +optional
 	SidecarImage string `json:"sidecarImage,omitempty"`
-	// +kubebuilder:default=""
-	// +optional
-	OTELCollectorHost string `json:"otelCollectorHost,omitempty"`
 }
 
 // ETOSSuiteStarter describes the deployment of an ETOS suite starter.
@@ -266,6 +278,8 @@ type ClusterSpec struct {
 	MessageBus MessageBus `json:"messageBus"`
 	// +kubebuilder:default={}
 	EventRepository EventRepository `json:"eventRepository"`
+	// +kubebuilder:default={}
+	OpenTelemetry OpenTelemetry `json:"openTelemetry"`
 }
 
 // ClusterStatus defines the observed state of Cluster

api/v1alpha1/zz_generated.deepcopy.go

@@ -325,12 +325,6 @@ spec:
                           gracePeriod:
                             default: "300"
                             type: string
-                          observabilityConfigmapName:
-                            default: ""
-                            type: string
-                          otelCollectorHost:
-                            default: ""
-                            type: string
                           sidecarImage:
                             default: ""
                             type: string
@@ -693,11 +687,33 @@ spec:
                         type: string
                     type: object
                 type: object
+              openTelemetry:
+                default: {}
+                description: OpenTelemetry describes a deployment of an opentelemetry
+                  collector for ETOS to use.
+                properties:
+                  enabled:
+                    default: false
+                    description: Enable opentelemetry support, adding the environment
+                      variables to services.
+                    type: boolean
+                  endpoint:
+                    default: http://localhost:4317
+                    description: Sets the OTEL_EXPORTER_OTLP_ENDPOINT environment
+                      variable
+                    type: string
+                  insecure:
+                    default: "true"
+                    description: Sets the OTEL_EXPORTER_OTLP_INSECURE environment
+                      variable
+                    type: string
+                type: object
             required:
             - database
             - etos
             - eventRepository
             - messageBus
+            - openTelemetry
             type: object
           status:
             description: ClusterStatus defines the observed state of Cluster

config/crd/bases/etos.eiffel-community.github.io_clusters.yaml

@@ -397,6 +397,10 @@ func (r *ETOSDeployment) config(name types.NamespacedName, cluster *etosv1alpha1
 	if cluster.Spec.ETOS.Config.TestRunRetention.Success != nil {
 		data["TESTRUN_SUCCESS_RETENTION"] = []byte(cluster.Spec.ETOS.Config.TestRunRetention.Success.Duration.String())
 	}
+	if cluster.Spec.OpenTelemetry.Enabled {
+		data["OTEL_EXPORTER_OTLP_ENDPOINT"] = []byte(cluster.Spec.OpenTelemetry.Endpoint)
+		data["OTEL_EXPORTER_OTLP_INSECURE"] = []byte(cluster.Spec.OpenTelemetry.Insecure)
+	}
 	if r.Config.Timezone != "" {
 		data["TZ"] = []byte(r.Config.Timezone)
 	}

internal/etos/etos.go

@@ -378,18 +378,13 @@ func (r *ETOSSuiteStarterDeployment) config(ctx context.Context, name types.Name
 		"RABBITMQ_ROUTING_KEY":          []byte(routingKey),
 		"RABBITMQ_QUEUE":                []byte(r.EiffelQueueName),
 	}
-	if r.Config.ObservabilityConfigmapName != "" {
-		data["ETOS_OBSERVABILITY_CONFIGMAP"] = []byte(r.Config.ObservabilityConfigmapName)
-	}
 	if r.Config.SidecarImage != "" {
 		data["ETOS_SIDECAR_IMAGE"] = []byte(r.Config.SidecarImage)
 	}
-	if r.Config.OTELCollectorHost != "" {
-		data["OTEL_COLLECTOR_HOST"] = []byte(r.Config.OTELCollectorHost)
-	}
 	if r.EiffelQueueParams != "" {
 		data["RABBITMQ_QUEUE_PARAMS"] = []byte(r.EiffelQueueParams)
 	}
+
 	eiffel := &corev1.Secret{}
 	if err := r.Get(ctx, types.NamespacedName{Name: r.rabbitmqSecret, Namespace: name.Namespace}, eiffel); err != nil {
 		return nil, err