-
Notifications
You must be signed in to change notification settings - Fork 221
Expand file tree
/
Copy pathworkload_service.go
More file actions
412 lines (361 loc) · 14.1 KB
/
workload_service.go
File metadata and controls
412 lines (361 loc) · 14.1 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
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
// SPDX-FileCopyrightText: Copyright 2025 Stacklok, Inc.
// SPDX-License-Identifier: Apache-2.0
package v1
import (
"context"
"errors"
"fmt"
"log/slog"
"time"
regtypes "github.com/stacklok/toolhive-core/registry/types"
groupval "github.com/stacklok/toolhive-core/validation/group"
httpval "github.com/stacklok/toolhive-core/validation/http"
"github.com/stacklok/toolhive/pkg/auth/remote"
"github.com/stacklok/toolhive/pkg/config"
"github.com/stacklok/toolhive/pkg/container/runtime"
"github.com/stacklok/toolhive/pkg/groups"
"github.com/stacklok/toolhive/pkg/networking"
"github.com/stacklok/toolhive/pkg/runner"
"github.com/stacklok/toolhive/pkg/runner/retriever"
"github.com/stacklok/toolhive/pkg/secrets"
"github.com/stacklok/toolhive/pkg/transport"
"github.com/stacklok/toolhive/pkg/transport/types"
"github.com/stacklok/toolhive/pkg/workloads"
)
const (
// imageRetrievalTimeout is the timeout for pulling Docker images
// Set to 10 minutes to handle large images (1GB+) on slower connections
imageRetrievalTimeout = 10 * time.Minute
)
// WorkloadService handles business logic for workload operations
type WorkloadService struct {
workloadManager workloads.Manager
groupManager groups.Manager
containerRuntime runtime.Runtime
debugMode bool
imageRetriever retriever.Retriever
appConfig *config.Config
}
// NewWorkloadService creates a new WorkloadService instance
func NewWorkloadService(
workloadManager workloads.Manager,
groupManager groups.Manager,
containerRuntime runtime.Runtime,
debugMode bool,
) *WorkloadService {
// Load application config for global settings
configProvider := config.NewDefaultProvider()
appConfig := configProvider.GetConfig()
return &WorkloadService{
workloadManager: workloadManager,
groupManager: groupManager,
containerRuntime: containerRuntime,
debugMode: debugMode,
imageRetriever: retriever.GetMCPServer,
appConfig: appConfig,
}
}
// CreateWorkloadFromRequest creates a workload from a request
func (s *WorkloadService) CreateWorkloadFromRequest(ctx context.Context, req *createRequest) (*runner.RunConfig, error) {
// Build the full run config (no existing port, so pass 0)
runConfig, err := s.BuildFullRunConfig(ctx, req, 0)
if err != nil {
return nil, err
}
// Save the workload state
if err := runConfig.SaveState(ctx); err != nil {
slog.Error("failed to save workload config", "error", err)
return nil, fmt.Errorf("failed to save workload config: %w", err)
}
// Start workload
if err := s.workloadManager.RunWorkloadDetached(ctx, runConfig); err != nil {
slog.Error("failed to start workload", "error", err)
return nil, fmt.Errorf("failed to start workload: %w", err)
}
return runConfig, nil
}
// UpdateWorkloadFromRequest updates a workload from a request
func (s *WorkloadService) UpdateWorkloadFromRequest(ctx context.Context, name string, req *createRequest, existingPort int) (*runner.RunConfig, error) { //nolint:lll
// If ProxyPort is 0, reuse the existing port
if req.ProxyPort == 0 && existingPort > 0 {
req.ProxyPort = existingPort
slog.Debug("reusing existing port", "port", existingPort, "name", name)
}
// Build the full run config
runConfig, err := s.BuildFullRunConfig(ctx, req, existingPort)
if err != nil {
return nil, fmt.Errorf("failed to build workload config: %w", err)
}
// Use the manager's UpdateWorkload method to handle the lifecycle
// Use background context since this is async operation
if _, err := s.workloadManager.UpdateWorkload(context.Background(), name, runConfig); err != nil {
return nil, fmt.Errorf("failed to update workload: %w", err)
}
return runConfig, nil
}
// BuildFullRunConfig builds a complete RunConfig
//
//nolint:gocyclo // TODO: refactor this into shorter functions
func (s *WorkloadService) BuildFullRunConfig(
ctx context.Context, req *createRequest, existingPort int,
) (*runner.RunConfig, error) {
// Default proxy mode to streamable-http if not specified (SSE is deprecated)
if !types.IsValidProxyMode(req.ProxyMode) {
if req.ProxyMode == "" {
req.ProxyMode = types.ProxyModeStreamableHTTP.String()
} else {
return nil, fmt.Errorf("%w: %s", retriever.ErrInvalidRunConfig, fmt.Sprintf("Invalid proxy_mode: %s", req.ProxyMode))
}
}
// Validate user-provided resource indicator (RFC 8707)
if req.OAuthConfig.Resource != "" {
if err := httpval.ValidateResourceURI(req.OAuthConfig.Resource); err != nil {
return nil, fmt.Errorf("%w: invalid resource parameter: %w", retriever.ErrInvalidRunConfig, err)
}
}
// Validate user-provided OAuth callback port
if req.OAuthConfig.CallbackPort != 0 {
if err := networking.ValidateCallbackPort(req.OAuthConfig.CallbackPort, req.OAuthConfig.ClientID); err != nil {
return nil, fmt.Errorf("%w: invalid OAuth callback port configuration", retriever.ErrInvalidRunConfig)
}
}
// Validate header forward configuration
if err := validateHeaderForwardConfig(req.HeaderForward); err != nil {
return nil, fmt.Errorf("%w: %w", retriever.ErrInvalidRunConfig, err)
}
// Default group if not specified
groupName := req.Group
if groupName == "" {
groupName = groups.DefaultGroup
}
// Validate that the group exists
exists, err := s.groupManager.Exists(ctx, groupName)
if err != nil {
return nil, fmt.Errorf("failed to check if group exists: %w", err)
}
if !exists {
return nil, fmt.Errorf("group '%s' does not exist", groupName)
}
var remoteAuthConfig *remote.Config
var imageURL string
var imageMetadata *regtypes.ImageMetadata
var serverMetadata regtypes.ServerMetadata
var registryProxyPort int
if req.URL != "" {
// Configure remote authentication if OAuth config is provided
if req.Transport == "" {
req.Transport = types.TransportTypeStreamableHTTP.String()
}
remoteAuthConfig = createRequestToRemoteAuthConfig(ctx, req)
} else {
// Create a dedicated context with longer timeout for image retrieval
imageCtx, cancel := context.WithTimeout(ctx, imageRetrievalTimeout)
defer cancel()
// Fetch or build the requested image
imageURL, serverMetadata, err = s.imageRetriever(
imageCtx,
req.Image,
"", // We do not let the user specify a CA cert path here.
retriever.VerifyImageWarn,
"", // TODO Add support for registry groups lookups for API
nil, // No runtime override from API (yet)
)
if err != nil {
// Check if the error is due to context timeout
if errors.Is(imageCtx.Err(), context.DeadlineExceeded) {
return nil, fmt.Errorf("image retrieval timed out after %v - image may be too large or connection too slow",
imageRetrievalTimeout)
}
return nil, fmt.Errorf("failed to retrieve MCP server image: %w", err)
}
if remoteServerMetadata, ok := serverMetadata.(*regtypes.RemoteServerMetadata); ok && remoteServerMetadata != nil {
// Use registry proxy port if not set by request
if req.ProxyPort == 0 && remoteServerMetadata.ProxyPort > 0 {
registryProxyPort = remoteServerMetadata.ProxyPort
}
if remoteServerMetadata.OAuthConfig != nil {
// Default resource: user-provided > registry metadata > derived from remote URL
resource := req.OAuthConfig.Resource
if resource == "" {
resource = remoteServerMetadata.OAuthConfig.Resource
}
if resource == "" && remoteServerMetadata.URL != "" {
resource = remote.DefaultResourceIndicator(remoteServerMetadata.URL)
}
remoteAuthConfig = &remote.Config{
ClientID: req.OAuthConfig.ClientID,
Scopes: remoteServerMetadata.OAuthConfig.Scopes,
CallbackPort: remoteServerMetadata.OAuthConfig.CallbackPort,
Issuer: remoteServerMetadata.OAuthConfig.Issuer,
AuthorizeURL: remoteServerMetadata.OAuthConfig.AuthorizeURL,
TokenURL: remoteServerMetadata.OAuthConfig.TokenURL,
UsePKCE: remoteServerMetadata.OAuthConfig.UsePKCE,
Resource: resource,
OAuthParams: remoteServerMetadata.OAuthConfig.OAuthParams,
Headers: remoteServerMetadata.Headers,
EnvVars: remoteServerMetadata.EnvVars,
}
// Store the client secret in CLI format if provided
if req.OAuthConfig.ClientSecret != nil {
remoteAuthConfig.ClientSecret = req.OAuthConfig.ClientSecret.ToCLIString()
}
// Store the bearer token in CLI format if provided
if req.OAuthConfig.BearerToken != nil {
remoteAuthConfig.BearerToken = req.OAuthConfig.BearerToken.ToCLIString()
}
}
}
// Handle server metadata - API only supports container servers.
// Use type assertion with nil check to guard against typed nil pointers.
if md, ok := serverMetadata.(*regtypes.ImageMetadata); ok && md != nil {
imageMetadata = md
}
}
// Build RunConfig
runSecrets := secrets.SecretParametersToCLI(req.Secrets)
toolsOverride := make(map[string]runner.ToolOverride)
for toolName, toolOverride := range req.ToolsOverride {
toolsOverride[toolName] = runner.ToolOverride{
Name: toolOverride.Name,
Description: toolOverride.Description,
}
}
// Resolve registry source URLs and server name when the server was discovered via registry lookup.
regAPIURL, regURL := runner.ResolveRegistrySourceURLs(serverMetadata, s.appConfig)
regServerName := runner.ResolveRegistryServerName(serverMetadata)
options := []runner.RunConfigBuilderOption{
runner.WithRuntime(s.containerRuntime),
runner.WithCmdArgs(req.CmdArguments),
runner.WithName(req.Name),
runner.WithGroup(groupName),
runner.WithImage(imageURL),
runner.WithRemoteURL(req.URL),
runner.WithRemoteAuth(remoteAuthConfig),
runner.WithHost(req.Host),
runner.WithTargetHost(transport.LocalhostIPv4),
runner.WithDebug(s.debugMode),
runner.WithVolumes(req.Volumes),
runner.WithSecrets(runSecrets),
runner.WithAuthzConfigPath(req.AuthzConfig),
runner.WithAuditConfigPath(""),
runner.WithPermissionProfile(req.PermissionProfile),
runner.WithNetworkIsolation(req.NetworkIsolation),
runner.WithTrustProxyHeaders(req.TrustProxyHeaders),
runner.WithK8sPodPatch(""),
runner.WithProxyMode(types.ProxyMode(req.ProxyMode)),
runner.WithTransportAndPorts(req.Transport, req.ProxyPort, req.TargetPort),
runner.WithAuditEnabled(false, ""),
runner.WithOIDCConfig(req.OIDC.Issuer, req.OIDC.Audience, req.OIDC.JwksURL, "",
req.OIDC.ClientID, "", "", "", "", false, false, req.OIDC.Scopes),
runner.WithToolsFilter(req.ToolsFilter),
runner.WithToolsOverride(toolsOverride),
runner.WithTelemetryConfigFromFlags("", false, false, false, "", 0.0, nil, false, nil, false),
runner.WithRegistrySourceURLs(regAPIURL, regURL),
runner.WithRegistryServerName(regServerName),
}
// Add header forward configuration if specified
if req.HeaderForward != nil {
if len(req.HeaderForward.AddPlaintextHeaders) > 0 {
options = append(options, runner.WithHeaderForward(req.HeaderForward.AddPlaintextHeaders))
}
if len(req.HeaderForward.AddHeadersFromSecret) > 0 {
options = append(options, runner.WithHeaderForwardSecrets(req.HeaderForward.AddHeadersFromSecret))
}
}
// Use registry proxy port for remote servers if not set by request
if registryProxyPort > 0 {
options = append(options, runner.WithRegistryProxyPort(registryProxyPort))
}
// Add existing port if provided (for update operations)
if existingPort > 0 {
options = append(options, runner.WithExistingPort(existingPort))
}
// Determine transport type
transportType := "streamable-http"
if req.Transport != "" {
transportType = req.Transport
} else if md, ok := serverMetadata.(*regtypes.ImageMetadata); ok && md != nil {
if t := md.GetTransport(); t != "" {
transportType = t
}
}
// Configure middleware from flags
options = append(options,
runner.WithMiddlewareFromFlags(
nil,
nil, // tokenExchangeConfig - not supported via API yet
req.ToolsFilter,
toolsOverride,
nil,
req.AuthzConfig,
false,
"",
req.Name,
transportType,
s.appConfig.DisableUsageMetrics,
),
)
runConfig, err := runner.NewRunConfigBuilder(ctx, imageMetadata, req.EnvVars, &runner.DetachedEnvVarValidator{}, options...)
if err != nil {
slog.Error("failed to build run config", "error", err)
return nil, fmt.Errorf("%w: Failed to build run config: %w", retriever.ErrInvalidRunConfig, err)
}
return runConfig, nil
}
// createRequestToRemoteAuthConfig converts API request to runner RemoteAuthConfig
func createRequestToRemoteAuthConfig(
_ context.Context,
req *createRequest,
) *remote.Config {
// Default resource: user-provided > derived from remote URL
resource := req.OAuthConfig.Resource
if resource == "" && req.URL != "" {
resource = remote.DefaultResourceIndicator(req.URL)
}
// Create RemoteAuthConfig
remoteAuthConfig := &remote.Config{
ClientID: req.OAuthConfig.ClientID,
Scopes: req.OAuthConfig.Scopes,
Issuer: req.OAuthConfig.Issuer,
AuthorizeURL: req.OAuthConfig.AuthorizeURL,
TokenURL: req.OAuthConfig.TokenURL,
UsePKCE: req.OAuthConfig.UsePKCE,
Resource: resource,
OAuthParams: req.OAuthConfig.OAuthParams,
CallbackPort: req.OAuthConfig.CallbackPort,
SkipBrowser: req.OAuthConfig.SkipBrowser,
Headers: req.Headers,
}
// Store the client secret in CLI format if provided
if req.OAuthConfig.ClientSecret != nil {
remoteAuthConfig.ClientSecret = req.OAuthConfig.ClientSecret.ToCLIString()
}
// Store the bearer token in CLI format if provided
if req.OAuthConfig.BearerToken != nil {
remoteAuthConfig.BearerToken = req.OAuthConfig.BearerToken.ToCLIString()
}
return remoteAuthConfig
}
// GetWorkloadNamesFromRequest gets workload names from either the names field or group
func (s *WorkloadService) GetWorkloadNamesFromRequest(ctx context.Context, req bulkOperationRequest) ([]string, error) {
if len(req.Names) > 0 {
return req.Names, nil
}
if err := groupval.ValidateName(req.Group); err != nil {
return nil, fmt.Errorf("invalid group name: %w", err)
}
// Check if the group exists
exists, err := s.groupManager.Exists(ctx, req.Group)
if err != nil {
return nil, fmt.Errorf("failed to check if group exists: %w", err)
}
if !exists {
return nil, fmt.Errorf("group '%s' does not exist", req.Group)
}
// Get all workload names in the group
workloadNames, err := s.workloadManager.ListWorkloadsInGroup(ctx, req.Group)
if err != nil {
return nil, fmt.Errorf("failed to list workloads in group: %w", err)
}
return workloadNames, nil
}