You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
|`name`_string_| Name is the name of the ConfigMap || MinLength: 1 <br />Required: \{\} <br /> |
100
+
|`key`_string_| Key is the key in the ConfigMap that contains the registry data | registry.json | MinLength: 1 <br /> |
101
+
102
+
68
103
#### EnvVar
69
104
70
105
@@ -146,6 +181,132 @@ _Appears in:_
146
181
|`useClusterAuth`_boolean_| UseClusterAuth enables using the Kubernetes cluster's CA bundle and service account token<br />When true, uses /var/run/secrets/kubernetes.io/serviceaccount/ca.crt for TLS verification<br />and /var/run/secrets/kubernetes.io/serviceaccount/token for bearer token authentication<br />Defaults to true if not specified |||
147
182
148
183
184
+
#### MCPRegistry
185
+
186
+
187
+
188
+
MCPRegistry is the Schema for the mcpregistries API
189
+
⚠️ Experimental API (v1alpha1) — subject to change.
|`kind`_string_| Kind is a string value representing the REST resource this object represents.<br />Servers may infer this from the endpoint the client submits requests to.<br />Cannot be updated.<br />In CamelCase.<br />More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds|||
201
+
|`apiVersion`_string_| APIVersion defines the versioned schema of this representation of an object.<br />Servers should convert recognized schemas to the latest internal value, and<br />may reject unrecognized values.<br />More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources|||
202
+
|`metadata`_[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#objectmeta-v1-meta)_| Refer to Kubernetes API documentation for fields of `metadata`. |||
|`kind`_string_| Kind is a string value representing the REST resource this object represents.<br />Servers may infer this from the endpoint the client submits requests to.<br />Cannot be updated.<br />In CamelCase.<br />More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds|||
222
+
|`apiVersion`_string_| APIVersion defines the versioned schema of this representation of an object.<br />Servers should convert recognized schemas to the latest internal value, and<br />may reject unrecognized values.<br />More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources|||
223
+
|`metadata`_[ListMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#listmeta-v1-meta)_| Refer to Kubernetes API documentation for fields of `metadata`. |||
224
+
|`items`_[MCPRegistry](#mcpregistry) array_||||
225
+
226
+
227
+
#### MCPRegistryPhase
228
+
229
+
_Underlying type:__string_
230
+
231
+
MCPRegistryPhase represents the phase of the MCPRegistry
|`Pending`| MCPRegistryPhasePending means the MCPRegistry is being initialized<br /> |
242
+
|`Ready`| MCPRegistryPhaseReady means the MCPRegistry is ready and operational<br /> |
243
+
|`Failed`| MCPRegistryPhaseFailed means the MCPRegistry has failed<br /> |
244
+
|`Syncing`| MCPRegistryPhaseSyncing means the MCPRegistry is currently syncing data<br /> |
245
+
|`Terminating`| MCPRegistryPhaseTerminating means the MCPRegistry is being deleted<br /> |
246
+
247
+
248
+
#### MCPRegistrySource
249
+
250
+
251
+
252
+
MCPRegistrySource defines the source configuration for registry data
253
+
254
+
255
+
256
+
_Appears in:_
257
+
-[MCPRegistrySpec](#mcpregistryspec)
258
+
259
+
| Field | Description | Default | Validation |
260
+
| --- | --- | --- | --- |
261
+
|`type`_string_| Type is the type of source (configmap) | configmap | Enum: [configmap] <br /> |
262
+
|`format`_string_| Format is the data format (toolhive, upstream) | toolhive | Enum: [toolhive upstream] <br /> |
263
+
|`configmap`_[ConfigMapSource](#configmapsource)_| ConfigMap defines the ConfigMap source configuration<br />Only used when Type is "configmap" |||
264
+
265
+
266
+
#### MCPRegistrySpec
267
+
268
+
269
+
270
+
MCPRegistrySpec defines the desired state of MCPRegistry
271
+
272
+
273
+
274
+
_Appears in:_
275
+
-[MCPRegistry](#mcpregistry)
276
+
277
+
| Field | Description | Default | Validation |
278
+
| --- | --- | --- | --- |
279
+
|`displayName`_string_| DisplayName is a human-readable name for the registry |||
280
+
|`source`_[MCPRegistrySource](#mcpregistrysource)_| Source defines the configuration for the registry data source || Required: \{\} <br /> |
281
+
|`syncPolicy`_[SyncPolicy](#syncpolicy)_| SyncPolicy defines the automatic synchronization behavior for the registry.<br />If specified, enables automatic synchronization at the given interval.<br />Manual synchronization is always supported via annotation-based triggers<br />regardless of this setting. |||
282
+
|`filter`_[RegistryFilter](#registryfilter)_| Filter defines include/exclude patterns for registry content |||
283
+
284
+
285
+
#### MCPRegistryStatus
286
+
287
+
288
+
289
+
MCPRegistryStatus defines the observed state of MCPRegistry
290
+
291
+
292
+
293
+
_Appears in:_
294
+
-[MCPRegistry](#mcpregistry)
295
+
296
+
| Field | Description | Default | Validation |
297
+
| --- | --- | --- | --- |
298
+
|`phase`_[MCPRegistryPhase](#mcpregistryphase)_| Phase represents the current phase of the MCPRegistry || Enum: [Pending Ready Failed Syncing Terminating] <br /> |
299
+
|`message`_string_| Message provides additional information about the current phase |||
300
+
|`lastSyncTime`_[Time](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#time-v1-meta)_| LastSyncTime is the timestamp of the last successful sync |||
301
+
|`lastSyncHash`_string_| LastSyncHash is the hash of the last successfully synced data<br />Used to detect changes in source data |||
302
+
|`serverCount`_integer_| ServerCount is the total number of servers in the registry || Minimum: 0 <br /> |
303
+
|`deployedServerCount`_integer_| DeployedServerCount is the number of deployed servers with matching labels || Minimum: 0 <br /> |
304
+
|`syncAttempts`_integer_| SyncAttempts is the number of sync attempts since last success || Minimum: 0 <br /> |
305
+
|`apiEndpoint`_string_| APIEndpoint is the URL of the registry API service |||
306
+
|`storageRef`_[StorageReference](#storagereference)_| StorageRef is a reference to the internal storage location |||
307
+
|`conditions`_[Condition](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#condition-v1-meta) array_| Conditions represent the latest available observations of the MCPRegistry's state |||
308
+
309
+
149
310
#### MCPServer
150
311
151
312
@@ -236,6 +397,7 @@ _Appears in:_
236
397
|`resourceOverrides`_[ResourceOverrides](#resourceoverrides)_| ResourceOverrides allows overriding annotations and labels for resources created by the operator |||
237
398
|`oidcConfig`_[OIDCConfigRef](#oidcconfigref)_| OIDCConfig defines OIDC authentication configuration for the MCP server |||
238
399
|`authzConfig`_[AuthzConfigRef](#authzconfigref)_| AuthzConfig defines authorization policy configuration for the MCP server |||
400
+
|`audit`_[AuditConfig](#auditconfig)_| Audit defines audit logging configuration for the MCP server |||
239
401
|`tools`_string array_| ToolsFilter is the filter on tools applied to the MCP server |||
240
402
|`telemetry`_[TelemetryConfig](#telemetryconfig)_| Telemetry defines observability configuration for the MCP server |||
241
403
@@ -259,6 +421,23 @@ _Appears in:_
259
421
|`message`_string_| Message provides additional information about the current phase |||
260
422
261
423
424
+
#### NameFilter
425
+
426
+
427
+
428
+
NameFilter defines name-based filtering
429
+
430
+
431
+
432
+
_Appears in:_
433
+
-[RegistryFilter](#registryfilter)
434
+
435
+
| Field | Description | Default | Validation |
436
+
| --- | --- | --- | --- |
437
+
|`include`_string array_| Include is a list of glob patterns to include |||
438
+
|`exclude`_string array_| Exclude is a list of glob patterns to exclude |||
439
+
440
+
262
441
#### NetworkPermissions
263
442
264
443
@@ -314,6 +493,7 @@ _Appears in:_
314
493
|`headers`_string array_| Headers contains authentication headers for the OTLP endpoint<br />Specified as key=value pairs |||
315
494
|`insecure`_boolean_| Insecure indicates whether to use HTTP instead of HTTPS for the OTLP endpoint | false ||
|`enabled`_boolean_| Enabled controls whether OTLP tracing is sent | false ||
529
+
|`samplingRate`_string_| SamplingRate is the trace sampling rate (0.0-1.0) | 0.05 ||
333
530
334
531
335
532
#### OutboundNetworkPermissions
@@ -405,6 +602,23 @@ _Appears in:_
405
602
|`env`_[EnvVar](#envvar) array_| Env are environment variables to set in the proxy container (thv run process)<br />These affect the toolhive proxy itself, not the MCP server it manages |||
406
603
407
604
605
+
#### RegistryFilter
606
+
607
+
608
+
609
+
RegistryFilter defines include/exclude patterns for registry content
|`targetEnvName`_string_| TargetEnvName is the environment variable to be used when setting up the secret in the MCP server<br />If left unspecified, it defaults to the key |||
493
707
494
708
709
+
#### StorageReference
710
+
711
+
712
+
713
+
StorageReference defines a reference to internal storage
714
+
715
+
716
+
717
+
_Appears in:_
718
+
-[MCPRegistryStatus](#mcpregistrystatus)
719
+
720
+
| Field | Description | Default | Validation |
721
+
| --- | --- | --- | --- |
722
+
|`type`_string_| Type is the storage type (configmap) || Enum: [configmap] <br /> |
723
+
|`configMapRef`_[LocalObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#localobjectreference-v1-core)_| ConfigMapRef is a reference to a ConfigMap storage<br />Only used when Type is "configmap" |||
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?v=4&size=40){kind=avatar}
0 commit comments