Skip to content

Commit 1abbf00

Browse files
sync docs (#524)
Co-authored-by: michaeljguarino <[email protected]>
1 parent 091432c commit 1abbf00

File tree

2 files changed

+116
-2
lines changed

2 files changed

+116
-2
lines changed

pages/overview/agent-api-reference.md

Lines changed: 110 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ Package v1alpha1 contains API Schema definitions for the deployments v1alpha1 AP
1010

1111
### Resource Types
1212
- [AgentConfiguration](#agentconfiguration)
13+
- [AgentRuntime](#agentruntime)
1314
- [ClusterDrain](#clusterdrain)
1415
- [CustomHealth](#customhealth)
1516
- [IngressReplica](#ingressreplica)
@@ -99,6 +100,78 @@ _Appears in:_
99100
| `valuesConfigMapRef` _[ConfigMapKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#configmapkeyselector-v1-core)_ | ValuesConfigMapRef fetches helm values from a config map in this cluster.<br />Use only one of:<br /> - Values<br /> - ValuesSecretRef<br /> - ValuesConfigMapRef | | Optional: \{\} <br /> |
100101

101102

103+
#### AgentRuntime
104+
105+
106+
107+
AgentRuntime is the Schema for the agentruntimes API
108+
109+
110+
111+
112+
113+
| Field | Description | Default | Validation |
114+
| --- | --- | --- | --- |
115+
| `apiVersion` _string_ | `deployments.plural.sh/v1alpha1` | | |
116+
| `kind` _string_ | `AgentRuntime` | | |
117+
| `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. | | |
118+
| `spec` _[AgentRuntimeSpec](#agentruntimespec)_ | | | |
119+
120+
121+
#### AgentRuntimeBindings
122+
123+
124+
125+
126+
127+
128+
129+
_Appears in:_
130+
- [AgentRuntimeSpec](#agentruntimespec)
131+
132+
| Field | Description | Default | Validation |
133+
| --- | --- | --- | --- |
134+
| `create` _[Binding](#binding) array_ | Create bindings control who can generate new agent runtimes. | | Optional: \{\} <br /> |
135+
136+
137+
#### AgentRuntimeConfig
138+
139+
140+
141+
AgentRuntimeConfig contains typed configuration for the agent runtime.
142+
143+
144+
145+
_Appears in:_
146+
- [AgentRuntimeSpec](#agentruntimespec)
147+
148+
| Field | Description | Default | Validation |
149+
| --- | --- | --- | --- |
150+
| `claude` _[ClaudeConfig](#claudeconfig)_ | Config for Claude CLI runtime. | | Optional: \{\} <br /> |
151+
| `opencode` _[OpenCodeConfig](#opencodeconfig)_ | Config for OpenCode CLI runtime. | | Optional: \{\} <br /> |
152+
153+
154+
#### AgentRuntimeSpec
155+
156+
157+
158+
AgentRuntimeSpec defines the desired state of AgentRuntime
159+
160+
161+
162+
_Appears in:_
163+
- [AgentRuntime](#agentruntime)
164+
165+
| Field | Description | Default | Validation |
166+
| --- | --- | --- | --- |
167+
| `name` _string_ | Name of this AgentRuntime.<br />If not provided, the name from AgentRuntime.ObjectMeta will be used. | | Optional: \{\} <br /> |
168+
| `type` _[AgentRuntimeType](#agentruntimetype)_ | Type specifies the agent runtime to use for executing the stack.<br />One of CLAUDE, OPENCODE, GEMINI, CUSTOM. | | Enum: [CLAUDE OPENCODE GEMINI CUSTOM] <br />Required: \{\} <br /> |
169+
| `bindings` _[AgentRuntimeBindings](#agentruntimebindings)_ | Bindings define the creation permissions for this agent runtime. | | Optional: \{\} <br /> |
170+
| `template` _[PodTemplateSpec](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#podtemplatespec-v1-core)_ | Template defines the pod template for this agent runtime. | | Required: \{\} <br /> |
171+
| `config` _[AgentRuntimeConfig](#agentruntimeconfig)_ | Config contains typed configuration depending on the chosen runtime type. | | |
172+
| `aiProxy` _boolean_ | AiProxy specifies whether the agent runtime should be proxied through the AI proxy. | | |
173+
174+
102175
#### Binding
103176

104177

@@ -108,6 +181,7 @@ Binding ...
108181

109182

110183
_Appears in:_
184+
- [AgentRuntimeBindings](#agentruntimebindings)
111185
- [Bindings](#bindings)
112186

113187
| Field | Description | Default | Validation |
@@ -138,6 +212,24 @@ _Appears in:_
138212
| `write` _[Binding](#binding) array_ | Write bindings. | | Optional: \{\} <br /> |
139213

140214

215+
#### ClaudeConfig
216+
217+
218+
219+
ClaudeConfig contains configuration for the Claude CLI runtime.
220+
221+
222+
223+
_Appears in:_
224+
- [AgentRuntimeConfig](#agentruntimeconfig)
225+
226+
| Field | Description | Default | Validation |
227+
| --- | --- | --- | --- |
228+
| `apiKeySecretRef` _[SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#secretkeyselector-v1-core)_ | ApiKeySecretRef Reference to a Kubernetes Secret containing the Claude API key. | | |
229+
| `model` _string_ | Model Name of the model to use. | | |
230+
| `extraArgs` _string array_ | ExtraArgs CLI args for advanced flags not modeled here | | |
231+
232+
141233
#### ClusterDrain
142234

143235

@@ -431,6 +523,24 @@ MetricsAggregate
431523

432524

433525

526+
#### OpenCodeConfig
527+
528+
529+
530+
OpenCodeConfig contains configuration for the OpenCode CLI runtime.
531+
532+
533+
534+
_Appears in:_
535+
- [AgentRuntimeConfig](#agentruntimeconfig)
536+
537+
| Field | Description | Default | Validation |
538+
| --- | --- | --- | --- |
539+
| `endpoint` _string_ | API endpoint for the OpenCode service. | | |
540+
| `tokenSecretRef` _[SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#secretkeyselector-v1-core)_ | Reference to a Kubernetes Secret containing the API token for OpenCode. | | |
541+
| `extraArgs` _string array_ | Extra args for advanced or experimental CLI flags. | | |
542+
543+
434544
#### PipelineGate
435545

436546

pages/overview/management-api-reference.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -249,7 +249,7 @@ _Appears in:_
249249

250250
| Field | Description | Default | Validation |
251251
| --- | --- | --- | --- |
252-
| `modelId` _string_ | ModelID is the AWS Bedrock Model ID to use. | | Required: \{\} <br /> |
252+
| `modelId` _string_ | ModelID is the AWS Bedrock Model ID to use. This will use the openai compatible endpoint, so the model id must be supported. | | Required: \{\} <br /> |
253253
| `toolModelId` _string_ | ToolModelId to use for tool calling, which is less frequent and often requires more advanced reasoning | | Optional: \{\} <br /> |
254254
| `embeddingModel` _string_ | EmbeddingModel to use for generating embeddings | | Optional: \{\} <br /> |
255255
| `region` _string_ | Region is the AWS region the model is hosted in | | Required: \{\} <br /> |
@@ -843,6 +843,7 @@ specifications that are populated with data from the discovered clusters.
843843

844844
Example usage:
845845

846+
```yaml
846847
apiVersion: deployments.plural.sh/v1alpha1
847848
kind: ClusterSync
848849
metadata:
@@ -861,6 +862,7 @@ Example usage:
861862
handle: "{{ .cluster.handle }}"
862863
version: "{{ .cluster.version }}"
863864
cloud: "{{ .cluster.cloud }}"
865+
````
864866

865867

866868

@@ -1146,6 +1148,7 @@ monitoring integrations, and AI-powered features.
11461148

11471149
Example usage:
11481150

1151+
```yaml
11491152
apiVersion: deployments.plural.sh/v1alpha1
11501153
kind: DeploymentSettings
11511154
metadata:
@@ -1183,6 +1186,7 @@ Example usage:
11831186
cost:
11841187
recommendationCushion: 20
11851188
recommendationThreshold: 100
1189+
```
11861190

11871191

11881192

@@ -4596,7 +4600,7 @@ _Appears in:_
45964600

45974601
| Field | Description | Default | Validation |
45984602
| --- | --- | --- | --- |
4599-
| `model` _string_ | Model is the Vertex AI model to use | | Optional: \{\} <br /> |
4603+
| `model` _string_ | Model is the Vertex AI model to use. Must support the OpenAI completions api, see: https://cloud.google.com/vertex-ai/generative-ai/docs/migrate/openai/overview | | Optional: \{\} <br /> |
46004604
| `toolModel` _string_ | ToolModel to use for tool calling, which is less frequent and often requires more advanced reasoning | | Optional: \{\} <br /> |
46014605
| `embeddingModel` _string_ | EmbeddingModel to use for generating embeddings | | Optional: \{\} <br /> |
46024606
| `project` _string_ | Project is the GCP project you'll be using | | Required: \{\} <br /> |

0 commit comments

Comments
 (0)