[CONTP-1502] chore: Refresh secrets on reconcile instead of callbacks#2916
[CONTP-1502] chore: Refresh secrets on reconcile instead of callbacks#2916Mathew-Estafanous wants to merge 10 commits intomainfrom
Conversation
🛑 Gate Violations
ℹ️ Info🎯 Code Coverage (details) Useful? React with 👍 / 👎 This comment will be updated automatically if new data arrives.🔗 Commit SHA: 628349c | Docs | Datadog PR Page | Give us feedback! |
6c63ce8 to
4cf448a
Compare
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 4cf448a31f
ℹ️ About Codex in GitHub
Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".
a3bcee6 to
db84b1e
Compare
| v1alpha1.Notebook: &NotebookHandler{auth: ddClient.Auth, client: ddClient.NotebooksClient}, | ||
| v1alpha1.SyntheticsAPITest: &SyntheticsAPITestHandler{auth: ddClient.Auth, client: ddClient.SyntheticsClient}, | ||
| v1alpha1.SyntheticsBrowserTest: &SyntheticsBrowserTestHandler{auth: ddClient.Auth, client: ddClient.SyntheticsClient}, | ||
| v1alpha1.Dashboard: &DashboardHandler{auth: auth, client: clients.DashboardsClient}, |
There was a problem hiding this comment.
This kind of replicates pervious behavior where auth is tied to handler/client. This forces a workaround in controller to rebuild handlers just to use new creds which is unnecessary and confusing. Updating handler interface and passing auth context would make things simpler and aligned with rest of the code.
There was a problem hiding this comment.
Good point. I've updated the handler interface to accept an auth context instead of rebuilding on each reconciliation.
| getResource(instance *v1alpha1.DatadogGenericResource) error | ||
| updateResource(instance *v1alpha1.DatadogGenericResource) error | ||
| deleteResource(instance *v1alpha1.DatadogGenericResource) error | ||
| createResource(instance *v1alpha1.DatadogGenericResource, auth context.Context) (CreateResult, error) |
There was a problem hiding this comment.
conventionally context is the first argument in go
| @@ -18,8 +20,8 @@ type CreateResult struct { | |||
| // Each implementation is stateful: it holds its own API client and auth context, | |||
| // so the caller does not need to supply them. | |||
ae95754 to
628349c
Compare
What does this PR do?
Replaces the callback-based secret refresh system with per-reconcile credential resolution. Each reconciler now calls
CredentialManager.GetAuth()at the start of every reconcile to get a fresh authentication context with the latest credentials, instead of registering callbacks that recreate API clients when credentials change.The API clients are stateless HTTP wrappers that don't hold credentials, so they no longer need to be recreated. API URL parsing has been moved into
CredentialManagerusingsync.Oncefor lazy initialization, and thedatadogclientpackage is now a simple factory for stateless API clients.Motivation
The previous callback system introduced unnecessary complexity. Every reconciler had to implement
UpdateDatadogClient(), register a callback at setup time, and recreate entire API clients on credential change — even though only the auth context needed refreshing.This is a reworked version of #2312, adjusted for the latest version of the codebase.
Describe how you validated your changes
Unit and integration tests were updated to reflect the new API surface.
Test_refreshnow validates cache updates instead of callback invocations, andTestReconciler_UpdateDatadogClienttests were removed from all four controller packages since the method no longer exists.Manual QA steps:
config/manager/manager.yamlto mount a secret backend script via a ConfigMap volume and pass--secretBackendCommandand--secretRefreshInterval=30sflags to the operator. SetDD_API_KEYandDD_APP_KEYenv vars toENC[api-key]andENC[app-key].manager.yaml diff
secrets_backend.sh script
make deployand created aDatadogMonitorCR to exercise CRUD operations.Credentials have changed, cache updatedappears at rotation boundaries.. Confirmed both API keys show recent activity in the Datadog API Keys page.