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
Copy file name to clipboardExpand all lines: pages/deployments/operator/api.md
+121-3Lines changed: 121 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -52,7 +52,8 @@ _Appears in:_
52
52
53
53
| Field | Description | Default | Validation |
54
54
| --- | --- | --- | --- |
55
-
|`model`_string_| Model is the LLM model name to use. || Required: {} <br /> |
55
+
|`model`_string_| Model is the LLM model name to use. || Optional: {} <br /> |
56
+
|`baseUrl`_string_| A custom base url to use, for reimplementations of the same API scheme (for instance Together.ai uses the OpenAI API spec) || Optional: {} <br /> |
56
57
|`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 /> |
57
58
58
59
@@ -70,13 +71,54 @@ _Appears in:_
70
71
| Field | Description | Default | Validation |
71
72
| --- | --- | --- | --- |
72
73
|`enabled`_boolean_| Enabled defines whether to enable the AI integration or not. | false | Optional: {} <br /> |
73
-
|`provider`_[AiProvider](#aiprovider)_| Provider defines which of the supported LLM providers should be used. | OPENAI | Enum: [OPENAI ANTHROPIC] <br />Optional: {} <br /> |
74
+
|`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 /> |
|`ollama`_[OllamaSettings](#ollamasettings)_| Ollama holds configuration for a self-hosted Ollama deployment, more details available at https://github.com/ollama/ollama|| Optional: {} <br /> |
78
+
|`azure`_[AzureOpenAISettings](#azureopenaisettings)_| Azure holds configuration for using AzureOpenAI to generate LLM insights || Optional: {} <br /> |
79
+
|`bedrock`_[BedrockSettings](#bedrocksettings)_| Bedrock holds configuration for using AWS Bedrock to generate LLM insights || Optional: {} <br /> |
80
+
|`vertex`_[VertexSettings](#vertexsettings)_| Vertex holds configuration for using GCP VertexAI to generate LLM insights || Optional: {} <br /> |
76
81
77
82
78
83
79
84
85
+
#### AzureOpenAISettings
86
+
87
+
88
+
89
+
90
+
91
+
92
+
93
+
_Appears in:_
94
+
-[AISettings](#aisettings)
95
+
96
+
| Field | Description | Default | Validation |
97
+
| --- | --- | --- | --- |
98
+
|`endpoint`_string_| Your Azure OpenAI endpoint, should be formatted like: https://{endpoint}/openai/deployments/{deployment-id}" || Required: {} <br /> |
99
+
|`apiVersion`_string_| The azure openai Data plane - inference api version to use, defaults to 2024-10-01-preview or the latest available || Optional: {} <br /> |
100
+
|`model`_string_| The OpenAi Model you wish to use. If not specified, Plural will provide a default || Optional: {} <br /> |
101
+
|`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 /> |
102
+
103
+
104
+
#### BedrockSettings
105
+
106
+
107
+
108
+
109
+
110
+
111
+
112
+
_Appears in:_
113
+
-[AISettings](#aisettings)
114
+
115
+
| Field | Description | Default | Validation |
116
+
| --- | --- | --- | --- |
117
+
|`modelId`_string_| The AWS Bedrock Model ID to use || Required: {} <br /> |
118
+
|`accessKeyId`_string_| An AWS Access Key ID to use, can also use IRSA to acquire credentials || Optional: {} <br /> |
119
+
|`secretAccessKeyRef`_[SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#secretkeyselector-v1-core)_| An AWS Secret Access Key to use, can also use IRSA to acquire credentials || Optional: {} <br /> |
Settings for configuring a self-hosted Ollama LLM, more details at https://github.com/ollama/ollama
1595
+
1596
+
1597
+
1598
+
_Appears in:_
1599
+
-[AISettings](#aisettings)
1600
+
1601
+
| Field | Description | Default | Validation |
1602
+
| --- | --- | --- | --- |
1603
+
|`url`_string_| URL is the url this model is queryable on || Required: {} <br /> |
1604
+
|`model`_string_| Model is the Ollama model to use when querying the /chat api || Required: {} <br /> |
1605
+
|`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 contents of a HTTP Authorization header<br />to send to your ollama api in case authorization is required (eg for an instance hosted on a public network) || Optional: {} <br /> |
1606
+
1607
+
1548
1608
#### Pipeline
1549
1609
1550
1610
@@ -1805,6 +1865,7 @@ _Appears in:_
1805
1865
| --- | --- | --- | --- |
1806
1866
|`regex`_string_| A regex to match string-valued configuration items || Optional: {} <br /> |
1807
1867
|`json`_boolean_| Whether the string value is supposed to be json-encoded || Optional: {} <br /> |
1868
+
|`uniqBy`_[PrAutomationUniqBy](#prautomationuniqby)_| How to determine uniquenss for this field || Optional: {} <br /> |
1808
1869
1809
1870
1810
1871
#### PrAutomationConfirmation
@@ -1877,7 +1938,7 @@ _Appears in:_
1877
1938
|`icon`_string_| An icon url to annotate this pr automation || Optional: {} <br /> |
1878
1939
|`darkIcon`_string_| An darkmode icon url to annotate this pr automation || Optional: {} <br /> |
|`identifier`_string_| Identifier is a string referencing the repository, i.e. for GitHub it would be "<organization>/<repositoryName>" || Optional: {} <br /> |
1941
+
|`identifier`_string_| Identifier is a string referencing the repository, i.e. for GitHub it would be "organization/repositoryName" || Optional: {} <br /> |
1881
1942
|`message`_string_| Message the commit message this pr will incorporate || Optional: {} <br /> |
1882
1943
|`name`_string_| Name name of the automation in the console api (defaults to metadata.name) || Optional: {} <br /> |
1883
1944
|`title`_string_| Title the title of the generated pr || Optional: {} <br /> |
@@ -1948,6 +2009,22 @@ _Appears in:_
1948
2009
|`context`_[RawExtension](https://pkg.go.dev/k8s.io/apimachinery/pkg/runtime#RawExtension)_| Context is a [PrAutomation] configuration context || Optional: {} <br /> |
|`matchStrategy`_[MatchStrategy](#matchstrategy)_| MatchStrategy, see enum for behavior || Optional: {} <br /> |
1966
2043
|`regexReplacements`_[RegexReplacement](#regexreplacement) array_| Full regex + replacement structs in case there is different behavior per regex || Optional: {} <br /> |
2044
+
|`yamlOverlays`_[YamlOverlay](#yamloverlay) array_| Replacement via overlaying a yaml structure on an existing yaml file || Optional: {} <br /> |
1967
2045
|`regexes`_string array_| The regexes to apply on each file || Optional: {} <br /> |
1968
2046
|`replaceTemplate`_string_| The template to use when replacing a regex || Optional: {} <br /> |
1969
2047
|`yq`_string_| (Unused so far) || Optional: {} <br /> |
|`configurationRef`_[SecretReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#secretreference-v1-core)_| ConfigurationRef is a secret reference which should contain service configuration. || Optional: {} <br /> |
2431
+
|`configuration`_object (keys:string, values:string)_| Configuration is a set of non-secret configuration to apply for lightweight templating of manifests in this service || Optional: {} <br /> |
2353
2432
|`bindings`_[Bindings](#bindings)_| Bindings contain read and write policies of this cluster || Optional: {} <br /> |
|`model`_string_| The Vertex AI model to use || Optional: {} <br /> |
2734
+
|`project`_string_| The GCP project you'll be using || Required: {} <br /> |
2735
+
|`location`_string_| The GCP region Vertex is queried from || Required: {} <br /> |
2736
+
|`endpoint`_string_| A custom endpoint for self-deployed models || Optional: {} <br /> |
2737
+
|`serviceAccountJsonSecretRef`_[SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#secretkeyselector-v1-core)_| An Service Account json file stored w/in a kubernetes secret to use for authentication to GCP || Optional: {} <br /> |
|`file`_string_| the file to execute the overlay on || Required: {} <br /> |
2754
+
|`yaml`_string_| the (possibly templated) yaml to use as the overlayed yaml blob written to the file || Required: {} <br /> |
2755
+
|`templated`_boolean_| Whether you want to apply templating to the yaml blob before overlaying || Optional: {} <br /> |
2756
+
|`listMerge`_[ListMerge](#listmerge)_| How you want list merge to be performed, defaults to OVERWRITE || Enum: [OVERWRITE APPEND] <br />Optional: {} <br /> |
0 commit comments