Skip to content

Commit b45b1c9

Browse files
michaeljguarinogithub-actions[bot]
michaeljguarino
authored and
github-actions[bot]
committed
sync docs
1 parent 9b8c5d0 commit b45b1c9

2 files changed

Lines changed: 70 additions & 5 deletions

File tree

‎pages/api-reference/kubernetes/agent-api-reference.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -271,6 +271,7 @@ _Appears in:_
271271
| `bootstrapScript` _string_ | BootstrapScript is a bash script that will be executed inside the cloned repository<br />directory before the coding agent starts. It can be used to install dependencies,<br />configure tooling, or perform any other setup required by the agent. | | Optional: \{\} <br /> |
272272
| `git` _[GitSpec](#gitspec)_ | Git configure commit signing on agent run. When provided, the runtime will be configured to sign git commits using the provided key reference. | | |
273273
| `babysitInterval` _[Duration](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#duration-v1-meta)_ | BabysitInterval configures the interval for the operator to check on the health of the agent runtime and perform necessary babysitting actions (e.g. restarting unhealthy runtimes). When not provided, a default interval of 1 minute will be used. | | |
274+
| `scmConnection` _string_ | ScmConnection is the name of an ScmConnection in Console to use for git operations on agent runs using this runtime.<br />This should match the name of an existing ScmConnection resource or connection created in the Plural UI. | | Optional: \{\} <br /> |
274275
| `exaConnection` _[ExaConnection](#exaconnection)_ | ExaConnection enables Exa web search and content retrieval tools on the Plural MCP server. | | |
275276

276277

@@ -496,6 +497,7 @@ _Appears in:_
496497
| --- | --- | --- | --- |
497498
| `apiKeySecretRef` _[SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#secretkeyselector-v1-core)_ | ApiKeySecretRef references a Secret containing the Codex API key.<br />Optional when aiProxy is enabled; authentication uses the Console deploy token instead. | | Optional: \{\} <br /> |
498499
| `model` _string_ | Model to use. | | |
500+
| `method` _[OpenAiMethod](#openaimethod)_ | Method configures which OpenAI API Codex should use.<br />AUTO omits wire_api and lets Codex choose. CHAT forces /chat/completions.<br />RESPONSES forces /responses. | | Enum: [CHAT RESPONSES AUTO] <br />Optional: \{\} <br /> |
499501
| `endpoint` _string_ | Endpoint is the base URL for the Codex API (supports OpenAI/Azure-compatible endpoints). | | Optional: \{\} <br /> |
500502
| `timeout` _[Duration](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#duration-v1-meta)_ | Timeout bounds a single codex run invocation. | | Optional: \{\} <br /> |
501503

@@ -515,6 +517,7 @@ _Appears in:_
515517
| --- | --- | --- | --- |
516518
| `apiKey` _string_ | ApiKey is the raw API key to use. | | |
517519
| `model` _string_ | Model to use. | | |
520+
| `method` _[OpenAiMethod](#openaimethod)_ | Method configures which OpenAI API Codex should use.<br />AUTO omits wire_api and lets Codex choose. CHAT forces /chat/completions.<br />RESPONSES forces /responses. | | Enum: [CHAT RESPONSES AUTO] <br />Optional: \{\} <br /> |
518521
| `endpoint` _string_ | Endpoint is the base URL for the Codex API (supports OpenAI/Azure-compatible endpoints). | | Optional: \{\} <br /> |
519522
| `timeout` _[Duration](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#duration-v1-meta)_ | Timeout bounds a single codex run invocation. | | Optional: \{\} <br /> |
520523

‎pages/api-reference/kubernetes/management-api-reference.md‎

Lines changed: 67 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,7 @@ Package v1alpha1 contains API Schema definitions for the deployments v1alpha1 AP
5454
- [UpgradePlanCallout](#upgradeplancallout)
5555
- [Workbench](#workbench)
5656
- [WorkbenchCron](#workbenchcron)
57+
- [WorkbenchPrompt](#workbenchprompt)
5758
- [WorkbenchTool](#workbenchtool)
5859
- [WorkbenchWebhook](#workbenchwebhook)
5960

@@ -96,11 +97,12 @@ _Appears in:_
9697
| `enabled` _boolean_ | Enabled defines whether to enable the AI integration or not. | false | Optional: \{\} <br /> |
9798
| `analysisRates` _[AnalysisRates](#analysisrates)_ | Configure the pace at which AI insight analysis should run. Useful if you want to minimize impacts on inference costs. | | Optional: \{\} <br /> |
9899
| `tools` _[Tools](#tools)_ | Tools holds the configuration for the tools that can be used with the AI integration. | | Optional: \{\} <br /> |
99-
| `provider` _[AiProvider](#aiprovider)_ | Provider defines which of the supported LLM providers should be used. | OPENAI | Enum: [OPENAI ANTHROPIC OLLAMA AZURE BEDROCK VERTEX] <br />Optional: \{\} <br /> |
100-
| `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 ANTHROPIC OLLAMA AZURE BEDROCK VERTEX] <br />Optional: \{\} <br /> |
101-
| `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 ANTHROPIC OLLAMA AZURE BEDROCK VERTEX] <br />Optional: \{\} <br /> |
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+
| `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+
| `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 /> |
102103
| `logAnalysis` _boolean_ | LogAnalysis defines whether to enable log analysis in AI insights (turn off to save on log query costs) | | Optional: \{\} <br /> |
103104
| `openAI` _[OpenAISettings](#openaisettings)_ | OpenAI holds the OpenAI provider configuration. | | Optional: \{\} <br /> |
105+
| `openAICompatible` _[OpenAISettings](#openaisettings)_ | OpenAICompatible holds the OpenAI-compatible provider configuration. | | Optional: \{\} <br /> |
104106
| `anthropic` _[AIProviderSettings](#aiprovidersettings)_ | Anthropic holds the Anthropic provider configuration. | | Optional: \{\} <br /> |
105107
| `ollama` _[OllamaSettings](#ollamasettings)_ | Ollama holds configuration for a self-hosted Ollama deployment,<br />more details available at https://github.com/ollama/ollama | | Optional: \{\} <br /> |
106108
| `azure` _[AzureOpenAISettings](#azureopenaisettings)_ | Azure holds configuration for using AzureOpenAI to generate LLM insights | | Optional: \{\} <br /> |
@@ -2134,7 +2136,7 @@ _Appears in:_
21342136
| Field | Description | Default | Validation |
21352137
| --- | --- | --- | --- |
21362138
| `name` _string_ | Name of this stack.<br />If not provided, the name from InfrastructureStack.ObjectMeta will be used. | | Optional: \{\} <br /> |
2137-
| `type` _[StackType](#stacktype)_ | Type specifies the IaC tool to use for executing the stack.<br />One of TERRAFORM, ANSIBLE, CUSTOM. | | Enum: [TERRAFORM ANSIBLE CUSTOM] <br />Required: \{\} <br /> |
2139+
| `type` _[StackType](#stacktype)_ | Type specifies the IaC tool to use for executing the stack.<br />One of TERRAFORM, TERRAGRUNT, ANSIBLE, CUSTOM. | | Enum: [TERRAFORM TERRAGRUNT ANSIBLE CUSTOM] <br />Required: \{\} <br /> |
21382140
| `interval` _string_ | Interval specifies the interval at which the stack will be reconciled, default is 5m | | Optional: \{\} <br /> |
21392141
| `repositoryRef` _[ObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#objectreference-v1-core)_ | RepositoryRef references the GitRepository containing the IaC source code. Leave empty to use git:url instead. | | Optional: \{\} <br /> |
21402142
| `clusterRef` _[ObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#objectreference-v1-core)_ | ClusterRef references the target Cluster where this stack will be executed. | | Optional: \{\} <br /> |
@@ -4118,6 +4120,7 @@ _Appears in:_
41184120
- [StackDefinitionSpec](#stackdefinitionspec)
41194121
- [UpgradePlanCalloutSpec](#upgradeplancalloutspec)
41204122
- [WorkbenchCronSpec](#workbenchcronspec)
4123+
- [WorkbenchPromptSpec](#workbenchpromptspec)
41214124
- [WorkbenchSpec](#workbenchspec)
41224125
- [WorkbenchToolSpec](#workbenchtoolspec)
41234126
- [WorkbenchWebhookSpec](#workbenchwebhookspec)
@@ -4983,6 +4986,7 @@ _Appears in:_
49834986
| `tag` _string_ | Tag of the IaC tool Docker image to use. | | Optional: \{\} <br /> |
49844987
| `hooks` _[StackHook](#stackhook) array_ | Hooks to run at various stages of the stack run. | | Optional: \{\} <br /> |
49854988
| `terraform` _[TerraformConfiguration](#terraformconfiguration)_ | Terraform configuration for this stack. | | Optional: \{\} <br /> |
4989+
| `terragrunt` _[TerragruntConfiguration](#terragruntconfiguration)_ | Terragrunt configuration for this stack. | | Optional: \{\} <br /> |
49864990
| `ansible` _[AnsibleConfiguration](#ansibleconfiguration)_ | Ansible configuration for this stack. | | Optional: \{\} <br /> |
49874991
| `aiApproval` _[AiApprovalConfiguration](#aiapprovalconfiguration)_ | AiApproval configuration for this stack to be auto-approved by AI according to rules sourced from Git. | | Optional: \{\} <br /> |
49884992

@@ -5116,6 +5120,7 @@ _Appears in:_
51165120
| Field | Description | Default | Validation |
51175121
| --- | --- | --- | --- |
51185122
| `terraform` _[TerraformConfiguration](#terraformconfiguration)_ | Terraform is the terraform configuration for this stack | | Optional: \{\} <br /> |
5123+
| `terragrunt` _[TerragruntConfiguration](#terragruntconfiguration)_ | Terragrunt is the terragrunt configuration for this stack | | Optional: \{\} <br /> |
51195124

51205125

51215126
#### StackSettings
@@ -5250,6 +5255,25 @@ _Appears in:_
52505255
| `tofuRegistry` _boolean_ | TofuRegistry is whether to use the OpenTofu registry for provider and module sources. | | Optional: \{\} <br /> |
52515256

52525257

5258+
#### TerragruntConfiguration
5259+
5260+
5261+
5262+
5263+
5264+
5265+
5266+
_Appears in:_
5267+
- [StackConfiguration](#stackconfiguration)
5268+
- [StackOverrides](#stackoverrides)
5269+
5270+
| Field | Description | Default | Validation |
5271+
| --- | --- | --- | --- |
5272+
| `parallelism` _integer_ | Parallelism is the number of concurrent operations to run,<br />equivalent to the -parallelism flag passed through to the underlying Terraform/OpenTofu invocation. | | Optional: \{\} <br /> |
5273+
| `refresh` _boolean_ | Refresh is whether to refresh the state of the stack,<br />equivalent to the -refresh flag passed through to the underlying Terraform/OpenTofu invocation. | | Optional: \{\} <br /> |
5274+
| `approveEmpty` _boolean_ | ApproveEmpty is whether to auto-approve a plan if there are no changes, preventing a stack from being blocked. | | Optional: \{\} <br /> |
5275+
5276+
52535277
#### Tools
52545278

52555279

@@ -5317,7 +5341,7 @@ _Appears in:_
53175341
| Field | Description | Default | Validation |
53185342
| --- | --- | --- | --- |
53195343
| `enabled` _boolean_ | Enabled controls whether the vector store is enabled or not.. | false | Optional: \{\} <br /> |
5320-
| `vectorStore` _[VectorStore](#vectorstore)_ | VectorStore is the type of the vector store to use. | | Enum: [ELASTIC OPENSEARCH] <br />Optional: \{\} <br /> |
5344+
| `vectorStore` _[VectorStore](#vectorstore)_ | VectorStore is the type of the vector store to use. | | Enum: [ELASTIC OPENSEARCH POSTGRES] <br />Optional: \{\} <br /> |
53215345
| `elastic` _[ElasticsearchConnectionSettings](#elasticsearchconnectionsettings)_ | Elastic configuration for the vector store. | | Optional: \{\} <br /> |
53225346
| `opensearch` _[OpensearchConnectionSettings](#opensearchconnectionsettings)_ | Opensearch configuration for the vector store. | | Optional: \{\} <br /> |
53235347

@@ -5473,6 +5497,44 @@ _Appears in:_
54735497
| `metrics` _boolean_ | Metrics enables the metrics capability. | | Optional: \{\} <br /> |
54745498

54755499

5500+
#### WorkbenchPrompt
5501+
5502+
5503+
5504+
WorkbenchPrompt represents a saved prompt for a Workbench.
5505+
5506+
5507+
5508+
5509+
5510+
| Field | Description | Default | Validation |
5511+
| --- | --- | --- | --- |
5512+
| `apiVersion` _string_ | `deployments.plural.sh/v1alpha1` | | |
5513+
| `kind` _string_ | `WorkbenchPrompt` | | |
5514+
| `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. | | |
5515+
| `spec` _[WorkbenchPromptSpec](#workbenchpromptspec)_ | Spec defines the desired state of the WorkbenchPrompt. | | Required: \{\} <br /> |
5516+
5517+
5518+
#### WorkbenchPromptSpec
5519+
5520+
5521+
5522+
WorkbenchPromptSpec defines the desired state of a WorkbenchPrompt.
5523+
5524+
5525+
5526+
_Appears in:_
5527+
- [WorkbenchPrompt](#workbenchprompt)
5528+
5529+
| Field | Description | Default | Validation |
5530+
| --- | --- | --- | --- |
5531+
| `workbenchRef` _[ObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#objectreference-v1-core)_ | WorkbenchRef references the Workbench this prompt belongs to. | | Required: \{\} <br /> |
5532+
| `title` _string_ | Title is the display title for the saved prompt. | | Optional: \{\} <br />Type: string <br /> |
5533+
| `category` _string_ | Category is the grouping category for the saved prompt. | | Optional: \{\} <br />Type: string <br /> |
5534+
| `prompt` _string_ | Prompt is the saved prompt text. | | MinLength: 1 <br />Required: \{\} <br />Type: string <br /> |
5535+
| `reconciliation` _[Reconciliation](#reconciliation)_ | Reconciliation settings for this resource. | | Optional: \{\} <br /> |
5536+
5537+
54765538
#### WorkbenchSkills
54775539

54785540

0 commit comments

Comments
 (0)