ConfigCheck override on the aggregator level

Signed-off-by: Peter Wilcsinszky <[email protected]>
kube-logging · May 27, 2024 · a7a1b66 · a7a1b66
1 parent c101a08
commit a7a1b66
Show file tree

Hide file tree

Showing 16 changed files with 134 additions and 13 deletions.
diff --git a/charts/logging-operator/crds/logging.banzaicloud.io_fluentdconfigs.yaml b/charts/logging-operator/crds/logging.banzaicloud.io_fluentdconfigs.yaml
@@ -856,6 +856,17 @@ spec:
                 type: object
               compressConfigFile:
                 type: boolean
+              configCheck:
+                properties:
+                  labels:
+                    additionalProperties:
+                      type: string
+                    type: object
+                  strategy:
+                    type: string
+                  timeoutSeconds:
+                    type: integer
+                type: object
               configCheckAnnotations:
                 additionalProperties:
                   type: string

diff --git a/charts/logging-operator/crds/logging.banzaicloud.io_loggings.yaml b/charts/logging-operator/crds/logging.banzaicloud.io_loggings.yaml
@@ -4199,6 +4199,17 @@ spec:
                     type: object
                   compressConfigFile:
                     type: boolean
+                  configCheck:
+                    properties:
+                      labels:
+                        additionalProperties:
+                          type: string
+                        type: object
+                      strategy:
+                        type: string
+                      timeoutSeconds:
+                        type: integer
+                    type: object
                   configCheckAnnotations:
                     additionalProperties:
                       type: string
@@ -12044,6 +12055,17 @@ spec:
                             type: string
                         type: object
                     type: object
+                  configCheck:
+                    properties:
+                      labels:
+                        additionalProperties:
+                          type: string
+                        type: object
+                      strategy:
+                        type: string
+                      timeoutSeconds:
+                        type: integer
+                    type: object
                   configCheckPod:
                     properties:
                       activeDeadlineSeconds:

diff --git a/charts/logging-operator/crds/logging.banzaicloud.io_syslogngconfigs.yaml b/charts/logging-operator/crds/logging.banzaicloud.io_syslogngconfigs.yaml
@@ -335,6 +335,17 @@ spec:
                         type: string
                     type: object
                 type: object
+              configCheck:
+                properties:
+                  labels:
+                    additionalProperties:
+                      type: string
+                    type: object
+                  strategy:
+                    type: string
+                  timeoutSeconds:
+                    type: integer
+                type: object
               configCheckPod:
                 properties:
                   activeDeadlineSeconds:

diff --git a/config/crd/bases/logging.banzaicloud.io_fluentdconfigs.yaml b/config/crd/bases/logging.banzaicloud.io_fluentdconfigs.yaml
@@ -856,6 +856,17 @@ spec:
                 type: object
               compressConfigFile:
                 type: boolean
+              configCheck:
+                properties:
+                  labels:
+                    additionalProperties:
+                      type: string
+                    type: object
+                  strategy:
+                    type: string
+                  timeoutSeconds:
+                    type: integer
+                type: object
               configCheckAnnotations:
                 additionalProperties:
                   type: string

diff --git a/config/crd/bases/logging.banzaicloud.io_loggings.yaml b/config/crd/bases/logging.banzaicloud.io_loggings.yaml
@@ -4199,6 +4199,17 @@ spec:
                     type: object
                   compressConfigFile:
                     type: boolean
+                  configCheck:
+                    properties:
+                      labels:
+                        additionalProperties:
+                          type: string
+                        type: object
+                      strategy:
+                        type: string
+                      timeoutSeconds:
+                        type: integer
+                    type: object
                   configCheckAnnotations:
                     additionalProperties:
                       type: string
@@ -12044,6 +12055,17 @@ spec:
                             type: string
                         type: object
                     type: object
+                  configCheck:
+                    properties:
+                      labels:
+                        additionalProperties:
+                          type: string
+                        type: object
+                      strategy:
+                        type: string
+                      timeoutSeconds:
+                        type: integer
+                    type: object
                   configCheckPod:
                     properties:
                       activeDeadlineSeconds:

diff --git a/config/crd/bases/logging.banzaicloud.io_syslogngconfigs.yaml b/config/crd/bases/logging.banzaicloud.io_syslogngconfigs.yaml
@@ -335,6 +335,17 @@ spec:
                         type: string
                     type: object
                 type: object
+              configCheck:
+                properties:
+                  labels:
+                    additionalProperties:
+                      type: string
+                    type: object
+                  strategy:
+                    type: string
+                  timeoutSeconds:
+                    type: integer
+                type: object
               configCheckPod:
                 properties:
                   activeDeadlineSeconds:

diff --git a/config/samples/configcheck-timeout.yaml b/config/samples/configcheck-timeout.yaml
@@ -3,10 +3,9 @@ kind: Logging
 metadata:
   name: all-to-file
 spec:
-  configCheck:
-    strategy: StartWithTimeout
-    timeoutSeconds: 5
-  fluentd: {}
+  fluentd:
+    configCheck:
+      strategy: StartWithTimeout
   controlNamespace: default
 ---
 apiVersion: logging.banzaicloud.io/v1beta1

diff --git a/controllers/logging/logging_controller.go b/controllers/logging/logging_controller.go
@@ -185,6 +185,7 @@ func (r *LoggingReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ct
 
 	fluentdExternal, fluentdSpec := loggingResources.GetFluentd()
 	if fluentdSpec != nil {
+		logging.AggregatorLevelConfigCheck(fluentdSpec.ConfigCheck)
 		fluentdConfig, secretList, err := r.clusterConfigurationFluentd(loggingResources)
 		if err != nil {
 			// TODO: move config generation into Fluentd reconciler
@@ -203,6 +204,7 @@ func (r *LoggingReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ct
 
 	syslogNGExternal, syslogNGSpec := loggingResources.GetSyslogNGSpec()
 	if syslogNGSpec != nil {
+		logging.AggregatorLevelConfigCheck(syslogNGSPec.ConfigCheck)
 		syslogNGConfig, secretList, err := r.clusterConfigurationSyslogNG(loggingResources)
 		if err != nil {
 			// TODO: move config generation into Syslog-NG reconciler

diff --git a/docs/configuration/crds/v1beta1/fluentd_types.md b/docs/configuration/crds/v1beta1/fluentd_types.md
@@ -34,6 +34,11 @@ BufferStorageVolume is by default configured as PVC using FluentdPvcSpec [volume
 ### compressConfigFile (bool, optional) {#fluentdspec-compressconfigfile}
 
 
+### configCheck (*ConfigCheck, optional) {#fluentdspec-configcheck}
+
+Overrides the default logging level configCheck setup This field is not used directly, just copied over the field in the logging resource if defined 
+
+
 ### configCheckAnnotations (map[string]string, optional) {#fluentdspec-configcheckannotations}
 
 

diff --git a/docs/configuration/crds/v1beta1/logging_types.md b/docs/configuration/crds/v1beta1/logging_types.md
@@ -21,7 +21,7 @@ Default: "cluster.local."
 
 ### configCheck (ConfigCheck, optional) {#loggingspec-configcheck}
 
-ConfigCheck settings that apply to both fluentd and syslog-ng 
+ConfigCheck settings that apply to both fluentd or syslog-ng Can be overridden on the fluentd / syslog-ng level 
 
 
 ### controlNamespace (string, required) {#loggingspec-controlnamespace}

diff --git a/docs/configuration/crds/v1beta1/syslogng_types.md b/docs/configuration/crds/v1beta1/syslogng_types.md
@@ -14,6 +14,11 @@ SyslogNGSpec defines the desired state of SyslogNG
 ### bufferVolumeMetricsService (*typeoverride.Service, optional) {#syslogngspec-buffervolumemetricsservice}
 
 
+### configCheck (*ConfigCheck, optional) {#syslogngspec-configcheck}
+
+Overrides the default logging level configCheck setup This field is not used directly, just copied over the field in the logging resource if defined 
+
+
 ### configCheckPod (*typeoverride.PodSpec, optional) {#syslogngspec-configcheckpod}
 
 

diff --git a/pkg/resources/model/resources.go b/pkg/resources/model/resources.go
@@ -61,12 +61,10 @@ func (l LoggingResources) getSyslogNG() *v1beta1.SyslogNGConfig {
 }
 
 func (l LoggingResources) GetSyslogNGSpec() (*v1beta1.SyslogNGConfig, *v1beta1.SyslogNGSpec) {
-
 	if detachedSyslogNG := l.getSyslogNG(); detachedSyslogNG != nil {
 		return detachedSyslogNG, &detachedSyslogNG.Spec
 	}
 	return nil, l.Logging.Spec.SyslogNGSpec
-
 }
 
 type SyslogNGLoggingResources struct {

diff --git a/pkg/sdk/logging/api/v1beta1/fluentd_types.go b/pkg/sdk/logging/api/v1beta1/fluentd_types.go
@@ -114,7 +114,8 @@ type FluentdSpec struct {
 	// Configure sidecar container in Fluentd pods, for example: [https://github.com/kube-logging/logging-operator/config/samples/logging_logging_fluentd_sidecars.yaml](https://github.com/kube-logging/logging-operator/config/samples/logging_logging_fluentd_sidecars.yaml).
 	SidecarContainers []corev1.Container `json:"sidecarContainers,omitempty"`
 	// Overrides the default logging level configCheck setup
-	ConfigCheck ConfigCheck `json:"configCheck,omitempty"`
+	// This field is not used directly, just copied over the field in the logging resource if defined
+	ConfigCheck *ConfigCheck `json:"configCheck,omitempty"`
 }
 
 // +kubebuilder:object:generate=true

diff --git a/pkg/sdk/logging/api/v1beta1/logging_types.go b/pkg/sdk/logging/api/v1beta1/logging_types.go
@@ -47,7 +47,8 @@ type LoggingSpec struct {
 	SkipInvalidResources bool `json:"skipInvalidResources,omitempty"`
 	// Override generated config. This is a *raw* configuration string for troubleshooting purposes.
 	FlowConfigOverride string `json:"flowConfigOverride,omitempty"`
-	// ConfigCheck settings that apply to both fluentd and syslog-ng
+	// ConfigCheck settings that apply to both fluentd or syslog-ng
+	// Can be overridden on the fluentd / syslog-ng level
 	ConfigCheck ConfigCheck `json:"configCheck,omitempty"`
 	// FluentbitAgent daemonset configuration.
 	// Deprecated, will be removed with next major version
@@ -198,16 +199,27 @@ func (l *Logging) SetDefaults() error {
 			return err
 		}
 	}
-	if l.Spec.ConfigCheck.TimeoutSeconds == 0 {
-		l.Spec.ConfigCheck.TimeoutSeconds = 10
-	}
+	l.configCheckDefaults()
 	if len(l.Status.SyslogNGConfigName) == 0 {
 		l.Spec.SyslogNGSpec.SetDefaults()
 	}
 
 	return nil
 }
 
+func (l *Logging) AggregatorLevelConfigCheck(check *ConfigCheck) {
+	if check != nil {
+		l.Spec.ConfigCheck = *check
+		l.configCheckDefaults()
+	}
+}
+
+func (l *Logging) configCheckDefaults() {
+	if l.Spec.ConfigCheck.TimeoutSeconds == 0 {
+		l.Spec.ConfigCheck.TimeoutSeconds = 10
+	}
+}
+
 func (logging *Logging) WatchAllNamespaces() bool {
 	watchNamespaces := logging.Spec.WatchNamespaces
 	nsLabelSelector := logging.Spec.WatchNamespaceSelector

diff --git a/pkg/sdk/logging/api/v1beta1/syslogng_types.go b/pkg/sdk/logging/api/v1beta1/syslogng_types.go
@@ -59,7 +59,8 @@ type SyslogNGSpec struct {
 	// Create [custom log metrics for sources and outputs]({{< relref "/docs/examples/custom-syslog-ng-metrics.md" >}}).
 	SourceMetrics []filter.MetricsProbe `json:"sourceMetrics,omitempty"`
 	// Overrides the default logging level configCheck setup
-	ConfigCheck ConfigCheck `json:"configCheck,omitempty"`
+	// This field is not used directly, just copied over the field in the logging resource if defined
+	ConfigCheck *ConfigCheck `json:"configCheck,omitempty"`
 }
 
 //

diff --git a/pkg/sdk/logging/api/v1beta1/zz_generated.deepcopy.go b/pkg/sdk/logging/api/v1beta1/zz_generated.deepcopy.go