-
Notifications
You must be signed in to change notification settings - Fork 221
Expand file tree
/
Copy pathtoolconfig_controller.go
More file actions
316 lines (272 loc) · 12 KB
/
toolconfig_controller.go
File metadata and controls
316 lines (272 loc) · 12 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
// SPDX-FileCopyrightText: Copyright 2025 Stacklok, Inc.
// SPDX-License-Identifier: Apache-2.0
package controllers
import (
"context"
"fmt"
"slices"
"time"
"k8s.io/apimachinery/pkg/api/errors"
"k8s.io/apimachinery/pkg/api/meta"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/runtime"
"k8s.io/apimachinery/pkg/types"
ctrl "sigs.k8s.io/controller-runtime"
"sigs.k8s.io/controller-runtime/pkg/client"
"sigs.k8s.io/controller-runtime/pkg/controller/controllerutil"
"sigs.k8s.io/controller-runtime/pkg/handler"
"sigs.k8s.io/controller-runtime/pkg/log"
"sigs.k8s.io/controller-runtime/pkg/reconcile"
mcpv1alpha1 "github.com/stacklok/toolhive/cmd/thv-operator/api/v1alpha1"
ctrlutil "github.com/stacklok/toolhive/cmd/thv-operator/pkg/controllerutil"
)
const (
// ToolConfigFinalizerName is the name of the finalizer for MCPToolConfig
ToolConfigFinalizerName = "toolhive.stacklok.dev/toolconfig-finalizer"
// finalizerRequeueDelay is the delay before requeuing after adding a finalizer
finalizerRequeueDelay = 500 * time.Millisecond
)
// ToolConfigReconciler reconciles a MCPToolConfig object
type ToolConfigReconciler struct {
client.Client
Scheme *runtime.Scheme
}
// +kubebuilder:rbac:groups=toolhive.stacklok.dev,resources=mcptoolconfigs,verbs=get;list;watch;create;update;patch;delete
// +kubebuilder:rbac:groups=toolhive.stacklok.dev,resources=mcptoolconfigs/status,verbs=get;update;patch
// +kubebuilder:rbac:groups=toolhive.stacklok.dev,resources=mcptoolconfigs/finalizers,verbs=update
// +kubebuilder:rbac:groups=toolhive.stacklok.dev,resources=mcpservers,verbs=get;list;watch
// Reconcile is part of the main kubernetes reconciliation loop which aims to
// move the current state of the cluster closer to the desired state.
func (r *ToolConfigReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error) {
logger := log.FromContext(ctx)
// Fetch the MCPToolConfig instance
toolConfig := &mcpv1alpha1.MCPToolConfig{}
err := r.Get(ctx, req.NamespacedName, toolConfig)
if err != nil {
if errors.IsNotFound(err) {
// Object not found, could have been deleted after reconcile request.
// Return and don't requeue
logger.Info("MCPToolConfig resource not found. Ignoring since object must be deleted")
return ctrl.Result{}, nil
}
// Error reading the object - requeue the request.
logger.Error(err, "Failed to get MCPToolConfig")
return ctrl.Result{}, err
}
// Check if the MCPToolConfig is being deleted
if !toolConfig.DeletionTimestamp.IsZero() {
return r.handleDeletion(ctx, toolConfig)
}
// Add finalizer if it doesn't exist
if !controllerutil.ContainsFinalizer(toolConfig, ToolConfigFinalizerName) {
controllerutil.AddFinalizer(toolConfig, ToolConfigFinalizerName)
if err := r.Update(ctx, toolConfig); err != nil {
logger.Error(err, "Failed to add finalizer")
return ctrl.Result{}, err
}
// Requeue to continue processing after finalizer is added
return ctrl.Result{RequeueAfter: finalizerRequeueDelay}, nil
}
// Validation succeeded - set Valid=True condition
conditionChanged := meta.SetStatusCondition(&toolConfig.Status.Conditions, metav1.Condition{
Type: mcpv1alpha1.ConditionToolConfigValid,
Status: metav1.ConditionTrue,
Reason: mcpv1alpha1.ConditionReasonToolConfigValidationSucceeded,
Message: "Spec validation passed",
ObservedGeneration: toolConfig.Generation,
})
// Calculate the hash of the current configuration
configHash := r.calculateConfigHash(toolConfig.Spec)
// Check if the hash has changed
hashChanged := toolConfig.Status.ConfigHash != configHash
if hashChanged {
return r.handleConfigHashChange(ctx, toolConfig, configHash)
}
// Refresh ReferencingWorkloads list
referencingWorkloads, err := r.findReferencingWorkloads(ctx, toolConfig)
if err != nil {
logger.Error(err, "Failed to find referencing workloads")
} else if !slices.Equal(toolConfig.Status.ReferencingWorkloads, referencingWorkloads) {
toolConfig.Status.ReferencingWorkloads = referencingWorkloads
conditionChanged = true
}
// Update condition if it changed (even without hash change)
if conditionChanged {
if err := r.Status().Update(ctx, toolConfig); err != nil {
logger.Error(err, "Failed to update MCPToolConfig status after condition change")
return ctrl.Result{}, err
}
}
return ctrl.Result{}, nil
}
// handleConfigHashChange handles the logic when the config hash changes
func (r *ToolConfigReconciler) handleConfigHashChange(
ctx context.Context,
toolConfig *mcpv1alpha1.MCPToolConfig,
configHash string,
) (ctrl.Result, error) {
logger := log.FromContext(ctx)
logger.Info("MCPToolConfig configuration changed", "oldHash", toolConfig.Status.ConfigHash, "newHash", configHash)
// Find all MCPServers that reference this MCPToolConfig
referencingServers, err := r.findReferencingMCPServers(ctx, toolConfig)
if err != nil {
logger.Error(err, "Failed to find referencing MCPServers")
// Don't persist the new hash on error — returning the error will requeue,
// and on the next attempt handleConfigHashChange will be re-entered so that
// MCPServer annotation updates are not permanently skipped.
return ctrl.Result{}, fmt.Errorf("failed to find referencing MCPServers: %w", err)
}
// Update the status with the new hash only after successful server lookup
toolConfig.Status.ConfigHash = configHash
toolConfig.Status.ObservedGeneration = toolConfig.Generation
// Update the status with the list of referencing workloads
refs := make([]mcpv1alpha1.WorkloadReference, 0, len(referencingServers))
for _, server := range referencingServers {
refs = append(refs, mcpv1alpha1.WorkloadReference{Kind: "MCPServer", Name: server.Name})
}
toolConfig.Status.ReferencingWorkloads = refs
// Update the MCPToolConfig status
if err := r.Status().Update(ctx, toolConfig); err != nil {
logger.Error(err, "Failed to update MCPToolConfig status")
return ctrl.Result{}, err
}
// Trigger reconciliation of all referencing MCPServers
for _, server := range referencingServers {
logger.Info("Triggering reconciliation of MCPServer due to MCPToolConfig change",
"mcpserver", server.Name, "toolconfig", toolConfig.Name)
if server.Annotations == nil {
server.Annotations = make(map[string]string)
}
server.Annotations["toolhive.stacklok.dev/toolconfig-hash"] = configHash
if err := r.Update(ctx, &server); err != nil {
logger.Error(err, "Failed to update MCPServer annotation", "mcpserver", server.Name)
}
}
return ctrl.Result{}, nil
}
// calculateConfigHash calculates a hash of the MCPToolConfig spec using Kubernetes utilities
func (*ToolConfigReconciler) calculateConfigHash(spec mcpv1alpha1.MCPToolConfigSpec) string {
return ctrlutil.CalculateConfigHash(spec)
}
// handleDeletion handles the deletion of a MCPToolConfig
func (r *ToolConfigReconciler) handleDeletion(ctx context.Context, toolConfig *mcpv1alpha1.MCPToolConfig) (ctrl.Result, error) {
logger := log.FromContext(ctx)
if controllerutil.ContainsFinalizer(toolConfig, ToolConfigFinalizerName) {
// Check if any workloads still reference this MCPToolConfig
referencingWorkloads, err := r.findReferencingWorkloads(ctx, toolConfig)
if err != nil {
logger.Error(err, "Failed to check referencing workloads during deletion")
return ctrl.Result{}, err
}
if len(referencingWorkloads) > 0 {
logger.Info("MCPToolConfig is still referenced by workloads, blocking deletion",
"toolconfig", toolConfig.Name,
"referencingWorkloads", referencingWorkloads)
meta.SetStatusCondition(&toolConfig.Status.Conditions, metav1.Condition{
Type: "DeletionBlocked",
Status: metav1.ConditionTrue,
Reason: "ReferencedByWorkloads",
Message: fmt.Sprintf("Cannot delete: referenced by workloads: %v", referencingWorkloads),
ObservedGeneration: toolConfig.Generation,
})
toolConfig.Status.ReferencingWorkloads = referencingWorkloads
if updateErr := r.Status().Update(ctx, toolConfig); updateErr != nil {
logger.Error(updateErr, "Failed to update status during deletion block")
}
// Requeue to check again later
return ctrl.Result{RequeueAfter: 30 * time.Second}, nil
}
// No references, safe to remove finalizer and allow deletion
controllerutil.RemoveFinalizer(toolConfig, ToolConfigFinalizerName)
if err := r.Update(ctx, toolConfig); err != nil {
logger.Error(err, "Failed to remove finalizer")
return ctrl.Result{}, err
}
logger.Info("Removed finalizer from MCPToolConfig", "toolconfig", toolConfig.Name)
}
return ctrl.Result{}, nil
}
// findReferencingWorkloads returns the workload resources (MCPServer)
// that reference this MCPToolConfig via their ToolConfigRef field.
func (r *ToolConfigReconciler) findReferencingWorkloads(
ctx context.Context,
toolConfig *mcpv1alpha1.MCPToolConfig,
) ([]mcpv1alpha1.WorkloadReference, error) {
mcpServerList := &mcpv1alpha1.MCPServerList{}
if err := r.List(ctx, mcpServerList, client.InNamespace(toolConfig.Namespace)); err != nil {
return nil, fmt.Errorf("failed to list MCPServers: %w", err)
}
var refs []mcpv1alpha1.WorkloadReference
for _, server := range mcpServerList.Items {
if server.Spec.ToolConfigRef != nil && server.Spec.ToolConfigRef.Name == toolConfig.Name {
refs = append(refs, mcpv1alpha1.WorkloadReference{Kind: "MCPServer", Name: server.Name})
}
}
return refs, nil
}
// findReferencingMCPServers finds all MCPServers that reference the given MCPToolConfig.
// Returns the full MCPServer objects, used by handleConfigHashChange to update server annotations.
func (r *ToolConfigReconciler) findReferencingMCPServers(
ctx context.Context,
toolConfig *mcpv1alpha1.MCPToolConfig,
) ([]mcpv1alpha1.MCPServer, error) {
return ctrlutil.FindReferencingMCPServers(ctx, r.Client, toolConfig.Namespace, toolConfig.Name,
func(server *mcpv1alpha1.MCPServer) *string {
if server.Spec.ToolConfigRef != nil {
return &server.Spec.ToolConfigRef.Name
}
return nil
})
}
// SetupWithManager sets up the controller with the Manager.
// Watches MCPServer changes to maintain accurate ReferencingWorkloads status.
func (r *ToolConfigReconciler) SetupWithManager(mgr ctrl.Manager) error {
// Watch MCPServer changes to update ReferencingWorkloads on referenced MCPToolConfigs.
// This handler enqueues both the currently-referenced MCPToolConfig AND any
// MCPToolConfig that still lists this server in ReferencingWorkloads (covers the
// case where a server removes its toolConfigRef — the previously-referenced
// config needs to reconcile and clean up the stale entry).
toolConfigHandler := handler.EnqueueRequestsFromMapFunc(
func(ctx context.Context, obj client.Object) []reconcile.Request {
server, ok := obj.(*mcpv1alpha1.MCPServer)
if !ok {
return nil
}
seen := make(map[types.NamespacedName]struct{})
var requests []reconcile.Request
// Enqueue the currently-referenced MCPToolConfig (if any)
if server.Spec.ToolConfigRef != nil {
nn := types.NamespacedName{
Name: server.Spec.ToolConfigRef.Name,
Namespace: server.Namespace,
}
seen[nn] = struct{}{}
requests = append(requests, reconcile.Request{NamespacedName: nn})
}
// Also enqueue any MCPToolConfig that still lists this server in
// ReferencingWorkloads — handles ref-removal and server-deletion cases.
toolConfigList := &mcpv1alpha1.MCPToolConfigList{}
if err := r.List(ctx, toolConfigList, client.InNamespace(server.Namespace)); err != nil {
log.FromContext(ctx).Error(err, "Failed to list MCPToolConfigs for MCPServer watch")
return requests
}
for _, cfg := range toolConfigList.Items {
nn := types.NamespacedName{Name: cfg.Name, Namespace: cfg.Namespace}
if _, already := seen[nn]; already {
continue
}
for _, ref := range cfg.Status.ReferencingWorkloads {
if ref.Kind == "MCPServer" && ref.Name == server.Name {
requests = append(requests, reconcile.Request{NamespacedName: nn})
break
}
}
}
return requests
},
)
return ctrl.NewControllerManagedBy(mgr).
For(&mcpv1alpha1.MCPToolConfig{}).
Watches(&mcpv1alpha1.MCPServer{}, toolConfigHandler).
Complete(r)
}