feat: enable replicas to use replication slots #47

piotrkpc · 2025-07-17T00:48:09Z

Part of: https://github.com/tetrateio/tetrate/issues/26058

This PR introduces the following options to enable use of replicaiton slots:
Here are default values:

spec:
  replicationSlots:
    enabled: false
    # below are not implemented yet
    disableCleanup: false # allows to disable cleaning up of inactive replication slots
    maxWalKeepSize: "1Gi" # controls https://www.postgresql.org/docs/current/runtime-config-replication.html#GUC-MAX-SLOT-WAL-KEEP-SIZE
    inactiveSlotGracePeriod: 2m # defines a time period after which inactive slot is deleted
    healthCheckInterval: 30s # defines interval that is used to check for inactive replication slots

Replication slots are created and deleted by the operator and the replication slot name is passed down to scripts as a env var in a similar way as $PRIMARY_HOST_NAME

Signed-off-by: Piotr Kopec <[email protected]>

…ication slots Signed-off-by: Piotr Kopec <[email protected]>

sergicastro · 2025-07-18T09:10:56Z

internal/replicationslot/repo/repo.go

+
+type Repository interface {
+	CreateSlot(ctx context.Context, name string) (replicationslot.ReplicationSlot, error)
+	FindSlotByName(ctx context.Context, name string) (replicationslot.ReplicationSlot, error)


just a nit:

Suggested change

FindSlotByName(ctx context.Context, name string) (replicationslot.ReplicationSlot, error)

GetSlot(ctx context.Context, name string) (replicationslot.ReplicationSlot, error)

I think name is the ID of the slot, so we can make it easier to understand this API.
If we add some fins slots by other filters, then we can add Find* methods.

Signed-off-by: Piotr Kopec <[email protected]>

piotrkpc

@sergicastro annotated code, let me know if something is not clear.

piotrkpc · 2025-07-21T09:55:09Z

controllers/spec/enforcer/resources_count_spec/statefulset/ReplicaDbCountSpecEnforcer.go

+		replicationSlotsCreateDeleter: noopReplicationSlotsCreateDeleter{},
+	}
+
+	// TODO(piotrkpc): should this be here ? not testable code really


this also does not looks great as the direct sql/postgres dependencies are here because of this. Maybe we can figure out better way to setup db connections.

piotrkpc · 2025-07-21T10:00:49Z

controllers/spec/enforcer/resources_count_spec/statefulset/ReplicaDbCountSpecEnforcer.go

+}
+
+// TODO(piotrkpc): @Sergi, this is likely to be changed to something more sophisticated that would enable ssl enabled connections
+func newConnectorConfig(


we need to figure out how to create and manage connection with SSL configuration.

piotrkpc · 2025-07-21T10:02:38Z

controllers/spec/enforcer/resources_count_spec/statefulset/ReplicaDbCountSpecEnforcer.go

@@ -159,7 +369,13 @@ func (r *ReplicaDbCountSpecEnforcer) getDeployedReplicas() []statefulset.Statefu
 }

 func (r *ReplicaDbCountSpecEnforcer) getNbreDeployedReplicas() int32 {
-	return r.resourcesStates.StatefulSets.Replicas.NbreDeployed
+	deployedReplicas := r.resourcesStates.StatefulSets.Replicas.NbreDeployed


this is required in cases when we enable/disable replication slots so we can deploy replicas with proper configuration before cleaning up replicas that have old config (enabled/disable replication slots).

piotrkpc · 2025-07-21T10:07:10Z

controllers/spec/enforcer/resources_count_spec/statefulset/ReplicaDbCountSpecEnforcer_test.go

+	"reactive-tech.io/kubegres/controllers/states"
+)
+
+func TestCreateReplicaDbCountSpecEnforcer(t *testing.T) {


This is empty now as I'm not sure we want to test it here - it will execute a lot faster but the setup requires creating a lot of fake object to make it work and I'm also not sure if there are some hidden dependencies on other controllers such as statefulset controllers.

piotrkpc · 2025-07-21T10:08:56Z

controllers/spec/template/yaml/BaseConfigMapTemplate.yaml

@@ -211,8 +211,16 @@ data:
        then
        chown -R postgres:postgres $PGDATA;
        fi
-
+
+        grep "primary_slot_name" $PGDATA/postgresql.auto.conf > /dev/null && sed -i '/primary_slot_name/d' $PGDATA/postgresql.auto.conf


This change will be also required in TSB since we use custom config.

piotrkpc · 2025-07-21T10:09:41Z

go.mod

 	github.com/onsi/ginkgo/v2 v2.21.0
 	github.com/onsi/gomega v1.34.2
+	github.com/stretchr/testify v1.10.0
+	github.com/testcontainers/testcontainers-go v0.38.0


let me know what do you think about using testcontainers - used to the repo object.

piotrkpc · 2025-07-21T10:18:49Z

test/spec_replica_test.go

 		})

+		// TODO(piotrkpc): missing tests:


this test is missing, it might work though :)

added the test, does work as expected.

Signed-off-by: Piotr Kopec <[email protected]>

# Conflicts: # go.mod # go.sum

Signed-off-by: Piotr Kopec <[email protected]>

…p after test case Signed-off-by: Piotr Kopec <[email protected]>

piotrkpc · 2025-07-28T19:32:35Z

test/util/TestResourceCreator.go

 			}
 		} else {
 			log.Println("No PVC found for kubegres resource '" + resourceToDelete.Name + "'")
 			continue
 		}
 	}

-	log.Println("Deleted all resources created during tests. Waiting for 30 seconds...")
-	time.Sleep(30 * time.Second)


watching for delete events rather than doing this sleep shave ~4min from each test group and hopefully helps with flakiness

…nce (#53) I need to finish testing of the TLS PR #51 before making this connection management compatible with TLS-secured connections. The [`func (r *ServicesCountSpecEnforcer) canConnectToPrimaryDb() bool`](https://github.com/tetrateio/kubegres/pull/53/files#diff-2069405fe99f8bae54d23273d6e4708cb8b4e1ec715bbe3f276c63b3157c5ee2R136) method is the current one checking all of this works. It will need to be removed once the target PR starts using these changes. --------- Signed-off-by: Sergi Castro <[email protected]> Co-authored-by: Copilot <[email protected]>

Signed-off-by: Piotr Kopec <[email protected]>

test/spec_replica_test.go

Signed-off-by: Piotr Kopec <[email protected]>

piotrkpc · 2025-08-12T12:30:56Z

test/util/TestResourceCreator.go

@@ -261,6 +262,28 @@ func (r *TestResourceCreator) DeleteResource(resourceToDelete client.Object, res
 	return true
 }

+func (r *TestResourceCreator) DeleteResourceWithWatch(resourceToDelete client.Object, resourceName string, listObject client.ObjectList) (<-chan watch.Event, func()) {


it's not used here but i'd keep iet here so we can speedup tests in followup PR.

Signed-off-by: Piotr Kopec <[email protected]>

piotrkpc added 2 commits July 16, 2025 16:52

add replication slots repo

4dde18a

Signed-off-by: Piotr Kopec <[email protected]>

add API changes, API validation and failing test that checks for repl…

adf93a4

…ication slots Signed-off-by: Piotr Kopec <[email protected]>

sergicastro reviewed Jul 18, 2025

View reviewed changes

make replication slots work

e2265f2

Signed-off-by: Piotr Kopec <[email protected]>

piotrkpc force-pushed the manage-replication-slots branch from 79232df to e2265f2 Compare July 20, 2025 00:32

piotrkpc added 2 commits July 20, 2025 02:42

make check

449fe9d

Signed-off-by: Piotr Kopec <[email protected]>

make replication slots work when turining on replicationSlots

36e2b6a

Signed-off-by: Piotr Kopec <[email protected]>

piotrkpc commented Jul 21, 2025

View reviewed changes

piotrkpc added 5 commits July 27, 2025 17:09

fix tests and add missing case for disabling replication slots

ed6d3f2

Signed-off-by: Piotr Kopec <[email protected]>

improve tests

4636f91

Signed-off-by: Piotr Kopec <[email protected]>

Merge branch 'release-v1.16.x' into manage-replication-slots

fe72d3e

# Conflicts: # go.mod # go.sum

go mod tidy after merge from main branch

0e564e5

Signed-off-by: Piotr Kopec <[email protected]>

replace sleep with watch for deletion of test resources during cleanu…

1cd47be

…p after test case Signed-off-by: Piotr Kopec <[email protected]>

piotrkpc changed the title ~~wip: replication slots~~ feat: enable replicas to use replication slots Jul 28, 2025

piotrkpc marked this pull request as ready for review July 28, 2025 19:30

piotrkpc commented Jul 28, 2025

View reviewed changes

sergicastro and others added 3 commits August 7, 2025 14:55

make check

19f62ee

Signed-off-by: Piotr Kopec <[email protected]>

updated golang to 1.24.6 to fix CVE-2025-47907

7bad45e

Signed-off-by: Piotr Kopec <[email protected]>

piotrkpc commented Aug 12, 2025

View reviewed changes

test/spec_replica_test.go Show resolved Hide resolved

piotrkpc added 5 commits August 12, 2025 13:28

fix issues with using connectionsStore

2bd4540

Signed-off-by: Piotr Kopec <[email protected]>

remove debugging function

ad3dffd

Signed-off-by: Piotr Kopec <[email protected]>

revert back to default sleep time

7ee9276

Signed-off-by: Piotr Kopec <[email protected]>

assert that you can query db in all cases

93dde9c

Signed-off-by: Piotr Kopec <[email protected]>

cleanup test

749d34b

Signed-off-by: Piotr Kopec <[email protected]>

piotrkpc commented Aug 12, 2025

View reviewed changes

piotrkpc added 2 commits August 13, 2025 10:40

delete unused function

9fe0971

Signed-off-by: Piotr Kopec <[email protected]>

Merge branch 'release-v1.16.x' into manage-replication-slots

49952c2

piotrkpc requested a review from sergicastro August 13, 2025 08:40

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat: enable replicas to use replication slots #47

feat: enable replicas to use replication slots #47

Uh oh!

piotrkpc commented Jul 17, 2025 •

edited

Loading

Uh oh!

sergicastro Jul 18, 2025

Uh oh!

piotrkpc left a comment

Uh oh!

piotrkpc Jul 21, 2025

Uh oh!

piotrkpc Jul 21, 2025

Uh oh!

piotrkpc Jul 21, 2025

Uh oh!

piotrkpc Jul 21, 2025

Uh oh!

piotrkpc Jul 21, 2025

Uh oh!

piotrkpc Jul 21, 2025

Uh oh!

piotrkpc Jul 21, 2025

Uh oh!

piotrkpc Jul 27, 2025

Uh oh!

piotrkpc Jul 28, 2025

Uh oh!

Uh oh!

piotrkpc Aug 12, 2025

Uh oh!

Uh oh!

	FindSlotByName(ctx context.Context, name string) (replicationslot.ReplicationSlot, error)
	GetSlot(ctx context.Context, name string) (replicationslot.ReplicationSlot, error)

feat: enable replicas to use replication slots #47

Are you sure you want to change the base?

feat: enable replicas to use replication slots #47

Uh oh!

Conversation

piotrkpc commented Jul 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

piotrkpc left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

piotrkpc commented Jul 17, 2025 •

edited

Loading