fix: ensure restore configuration points to manager wal-restore (#68)

Signed-off-by: Armando Ruocco <[email protected]>
Signed-off-by: Leonardo Cecchi <[email protected]>
Signed-off-by: Francesco Canovai <[email protected]>
Co-authored-by: Leonardo Cecchi <[email protected]>
Co-authored-by: Francesco Canovai <[email protected]>

Author: 3 people

internal/cmd/instance/main.go

@@ -22,6 +22,7 @@ func NewCmd() *cobra.Command {
 				"cluster-name",
 				"pod-name",
 				"spool-directory",
+				"server-name",
 			}
 
 			for _, k := range requiredSettings {
@@ -40,6 +41,7 @@ func NewCmd() *cobra.Command {
 	_ = viper.BindEnv("pod-name", "POD_NAME")
 	_ = viper.BindEnv("pgdata", "PGDATA")
 	_ = viper.BindEnv("spool-directory", "SPOOL_DIRECTORY")
+	_ = viper.BindEnv("server-name", "SERVER_NAME")
 
 	return cmd
 }

internal/cmd/restore/main.go

@@ -23,6 +23,8 @@ func NewCmd() *cobra.Command {
 				"cluster-name",
 				"pod-name",
 				"spool-directory",
+				"barman-object-name",
+				"server-name",
 			}
 
 			for _, k := range requiredSettings {
@@ -40,6 +42,8 @@ func NewCmd() *cobra.Command {
 	_ = 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")
 
 	return cmd
 }

internal/cnpgi/instance/wal.go internal/cnpgi/common/wal.gointernal/cnpgi/instance/wal.go renamed to internal/cnpgi/common/wal.go

@@ -1,4 +1,4 @@
-package instance
+package common
 
 import (
 	"context"
@@ -19,12 +19,12 @@ import (
 	"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/common"
 	"github.com/cloudnative-pg/plugin-barman-cloud/internal/cnpgi/metadata"
 )
 
 // WALServiceImplementation is the implementation of the WAL Service
 type WALServiceImplementation struct {
+	ServerName       string
 	BarmanObjectKey  client.ObjectKey
 	ClusterObjectKey client.ObjectKey
 	Client           client.Client
@@ -73,16 +73,6 @@ func (w WALServiceImplementation) Archive(
 		return nil, err
 	}
 
-	// TODO: refactor this code elsewhere
-	serverName := cluster.Name
-	for _, plugin := range cluster.Spec.Plugins {
-		if plugin.IsEnabled() && plugin.Name == metadata.PluginName {
-			if pluginServerName, ok := plugin.Parameters["serverName"]; ok {
-				serverName = pluginServerName
-			}
-		}
-	}
-
 	var objectStore barmancloudv1.ObjectStore
 	if err := w.Client.Get(ctx, w.BarmanObjectKey, &objectStore); err != nil {
 		return nil, err
@@ -112,7 +102,7 @@ func (w WALServiceImplementation) Archive(
 		return nil, err
 	}
 
-	options, err := arch.BarmanCloudWalArchiveOptions(ctx, &objectStore.Spec.Configuration, serverName)
+	options, err := arch.BarmanCloudWalArchiveOptions(ctx, &objectStore.Spec.Configuration, w.ServerName)
 	if err != nil {
 		return nil, err
 	}
@@ -152,7 +142,7 @@ func (w WALServiceImplementation) Restore(
 
 	barmanConfiguration := &objectStore.Spec.Configuration
 
-	env := common.GetRestoreCABundleEnv(barmanConfiguration)
+	env := GetRestoreCABundleEnv(barmanConfiguration)
 	credentialsEnv, err := barmanCredentials.EnvSetBackupCloudCredentials(
 		ctx,
 		w.Client,
@@ -163,19 +153,9 @@ func (w WALServiceImplementation) Restore(
 	if err != nil {
 		return nil, fmt.Errorf("while getting recover credentials: %w", err)
 	}
-	env = common.MergeEnv(env, credentialsEnv)
-
-	// TODO: refactor this code elsewhere
-	serverName := cluster.Name
-	for _, plugin := range cluster.Spec.Plugins {
-		if plugin.IsEnabled() && plugin.Name == metadata.PluginName {
-			if pluginServerName, ok := plugin.Parameters["serverName"]; ok {
-				serverName = pluginServerName
-			}
-		}
-	}
+	env = MergeEnv(env, credentialsEnv)
 
-	options, err := barmanCommand.CloudWalRestoreOptions(ctx, barmanConfiguration, serverName)
+	options, err := barmanCommand.CloudWalRestoreOptions(ctx, barmanConfiguration, w.ServerName)
 	if err != nil {
 		return nil, fmt.Errorf("while getting barman-cloud-wal-restore options: %w", err)
 	}

internal/cnpgi/instance/wal_import.go internal/cnpgi/common/wal_import.gointernal/cnpgi/instance/wal_import.go renamed to internal/cnpgi/common/wal_import.go

@@ -14,7 +14,7 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
-package instance
+package common
 
 import (
 	"errors"

internal/cnpgi/instance/backup.go

@@ -31,6 +31,7 @@ type BackupServiceImplementation struct {
 	ClusterObjectKey client.ObjectKey
 	Client           client.Client
 	InstanceName     string
+	ServerName       string
 	backup.UnimplementedBackupServer
 }
 
@@ -111,21 +112,12 @@ func (b BackupServiceImplementation) Backup(
 		return nil, err
 	}
 
-	serverName := cluster.Name
-	for _, plugin := range cluster.Spec.Plugins {
-		if plugin.IsEnabled() && plugin.Name == metadata.PluginName {
-			if pluginServerName, ok := plugin.Parameters["serverName"]; ok {
-				serverName = pluginServerName
-			}
-		}
-	}
-
 	backupName := fmt.Sprintf("backup-%v", pgTime.ToCompactISO8601(time.Now()))
 
 	if err = backupCmd.Take(
 		ctx,
 		backupName,
-		serverName,
+		b.ServerName,
 		env,
 		barmanCloudExecutor{},
 		postgres.BackupTemporaryDirectory,
@@ -137,7 +129,7 @@ func (b BackupServiceImplementation) Backup(
 	executedBackupInfo, err := backupCmd.GetExecutedBackupInfo(
 		ctx,
 		backupName,
-		serverName,
+		b.ServerName,
 		barmanCloudExecutor{},
 		env)
 	if err != nil {

internal/cnpgi/instance/manager.go

@@ -81,6 +81,7 @@ func Start(ctx context.Context) error {
 			Name:      clusterName,
 		},
 		BarmanObjectKey: barmanObjectKey,
+		ServerName:      viper.GetString("server-name"),
 		InstanceName:    podName,
 		// TODO: improve
 		PGDataPath:     viper.GetString("pgdata"),

internal/cnpgi/instance/start.go

@@ -8,12 +8,15 @@ import (
 	"github.com/cloudnative-pg/cnpg-i/pkg/wal"
 	"google.golang.org/grpc"
 	"sigs.k8s.io/controller-runtime/pkg/client"
+
+	"github.com/cloudnative-pg/plugin-barman-cloud/internal/cnpgi/common"
 )
 
 // CNPGI is the implementation of the PostgreSQL sidecar
 type CNPGI struct {
 	Client           client.Client
 	BarmanObjectKey  client.ObjectKey
+	ServerName       string
 	ClusterObjectKey client.ObjectKey
 	PGDataPath       string
 	PGWALPath        string
@@ -26,9 +29,10 @@ type CNPGI struct {
 // Start starts the GRPC service
 func (c *CNPGI) Start(ctx context.Context) error {
 	enrich := func(server *grpc.Server) error {
-		wal.RegisterWALServer(server, WALServiceImplementation{
+		wal.RegisterWALServer(server, common.WALServiceImplementation{
 			BarmanObjectKey:  c.BarmanObjectKey,
 			ClusterObjectKey: c.ClusterObjectKey,
+			ServerName:       c.ServerName,
 			InstanceName:     c.InstanceName,
 			Client:           c.Client,
 			SpoolDirectory:   c.SpoolDirectory,
@@ -38,6 +42,7 @@ func (c *CNPGI) Start(ctx context.Context) error {
 		backup.RegisterBackupServer(server, BackupServiceImplementation{
 			Client:           c.Client,
 			BarmanObjectKey:  c.BarmanObjectKey,
+			ServerName:       c.ServerName,
 			ClusterObjectKey: c.ClusterObjectKey,
 			InstanceName:     c.InstanceName,
 		})

internal/cnpgi/operator/config/config.go

@@ -45,6 +45,7 @@ func (e *ConfigurationError) IsEmpty() bool {
 // PluginConfiguration is the configuration of the plugin
 type PluginConfiguration struct {
 	BarmanObjectName         string
+	ServerName               string
 	RecoveryBarmanObjectName string
 	RecoveryBarmanServerName string
 }
@@ -56,6 +57,15 @@ func NewFromCluster(cluster *cnpgv1.Cluster) *PluginConfiguration {
 		metadata.PluginName,
 	)
 
+	serverName := cluster.Name
+	for _, plugin := range cluster.Spec.Plugins {
+		if plugin.IsEnabled() && plugin.Name == metadata.PluginName {
+			if pluginServerName, ok := plugin.Parameters["serverName"]; ok {
+				serverName = pluginServerName
+			}
+		}
+	}
+
 	recoveryServerName := ""
 	recoveryBarmanObjectName := ""
 
@@ -70,6 +80,7 @@ func NewFromCluster(cluster *cnpgv1.Cluster) *PluginConfiguration {
 	result := &PluginConfiguration{
 		// used for the backup/archive
 		BarmanObjectName: helper.Parameters["barmanObjectName"],
+		ServerName:       serverName,
 		// used for restore/wal_restore
 		RecoveryBarmanServerName: recoveryServerName,
 		RecoveryBarmanObjectName: recoveryBarmanObjectName,

internal/cnpgi/operator/lifecycle.go

@@ -115,6 +115,13 @@ func reconcileJob(
 		return nil, nil
 	}
 
+	// Since we're recovering from an existing object store,
+	// we set our primary object store name to the recovery one.
+	// This won't be needed anymore when wal-restore will be able
+	// to check two object stores
+	pluginConfiguration.BarmanObjectName = pluginConfiguration.RecoveryBarmanObjectName
+	pluginConfiguration.ServerName = pluginConfiguration.RecoveryBarmanServerName
+
 	var job batchv1.Job
 	if err := decoder.DecodeObject(
 		request.GetObjectDefinition(),
@@ -175,10 +182,14 @@ func reconcilePod(
 
 	mutatedPod := pod.DeepCopy()
 
-	if err := reconcilePodSpec(pluginConfiguration, cluster, &mutatedPod.Spec, "postgres", corev1.Container{
-		Args: []string{"instance"},
-	}); err != nil {
-		return nil, fmt.Errorf("while reconciling pod spec for pod: %w", err)
+	if len(pluginConfiguration.BarmanObjectName) != 0 {
+		if err := reconcilePodSpec(pluginConfiguration, cluster, &mutatedPod.Spec, "postgres", corev1.Container{
+			Args: []string{"instance"},
+		}); err != nil {
+			return nil, fmt.Errorf("while reconciling pod spec for pod: %w", err)
+		}
+	} else {
+		contextLogger.Debug("No need to mutate instance with no backup & archiving configuration")
 	}
 
 	patch, err := object.CreatePatch(mutatedPod, pod)
@@ -212,6 +223,10 @@ func reconcilePodSpec(
 			Name:  "BARMAN_OBJECT_NAME",
 			Value: cfg.BarmanObjectName,
 		},
+		{
+			Name:  "SERVER_NAME",
+			Value: cfg.ServerName,
+		},
 		{
 			// TODO: should we really use this one?
 			// should we mount an emptyDir volume just for that?

internal/cnpgi/restore/identity.go

@@ -38,6 +38,13 @@ func (i IdentityImplementation) GetPluginCapabilities(
 					},
 				},
 			},
+			{
+				Type: &identity.PluginCapability_Service_{
+					Service: &identity.PluginCapability_Service{
+						Type: identity.PluginCapability_Service_TYPE_WAL_SERVICE,
+					},
+				},
+			},
 		},
 	}, nil
 }