Skip to content

Commit fd9e5e2

Browse files
Update ToolHive reference docs for toolhive-operator-crds-0.0.11 (#51)
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
1 parent 806bfff commit fd9e5e2

File tree

1 file changed

+29
-5
lines changed

1 file changed

+29
-5
lines changed

static/api-specs/crd-api.md

Lines changed: 29 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,7 @@ EnvVar represents an environment variable in a container
7575

7676
_Appears in:_
7777
- [MCPServerSpec](#mcpserverspec)
78+
- [ProxyDeploymentOverrides](#proxydeploymentoverrides)
7879

7980
| Field | Description | Default | Validation |
8081
| --- | --- | --- | --- |
@@ -115,7 +116,10 @@ _Appears in:_
115116
| `issuer` _string_ | Issuer is the OIDC issuer URL | | Required: \{\} <br /> |
116117
| `audience` _string_ | Audience is the expected audience for the token | | |
117118
| `jwksUrl` _string_ | JWKSURL is the URL to fetch the JWKS from | | |
118-
| `clientId` _string_ | ClientID is the OIDC client ID | | |
119+
| `clientId` _string_ | ClientID is deprecated and will be removed in a future release. | | |
120+
| `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) | | |
121+
| `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) | | |
122+
| `jwksAllowPrivateIP` _boolean_ | JWKSAllowPrivateIP allows JWKS/OIDC endpoints on private IP addresses<br />Use with caution - only enable for trusted internal IDPs | false | |
119123

120124

121125
#### KubernetesOIDCConfig
@@ -131,11 +135,12 @@ _Appears in:_
131135

132136
| Field | Description | Default | Validation |
133137
| --- | --- | --- | --- |
134-
| `serviceAccount` _string_ | ServiceAccount is the name of the service account to validate tokens for<br />If empty, uses the pod's service account | | |
138+
| `serviceAccount` _string_ | ServiceAccount is deprecated and will be removed in a future release. | | |
135139
| `namespace` _string_ | Namespace is the namespace of the service account<br />If empty, uses the MCPServer's namespace | | |
136140
| `audience` _string_ | Audience is the expected audience for the token | toolhive | |
137141
| `issuer` _string_ | Issuer is the OIDC issuer URL | https://kubernetes.default.svc | |
138-
| `jwksUrl` _string_ | JWKSURL is the URL to fetch the JWKS from | https://kubernetes.default.svc/openid/v1/jwks | |
142+
| `jwksUrl` _string_ | JWKSURL is the URL to fetch the JWKS from<br />If empty, OIDC discovery will be used to automatically determine the JWKS URL | | |
143+
| `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 | | |
139144

140145

141146
#### MCPServer
@@ -277,7 +282,7 @@ _Appears in:_
277282

278283
| Field | Description | Default | Validation |
279284
| --- | --- | --- | --- |
280-
| `type` _string_ | Type is the type of OIDC configuration | kubernetes | Enum: [kubernetes configmap inline] <br /> |
285+
| `type` _string_ | Type is the type of OIDC configuration | kubernetes | Enum: [kubernetes configMap inline] <br /> |
281286
| `kubernetes` _[KubernetesOIDCConfig](#kubernetesoidcconfig)_ | Kubernetes configures OIDC for Kubernetes service account token validation<br />Only used when Type is "kubernetes" | | |
282287
| `configMap` _[ConfigMapOIDCRef](#configmapoidcref)_ | ConfigMap references a ConfigMap containing OIDC configuration<br />Only used when Type is "configmap" | | |
283288
| `inline` _[InlineOIDCConfig](#inlineoidcconfig)_ | Inline contains direct OIDC configuration<br />Only used when Type is "inline" | | |
@@ -322,6 +327,24 @@ _Appears in:_
322327

323328

324329

330+
#### ProxyDeploymentOverrides
331+
332+
333+
334+
ProxyDeploymentOverrides defines overrides specific to the proxy deployment
335+
336+
337+
338+
_Appears in:_
339+
- [ResourceOverrides](#resourceoverrides)
340+
341+
| Field | Description | Default | Validation |
342+
| --- | --- | --- | --- |
343+
| `annotations` _object (keys:string, values:string)_ | Annotations to add or override on the resource | | |
344+
| `labels` _object (keys:string, values:string)_ | Labels to add or override on the resource | | |
345+
| `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 | | |
346+
347+
325348
#### ResourceList
326349

327350

@@ -348,6 +371,7 @@ ResourceMetadataOverrides defines metadata overrides for a resource
348371

349372

350373
_Appears in:_
374+
- [ProxyDeploymentOverrides](#proxydeploymentoverrides)
351375
- [ResourceOverrides](#resourceoverrides)
352376

353377
| Field | Description | Default | Validation |
@@ -369,7 +393,7 @@ _Appears in:_
369393

370394
| Field | Description | Default | Validation |
371395
| --- | --- | --- | --- |
372-
| `proxyDeployment` _[ResourceMetadataOverrides](#resourcemetadataoverrides)_ | ProxyDeployment defines overrides for the Proxy Deployment resource (toolhive proxy) | | |
396+
| `proxyDeployment` _[ProxyDeploymentOverrides](#proxydeploymentoverrides)_ | ProxyDeployment defines overrides for the Proxy Deployment resource (toolhive proxy) | | |
373397
| `proxyService` _[ResourceMetadataOverrides](#resourcemetadataoverrides)_ | ProxyService defines overrides for the Proxy Service resource (points to the proxy deployment) | | |
374398

375399

0 commit comments

Comments
 (0)