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
+83-33Lines changed: 83 additions & 33 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -23,6 +23,7 @@ Package v1alpha1 contains API Schema definitions for the deployments v1alpha1 AP
23
23
-[NamespaceCredentials](#namespacecredentials)
24
24
-[NotificationRouter](#notificationrouter)
25
25
-[NotificationSink](#notificationsink)
26
+
-[OIDCProvider](#oidcprovider)
26
27
-[ObservabilityProvider](#observabilityprovider)
27
28
-[Observer](#observer)
28
29
-[Pipeline](#pipeline)
@@ -38,6 +39,42 @@ Package v1alpha1 contains API Schema definitions for the deployments v1alpha1 AP
38
39
39
40
40
41
42
+
#### AIProviderSettings
43
+
44
+
45
+
46
+
47
+
48
+
49
+
50
+
_Appears in:_
51
+
-[AISettings](#aisettings)
52
+
53
+
| Field | Description | Default | Validation |
54
+
| --- | --- | --- | --- |
55
+
|`model`_string_| Model is the LLM model name to use. || Required: {} <br /> |
56
+
|`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
+
59
+
#### AISettings
60
+
61
+
62
+
63
+
AISettings holds the configuration for LLM provider clients.
|`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 /> |
|`agentHelmValues`_[RawExtension](https://pkg.go.dev/k8s.io/apimachinery/pkg/runtime#RawExtension)_| AgentHelmValues custom helm values to apply to all agents (useful for things like adding customary annotations/labels) || Optional: {} <br /> |
665
-
|`stacks`_[StackSettings](#stacksettings)_| Stacks global configuration for stack execution |||
698
+
|`stacks`_[StackSettings](#stacksettings)_| Stacks global configuration for stack execution ||Optional: {} <br />|
|`prometheusConnection`_[HTTPConnection](#httpconnection)_| PrometheusConnection connection details for a prometheus instance to use |||
668
-
|`lokiConnection`_[HTTPConnection](#httpconnection)_| connection details for a loki instance to use |||
669
-
670
-
671
-
#### Env
672
-
673
-
_Underlying type:__[struct{Name string "json:\"name\""; Value string "json:\"value\""}](#struct{name-string-"json:\"name\"";-value-string-"json:\"value\""})_
674
-
700
+
|`prometheusConnection`_[HTTPConnection](#httpconnection)_| PrometheusConnection connection details for a prometheus instance to use || Optional: {} <br /> |
701
+
|`lokiConnection`_[HTTPConnection](#httpconnection)_| LokiConnection connection details for a loki instance to use || Optional: {} <br /> |
702
+
|`ai`_[AISettings](#aisettings)_| AI settings specifies a configuration for LLM provider clients || Optional: {} <br /> |
|`user`_string_|user to connect with basic auth |||
841
-
|`password`_string_|password to connect w/ for basic auth |||
851
+
|`host`_string_|Host ... ||Required: {} <br />|
852
+
|`user`_string_|User to connect with basic auth ||Optional: {} <br />|
853
+
|`password`_string_|Password to connect w/ for basic auth ||Optional: {} <br />|
842
854
|`passwordSecretRef`_[SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#secretkeyselector-v1-core)_| PasswordSecretRef selects a key of a password Secret || Optional: {} <br /> |
843
855
844
856
@@ -1241,6 +1253,43 @@ _Appears in:_
1241
1253
|`bindings`_[Binding](#binding) array_| Bindings to determine users/groups to be notified for PLURAL sync types || Optional: {} <br /> |
1242
1254
1243
1255
1256
+
#### OIDCProvider
1257
+
1258
+
1259
+
1260
+
OIDCProvider is the Schema for the OIDCProviders API
|`metadata`_[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#objectmeta-v1-meta)_| Refer to Kubernetes API documentation for fields of `metadata`. |||
OIDCProviderSpec defines the desired state of OIDCProvider
1279
+
1280
+
1281
+
1282
+
_Appears in:_
1283
+
-[OIDCProvider](#oidcprovider)
1284
+
1285
+
| Field | Description | Default | Validation |
1286
+
| --- | --- | --- | --- |
1287
+
|`name`_string_| Name of this OIDCProvider. If not provided OIDCProvider's own name<br />from OIDCProvider.ObjectMeta will be used. || Optional: {} <br /> |
1288
+
|`description`_string_| Description can be used to describe this OIDCProvider. || Optional: {} <br /> |
1289
+
|`redirectUris`_string array_| RedirectUris is a list of custom run steps that will be executed as<br />part of the stack run. || Optional: {} <br /> |
1290
+
|`credentialsSecretRef`_[LocalObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#localobjectreference-v1-core)_| CredentialsSecretRef is a local reference to the secret that contains OIDC provider credentials.<br />It will be created once OIDCProvider is created in the Console API.<br />Secret will contain 2 keys:<br />- 'clientId'<br />- 'clientSecret' || Required: {} <br /> |
1291
+
1292
+
1244
1293
#### ObservabilityProvider
1245
1294
1246
1295
@@ -2240,6 +2289,7 @@ _Appears in:_
2240
2289
|`chart`_string_| chart to use || Optional: {} <br /> |
2241
2290
|`version`_string_| chart version to use || Optional: {} <br /> |
2242
2291
|`repository`_[NamespacedName](#namespacedname)_| pointer to the FluxCD helm repository to use || Optional: {} <br /> |
2292
+
|`ignoreHooks`_boolean_| whether you want to completely ignore any helm hooks when actualizing this service || Optional: {} <br /> |
0 commit comments