Expose rsyslog template format in Logging CRD

Add RsyslogTemplate field to LoggingSpec with enum validation
restricting values to RSYSLOG_TraditionalFileFormat (default)
and RSYSLOG_SyslogProtocol23Format. This allows users to
configure the syslog message format used by the rsyslog
forwarding action on dataplane nodes.

Closes: OSPRH-29473

Author: jlarriba

api/bases/telemetry.openstack.org_loggings.yaml

@@ -84,6 +84,13 @@ spec:
                 description: The number of retries rsyslog will attempt before abandoning
                 format: int32
                 type: integer
+              rsyslogTemplate:
+                default: RSYSLOG_TraditionalFileFormat
+                description: The template format for rsyslog forwarding actions
+                enum:
+                - RSYSLOG_TraditionalFileFormat
+                - RSYSLOG_SyslogProtocol23Format
+                type: string
               targetPort:
                 default: 10514
                 description: TargetPort is the port where the logging syslog receiver

api/bases/telemetry.openstack.org_telemetries.yaml

@@ -1414,6 +1414,13 @@ spec:
                       abandoning
                     format: int32
                     type: integer
+                  rsyslogTemplate:
+                    default: RSYSLOG_TraditionalFileFormat
+                    description: The template format for rsyslog forwarding actions
+                    enum:
+                    - RSYSLOG_TraditionalFileFormat
+                    - RSYSLOG_SyslogProtocol23Format
+                    type: string
                   targetPort:
                     default: 10514
                     description: TargetPort is the port where the logging syslog receiver

api/v1beta1/logging_types.go

@@ -58,6 +58,12 @@ type LoggingSpec struct {
 	// +kubebuilder:validation:Optional
 	// +kubebuilder:default=10000
 	RsyslogQueueSize int32 `json:"rsyslogQueueSize"`
+
+	// The template format for rsyslog forwarding actions
+	// +kubebuilder:validation:Optional
+	// +kubebuilder:default=RSYSLOG_TraditionalFileFormat
+	// +kubebuilder:validation:Enum=RSYSLOG_TraditionalFileFormat;RSYSLOG_SyslogProtocol23Format
+	RsyslogTemplate string `json:"rsyslogTemplate"`
 }
 
 // LoggingStatus defines the observed state of Logging

config/crd/bases/telemetry.openstack.org_loggings.yaml

@@ -84,6 +84,13 @@ spec:
                 description: The number of retries rsyslog will attempt before abandoning
                 format: int32
                 type: integer
+              rsyslogTemplate:
+                default: RSYSLOG_TraditionalFileFormat
+                description: The template format for rsyslog forwarding actions
+                enum:
+                - RSYSLOG_TraditionalFileFormat
+                - RSYSLOG_SyslogProtocol23Format
+                type: string
               targetPort:
                 default: 10514
                 description: TargetPort is the port where the logging syslog receiver

config/crd/bases/telemetry.openstack.org_telemetries.yaml

@@ -1414,6 +1414,13 @@ spec:
                       abandoning
                     format: int32
                     type: integer
+                  rsyslogTemplate:
+                    default: RSYSLOG_TraditionalFileFormat
+                    description: The template format for rsyslog forwarding actions
+                    enum:
+                    - RSYSLOG_TraditionalFileFormat
+                    - RSYSLOG_SyslogProtocol23Format
+                    type: string
                   targetPort:
                     default: 10514
                     description: TargetPort is the port where the logging syslog receiver

internal/controller/logging_controller.go

@@ -300,6 +300,7 @@ func (r *LoggingReconciler) generateComputeServiceConfig(
 		"RsyslogRetries":   instance.Spec.RsyslogRetries,
 		"RsyslogQueueType": instance.Spec.RsyslogQueueType,
 		"RsyslogQueueSize": instance.Spec.RsyslogQueueSize,
+		"RsyslogTemplate":  instance.Spec.RsyslogTemplate,
 	}
 
 	customData := map[string]string{}

templates/logging/config/10-telemetry.conf

@@ -2,6 +2,7 @@ action(type="omfwd"
        target="{{ .RsyslogAddress }}"
        port="{{ .RsyslogPort }}"
        protocol="tcp"
+       template="{{ .RsyslogTemplate }}"
        action.resumeRetryCount="{{ .RsyslogRetries }}"
        queue.type="{{ .RsyslogQueueType }}"
        queue.size="{{ .RsyslogQueueSize }}"

test/kuttl/tests/logging/01-assert.yaml

@@ -0,0 +1,6 @@
+apiVersion: kuttl.dev/v1beta1
+kind: TestAssert
+commands:
+- script: >
+    secret_data=$(oc -n $NAMESPACE get secret logging-compute-config-data -o jsonpath='{.data.10-telemetry\.conf}' | base64 -d) &&
+    echo "$secret_data" | grep -q 'template="RSYSLOG_SyslogProtocol23Format"'

test/kuttl/tests/logging/01-update-template.yaml

@@ -0,0 +1,8 @@
+apiVersion: telemetry.openstack.org/v1beta1
+kind: Logging
+metadata:
+  name: telemetry-kuttl-logging
+spec:
+    port: 10514
+    cloNamespace: telemetry-kuttl-tests
+    rsyslogTemplate: RSYSLOG_SyslogProtocol23Format