You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
|`prompt`_string_| Prompt is the task/prompt given to the agent || Required: \{\} <br /> |
167
167
|`repository`_string_| Repository is the git repository the agent will work with || Required: \{\} <br /> |
168
+
|`branch`_string_| Branch is the repository branch the agent should operate on. If omitted, the repository default branch is used. || Optional: \{\} <br /> |
168
169
|`mode`_[AgentRunMode](#agentrunmode)_| Mode defines how the agent should run (ANALYZE, WRITE) || Required: \{\} <br /> |
169
170
|`flowId`_string_| FlowID is the flow this agent run is associated with (optional) || Optional: \{\} <br /> |
170
171
|`language`_[AgentRunLanguage](#agentrunlanguage)_| Language is the programming language used in the agent run.<br />Deprecated: No longer used for image selection. Enable dind on the AgentRuntime instead. || Optional: \{\} <br /> |
@@ -265,6 +266,7 @@ _Appears in:_
265
266
|`template`_[PodTemplateSpec](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#podtemplatespec-v1-core)_| Template defines the pod template for this agent runtime. |||
266
267
|`config`_[AgentRuntimeConfig](#agentruntimeconfig)_| Config contains typed configuration depending on the chosen runtime type. || Optional: \{\} <br /> |
267
268
|`aiProxy`_boolean_| AiProxy routes LLM requests through the Console AI proxy (/ext/ai) using the deploy token,<br />so provider API keys in spec.config are optional.<br />Set the model on the runtime-specific config block (for example spec.config.codex.model).<br />The proxy expects models in provider/name format (for example openai/gpt-5.4,<br />anthropic/claude-sonnet-4-5, vertex/gemini-2.5-pro). Values that already include a "/"<br />are passed through unchanged.<br />When only a bare model id is given, the harness may prefix it by runtime type:<br /> - CLAUDE: anthropic/\{model\} (for example claude-sonnet-4-5 -> anthropic/claude-sonnet-4-5)<br /> - CODEX, OPENCODE: openai/\{model\} (for example gpt-5.4 -> openai/gpt-5.4)<br /> - GEMINI: vertex/\{model\}<br /> - CUSTOM: no automatic prefix; use provider/name explicitly |||
269
+
|`streamingProxy`_boolean_| StreamingProxy routes OpenAI-compatible LLM requests through the in-pod mcpserver<br />sse conversion proxy before they reach the Console AI proxy (/ext/ai). Only valid when aiProxy<br />is enabled. Applies to CODEX and OPENCODE runtimes. || Optional: \{\} <br /> |
268
270
|`dind`_boolean_| Dind enables Docker-in-Docker for this agent runtime.<br />When true, the runtime will be configured to run with DinD support. || Optional: \{\} <br /> |
269
271
|`allowedRepositories`_string array_| AllowedRepositories the git repositories allowed to be used with this runtime. || Optional: \{\} <br /> |
270
272
|`browser`_[BrowserConfig](#browserconfig)_| Browser configuration augments agent runtime with a headless browser.<br />When provided, the runtime will be configured to run with a headless browser available<br />for the agent to use. || Optional: \{\} <br /> |
@@ -528,6 +530,23 @@ _Appears in:_
528
530
529
531
530
532
533
+
#### CostProvider
534
+
535
+
_Underlying type:__string_
536
+
537
+
CostProvider identifies which cost allocation backend to query.
538
+
539
+
540
+
541
+
_Appears in:_
542
+
-[KubecostExtractorSpec](#kubecostextractorspec)
543
+
544
+
| Field | Description |
545
+
| --- | --- |
546
+
|`Kubecost`||
547
+
|`OpenCost`||
548
+
549
+
531
550
#### CustomHealth
532
551
533
552
@@ -560,6 +579,9 @@ _Appears in:_
560
579
| Field | Description | Default | Validation |
561
580
| --- | --- | --- | --- |
562
581
|`script`_string_||||
582
+
|`group`_string_||| Optional: \{\} <br /> |
583
+
|`version`_string_||| Optional: \{\} <br /> |
584
+
|`kind`_string_||| Optional: \{\} <br /> |
563
585
564
586
565
587
@@ -814,8 +836,9 @@ _Appears in:_
814
836
815
837
| Field | Description | Default | Validation |
816
838
| --- | --- | --- | --- |
839
+
|`provider`_[CostProvider](#costprovider)_| Provider selects which cost backend to query. Defaults to Kubecost. | Kubecost | Enum: [Kubecost OpenCost] <br />Optional: \{\} <br /> |
|`kubecostServiceRef`_[ObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#objectreference-v1-core)_|KubecostServiceRef points at the cost analyzer Service. When omitted, defaults<br />are chosen from provider: kubecost-cost-analyzer/kubecost or opencost/opencost. ||Optional: \{\} <br />|
Copy file name to clipboardExpand all lines: pages/api-reference/kubernetes/management-api-reference.md
+38-1Lines changed: 38 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -99,6 +99,7 @@ _Appears in:_
99
99
|`tools`_[Tools](#tools)_| Tools holds the configuration for the tools that can be used with the AI integration. || Optional: \{\} <br /> |
100
100
|`provider`_[AiProvider](#aiprovider)_| Provider defines which of the supported LLM providers should be used. | OPENAI | Enum: [OPENAI OPENAI_COMPATIBLE ANTHROPIC OLLAMA AZURE BEDROCK VERTEX] <br />Optional: \{\} <br /> |
101
101
|`toolProvider`_[AiProvider](#aiprovider)_| ToolProvider to use for tool calling, in case you want to use a different LLM more optimized to those tasks || Enum: [OPENAI OPENAI_COMPATIBLE ANTHROPIC OLLAMA AZURE BEDROCK VERTEX] <br />Optional: \{\} <br /> |
102
+
|`streaming`_boolean_| Streaming defines whether to stream responses from LLM providers. | true | Optional: \{\} <br /> |
102
103
|`embeddingProvider`_[AiProvider](#aiprovider)_| EmbeddingProvider to use for generating embeddings. Oftentimes foundational<br />model providers do not have embeddings models, and it's better to simply use OpenAI. || Enum: [OPENAI OPENAI_COMPATIBLE ANTHROPIC OLLAMA AZURE BEDROCK VERTEX] <br />Optional: \{\} <br /> |
103
104
|`logAnalysis`_boolean_| LogAnalysis defines whether to enable log analysis in AI insights (turn off to save on log query costs) || Optional: \{\} <br /> |
|`cmd`_string_| Cmd is the command to execute || Required: \{\} <br /> |
1005
1006
|`args`_string array_| Args are the arguments to pass to the command. || Optional: \{\} <br /> |
1006
1007
|`dir`_string_| Dir is the working directory for the command. || Optional: \{\} <br /> |
1008
+
|`approve`_boolean_| Approve determines whether this command should run in the approval-gated stage. || Optional: \{\} <br /> |
1007
1009
1008
1010
1009
1011
#### CompatibilityMatrixSummary
@@ -1897,6 +1899,23 @@ _Appears in:_
1897
1899
|`passwordSecretRef`_[SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#secretkeyselector-v1-core)_| PasswordSecretRef is a reference to a secret containing the password to connect with basic auth. || Optional: \{\} <br /> |
1898
1900
1899
1901
1902
+
#### HTTPHeader
1903
+
1904
+
1905
+
1906
+
1907
+
1908
+
1909
+
1910
+
_Appears in:_
1911
+
-[OpenAISettings](#openaisettings)
1912
+
1913
+
| Field | Description | Default | Validation |
1914
+
| --- | --- | --- | --- |
1915
+
|`name`_string_| Name is the HTTP header name. || Required: \{\} <br /> |
1916
+
|`value`_string_| Value is the HTTP header value. || Required: \{\} <br /> |
1917
+
1918
+
1900
1919
1901
1920
1902
1921
#### HelmMinimal
@@ -2943,6 +2962,22 @@ _Appears in:_
2943
2962
|`prompt`_string_| The prompt to use to guide the AI code change for this PR. || Required: \{\} <br /> |
2944
2963
2945
2964
2965
+
#### ObserverRenovate
2966
+
2967
+
2968
+
2969
+
ObserverRenovate defines Renovate regex versioning options for observer target ordering.
2970
+
2971
+
2972
+
2973
+
_Appears in:_
2974
+
-[ObserverTarget](#observertarget)
2975
+
2976
+
| Field | Description | Default | Validation |
2977
+
| --- | --- | --- | --- |
2978
+
|`ignoreUnstable`_boolean_| IgnoreUnstable skips prerelease values captured by the target format regex. || Optional: \{\} <br /> |
2979
+
2980
+
2946
2981
#### ObserverSpec
2947
2982
2948
2983
@@ -2984,7 +3019,8 @@ _Appears in:_
2984
3019
| --- | --- | --- | --- |
2985
3020
|`type`_[ObserverTargetType](#observertargettype)_| Type specifies the kind of external source to monitor.<br />Each type has different configuration requirements and polling mechanisms.<br />Supported types include Helm charts, OCI images, Git tags, and Kubernetes add-ons. || Enum: [OCI HELM GIT ADDON EKS_ADDON] <br />Required: \{\} <br />Type: string <br /> |
2986
3021
|`format`_string_| Format is a regex pattern with a capture group for extracting version information.<br />Useful when version strings are embedded in larger release names or tags.<br />The first capture group is used as the version value.<br />Example: "app-v([0-9]+.[0-9]+.[0-9]+)" extracts "1.2.3" from "app-v1.2.3". || Optional: \{\} <br /> |
2987
-
|`order`_[ObserverTargetOrder](#observertargetorder)_| Order determines how discovered versions are sorted and which one is selected.<br />SEMVER sorts by semantic version rules, while LATEST uses chronological ordering.<br />SEMVER is recommended for most use cases as it provides predictable version ordering. || Enum: [SEMVER LATEST] <br />Required: \{\} <br />Type: string <br /> |
3022
+
|`order`_[ObserverTargetOrder](#observertargetorder)_| Order determines how discovered versions are sorted and which one is selected.<br />SEMVER sorts by semantic version rules, LATEST uses chronological ordering,<br />and RENOVATE uses regex capture groups with Renovate-style version comparison. || Enum: [SEMVER LATEST RENOVATE] <br />Required: \{\} <br />Type: string <br /> |
3023
+
|`renovate`_[ObserverRenovate](#observerrenovate)_| Renovate contains options for RENOVATE target ordering.<br />Used when Order is RENOVATE to control prerelease filtering and related behavior. || Optional: \{\} <br /> |
2988
3024
|`helm`_[ObserverHelm](#observerhelm)_| Helm contains configuration for monitoring Helm chart repositories.<br />Used when Type is HELM to specify the repository URL, chart name, and authentication. || Optional: \{\} <br /> |
2989
3025
|`oci`_[ObserverOci](#observeroci)_| OCI contains configuration for monitoring OCI (container) registries.<br />Used when Type is OCI to specify the registry URL and authentication credentials. || Optional: \{\} <br /> |
2990
3026
|`git`_[ObserverGit](#observergit)_| Git contains configuration for monitoring Git repository tags.<br />Used when Type is GIT to specify which Git repository to monitor for new tags. || Optional: \{\} <br /> |
@@ -3030,6 +3066,7 @@ _Appears in:_
3030
3066
|`proxyModels`_string array_| ProxyModels are additional models to support within our integrated ai proxy. || Optional: \{\} <br /> |
3031
3067
|`baseUrl`_string_| BaseUrl is a custom base url to use, for reimplementations of the same API scheme (for instance Together.ai uses the OpenAI API spec). Should be similar to https://api.openai.com/v1|| Optional: \{\} <br /> |
3032
3068
|`tokenExchange`_[OAuth2TokenExchange](#oauth2tokenexchange)_| TokenExchange configures OAuth2 client credentials against a token endpoint to obtain access tokens for OpenAI-compatible APIs. || Optional: \{\} <br /> |
3069
+
|`headers`_[HTTPHeader](#httpheader) array_| Headers are custom HTTP headers to include in OpenAI-compatible API requests. || Optional: \{\} <br /> |
3033
3070
|`method`_[OpenAiMethod](#openaimethod)_| Method to use for openai api calls (defaults to auto, but can be used to restrict to only responses or chart completions apis, useful for configuring against common AI proxies) || Enum: [CHAT RESPONSES AUTO] <br />Optional: \{\} <br /> |
3034
3071
|`tokenSecretRef`_[SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#secretkeyselector-v1-core)_| TokenSecretRef is a reference to the local secret holding the token to access<br />the configured AI provider. || Required: \{\} <br /> |
0 commit comments