diff --git a/pages/deployments/operator/api.md b/pages/deployments/operator/api.md index 4b9d076f..7f41b6a2 100644 --- a/pages/deployments/operator/api.md +++ b/pages/deployments/operator/api.md @@ -52,7 +52,8 @@ _Appears in:_ | Field | Description | Default | Validation | | --- | --- | --- | --- | -| `model` _string_ | Model is the LLM model name to use. | | Required: {}
| +| `model` _string_ | Model is the LLM model name to use. | | Optional: {}
| +| `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: {}
| | `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: {}
| @@ -70,13 +71,54 @@ _Appears in:_ | 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: {}
| +| `provider` _[AiProvider](#aiprovider)_ | Provider defines which of the supported LLM providers should be used. | OPENAI | Enum: [OPENAI ANTHROPIC OLLAMA AZURE BEDROCK VERTEX]
Optional: {}
| | `openAI` _[AIProviderSettings](#aiprovidersettings)_ | OpenAI holds the OpenAI provider configuration. | | Optional: {}
| | `anthropic` _[AIProviderSettings](#aiprovidersettings)_ | Anthropic holds the Anthropic provider configuration. | | Optional: {}
| +| `ollama` _[OllamaSettings](#ollamasettings)_ | Ollama holds configuration for a self-hosted Ollama deployment, more details available at https://github.com/ollama/ollama | | Optional: {}
| +| `azure` _[AzureOpenAISettings](#azureopenaisettings)_ | Azure holds configuration for using AzureOpenAI to generate LLM insights | | Optional: {}
| +| `bedrock` _[BedrockSettings](#bedrocksettings)_ | Bedrock holds configuration for using AWS Bedrock to generate LLM insights | | Optional: {}
| +| `vertex` _[VertexSettings](#vertexsettings)_ | Vertex holds configuration for using GCP VertexAI to generate LLM insights | | Optional: {}
| +#### AzureOpenAISettings + + + + + + + +_Appears in:_ +- [AISettings](#aisettings) + +| Field | Description | Default | Validation | +| --- | --- | --- | --- | +| `endpoint` _string_ | Your Azure OpenAI endpoint, should be formatted like: https://{endpoint}/openai/deployments/{deployment-id}" | | Required: {}
| +| `apiVersion` _string_ | The azure openai Data plane - inference api version to use, defaults to 2024-10-01-preview or the latest available | | Optional: {}
| +| `model` _string_ | The OpenAi Model you wish to use. If not specified, Plural will provide a default | | Optional: {}
| +| `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: {}
| + + +#### BedrockSettings + + + + + + + +_Appears in:_ +- [AISettings](#aisettings) + +| Field | Description | Default | Validation | +| --- | --- | --- | --- | +| `modelId` _string_ | The AWS Bedrock Model ID to use | | Required: {}
| +| `accessKeyId` _string_ | An AWS Access Key ID to use, can also use IRSA to acquire credentials | | Optional: {}
| +| `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: {}
| + + #### Binding @@ -1545,6 +1587,24 @@ _Appears in:_ | `git` _[ObserverGit](#observergit)_ | | | Optional: {}
| +#### OllamaSettings + + + +Settings for configuring a self-hosted Ollama LLM, more details at https://github.com/ollama/ollama + + + +_Appears in:_ +- [AISettings](#aisettings) + +| Field | Description | Default | Validation | +| --- | --- | --- | --- | +| `url` _string_ | URL is the url this model is queryable on | | Required: {}
| +| `model` _string_ | Model is the Ollama model to use when querying the /chat api | | 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 contents of a HTTP Authorization header
to send to your ollama api in case authorization is required (eg for an instance hosted on a public network) | | Optional: {}
| + + #### Pipeline @@ -1805,6 +1865,7 @@ _Appears in:_ | --- | --- | --- | --- | | `regex` _string_ | A regex to match string-valued configuration items | | Optional: {}
| | `json` _boolean_ | Whether the string value is supposed to be json-encoded | | Optional: {}
| +| `uniqBy` _[PrAutomationUniqBy](#prautomationuniqby)_ | How to determine uniquenss for this field | | Optional: {}
| #### PrAutomationConfirmation @@ -1877,7 +1938,7 @@ _Appears in:_ | `icon` _string_ | An icon url to annotate this pr automation | | Optional: {}
| | `darkIcon` _string_ | An darkmode icon url to annotate this pr automation | | Optional: {}
| | `documentation` _string_ | Documentation ... | | Optional: {}
| -| `identifier` _string_ | Identifier is a string referencing the repository, i.e. for GitHub it would be "/" | | Optional: {}
| +| `identifier` _string_ | Identifier is a string referencing the repository, i.e. for GitHub it would be "organization/repositoryName" | | Optional: {}
| | `message` _string_ | Message the commit message this pr will incorporate | | Optional: {}
| | `name` _string_ | Name name of the automation in the console api (defaults to metadata.name) | | Optional: {}
| | `title` _string_ | Title the title of the generated pr | | Optional: {}
| @@ -1948,6 +2009,22 @@ _Appears in:_ | `context` _[RawExtension](https://pkg.go.dev/k8s.io/apimachinery/pkg/runtime#RawExtension)_ | Context is a [PrAutomation] configuration context | | Optional: {}
| +#### PrAutomationUniqBy + + + + + + + +_Appears in:_ +- [PrAutomationConfigurationValidation](#prautomationconfigurationvalidation) + +| Field | Description | Default | Validation | +| --- | --- | --- | --- | +| `scope` _[ValidationUniqScope](#validationuniqscope)_ | | | Enum: [PROJECT CLUSTER]
Required: {}
| + + #### PrAutomationUpdateConfiguration @@ -1964,6 +2041,7 @@ _Appears in:_ | `files` _string array_ | Files to update | | Optional: {}
| | `matchStrategy` _[MatchStrategy](#matchstrategy)_ | MatchStrategy, see enum for behavior | | Optional: {}
| | `regexReplacements` _[RegexReplacement](#regexreplacement) array_ | Full regex + replacement structs in case there is different behavior per regex | | Optional: {}
| +| `yamlOverlays` _[YamlOverlay](#yamloverlay) array_ | Replacement via overlaying a yaml structure on an existing yaml file | | Optional: {}
| | `regexes` _string array_ | The regexes to apply on each file | | Optional: {}
| | `replaceTemplate` _string_ | The template to use when replacing a regex | | Optional: {}
| | `yq` _string_ | (Unused so far) | | Optional: {}
| @@ -2350,6 +2428,7 @@ _Appears in:_ | `repositoryRef` _[ObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#objectreference-v1-core)_ | | | Optional: {}
| | `clusterRef` _[ObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#objectreference-v1-core)_ | | | Required: {}
| | `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: {}
| +| `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: {}
| | `bindings` _[Bindings](#bindings)_ | Bindings contain read and write policies of this cluster | | Optional: {}
| | `dependencies` _[ServiceDependency](#servicedependency) array_ | Dependencies contain dependent services | | Optional: {}
| | `contexts` _string array_ | Contexts contain dependent service context names | | Optional: {}
| @@ -2638,3 +2717,42 @@ _Appears in:_ +#### VertexSettings + + + + + + + +_Appears in:_ +- [AISettings](#aisettings) + +| Field | Description | Default | Validation | +| --- | --- | --- | --- | +| `model` _string_ | The Vertex AI model to use | | Optional: {}
| +| `project` _string_ | The GCP project you'll be using | | Required: {}
| +| `location` _string_ | The GCP region Vertex is queried from | | Required: {}
| +| `endpoint` _string_ | A custom endpoint for self-deployed models | | Optional: {}
| +| `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: {}
| + + +#### YamlOverlay + + + +YamlOverlay ... + + + +_Appears in:_ +- [PrAutomationUpdateConfiguration](#prautomationupdateconfiguration) + +| Field | Description | Default | Validation | +| --- | --- | --- | --- | +| `file` _string_ | the file to execute the overlay on | | Required: {}
| +| `yaml` _string_ | the (possibly templated) yaml to use as the overlayed yaml blob written to the file | | Required: {}
| +| `templated` _boolean_ | Whether you want to apply templating to the yaml blob before overlaying | | Optional: {}
| +| `listMerge` _[ListMerge](#listmerge)_ | How you want list merge to be performed, defaults to OVERWRITE | | Enum: [OVERWRITE APPEND]
Optional: {}
| + + diff --git a/src/generated/graphql.ts b/src/generated/graphql.ts index fb9544e8..fb6944ec 100644 --- a/src/generated/graphql.ts +++ b/src/generated/graphql.ts @@ -1814,6 +1814,8 @@ export type OidcAttributes = { authMethod: OidcAuthMethod; /** The users or groups that can login through the OIDC provider. */ bindings?: InputMaybe>>; + description?: InputMaybe; + name?: InputMaybe; /** The redirect URIs for the OIDC provider. */ redirectUris?: InputMaybe>>; }; @@ -1859,9 +1861,12 @@ export type OidcProvider = { clientSecret: Scalars['String']['output']; configuration?: Maybe; consent?: Maybe; + description?: Maybe; id: Scalars['ID']['output']; insertedAt?: Maybe; invites?: Maybe>>; + name?: Maybe; + owner?: Maybe; redirectUris?: Maybe>>; updatedAt?: Maybe; }; @@ -1875,6 +1880,18 @@ export type OidcProviderBinding = { user?: Maybe; }; +export type OidcProviderConnection = { + __typename?: 'OidcProviderConnection'; + edges?: Maybe>>; + pageInfo: PageInfo; +}; + +export type OidcProviderEdge = { + __typename?: 'OidcProviderEdge'; + cursor?: Maybe; + node?: Maybe; +}; + export type OidcSettings = { __typename?: 'OidcSettings'; authMethod: OidcAuthMethod; @@ -2857,6 +2874,7 @@ export type RootMutationType = { deleteInvite?: Maybe; deleteKeyBackup?: Maybe; deleteMessage?: Maybe; + deleteOidcProvider?: Maybe; deletePaymentMethod?: Maybe; deletePlatformSubscription?: Maybe; deletePublicKey?: Maybe; @@ -3073,7 +3091,7 @@ export type RootMutationTypeCreateOauthIntegrationArgs = { export type RootMutationTypeCreateOidcProviderArgs = { attributes: OidcAttributes; - installationId: Scalars['ID']['input']; + installationId?: InputMaybe; }; @@ -3289,6 +3307,11 @@ export type RootMutationTypeDeleteMessageArgs = { }; +export type RootMutationTypeDeleteOidcProviderArgs = { + id: Scalars['ID']['input']; +}; + + export type RootMutationTypeDeletePaymentMethodArgs = { id: Scalars['ID']['input']; }; @@ -3625,7 +3648,8 @@ export type RootMutationTypeUpdateMessageArgs = { export type RootMutationTypeUpdateOidcProviderArgs = { attributes: OidcAttributes; - installationId: Scalars['ID']['input']; + id?: InputMaybe; + installationId?: InputMaybe; }; @@ -3786,6 +3810,7 @@ export type RootQueryType = { oidcConsent?: Maybe; oidcLogin?: Maybe; oidcLogins?: Maybe; + oidcProviders?: Maybe; oidcToken?: Maybe; platformMetrics?: Maybe; platformPlans?: Maybe>>; @@ -4141,6 +4166,14 @@ export type RootQueryTypeOidcLoginsArgs = { }; +export type RootQueryTypeOidcProvidersArgs = { + after?: InputMaybe; + before?: InputMaybe; + first?: InputMaybe; + last?: InputMaybe; +}; + + export type RootQueryTypeOidcTokenArgs = { email: Scalars['String']['input']; idToken: Scalars['String']['input'];