feat: separate recovery object store from replica source

api/v1/objectstore_types.go

@@ -24,26 +24,11 @@ import (
 
 // InstanceSidecarConfiguration defines the configuration for the sidecar that runs in the instance pods.
 type InstanceSidecarConfiguration struct {
-	// The expiration time of the cache entries not managed by the informers. Expressed in seconds.
-	// +optional
-	// +kubebuilder:validation:Minimum=0
-	// +kubebuilder:validation:Maximum=3600
-	// +kubebuilder:default=180
-	CacheTTL *int `json:"cacheTTL,omitempty"`
-
 	// The environment to be explicitly passed to the sidecar
 	// +optional
 	Env []corev1.EnvVar `json:"env,omitempty"`
 }
 
-// GetCacheTTL returns the cache TTL value, defaulting to 180 seconds if not set.
-func (i InstanceSidecarConfiguration) GetCacheTTL() int {
-	if i.CacheTTL == nil {
-		return 180
-	}
-	return *i.CacheTTL
-}
-
 // ObjectStoreSpec defines the desired state of ObjectStore.
 type ObjectStoreSpec struct {
 	Configuration barmanapi.BarmanObjectStoreConfiguration `json:"configuration"`

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

@@ -382,13 +382,6 @@ spec:
                 description: InstanceSidecarConfiguration defines the configuration
                   for the sidecar that runs in the instance pods.
                 properties:
-                  cacheTTL:
-                    default: 180
-                    description: The expiration time of the cache entries not managed
-                      by the informers. Expressed in seconds.
-                    maximum: 3600
-                    minimum: 0
-                    type: integer
                   env:
                     description: The environment to be explicitly passed to the sidecar
                     items:

docs/examples/cluster-example.yaml

@@ -4,7 +4,7 @@ metadata:
   name: cluster-example
 spec:
   instances: 3
-  imagePullPolicy: IfNotPresent
+  imagePullPolicy: Always
   plugins:
   - name: barman-cloud.cloudnative-pg.io
     parameters:

go.mod

@@ -10,7 +10,7 @@ require (
 	github.com/cloudnative-pg/barman-cloud v0.0.0-20241105055149-ae6c2408bd14
 	github.com/cloudnative-pg/cloudnative-pg v1.24.1-0.20241113134512-8608232c2813
 	github.com/cloudnative-pg/cnpg-i v0.0.0-20241109002750-8abd359df734
-	github.com/cloudnative-pg/cnpg-i-machinery v0.0.0-20241129144432-bd94f16685d3
+	github.com/cloudnative-pg/cnpg-i-machinery v0.0.0-20241205093641-958e207b8afe
 	github.com/cloudnative-pg/machinery v0.0.0-20241105070525-042a028b767c
 	github.com/docker/docker v27.3.1+incompatible
 	github.com/onsi/ginkgo/v2 v2.21.0

go.sum

@@ -32,8 +32,8 @@ github.com/cloudnative-pg/cloudnative-pg v1.24.1-0.20241113134512-8608232c2813 h
 github.com/cloudnative-pg/cloudnative-pg v1.24.1-0.20241113134512-8608232c2813/go.mod h1:f4hObdRVoQtMmVtWqZ6VDZBrI6ok9Td/UMhojQ+EPmk=
 github.com/cloudnative-pg/cnpg-i v0.0.0-20241109002750-8abd359df734 h1:4jq/FUrlAKxu0Kw9PL5lj5Njq8pAnmUpP/kXKOrJAaE=
 github.com/cloudnative-pg/cnpg-i v0.0.0-20241109002750-8abd359df734/go.mod h1:3U7miYasKr2rYCQzrn/IvbSQc0OpYF8ieZt2FKG4nv0=
-github.com/cloudnative-pg/cnpg-i-machinery v0.0.0-20241129144432-bd94f16685d3 h1:hKTlmgyOq5ZS7t1eVa4SY1hH361gZ7VIb0an+BH9rJs=
-github.com/cloudnative-pg/cnpg-i-machinery v0.0.0-20241129144432-bd94f16685d3/go.mod h1:X6r1fRuUEIAv4+5SSBY2RmQ201K6GcptOXgnmaX/8tY=
+github.com/cloudnative-pg/cnpg-i-machinery v0.0.0-20241205093641-958e207b8afe h1:gUGqx4eTHreM0QWbszSx6wnbBw9Vavp5uYl4uA9fh1k=
+github.com/cloudnative-pg/cnpg-i-machinery v0.0.0-20241205093641-958e207b8afe/go.mod h1:X6r1fRuUEIAv4+5SSBY2RmQ201K6GcptOXgnmaX/8tY=
 github.com/cloudnative-pg/machinery v0.0.0-20241105070525-042a028b767c h1:t0RBU2gBiwJQ9XGeXlHPBYpsTscSKHgB5TfcWaiwanc=
 github.com/cloudnative-pg/machinery v0.0.0-20241105070525-042a028b767c/go.mod h1:uBHGRIk5rt07mO4zjIC1uvGBWTH6PqIiD1PfpvPGZKU=
 github.com/containerd/log v0.1.0 h1:TCJt7ioM2cr/tfR8GPbGf9/VRAX8D2B4PjzCpfX540I=

internal/cmd/instance/main.go

@@ -18,11 +18,8 @@ func NewCmd() *cobra.Command {
 		RunE: func(cmd *cobra.Command, _ []string) error {
 			requiredSettings := []string{
 				"namespace",
-				"barman-object-name",
-				"cluster-name",
 				"pod-name",
 				"spool-directory",
-				"server-name",
 			}
 
 			for _, k := range requiredSettings {
@@ -36,16 +33,9 @@ func NewCmd() *cobra.Command {
 	}
 
 	_ = viper.BindEnv("namespace", "NAMESPACE")
-	_ = viper.BindEnv("cluster-name", "CLUSTER_NAME")
 	_ = viper.BindEnv("pod-name", "POD_NAME")
 	_ = viper.BindEnv("pgdata", "PGDATA")
 	_ = viper.BindEnv("spool-directory", "SPOOL_DIRECTORY")
 
-	_ = viper.BindEnv("barman-object-name", "BARMAN_OBJECT_NAME")
-	_ = viper.BindEnv("server-name", "SERVER_NAME")
-
-	_ = viper.BindEnv("recovery-barman-object-name", "RECOVERY_BARMAN_OBJECT_NAME")
-	_ = viper.BindEnv("recovery-server-name", "RECOVERY_SERVER_NAME")
-
 	return cmd
 }

internal/cmd/restore/main.go

@@ -20,14 +20,8 @@ func NewCmd() *cobra.Command {
 		RunE: func(cmd *cobra.Command, _ []string) error {
 			requiredSettings := []string{
 				"namespace",
-				"cluster-name",
 				"pod-name",
 				"spool-directory",
-
-				// IMPORTANT: barman-object-name and server-name are not required
-				// to restore a cluster.
-				"recovery-barman-object-name",
-				"recovery-server-name",
 			}
 
 			for _, k := range requiredSettings {
@@ -41,16 +35,9 @@ func NewCmd() *cobra.Command {
 	}
 
 	_ = viper.BindEnv("namespace", "NAMESPACE")
-	_ = viper.BindEnv("cluster-name", "CLUSTER_NAME")
 	_ = viper.BindEnv("pod-name", "POD_NAME")
 	_ = viper.BindEnv("pgdata", "PGDATA")
 	_ = viper.BindEnv("spool-directory", "SPOOL_DIRECTORY")
 
-	_ = viper.BindEnv("barman-object-name", "BARMAN_OBJECT_NAME")
-	_ = viper.BindEnv("server-name", "SERVER_NAME")
-
-	_ = viper.BindEnv("recovery-barman-object-name", "RECOVERY_BARMAN_OBJECT_NAME")
-	_ = viper.BindEnv("recovery-server-name", "RECOVERY_SERVER_NAME")
-
 	return cmd
 }

internal/cnpgi/common/errors.go

@@ -0,0 +1,16 @@
+package common
+
+// walNotFoundError is raised when a WAL file has not been found in the object store
+type walNotFoundError struct{}
+
+func newWALNotFoundError() *walNotFoundError { return &walNotFoundError{} }
+
+// ShouldPrintStackTrace tells whether the sidecar log stream should contain the stack trace
+func (e walNotFoundError) ShouldPrintStackTrace() bool {
+	return false
+}
+
+// Error implements the error interface
+func (e walNotFoundError) Error() string {
+	return "WAL file not found"
+}

internal/cnpgi/common/wal.go

@@ -20,23 +20,17 @@ import (
 
 	barmancloudv1 "github.com/cloudnative-pg/plugin-barman-cloud/api/v1"
 	"github.com/cloudnative-pg/plugin-barman-cloud/internal/cnpgi/metadata"
+	"github.com/cloudnative-pg/plugin-barman-cloud/internal/cnpgi/operator/config"
 )
 
 // WALServiceImplementation is the implementation of the WAL Service
 type WALServiceImplementation struct {
 	wal.UnimplementedWALServer
-	ClusterObjectKey client.ObjectKey
-	Client           client.Client
-	InstanceName     string
-	SpoolDirectory   string
-	PGDataPath       string
-	PGWALPath        string
-
-	BarmanObjectKey client.ObjectKey
-	ServerName      string
-
-	RecoveryBarmanObjectKey client.ObjectKey
-	RecoveryServerName      string
+	Client         client.Client
+	InstanceName   string
+	SpoolDirectory string
+	PGDataPath     string
+	PGWALPath      string
 }
 
 // GetCapabilities implements the WALService interface
@@ -72,13 +66,13 @@ func (w WALServiceImplementation) Archive(
 	contextLogger := log.FromContext(ctx)
 	contextLogger.Debug("starting wal archive")
 
-	var cluster cnpgv1.Cluster
-	if err := w.Client.Get(ctx, w.ClusterObjectKey, &cluster); err != nil {
+	configuration, err := config.NewFromClusterJSON(request.ClusterDefinition)
+	if err != nil {
 		return nil, err
 	}
 
 	var objectStore barmancloudv1.ObjectStore
-	if err := w.Client.Get(ctx, w.BarmanObjectKey, &objectStore); err != nil {
+	if err := w.Client.Get(ctx, configuration.GetBarmanObjectKey(), &objectStore); err != nil {
 		return nil, err
 	}
 
@@ -106,7 +100,7 @@ func (w WALServiceImplementation) Archive(
 		return nil, err
 	}
 
-	options, err := arch.BarmanCloudWalArchiveOptions(ctx, &objectStore.Spec.Configuration, w.ServerName)
+	options, err := arch.BarmanCloudWalArchiveOptions(ctx, &objectStore.Spec.Configuration, configuration.ServerName)
 	if err != nil {
 		return nil, err
 	}
@@ -127,43 +121,49 @@ func (w WALServiceImplementation) Restore(
 	ctx context.Context,
 	request *wal.WALRestoreRequest,
 ) (*wal.WALRestoreResult, error) {
-	// TODO: build full paths
+	contextLogger := log.FromContext(ctx)
+
 	walName := request.GetSourceWalName()
 	destinationPath := request.GetDestinationFileName()
 
-	var cluster cnpgv1.Cluster
-	if err := w.Client.Get(ctx, w.ClusterObjectKey, &cluster); err != nil {
+	configuration, err := config.NewFromClusterJSON(request.ClusterDefinition)
+	if err != nil {
 		return nil, err
 	}
 
 	var objectStore barmancloudv1.ObjectStore
 	var serverName string
 
 	switch {
-	case cluster.IsReplica() && cluster.Status.CurrentPrimary == w.InstanceName:
-		// Designated primary on replica cluster, using recovery object store
-		serverName = w.RecoveryServerName
-		if err := w.Client.Get(ctx, w.RecoveryBarmanObjectKey, &objectStore); err != nil {
+	case configuration.Cluster.IsReplica() && configuration.Cluster.Status.CurrentPrimary == w.InstanceName:
+		// Designated primary on replica cluster, using replica source object store
+		serverName = configuration.ReplicaSourceServerName
+		if err := w.Client.Get(ctx, configuration.GetReplicaSourceBarmanObjectKey(), &objectStore); err != nil {
 			return nil, err
 		}
 
-	case cluster.Status.CurrentPrimary == "":
+	case configuration.Cluster.Status.CurrentPrimary == "":
 		// Recovery from object store, using recovery object store
-		serverName = w.RecoveryServerName
-		if err := w.Client.Get(ctx, w.RecoveryBarmanObjectKey, &objectStore); err != nil {
+		serverName = configuration.RecoveryServerName
+		if err := w.Client.Get(ctx, configuration.GetRecoveryBarmanObjectKey(), &objectStore); err != nil {
 			return nil, err
 		}
 
 	default:
 		// Using cluster object store
-		serverName = w.ServerName
-		if err := w.Client.Get(ctx, w.BarmanObjectKey, &objectStore); err != nil {
+		serverName = configuration.ServerName
+		if err := w.Client.Get(ctx, configuration.GetBarmanObjectKey(), &objectStore); err != nil {
 			return nil, err
 		}
 	}
 
+	contextLogger.Info(
+		"Restoring WAL file",
+		"objectStore", objectStore.Name,
+		"serverName", serverName,
+		"walName", walName)
 	return &wal.WALRestoreResult{}, w.restoreFromBarmanObjectStore(
-		ctx, &cluster, &objectStore, serverName, walName, destinationPath)
+		ctx, configuration.Cluster, &objectStore, serverName, walName, destinationPath)
 }
 
 func (w WALServiceImplementation) restoreFromBarmanObjectStore(
@@ -246,6 +246,10 @@ func (w WALServiceImplementation) restoreFromBarmanObjectStore(
 	// is the one that PostgreSQL has requested to restore.
 	// The failure has already been logged in walRestorer.RestoreList method
 	if walStatus[0].Err != nil {
+		if errors.Is(walStatus[0].Err, barmanRestorer.ErrWALNotFound) {
+			return newWALNotFoundError()
+		}
+
 		return walStatus[0].Err
 	}
 

internal/cnpgi/instance/backup.go

@@ -10,7 +10,6 @@ import (
 	barmanBackup "github.com/cloudnative-pg/barman-cloud/pkg/backup"
 	barmanCapabilities "github.com/cloudnative-pg/barman-cloud/pkg/capabilities"
 	barmanCredentials "github.com/cloudnative-pg/barman-cloud/pkg/credentials"
-	cnpgv1 "github.com/cloudnative-pg/cloudnative-pg/api/v1"
 	"github.com/cloudnative-pg/cloudnative-pg/pkg/postgres"
 	"github.com/cloudnative-pg/cnpg-i/pkg/backup"
 	"github.com/cloudnative-pg/machinery/pkg/fileutils"
@@ -22,16 +21,14 @@ import (
 	barmancloudv1 "github.com/cloudnative-pg/plugin-barman-cloud/api/v1"
 	"github.com/cloudnative-pg/plugin-barman-cloud/internal/cnpgi/common"
 	"github.com/cloudnative-pg/plugin-barman-cloud/internal/cnpgi/metadata"
+	"github.com/cloudnative-pg/plugin-barman-cloud/internal/cnpgi/operator/config"
 )
 
 // BackupServiceImplementation is the implementation
 // of the Backup CNPG capability
 type BackupServiceImplementation struct {
-	BarmanObjectKey  client.ObjectKey
-	ClusterObjectKey client.ObjectKey
-	Client           client.Client
-	InstanceName     string
-	ServerName       string
+	Client       client.Client
+	InstanceName string
 	backup.UnimplementedBackupServer
 }
 
@@ -65,20 +62,20 @@ func (b BackupServiceImplementation) GetCapabilities(
 // Backup implements the Backup interface
 func (b BackupServiceImplementation) Backup(
 	ctx context.Context,
-	_ *backup.BackupRequest,
+	request *backup.BackupRequest,
 ) (*backup.BackupResult, error) {
 	contextLogger := log.FromContext(ctx)
 
 	contextLogger.Info("Starting backup")
 
-	var cluster cnpgv1.Cluster
-	if err := b.Client.Get(ctx, b.ClusterObjectKey, &cluster); err != nil {
+	configuration, err := config.NewFromClusterJSON(request.ClusterDefinition)
+	if err != nil {
 		return nil, err
 	}
 
 	var objectStore barmancloudv1.ObjectStore
-	if err := b.Client.Get(ctx, b.BarmanObjectKey, &objectStore); err != nil {
-		contextLogger.Error(err, "while getting object store", "key", b.BarmanObjectKey)
+	if err := b.Client.Get(ctx, configuration.GetBarmanObjectKey(), &objectStore); err != nil {
+		contextLogger.Error(err, "while getting object store", "key", configuration.GetRecoveryBarmanObjectKey())
 		return nil, err
 	}
 
@@ -117,7 +114,7 @@ func (b BackupServiceImplementation) Backup(
 	if err = backupCmd.Take(
 		ctx,
 		backupName,
-		b.ServerName,
+		configuration.ServerName,
 		env,
 		barmanCloudExecutor{},
 		postgres.BackupTemporaryDirectory,
@@ -129,7 +126,7 @@ func (b BackupServiceImplementation) Backup(
 	executedBackupInfo, err := backupCmd.GetExecutedBackupInfo(
 		ctx,
 		backupName,
-		b.ServerName,
+		configuration.ServerName,
 		barmanCloudExecutor{},
 		env)
 	if err != nil {

internal/cnpgi/instance/identity.go

@@ -2,20 +2,17 @@ package instance
 
 import (
 	"context"
-	"fmt"
 
 	"github.com/cloudnative-pg/cnpg-i/pkg/identity"
 	"sigs.k8s.io/controller-runtime/pkg/client"
 
-	barmancloudv1 "github.com/cloudnative-pg/plugin-barman-cloud/api/v1"
 	"github.com/cloudnative-pg/plugin-barman-cloud/internal/cnpgi/metadata"
 )
 
 // IdentityImplementation implements IdentityServer
 type IdentityImplementation struct {
 	identity.UnimplementedIdentityServer
-	BarmanObjectKey client.ObjectKey
-	Client          client.Client
+	Client client.Client
 }
 
 // GetPluginMetadata implements IdentityServer
@@ -53,14 +50,9 @@ func (i IdentityImplementation) GetPluginCapabilities(
 
 // Probe implements IdentityServer
 func (i IdentityImplementation) Probe(
-	ctx context.Context,
+	_ context.Context,
 	_ *identity.ProbeRequest,
 ) (*identity.ProbeResponse, error) {
-	var obj barmancloudv1.ObjectStore
-	if err := i.Client.Get(ctx, i.BarmanObjectKey, &obj); err != nil {
-		return nil, fmt.Errorf("while fetching object store %s: %w", i.BarmanObjectKey.Name, err)
-	}
-
 	return &identity.ProbeResponse{
 		Ready: true,
 	}, nil