From 10ce8d5d1e224d8e60d80c6efc671d9c92803d5a Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Sun, 3 Nov 2024 18:48:58 -0500 Subject: [PATCH] Update docs for operator (#334) Co-authored-by: michaeljguarino --- pages/deployments/operator/api.md | 116 +++++++++++++++++++++--------- 1 file changed, 83 insertions(+), 33 deletions(-) diff --git a/pages/deployments/operator/api.md b/pages/deployments/operator/api.md index 877ca7a3..4b9d076f 100644 --- a/pages/deployments/operator/api.md +++ b/pages/deployments/operator/api.md @@ -23,6 +23,7 @@ Package v1alpha1 contains API Schema definitions for the deployments v1alpha1 AP - [NamespaceCredentials](#namespacecredentials) - [NotificationRouter](#notificationrouter) - [NotificationSink](#notificationsink) +- [OIDCProvider](#oidcprovider) - [ObservabilityProvider](#observabilityprovider) - [Observer](#observer) - [Pipeline](#pipeline) @@ -38,6 +39,42 @@ Package v1alpha1 contains API Schema definitions for the deployments v1alpha1 AP +#### AIProviderSettings + + + + + + + +_Appears in:_ +- [AISettings](#aisettings) + +| Field | Description | Default | Validation | +| --- | --- | --- | --- | +| `model` _string_ | Model is the LLM model name to use. | | Required: {}
| +| `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
the configured AI provider. | | Required: {}
| + + +#### AISettings + + + +AISettings holds the configuration for LLM provider clients. + + + +_Appears in:_ +- [DeploymentSettingsSpec](#deploymentsettingsspec) + +| Field | Description | Default | Validation | +| --- | --- | --- | --- | +| `enabled` _boolean_ | Enabled defines whether to enable the AI integration or not. | false | Optional: {}
| +| `provider` _[AiProvider](#aiprovider)_ | Provider defines which of the supported LLM providers should be used. | OPENAI | Enum: [OPENAI ANTHROPIC]
Optional: {}
| +| `openAI` _[AIProviderSettings](#aiprovidersettings)_ | OpenAI holds the OpenAI provider configuration. | | Optional: {}
| +| `anthropic` _[AIProviderSettings](#aiprovidersettings)_ | Anthropic holds the Anthropic provider configuration. | | Optional: {}
| + + #### Binding @@ -538,7 +575,7 @@ _Appears in:_ #### ContainerResources - +_Underlying type:_ _[struct{Requests *ContainerResourceRequests "json:\"requests,omitempty\""; Limits *ContainerResourceRequests "json:\"limits,omitempty\""}](#struct{requests-*containerresourcerequests-"json:\"requests,omitempty\"";-limits-*containerresourcerequests-"json:\"limits,omitempty\""})_ @@ -548,10 +585,6 @@ _Appears in:_ - [Container](#container) - [JobSpec](#jobspec) -| Field | Description | Default | Validation | -| --- | --- | --- | --- | -| `requests` _[ContainerResourceRequests](#containerresourcerequests)_ | | | Optional: {}
| -| `limits` _[ContainerResourceRequests](#containerresourcerequests)_ | | | Optional: {}
| #### CustomRunStep @@ -662,36 +695,15 @@ _Appears in:_ | Field | Description | Default | Validation | | --- | --- | --- | --- | | `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: {}
| -| `stacks` _[StackSettings](#stacksettings)_ | Stacks global configuration for stack execution | | | +| `stacks` _[StackSettings](#stacksettings)_ | Stacks global configuration for stack execution | | Optional: {}
| | `bindings` _[DeploymentSettingsBindings](#deploymentsettingsbindings)_ | Bindings | | Optional: {}
| -| `prometheusConnection` _[HTTPConnection](#httpconnection)_ | PrometheusConnection connection details for a prometheus instance to use | | | -| `lokiConnection` _[HTTPConnection](#httpconnection)_ | connection details for a loki instance to use | | | - - -#### Env - -_Underlying type:_ _[struct{Name string "json:\"name\""; Value string "json:\"value\""}](#struct{name-string-"json:\"name\"";-value-string-"json:\"value\""})_ - +| `prometheusConnection` _[HTTPConnection](#httpconnection)_ | PrometheusConnection connection details for a prometheus instance to use | | Optional: {}
| +| `lokiConnection` _[HTTPConnection](#httpconnection)_ | LokiConnection connection details for a loki instance to use | | Optional: {}
| +| `ai` _[AISettings](#aisettings)_ | AI settings specifies a configuration for LLM provider clients | | Optional: {}
| -_Appears in:_ -- [Container](#container) - - - -#### EnvFrom - -_Underlying type:_ _[struct{Secret string "json:\"secret\""; ConfigMap string "json:\"configMap\""}](#struct{secret-string-"json:\"secret\"";-configmap-string-"json:\"configmap\""})_ - - - - - -_Appears in:_ -- [Container](#container) - #### GateSpec @@ -836,9 +848,9 @@ _Appears in:_ | Field | Description | Default | Validation | | --- | --- | --- | --- | -| `host` _string_ | | | | -| `user` _string_ | user to connect with basic auth | | | -| `password` _string_ | password to connect w/ for basic auth | | | +| `host` _string_ | Host ... | | Required: {}
| +| `user` _string_ | User to connect with basic auth | | Optional: {}
| +| `password` _string_ | Password to connect w/ for basic auth | | Optional: {}
| | `passwordSecretRef` _[SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#secretkeyselector-v1-core)_ | PasswordSecretRef selects a key of a password Secret | | Optional: {}
| @@ -1241,6 +1253,43 @@ _Appears in:_ | `bindings` _[Binding](#binding) array_ | Bindings to determine users/groups to be notified for PLURAL sync types | | Optional: {}
| +#### OIDCProvider + + + +OIDCProvider is the Schema for the OIDCProviders API + + + + + +| Field | Description | Default | Validation | +| --- | --- | --- | --- | +| `apiVersion` _string_ | `deployments.plural.sh/v1alpha1` | | | +| `kind` _string_ | `OIDCProvider` | | | +| `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. | | | +| `spec` _[OIDCProviderSpec](#oidcproviderspec)_ | | | | + + +#### OIDCProviderSpec + + + +OIDCProviderSpec defines the desired state of OIDCProvider + + + +_Appears in:_ +- [OIDCProvider](#oidcprovider) + +| Field | Description | Default | Validation | +| --- | --- | --- | --- | +| `name` _string_ | Name of this OIDCProvider. If not provided OIDCProvider's own name
from OIDCProvider.ObjectMeta will be used. | | Optional: {}
| +| `description` _string_ | Description can be used to describe this OIDCProvider. | | Optional: {}
| +| `redirectUris` _string array_ | RedirectUris is a list of custom run steps that will be executed as
part of the stack run. | | Optional: {}
| +| `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.
It will be created once OIDCProvider is created in the Console API.
Secret will contain 2 keys:
- 'clientId'
- 'clientSecret' | | Required: {}
| + + #### ObservabilityProvider @@ -2240,6 +2289,7 @@ _Appears in:_ | `chart` _string_ | chart to use | | Optional: {}
| | `version` _string_ | chart version to use | | Optional: {}
| | `repository` _[NamespacedName](#namespacedname)_ | pointer to the FluxCD helm repository to use | | Optional: {}
| +| `ignoreHooks` _boolean_ | whether you want to completely ignore any helm hooks when actualizing this service | | Optional: {}
| #### ServiceImport