Separate controller client concerns #4253
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
We want to be mindful of our interactions with the Kubernetes API, and these interfaces will help keep functions focused. These interfaces are also narrower than client.Reader and client.Writer and may help us keep RBAC markers accurate. A new constructor populates these fields with a single client.Client. The client.WithFieldOwner constructor allows us to drop our Owner field and patch method.
We want to be mindful of our interactions with the Kubernetes API, and these interfaces will help keep functions focused. These interfaces are also narrower than client.Reader and client.Writer and may help us keep RBAC markers accurate. A new constructor populates these fields with a single client.Client. The client.WithFieldOwner constructor allows us to drop our Owner field and patch method. This allows `make check` to cover 47% more of the "crunchybridgecluster" package.
We want to be mindful of our interactions with the Kubernetes API, and these interfaces will help keep functions focused. These interfaces are also narrower than client.Reader and client.Writer and may help us keep RBAC markers accurate. A new constructor populates these fields with a single client.Client. The client.WithFieldOwner constructor allows us to drop our Owner field and patch method.
benjaminjb
reviewed
Aug 21, 2025
| @@ -316,8 +316,7 @@ func TestWritePGAdminUsers(t *testing.T) { | |||
| assert.Equal(t, calls, 1, "PodExec should be called once") | |||
|
|
|||
| secret := &corev1.Secret{ObjectMeta: naming.StandalonePGAdmin(pgadmin)} | |||
| assert.NilError(t, | |||
| reconciler.Get(ctx, client.ObjectKeyFromObject(secret), secret)) | |||
| assert.NilError(t, cc.Get(ctx, client.ObjectKeyFromObject(secret), secret)) | |||
There was a problem hiding this comment.
but we could use reconciler.Reader.Get, yeah? Which is more indirection but maybe a reminder of separation of client powers?
There was a problem hiding this comment.
But then -- who cares? This step isn't about what our operator does, this is just a step to get the object. "Getting the object" is not what we're testing here.
benjaminjb
reviewed
Aug 21, 2025
| Client: tClient, | ||
| Owner: "crunchybridgecluster-controller", | ||
| } | ||
| reconciler := &CrunchyBridgeClusterReconciler{} |
There was a problem hiding this comment.
Kind of want to rename generatePostgresRoleSecret generatePostgresRoleSecretIntent or something
There was a problem hiding this comment.
Yeah, there's a few funcs here that, from the name, I would've said call kubernetes.
benjaminjb
reviewed
Aug 21, 2025
| @@ -5,6 +5,9 @@ | |||
| package naming | |||
|
|
|||
| const ( | |||
| ControllerBridge = "bridge-controller" | |||
| ControllerPGAdmin = "pgadmin-controller" | |||
| ControllerBridge = "bridge-controller" | |||
There was a problem hiding this comment.
ah, the bridge installation controller already has this split between reader/writer, but no statuswriter -- and we never touch the status
benjaminjb
approved these changes
Aug 21, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This separates the
client.Clientinterface in our controllers into three:Reader,Writer, andStatusWriter. The idea is to add a little friction when adding a Client to a test, so we're more intentional about separating reads from writes. During this refactor, I found a number of tests that didn't need Kubernetes at all. This exercise has increased the amount of code covered bymake check.This refactor is one step toward my goal of a single, shared SSA Apply function.
Checklist:
Type of Changes:
Other Information:
📝 The changes to the PGUpgrade controller are representative and rather small.
📝 The PostgresCluster controller is kinda big, so I'll submit it as a separate PR.