Defines registration and encumbrance PGO-217

Author: Anthony Landreth

config/crd/bases/postgres-operator.crunchydata.com_postgresclusters.yaml

@@ -15424,13 +15424,24 @@ spec:
                         type: integer
                     type: object
                 type: object
+              registrationRequired:
+                description: Version information for installations with a registration
+                  requirement.
+                properties:
+                  pgoVersion:
+                    type: string
+                type: object
               startupInstance:
                 description: The instance that should be started first when bootstrapping
                   and/or starting a PostgresCluster.
                 type: string
               startupInstanceSet:
                 description: The instance set associated with the startupInstance
                 type: string
+              tokenRequired:
+                description: Signals the need for a token to be applied when registration
+                  is required.
+                type: string
               userInterface:
                 description: Current state of the PostgreSQL user interface.
                 properties:

go.mod

@@ -20,6 +20,7 @@ require (
 	go.opentelemetry.io/otel/sdk v1.2.0
 	go.opentelemetry.io/otel/trace v1.2.0
 	golang.org/x/crypto v0.11.0
+	golang.org/x/mod v0.8.0
 	gotest.tools/v3 v3.1.0
 	k8s.io/api v0.24.2
 	k8s.io/apimachinery v0.24.2

go.sum

@@ -597,6 +597,8 @@ golang.org/x/mod v0.4.0/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA=
 golang.org/x/mod v0.4.1/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA=
 golang.org/x/mod v0.4.2/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA=
 golang.org/x/mod v0.6.0-dev.0.20220106191415-9b9b3d81d5e3/go.mod h1:3p9vT2HGsQu2K1YbXdKPJLVgG5VJdoTa1poYQBtP1AY=
+golang.org/x/mod v0.8.0 h1:LUYupSeNrTNCGzR/hVBk2NHZO4hXcVaW1k4Qx7rjPx8=
+golang.org/x/mod v0.8.0/go.mod h1:iBbtSCu2XBx23ZKBPSOrRkjjQPZFPuis4dIYUhu/chs=
 golang.org/x/net v0.0.0-20180724234803-3673e40ba225/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4=
 golang.org/x/net v0.0.0-20180826012351-8a410e7b638d/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4=
 golang.org/x/net v0.0.0-20180906233101-161cd47e91fd/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4=

internal/config/config.go

@@ -30,6 +30,15 @@ func defaultFromEnv(value, key string) string {
 	return value
 }
 
+func RegistrationRequired() bool {
+	return os.Getenv("REGISTRATION_REQUIRED") == "true"
+}
+
+// Get the version of CPK that applied the first RegistrationRequired status to this cluster.
+func RegistrationRequiredBy(cluster *v1beta1.PostgresCluster) string {
+	return cluster.Status.RegistrationRequired.PGOVersion
+}
+
 // Red Hat Marketplace requires operators to use environment variables be used
 // for any image other than the operator itself. Those variables must start with
 // "RELATED_IMAGE_" so that OSBS can transform their tag values into digests

internal/controller/postgrescluster/controller.go

@@ -192,7 +192,7 @@ func (r *Reconciler) Reconcile(
 		err                      error
 	)
 
-	// Define the function for the updating the PostgresCluster status. Returns any error that
+	// Define a function for updating PostgresCluster status. Returns any error that
 	// occurs while attempting to patch the status, while otherwise simply returning the
 	// Result and error variables that are populated while reconciling the PostgresCluster.
 	patchClusterStatus := func() (reconcile.Result, error) {
@@ -209,6 +209,21 @@ func (r *Reconciler) Reconcile(
 		return result, err
 	}
 
+	if config.RegistrationRequired() {
+		if !registrationRequiredStatusFound(cluster) {
+			addRegistrationRequiredStatus(cluster)
+			return patchClusterStatus()
+		}
+
+		if shouldEncumberReconciliation(cluster) {
+			emitEncumbranceWarning(cluster, r)
+			// Encumbrance is just an early return from the reconciliation loop.
+			return patchClusterStatus()
+		} else {
+			emitAdvanceWarning(cluster, r)
+		}
+	}
+
 	// if the cluster is paused, set a condition and return
 	if cluster.Spec.Paused != nil && *cluster.Spec.Paused {
 		meta.SetStatusCondition(&cluster.Status.Conditions, metav1.Condition{

internal/controller/postgrescluster/controller_test.go

@@ -21,6 +21,7 @@ package postgrescluster
 import (
 	"context"
 	"fmt"
+	"os"
 	"strings"
 	"testing"
 
@@ -41,6 +42,7 @@ import (
 	"sigs.k8s.io/controller-runtime/pkg/reconcile"
 	"sigs.k8s.io/yaml"
 
+	"github.com/crunchydata/postgres-operator/internal/config"
 	"github.com/crunchydata/postgres-operator/internal/naming"
 	"github.com/crunchydata/postgres-operator/internal/testing/require"
 	"github.com/crunchydata/postgres-operator/internal/util"
@@ -164,6 +166,80 @@ var _ = Describe("PostgresCluster Reconciler", func() {
 		return result
 	}
 
+	Context("New Cluster with Registration Requirement, no need to Encumber", func() {
+		var cluster *v1beta1.PostgresCluster
+
+		BeforeEach(func() {
+			// PGO_VERSION and REGISTRATION_REQUIRED will be set by OLM installers.
+			os.Setenv("PGO_VERSION", "v5.4.2")
+			os.Setenv("REGISTRATION_REQUIRED", "true")
+			cluster = create(`
+metadata:
+  name: olm
+spec:
+  postgresVersion: 13
+  image: postgres
+  instances:
+  - name: register-now
+    dataVolumeClaimSpec:
+      accessModes:
+      - "ReadWriteMany"
+      resources:
+        requests:
+          storage: 1Gi
+  backups:
+    pgbackrest:
+      image: pgbackrest
+      repos:
+      - name: repo1
+        volume:
+          volumeClaimSpec:
+            accessModes:
+            - "ReadWriteOnce"
+            resources:
+              requests:
+                storage: 1Gi
+`)
+			Expect(reconcile(cluster)).To(BeZero())
+		})
+
+		AfterEach(func() {
+			ctx := context.Background()
+
+			if cluster != nil {
+				Expect(client.IgnoreNotFound(
+					suite.Client.Delete(ctx, cluster),
+				)).To(Succeed())
+
+				// Remove finalizers, if any, so the namespace can terminate.
+				Expect(client.IgnoreNotFound(
+					suite.Client.Patch(ctx, cluster, client.RawPatch(
+						client.Merge.Type(), []byte(`{"metadata":{"finalizers":[]}}`))),
+				)).To(Succeed())
+			}
+			os.Unsetenv("PGO_VERSION")
+			os.Unsetenv("REGISTRATION_REQUIRED")
+		})
+
+		Specify("Cluster RegistrationRequired Status", func() {
+			existing := &v1beta1.PostgresCluster{}
+			Expect(suite.Client.Get(
+				context.Background(), client.ObjectKeyFromObject(cluster), existing,
+			)).To(Succeed())
+
+			registrationRequired := config.RegistrationRequired()
+			Expect(registrationRequired).To(BeTrue())
+
+			pgoVersion := existing.Status.RegistrationRequired.PGOVersion
+			Expect(pgoVersion).To(Equal("v5.4.2"))
+
+			shouldEncumber := shouldEncumberReconciliation(existing)
+			// Only encumber when the RegistrationRequired PGOVersion <
+			// the running CPK version.
+			Expect(shouldEncumber).To(BeFalse())
+		})
+	})
+
 	Context("Cluster", func() {
 		var cluster *v1beta1.PostgresCluster
 

internal/controller/postgrescluster/olm_registration.go

@@ -0,0 +1,63 @@
+package postgrescluster
+
+import (
+	"os"
+
+	"golang.org/x/mod/semver"
+	corev1 "k8s.io/api/core/v1"
+	"k8s.io/apimachinery/pkg/api/meta"
+	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
+
+	"github.com/crunchydata/postgres-operator/internal/config"
+	"github.com/crunchydata/postgres-operator/pkg/apis/postgres-operator.crunchydata.com/v1beta1"
+)
+
+func emitAdvanceWarning(cluster *v1beta1.PostgresCluster, r *Reconciler) {
+	advanceWarning := "Crunchy Postgres for Kubernetes now requires registration for " +
+		"operator upgrades. Register now to be ready for your next upgrade. See " +
+		"http://crunchydata.com/register-cpk for further details."
+	r.Recorder.Event(cluster, corev1.EventTypeWarning, "Register Soon", advanceWarning)
+}
+
+func emitEncumbranceWarning(cluster *v1beta1.PostgresCluster, r *Reconciler) {
+	encumbranceWarning := "Registration required for Crunchy Postgres for Kubernetes to modify " +
+		cluster.Name + ". See http://crunchydata.com/register-cpk for further details."
+	r.Recorder.Event(cluster, corev1.EventTypeWarning, "Registration Required", encumbranceWarning)
+	addTokenRequiredCondition(cluster)
+}
+
+func registrationRequiredStatusFound(cluster *v1beta1.PostgresCluster) bool {
+	return cluster.Status.RegistrationRequired.PGOVersion != ""
+}
+
+func addTokenRequiredCondition(cluster *v1beta1.PostgresCluster) {
+	meta.SetStatusCondition(&cluster.Status.Conditions, metav1.Condition{
+		Type:               v1beta1.TokenRequired,
+		Status:             metav1.ConditionTrue,
+		Reason:             "TokenRequired",
+		Message:            "Reconciliation suspended",
+		ObservedGeneration: cluster.GetGeneration(),
+	})
+}
+
+func addRegistrationRequiredStatus(cluster *v1beta1.PostgresCluster) {
+	cluster.Status.RegistrationRequired = v1beta1.RegistrationRequirementStatus{
+		PGOVersion: os.Getenv("PGO_VERSION"),
+	}
+}
+
+func shouldEncumberReconciliation(cluster *v1beta1.PostgresCluster) bool {
+	validToken := false
+
+	// TODO(tlandreth): Implement token validation.
+	if validToken {
+		return false
+	}
+
+	// Get the CPK version that first imposed RegistrationRequired status on this cluster.
+	trialStartedWith := config.RegistrationRequiredBy(cluster)
+	currentPGOVersion := os.Getenv("PGO_VERSION")
+	startedLessThanCurrent := semver.Compare(trialStartedWith, currentPGOVersion) == -1
+
+	return startedLessThanCurrent
+}

pkg/apis/postgres-operator.crunchydata.com/v1beta1/postgrescluster_test.go

@@ -67,7 +67,8 @@ status:
   postgresVersion: 0
   proxy:
     pgBouncer: {}
-		`)+"\n")
+  registrationRequired: {}
+	`)+"\n")
 	})
 
 	t.Run("one instance set", func(t *testing.T) {
@@ -105,7 +106,8 @@ status:
   postgresVersion: 0
   proxy:
     pgBouncer: {}
-		`)+"\n")
+  registrationRequired: {}
+	`)+"\n")
 	})
 
 	t.Run("empty proxy", func(t *testing.T) {

pkg/apis/postgres-operator.crunchydata.com/v1beta1/postgrescluster_types.go

@@ -340,6 +340,14 @@ type PostgresClusterStatus struct {
 	// +optional
 	PGBackRest *PGBackRestStatus `json:"pgbackrest,omitempty"`
 
+	// Version information for installations with a registration requirement.
+	// +optional
+	RegistrationRequired RegistrationRequirementStatus `json:"registrationRequired,omitempty"`
+
+	// Signals the need for a token to be applied when registration is required.
+	// +optional
+	TokenRequired string `json:"tokenRequired,omitempty"`
+
 	// Stores the current PostgreSQL major version following a successful
 	// major PostgreSQL upgrade.
 	// +optional
@@ -393,6 +401,8 @@ const (
 	PersistentVolumeResizing   = "PersistentVolumeResizing"
 	PostgresClusterProgressing = "Progressing"
 	ProxyAvailable             = "ProxyAvailable"
+	RegistrationRequired       = "RegistrationRequired"
+	TokenRequired              = "TokenRequired"
 )
 
 type PostgresInstanceSetSpec struct {
@@ -558,6 +568,10 @@ func (s *PostgresProxySpec) Default() {
 	}
 }
 
+type RegistrationRequirementStatus struct {
+	PGOVersion string `json:"pgoVersion,omitempty"`
+}
+
 type PostgresProxyStatus struct {
 	PGBouncer PGBouncerPodStatus `json:"pgBouncer,omitempty"`
 }