Skip to content

Commit d7b7588

Browse files
sync docs (#527)
Co-authored-by: michaeljguarino <[email protected]>
1 parent 5d36fa0 commit d7b7588

File tree

1 file changed

+84
-2
lines changed

1 file changed

+84
-2
lines changed

pages/overview/agent-api-reference.md

Lines changed: 84 additions & 2 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+
- [AgentRun](#agentrun)
1314
- [AgentRuntime](#agentruntime)
1415
- [ClusterDrain](#clusterdrain)
1516
- [CustomHealth](#customhealth)
@@ -100,6 +101,67 @@ _Appears in:_
100101
| `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 /> |
101102

102103

104+
#### AgentRun
105+
106+
107+
108+
AgentRun is the Schema for the agentruns API
109+
110+
111+
112+
113+
114+
| Field | Description | Default | Validation |
115+
| --- | --- | --- | --- |
116+
| `apiVersion` _string_ | `deployments.plural.sh/v1alpha1` | | |
117+
| `kind` _string_ | `AgentRun` | | |
118+
| `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. | | |
119+
| `spec` _[AgentRunSpec](#agentrunspec)_ | | | |
120+
121+
122+
#### AgentRunPhase
123+
124+
_Underlying type:_ _string_
125+
126+
AgentRunPhase represents the phase of an agent run
127+
128+
_Validation:_
129+
- Enum: [Pending Running Succeeded Failed Cancelled]
130+
131+
_Appears in:_
132+
- [AgentRunStatus](#agentrunstatus)
133+
134+
| Field | Description |
135+
| --- | --- |
136+
| `Pending` | |
137+
| `Running` | |
138+
| `Succeeded` | |
139+
| `Failed` | |
140+
| `Cancelled` | |
141+
142+
143+
#### AgentRunSpec
144+
145+
146+
147+
AgentRunSpec defines the desired state of AgentRun
148+
149+
150+
151+
_Appears in:_
152+
- [AgentRun](#agentrun)
153+
154+
| Field | Description | Default | Validation |
155+
| --- | --- | --- | --- |
156+
| `runtimeRef` _[AgentRuntimeReference](#agentruntimereference)_ | | | Required: \{\} <br /> |
157+
| `prompt` _string_ | Prompt is the task/prompt given to the agent | | Required: \{\} <br /> |
158+
| `repository` _string_ | Repository is the git repository the agent will work with | | Required: \{\} <br /> |
159+
| `mode` _[AgentRunMode](#agentrunmode)_ | Mode defines how the agent should run (ANALYZE, WRITE) | | Required: \{\} <br /> |
160+
| `flowId` _string_ | FlowID is the flow this agent run is associated with (optional) | | Optional: \{\} <br /> |
161+
162+
163+
164+
103165
#### AgentRuntime
104166

105167

@@ -151,6 +213,22 @@ _Appears in:_
151213
| `opencode` _[OpenCodeConfig](#opencodeconfig)_ | Config for OpenCode CLI runtime. | | Optional: \{\} <br /> |
152214

153215

216+
#### AgentRuntimeReference
217+
218+
219+
220+
221+
222+
223+
224+
_Appears in:_
225+
- [AgentRunSpec](#agentrunspec)
226+
227+
| Field | Description | Default | Validation |
228+
| --- | --- | --- | --- |
229+
| `name` _string_ | | | Required: \{\} <br /> |
230+
231+
154232
#### AgentRuntimeSpec
155233

156234

@@ -165,10 +243,11 @@ _Appears in:_
165243
| Field | Description | Default | Validation |
166244
| --- | --- | --- | --- |
167245
| `name` _string_ | Name of this AgentRuntime.<br />If not provided, the name from AgentRuntime.ObjectMeta will be used. | | Optional: \{\} <br /> |
246+
| `targetNamespace` _string_ | | | Required: \{\} <br /> |
168247
| `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 /> |
169248
| `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. | | |
249+
| `template` _[PodTemplateSpec](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#podtemplatespec-v1-core)_ | Template defines the pod template for this agent runtime. | | |
250+
| `config` _[AgentRuntimeConfig](#agentruntimeconfig)_ | Config contains typed configuration depending on the chosen runtime type. | | Optional: \{\} <br /> |
172251
| `aiProxy` _boolean_ | AiProxy specifies whether the agent runtime should be proxied through the AI proxy. | | |
173252

174253

@@ -580,6 +659,8 @@ _Appears in:_
580659

581660

582661

662+
663+
583664
#### Progress
584665

585666

@@ -642,6 +723,7 @@ _Appears in:_
642723

643724

644725
_Appears in:_
726+
- [AgentRunStatus](#agentrunstatus)
645727
- [VirtualClusterStatus](#virtualclusterstatus)
646728

647729
| Field | Description | Default | Validation |

0 commit comments

Comments
 (0)