Skip to content

Commit 10ce8d5

Browse files
Update docs for operator (#334)
Co-authored-by: michaeljguarino <[email protected]>
1 parent 42fccb2 commit 10ce8d5

File tree

1 file changed

+83
-33
lines changed
  • pages/deployments/operator

1 file changed

+83
-33
lines changed

pages/deployments/operator/api.md

Lines changed: 83 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ Package v1alpha1 contains API Schema definitions for the deployments v1alpha1 AP
2323
- [NamespaceCredentials](#namespacecredentials)
2424
- [NotificationRouter](#notificationrouter)
2525
- [NotificationSink](#notificationsink)
26+
- [OIDCProvider](#oidcprovider)
2627
- [ObservabilityProvider](#observabilityprovider)
2728
- [Observer](#observer)
2829
- [Pipeline](#pipeline)
@@ -38,6 +39,42 @@ Package v1alpha1 contains API Schema definitions for the deployments v1alpha1 AP
3839

3940

4041

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.
64+
65+
66+
67+
_Appears in:_
68+
- [DeploymentSettingsSpec](#deploymentsettingsspec)
69+
70+
| Field | Description | Default | Validation |
71+
| --- | --- | --- | --- |
72+
| `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+
| `openAI` _[AIProviderSettings](#aiprovidersettings)_ | OpenAI holds the OpenAI provider configuration. | | Optional: {} <br /> |
75+
| `anthropic` _[AIProviderSettings](#aiprovidersettings)_ | Anthropic holds the Anthropic provider configuration. | | Optional: {} <br /> |
76+
77+
4178

4279

4380
#### Binding
@@ -538,7 +575,7 @@ _Appears in:_
538575

539576
#### ContainerResources
540577

541-
578+
_Underlying type:_ _[struct{Requests *ContainerResourceRequests "json:\"requests,omitempty\""; Limits *ContainerResourceRequests "json:\"limits,omitempty\""}](#struct{requests-*containerresourcerequests-"json:\"requests,omitempty\"";-limits-*containerresourcerequests-"json:\"limits,omitempty\""})_
542579

543580

544581

@@ -548,10 +585,6 @@ _Appears in:_
548585
- [Container](#container)
549586
- [JobSpec](#jobspec)
550587

551-
| Field | Description | Default | Validation |
552-
| --- | --- | --- | --- |
553-
| `requests` _[ContainerResourceRequests](#containerresourcerequests)_ | | | Optional: {} <br /> |
554-
| `limits` _[ContainerResourceRequests](#containerresourcerequests)_ | | | Optional: {} <br /> |
555588

556589

557590
#### CustomRunStep
@@ -662,36 +695,15 @@ _Appears in:_
662695
| Field | Description | Default | Validation |
663696
| --- | --- | --- | --- |
664697
| `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 /> |
666699
| `bindings` _[DeploymentSettingsBindings](#deploymentsettingsbindings)_ | Bindings | | Optional: {} <br /> |
667-
| `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 /> |
675703

676704

677705

678706

679-
_Appears in:_
680-
- [Container](#container)
681-
682-
683-
684-
#### EnvFrom
685-
686-
_Underlying type:_ _[struct{Secret string "json:\"secret\""; ConfigMap string "json:\"configMap\""}](#struct{secret-string-"json:\"secret\"";-configmap-string-"json:\"configmap\""})_
687-
688-
689-
690-
691-
692-
_Appears in:_
693-
- [Container](#container)
694-
695707

696708

697709
#### GateSpec
@@ -836,9 +848,9 @@ _Appears in:_
836848

837849
| Field | Description | Default | Validation |
838850
| --- | --- | --- | --- |
839-
| `host` _string_ | | | |
840-
| `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 /> |
842854
| `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 /> |
843855

844856

@@ -1241,6 +1253,43 @@ _Appears in:_
12411253
| `bindings` _[Binding](#binding) array_ | Bindings to determine users/groups to be notified for PLURAL sync types | | Optional: {} <br /> |
12421254

12431255

1256+
#### OIDCProvider
1257+
1258+
1259+
1260+
OIDCProvider is the Schema for the OIDCProviders API
1261+
1262+
1263+
1264+
1265+
1266+
| Field | Description | Default | Validation |
1267+
| --- | --- | --- | --- |
1268+
| `apiVersion` _string_ | `deployments.plural.sh/v1alpha1` | | |
1269+
| `kind` _string_ | `OIDCProvider` | | |
1270+
| `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. | | |
1271+
| `spec` _[OIDCProviderSpec](#oidcproviderspec)_ | | | |
1272+
1273+
1274+
#### OIDCProviderSpec
1275+
1276+
1277+
1278+
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+
12441293
#### ObservabilityProvider
12451294

12461295

@@ -2240,6 +2289,7 @@ _Appears in:_
22402289
| `chart` _string_ | chart to use | | Optional: {} <br /> |
22412290
| `version` _string_ | chart version to use | | Optional: {} <br /> |
22422291
| `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 /> |
22432293

22442294

22452295
#### ServiceImport

0 commit comments

Comments
 (0)