Skip to content

Commit 6c6f477

Browse files
Update ToolHive reference docs for toolhive-operator-crds-0.0.8 (#32)
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
1 parent a50e950 commit 6c6f477

File tree

1 file changed

+53
-0
lines changed

1 file changed

+53
-0
lines changed

static/api-specs/crd-api.md

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,41 @@ Package v1alpha1 contains API Schema definitions for the toolhive v1alpha1 API g
1313

1414

1515

16+
#### AuthzConfigRef
17+
18+
19+
20+
AuthzConfigRef defines a reference to authorization configuration
21+
22+
23+
24+
_Appears in:_
25+
- [MCPServerSpec](#mcpserverspec)
26+
27+
| Field | Description | Default | Validation |
28+
| --- | --- | --- | --- |
29+
| `type` _string_ | Type is the type of authorization configuration | configMap | Enum: [configMap inline] <br /> |
30+
| `configMap` _[ConfigMapAuthzRef](#configmapauthzref)_ | ConfigMap references a ConfigMap containing authorization configuration<br />Only used when Type is "configMap" | | |
31+
| `inline` _[InlineAuthzConfig](#inlineauthzconfig)_ | Inline contains direct authorization configuration<br />Only used when Type is "inline" | | |
32+
33+
34+
#### ConfigMapAuthzRef
35+
36+
37+
38+
ConfigMapAuthzRef references a ConfigMap containing authorization configuration
39+
40+
41+
42+
_Appears in:_
43+
- [AuthzConfigRef](#authzconfigref)
44+
45+
| Field | Description | Default | Validation |
46+
| --- | --- | --- | --- |
47+
| `name` _string_ | Name is the name of the ConfigMap | | Required: \{\} <br /> |
48+
| `key` _string_ | Key is the key in the ConfigMap that contains the authorization configuration | authz.json | |
49+
50+
1651
#### ConfigMapOIDCRef
1752

1853

@@ -47,6 +82,23 @@ _Appears in:_
4782
| `value` _string_ | Value of the environment variable | | Required: \{\} <br /> |
4883

4984

85+
#### InlineAuthzConfig
86+
87+
88+
89+
InlineAuthzConfig contains direct authorization configuration
90+
91+
92+
93+
_Appears in:_
94+
- [AuthzConfigRef](#authzconfigref)
95+
96+
| Field | Description | Default | Validation |
97+
| --- | --- | --- | --- |
98+
| `policies` _string array_ | Policies is a list of Cedar policy strings | | MinItems: 1 <br />Required: \{\} <br /> |
99+
| `entitiesJson` _string_ | EntitiesJSON is a JSON string representing Cedar entities | [] | |
100+
101+
50102
#### InlineOIDCConfig
51103

52104

@@ -174,6 +226,7 @@ _Appears in:_
174226
| `podTemplateSpec` _[PodTemplateSpec](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.27/#podtemplatespec-v1-core)_ | PodTemplateSpec defines the pod template to use for the MCP server<br />This allows for customizing the pod configuration beyond what is provided by the other fields.<br />Note that to modify the specific container the MCP server runs in, you must specify<br />the `mcp` container name in the PodTemplateSpec. | | |
175227
| `resourceOverrides` _[ResourceOverrides](#resourceoverrides)_ | ResourceOverrides allows overriding annotations and labels for resources created by the operator | | |
176228
| `oidcConfig` _[OIDCConfigRef](#oidcconfigref)_ | OIDCConfig defines OIDC authentication configuration for the MCP server | | |
229+
| `authzConfig` _[AuthzConfigRef](#authzconfigref)_ | AuthzConfig defines authorization policy configuration for the MCP server | | |
177230

178231

179232
#### MCPServerStatus

0 commit comments

Comments
 (0)