Skip to content

Commit a4dc1da

Browse files
Update ToolHive reference docs for toolhive-operator-crds-0.0.19 (#158)
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
1 parent 67bd704 commit a4dc1da

File tree

1 file changed

+74
-2
lines changed

1 file changed

+74
-2
lines changed

static/api-specs/toolhive-crd-api.md

Lines changed: 74 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ _Appears in:_
117117
| `audience` _string_ | Audience is the expected audience for the token | | |
118118
| `jwksUrl` _string_ | JWKSURL is the URL to fetch the JWKS from | | |
119119
| `introspectionUrl` _string_ | IntrospectionURL is the URL for token introspection endpoint | | |
120-
| `clientId` _string_ | ClientID is deprecated and will be removed in a future release. | | |
120+
| `clientId` _string_ | ClientID is the OIDC client ID | | |
121121
| `clientSecret` _string_ | ClientSecret is the client secret for introspection (optional) | | |
122122
| `thvCABundlePath` _string_ | ThvCABundlePath is the path to CA certificate bundle file for HTTPS requests<br />The file must be mounted into the pod (e.g., via ConfigMap or Secret volume) | | |
123123
| `jwksAuthTokenPath` _string_ | JWKSAuthTokenPath is the path to file containing bearer token for JWKS/OIDC requests<br />The file must be mounted into the pod (e.g., via Secret volume) | | |
@@ -137,7 +137,7 @@ _Appears in:_
137137

138138
| Field | Description | Default | Validation |
139139
| --- | --- | --- | --- |
140-
| `serviceAccount` _string_ | ServiceAccount is deprecated and will be removed in a future release. | | |
140+
| `serviceAccount` _string_ | ServiceAccount is the name of the service account to validate tokens for<br />If empty, uses the pod's service account | | |
141141
| `namespace` _string_ | Namespace is the namespace of the service account<br />If empty, uses the MCPServer's namespace | | |
142142
| `audience` _string_ | Audience is the expected audience for the token | toolhive | |
143143
| `issuer` _string_ | Issuer is the OIDC issuer URL | https://kubernetes.default.svc | |
@@ -237,6 +237,7 @@ _Appears in:_
237237
| `oidcConfig` _[OIDCConfigRef](#oidcconfigref)_ | OIDCConfig defines OIDC authentication configuration for the MCP server | | |
238238
| `authzConfig` _[AuthzConfigRef](#authzconfigref)_ | AuthzConfig defines authorization policy configuration for the MCP server | | |
239239
| `tools` _string array_ | ToolsFilter is the filter on tools applied to the MCP server | | |
240+
| `telemetry` _[TelemetryConfig](#telemetryconfig)_ | Telemetry defines observability configuration for the MCP server | | |
240241

241242

242243
#### MCPServerStatus
@@ -294,6 +295,43 @@ _Appears in:_
294295
| `inline` _[InlineOIDCConfig](#inlineoidcconfig)_ | Inline contains direct OIDC configuration<br />Only used when Type is "inline" | | |
295296

296297

298+
#### OpenTelemetryConfig
299+
300+
301+
302+
OpenTelemetryConfig defines pure OpenTelemetry configuration
303+
304+
305+
306+
_Appears in:_
307+
- [TelemetryConfig](#telemetryconfig)
308+
309+
| Field | Description | Default | Validation |
310+
| --- | --- | --- | --- |
311+
| `enabled` _boolean_ | Enabled controls whether OpenTelemetry is enabled | false | |
312+
| `endpoint` _string_ | Endpoint is the OTLP endpoint URL for tracing and metrics | | |
313+
| `serviceName` _string_ | ServiceName is the service name for telemetry<br />If not specified, defaults to the MCPServer name | | |
314+
| `headers` _string array_ | Headers contains authentication headers for the OTLP endpoint<br />Specified as key=value pairs | | |
315+
| `insecure` _boolean_ | Insecure indicates whether to use HTTP instead of HTTPS for the OTLP endpoint | false | |
316+
| `metrics` _[OpenTelemetryMetricsConfig](#opentelemetrymetricsconfig)_ | Metrics defines OpenTelemetry metrics-specific configuration | | |
317+
318+
319+
#### OpenTelemetryMetricsConfig
320+
321+
322+
323+
OpenTelemetryMetricsConfig defines OpenTelemetry metrics configuration
324+
325+
326+
327+
_Appears in:_
328+
- [OpenTelemetryConfig](#opentelemetryconfig)
329+
330+
| Field | Description | Default | Validation |
331+
| --- | --- | --- | --- |
332+
| `enabled` _boolean_ | Enabled controls whether OTLP metrics are sent | true | |
333+
334+
297335
#### OutboundNetworkPermissions
298336

299337

@@ -332,6 +370,22 @@ _Appears in:_
332370

333371

334372

373+
#### PrometheusConfig
374+
375+
376+
377+
PrometheusConfig defines Prometheus-specific configuration
378+
379+
380+
381+
_Appears in:_
382+
- [TelemetryConfig](#telemetryconfig)
383+
384+
| Field | Description | Default | Validation |
385+
| --- | --- | --- | --- |
386+
| `enabled` _boolean_ | Enabled controls whether Prometheus metrics endpoint is exposed | false | |
387+
388+
335389
#### ProxyDeploymentOverrides
336390

337391

@@ -347,6 +401,7 @@ _Appears in:_
347401
| --- | --- | --- | --- |
348402
| `annotations` _object (keys:string, values:string)_ | Annotations to add or override on the resource | | |
349403
| `labels` _object (keys:string, values:string)_ | Labels to add or override on the resource | | |
404+
| `podTemplateMetadataOverrides` _[ResourceMetadataOverrides](#resourcemetadataoverrides)_ | | | |
350405
| `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 | | |
351406

352407

@@ -437,6 +492,23 @@ _Appears in:_
437492
| `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 | | |
438493

439494

495+
#### TelemetryConfig
496+
497+
498+
499+
TelemetryConfig defines observability configuration for the MCP server
500+
501+
502+
503+
_Appears in:_
504+
- [MCPServerSpec](#mcpserverspec)
505+
506+
| Field | Description | Default | Validation |
507+
| --- | --- | --- | --- |
508+
| `openTelemetry` _[OpenTelemetryConfig](#opentelemetryconfig)_ | OpenTelemetry defines OpenTelemetry configuration | | |
509+
| `prometheus` _[PrometheusConfig](#prometheusconfig)_ | Prometheus defines Prometheus-specific configuration | | |
510+
511+
440512
#### Volume
441513

442514

0 commit comments

Comments
 (0)