Deprecate old LB options, fix endpoint sync. (#287)

* Depreate old LB options, fix endpoint sync.

- deprecate useLoadBalancer, replicaLoadBalancer from the manifest
  and enable_load_balancer from the operator configuration. The old
  operator configuration options become no-op with this commit. For
  the old manifest options, `useLoadBalancer` and `replicaLoadBalancer`
  are still consulted,  but only in the absense of the new ones
  (enableMasterLoadBalancer and enableReplicaLoadBalancer).

- Make sure the endpoint being created during the sync receives proper
  addresses subset. This is more critical for the replicas, as for the
  masters Patroni will normally re-create the endpoint before the
  operator.

- Avoid creating the replica endpoint, since it will be created automatically
  by the corresponding service.
- Update the README and unit tests.

Code review by @mgomezch and @zerg-junior

pkg/controller/controller.go

@@ -111,6 +111,7 @@ func (c *Controller) initOperatorConfig() {
 	}
 
 	c.opConfig = config.NewFromMap(configMapData)
+	c.warnOnDeprecatedOperatorParameters()
 
 	scalyrAPIKey := os.Getenv("SCALYR_API_KEY")
 	if scalyrAPIKey != "" {
@@ -119,6 +120,14 @@ func (c *Controller) initOperatorConfig() {
 
 }
 
+// warningOnDeprecatedParameters emits warnings upon finding deprecated parmaters
+func (c *Controller) warnOnDeprecatedOperatorParameters() {
+	if c.opConfig.EnableLoadBalancer != nil {
+		c.logger.Warningf("Operator configuration parameter 'enable_load_balancer' is deprecated and takes no effect. " +
+			"Consider using the 'enable_master_load_balancer' or 'enable_replica_load_balancer' instead.")
+	}
+}
+
 func (c *Controller) initPodServiceAccount() {
 
 	if c.opConfig.PodServiceAccountDefinition == "" {

pkg/controller/postgresql.go

@@ -166,6 +166,17 @@ func (c *Controller) processEvent(event spec.ClusterEvent) {
 
 	defer c.curWorkerCluster.Store(event.WorkerID, nil)
 
+	if event.EventType == spec.EventAdd || event.EventType == spec.EventUpdate || event.EventType == spec.EventSync {
+		// handle deprecated parameters by possibly assigning their values to the new ones.
+		if event.OldSpec != nil {
+			c.mergeDeprecatedPostgreSQLSpecParameters(&event.OldSpec.Spec)
+		}
+		if event.NewSpec != nil {
+			c.mergeDeprecatedPostgreSQLSpecParameters(&event.NewSpec.Spec)
+		}
+		c.warnOnDeprecatedPostgreSQLSpecParameters(&event.NewSpec.Spec)
+	}
+
 	switch event.EventType {
 	case spec.EventAdd:
 		if clusterFound {
@@ -287,6 +298,46 @@ func (c *Controller) processClusterEventsQueue(idx int, stopCh <-chan struct{},
 	}
 }
 
+func (c *Controller) warnOnDeprecatedPostgreSQLSpecParameters(spec *spec.PostgresSpec) {
+
+	deprecate := func(deprecated, replacement string) {
+		c.logger.Warningf("Parameter %q is deprecated. Consider setting %q instead", deprecated, replacement)
+	}
+
+	noeffect := func(param string, explanation string) {
+		c.logger.Warningf("Parameter %q takes no effect. %s", param, explanation)
+	}
+
+	if spec.UseLoadBalancer != nil {
+		deprecate("useLoadBalancer", "enableMasterLoadBalancer")
+	}
+	if spec.ReplicaLoadBalancer != nil {
+		deprecate("replicaLoadBalancer", "enableReplicaLoadBalancer")
+	}
+
+	if len(spec.MaintenanceWindows) > 0 {
+		noeffect("maintenanceWindows", "Not implemented.")
+	}
+}
+
+func (c *Controller) mergeDeprecatedPostgreSQLSpecParameters(spec *spec.PostgresSpec) *spec.PostgresSpec {
+	if spec.UseLoadBalancer != nil || spec.ReplicaLoadBalancer != nil {
+		if spec.EnableReplicaLoadBalancer != nil || spec.EnableMasterLoadBalancer != nil {
+			c.logger.Warnf("Both old and new load balancer options are present, ignoring old ones")
+		} else {
+			if spec.UseLoadBalancer != nil {
+				spec.EnableMasterLoadBalancer = new(bool)
+				*spec.EnableMasterLoadBalancer = *spec.UseLoadBalancer
+			}
+			if spec.ReplicaLoadBalancer != nil {
+				spec.EnableReplicaLoadBalancer = new(bool)
+				*spec.EnableReplicaLoadBalancer = *spec.ReplicaLoadBalancer
+			}
+		}
+	}
+	return spec
+}
+
 func (c *Controller) queueClusterEvent(old, new *spec.Postgresql, eventType spec.EventType) {
 	var (
 		uid          types.UID

pkg/controller/postgresql_test.go

@@ -0,0 +1,43 @@
+package controller
+
+import (
+	"github.com/zalando-incubator/postgres-operator/pkg/spec"
+	"reflect"
+	"testing"
+)
+
+var (
+	True  bool = true
+	False bool = false
+)
+
+func TestMergeDeprecatedPostgreSQLSpecParameters(t *testing.T) {
+	c := NewController(&spec.ControllerConfig{})
+
+	tests := []struct {
+		name  string
+		in    *spec.PostgresSpec
+		out   *spec.PostgresSpec
+		error string
+	}{
+		{
+			"Check that old parameters propagate values to the new ones",
+			&spec.PostgresSpec{UseLoadBalancer: &True, ReplicaLoadBalancer: &True},
+			&spec.PostgresSpec{UseLoadBalancer: &True, ReplicaLoadBalancer: &True,
+				EnableMasterLoadBalancer: &True, EnableReplicaLoadBalancer: &True},
+			"New parameters should be set from the values of old ones",
+		},
+		{
+			"Check that new parameters are not set when both old and new ones are present",
+			&spec.PostgresSpec{UseLoadBalancer: &True, EnableReplicaLoadBalancer: &True},
+			&spec.PostgresSpec{UseLoadBalancer: &True, EnableReplicaLoadBalancer: &True},
+			"New parameters should remain unchanged when both old and new are present",
+		},
+	}
+	for _, tt := range tests {
+		result := c.mergeDeprecatedPostgreSQLSpecParameters(tt.in)
+		if !reflect.DeepEqual(result, tt.out) {
+			t.Errorf("%s: %v", tt.name, tt.error)
+		}
+	}
+}