feat: add loglevel

Signed-off-by: Armando Ruocco <[email protected]>

Author: armru

api/v1/objectstore_types.go

@@ -41,8 +41,15 @@ type InstanceSidecarConfiguration struct {
 	// AdditionalContainerArgs is an optional list of command-line arguments
 	// to be passed to the sidecar container when it starts.
 	// The provided arguments are appended to the container’s default arguments.
+	// +kubebuilder:validation:XValidation:rule="self == null || !self.exists(a, a.startsWith('--log-level'))",reason="FieldValueForbidden",message="do not set --log-level in additionalContainerArgs; use spec.instanceSidecarConfiguration.logLevel"
 	// +optional
 	AdditionalContainerArgs []string `json:"additionalContainerArgs,omitempty"`
+
+	// The instances' log level, one of the following values: error, warning, info (default), debug, trace
+	// +kubebuilder:default:=info
+	// +kubebuilder:validation:Enum:=error;warning;info;debug;trace
+	// +optional
+	LogLevel string `json:"logLevel,omitempty"`
 }
 
 // ObjectStoreSpec defines the desired state of ObjectStore.

config/crd/bases/barmancloud.cnpg.io_objectstores.yaml

@@ -399,6 +399,11 @@ spec:
                     items:
                       type: string
                     type: array
+                    x-kubernetes-validations:
+                    - message: do not set --log-level in additionalContainerArgs;
+                        use spec.instanceSidecarConfiguration.logLevel
+                      reason: FieldValueForbidden
+                      rule: self == null || !self.exists(a, a.startsWith('--log-level'))
                   env:
                     description: The environment to be explicitly passed to the sidecar
                     items:
@@ -519,6 +524,17 @@ spec:
                       - name
                       type: object
                     type: array
+                  logLevel:
+                    default: info
+                    description: 'The instances'' log level, one of the following
+                      values: error, warning, info (default), debug, trace'
+                    enum:
+                    - error
+                    - warning
+                    - info
+                    - debug
+                    - trace
+                    type: string
                   resources:
                     description: Resources define cpu/memory requests and limits for
                       the sidecar that runs in the instance pods.

internal/cnpgi/operator/lifecycle.go

@@ -236,6 +236,19 @@ func (impl LifecycleImplementation) collectAdditionalInstanceArgs(
 	ctx context.Context,
 	pluginConfiguration *config.PluginConfiguration,
 ) ([]string, error) {
+	collectTypedAdditionalArgs := func(store *barmancloudv1.ObjectStore) []string {
+		if store == nil {
+			return nil
+		}
+
+		var args []string
+		if len(store.Spec.InstanceSidecarConfiguration.LogLevel) > 0 {
+			args = append(args, fmt.Sprintf("--log-level=%s", store.Spec.InstanceSidecarConfiguration.LogLevel))
+		}
+
+		return args
+	}
+
 	// Prefer the cluster object store (backup/archive). If not set, fallback to the recovery object store.
 	// If neither is configured, no additional args are provided.
 	if len(pluginConfiguration.BarmanObjectName) > 0 {
@@ -244,7 +257,11 @@ func (impl LifecycleImplementation) collectAdditionalInstanceArgs(
 			return nil, fmt.Errorf("while getting barman object store %s: %w",
 				pluginConfiguration.GetBarmanObjectKey().String(), err)
 		}
-		return barmanObjectStore.Spec.InstanceSidecarConfiguration.AdditionalContainerArgs, nil
+		args := append(
+			barmanObjectStore.Spec.InstanceSidecarConfiguration.AdditionalContainerArgs,
+			collectTypedAdditionalArgs(&barmanObjectStore)...,
+		)
+		return args, nil
 	}
 
 	if len(pluginConfiguration.RecoveryBarmanObjectName) > 0 {
@@ -253,7 +270,11 @@ func (impl LifecycleImplementation) collectAdditionalInstanceArgs(
 			return nil, fmt.Errorf("while getting recovery barman object store %s: %w",
 				pluginConfiguration.GetRecoveryBarmanObjectKey().String(), err)
 		}
-		return barmanObjectStore.Spec.InstanceSidecarConfiguration.AdditionalContainerArgs, nil
+		args := append(
+			barmanObjectStore.Spec.InstanceSidecarConfiguration.AdditionalContainerArgs,
+			collectTypedAdditionalArgs(&barmanObjectStore)...,
+		)
+		return args, nil
 	}
 
 	return nil, nil

internal/cnpgi/operator/lifecycle_test.go

@@ -313,6 +313,60 @@ var _ = Describe("LifecycleImplementation", func() {
 			Expect(err.Error()).To(ContainSubstring(ns + "/" + pc.RecoveryBarmanObjectName))
 			Expect(args).To(BeNil())
 		})
+
+		It("includes --log-level from primary object store when set", func(ctx SpecContext) {
+			ns := "test-ns"
+			cluster := &cnpgv1.Cluster{ObjectMeta: metav1.ObjectMeta{Name: "c", Namespace: ns}}
+			pc := &config.PluginConfiguration{
+				Cluster:          cluster,
+				BarmanObjectName: "primary-store",
+			}
+			store := &barmancloudv1.ObjectStore{
+				TypeMeta:   metav1.TypeMeta{Kind: "ObjectStore", APIVersion: barmancloudv1.GroupVersion.String()},
+				ObjectMeta: metav1.ObjectMeta{Name: pc.BarmanObjectName, Namespace: ns},
+				Spec: barmancloudv1.ObjectStoreSpec{
+					InstanceSidecarConfiguration: barmancloudv1.InstanceSidecarConfiguration{
+						AdditionalContainerArgs: []string{"--alpha"},
+						LogLevel:                "debug",
+					},
+				},
+			}
+			s := runtime.NewScheme()
+			_ = barmancloudv1.AddToScheme(s)
+			cli := fake.NewClientBuilder().WithScheme(s).WithRuntimeObjects(store).Build()
+
+			impl := LifecycleImplementation{Client: cli}
+			args, err := impl.collectAdditionalInstanceArgs(ctx, pc)
+			Expect(err).NotTo(HaveOccurred())
+			Expect(args).To(Equal([]string{"--alpha", "--log-level=debug"}))
+		})
+
+		It("includes --log-level from recovery object store when primary not set", func(ctx SpecContext) {
+			ns := "test-ns"
+			cluster := &cnpgv1.Cluster{ObjectMeta: metav1.ObjectMeta{Name: "c", Namespace: ns}}
+			pc := &config.PluginConfiguration{
+				Cluster:                  cluster,
+				BarmanObjectName:         "",
+				RecoveryBarmanObjectName: "reco-store",
+			}
+			store := &barmancloudv1.ObjectStore{
+				TypeMeta:   metav1.TypeMeta{Kind: "ObjectStore", APIVersion: barmancloudv1.GroupVersion.String()},
+				ObjectMeta: metav1.ObjectMeta{Name: pc.RecoveryBarmanObjectName, Namespace: ns},
+				Spec: barmancloudv1.ObjectStoreSpec{
+					InstanceSidecarConfiguration: barmancloudv1.InstanceSidecarConfiguration{
+						LogLevel: "info",
+					},
+				},
+			}
+			s := runtime.NewScheme()
+			_ = barmancloudv1.AddToScheme(s)
+			cli := fake.NewClientBuilder().WithScheme(s).WithRuntimeObjects(store).Build()
+
+			impl := LifecycleImplementation{Client: cli}
+			args, err := impl.collectAdditionalInstanceArgs(ctx, pc)
+			Expect(err).NotTo(HaveOccurred())
+			Expect(args).To(Equal([]string{"--log-level=info"}))
+		})
 	})
 })
 

manifest.yaml

@@ -398,6 +398,10 @@ spec:
                     items:
                       type: string
                     type: array
+                    x-kubernetes-validations:
+                    - message: do not set --log-level in additionalContainerArgs; use spec.instanceSidecarConfiguration.logLevel
+                      reason: FieldValueForbidden
+                      rule: self == null || !self.exists(a, a.startsWith('--log-level'))
                   env:
                     description: The environment to be explicitly passed to the sidecar
                     items:
@@ -518,6 +522,16 @@ spec:
                       - name
                       type: object
                     type: array
+                  logLevel:
+                    default: info
+                    description: "The instances' log level, one of the following values: error, warning, info (default), debug, trace"
+                    enum:
+                    - error
+                    - warning
+                    - info
+                    - debug
+                    - trace
+                    type: string
                   resources:
                     description: Resources define cpu/memory requests and limits for
                       the sidecar that runs in the instance pods.