Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Update CRD docs #336

Merged
merged 1 commit into from
Dec 2, 2024
Merged

docs: Update CRD docs #336

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
124 changes: 121 additions & 3 deletions pages/deployments/operator/api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,8 @@ _Appears in:_

| Field | Description | Default | Validation |
| --- | --- | --- | --- |
| `model` _string_ | Model is the LLM model name to use. | | Required: {} <br /> |
| `model` _string_ | Model is the LLM model name to use. | | Optional: {} <br /> |
| `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 /> |
| `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 /> |


Expand All @@ -70,13 +71,54 @@ _Appears in:_
| Field | Description | Default | Validation |
| --- | --- | --- | --- |
| `enabled` _boolean_ | Enabled defines whether to enable the AI integration or not. | false | Optional: {} <br /> |
| `provider` _[AiProvider](#aiprovider)_ | Provider defines which of the supported LLM providers should be used. | OPENAI | Enum: [OPENAI ANTHROPIC] <br />Optional: {} <br /> |
| `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 /> |
| `openAI` _[AIProviderSettings](#aiprovidersettings)_ | OpenAI holds the OpenAI provider configuration. | | Optional: {} <br /> |
| `anthropic` _[AIProviderSettings](#aiprovidersettings)_ | Anthropic holds the Anthropic provider configuration. | | 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 /> |
| `azure` _[AzureOpenAISettings](#azureopenaisettings)_ | Azure holds configuration for using AzureOpenAI to generate LLM insights | | Optional: {} <br /> |
| `bedrock` _[BedrockSettings](#bedrocksettings)_ | Bedrock holds configuration for using AWS Bedrock to generate LLM insights | | Optional: {} <br /> |
| `vertex` _[VertexSettings](#vertexsettings)_ | Vertex holds configuration for using GCP VertexAI to generate LLM insights | | Optional: {} <br /> |




#### 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: {} <br /> |
| `apiVersion` _string_ | The azure openai Data plane - inference api version to use, defaults to 2024-10-01-preview or the latest available | | Optional: {} <br /> |
| `model` _string_ | The OpenAi Model you wish to use. If not specified, Plural will provide a default | | Optional: {} <br /> |
| `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 /> |


#### BedrockSettings







_Appears in:_
- [AISettings](#aisettings)

| Field | Description | Default | Validation |
| --- | --- | --- | --- |
| `modelId` _string_ | The AWS Bedrock Model ID to use | | Required: {} <br /> |
| `accessKeyId` _string_ | An AWS Access Key ID to use, can also use IRSA to acquire credentials | | Optional: {} <br /> |
| `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 /> |


#### Binding


Expand Down Expand Up @@ -1545,6 +1587,24 @@ _Appears in:_
| `git` _[ObserverGit](#observergit)_ | | | Optional: {} <br /> |


#### 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: {} <br /> |
| `model` _string_ | Model is the Ollama model to use when querying the /chat api | | Required: {} <br /> |
| `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 /> |


#### Pipeline


Expand Down Expand Up @@ -1805,6 +1865,7 @@ _Appears in:_
| --- | --- | --- | --- |
| `regex` _string_ | A regex to match string-valued configuration items | | Optional: {} <br /> |
| `json` _boolean_ | Whether the string value is supposed to be json-encoded | | Optional: {} <br /> |
| `uniqBy` _[PrAutomationUniqBy](#prautomationuniqby)_ | How to determine uniquenss for this field | | Optional: {} <br /> |


#### PrAutomationConfirmation
Expand Down Expand Up @@ -1877,7 +1938,7 @@ _Appears in:_
| `icon` _string_ | An icon url to annotate this pr automation | | Optional: {} <br /> |
| `darkIcon` _string_ | An darkmode icon url to annotate this pr automation | | Optional: {} <br /> |
| `documentation` _string_ | Documentation ... | | Optional: {} <br /> |
| `identifier` _string_ | Identifier is a string referencing the repository, i.e. for GitHub it would be "<organization>/<repositoryName>" | | Optional: {} <br /> |
| `identifier` _string_ | Identifier is a string referencing the repository, i.e. for GitHub it would be "organization/repositoryName" | | Optional: {} <br /> |
| `message` _string_ | Message the commit message this pr will incorporate | | Optional: {} <br /> |
| `name` _string_ | Name name of the automation in the console api (defaults to metadata.name) | | Optional: {} <br /> |
| `title` _string_ | Title the title of the generated pr | | Optional: {} <br /> |
Expand Down Expand Up @@ -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: {} <br /> |


#### PrAutomationUniqBy







_Appears in:_
- [PrAutomationConfigurationValidation](#prautomationconfigurationvalidation)

| Field | Description | Default | Validation |
| --- | --- | --- | --- |
| `scope` _[ValidationUniqScope](#validationuniqscope)_ | | | Enum: [PROJECT CLUSTER] <br />Required: {} <br /> |


#### PrAutomationUpdateConfiguration


Expand All @@ -1964,6 +2041,7 @@ _Appears in:_
| `files` _string array_ | Files to update | | Optional: {} <br /> |
| `matchStrategy` _[MatchStrategy](#matchstrategy)_ | MatchStrategy, see enum for behavior | | Optional: {} <br /> |
| `regexReplacements` _[RegexReplacement](#regexreplacement) array_ | Full regex + replacement structs in case there is different behavior per regex | | Optional: {} <br /> |
| `yamlOverlays` _[YamlOverlay](#yamloverlay) array_ | Replacement via overlaying a yaml structure on an existing yaml file | | Optional: {} <br /> |
| `regexes` _string array_ | The regexes to apply on each file | | Optional: {} <br /> |
| `replaceTemplate` _string_ | The template to use when replacing a regex | | Optional: {} <br /> |
| `yq` _string_ | (Unused so far) | | Optional: {} <br /> |
Expand Down Expand Up @@ -2350,6 +2428,7 @@ _Appears in:_
| `repositoryRef` _[ObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#objectreference-v1-core)_ | | | Optional: {} <br /> |
| `clusterRef` _[ObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#objectreference-v1-core)_ | | | Required: {} <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 /> |
| `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 /> |
| `bindings` _[Bindings](#bindings)_ | Bindings contain read and write policies of this cluster | | Optional: {} <br /> |
| `dependencies` _[ServiceDependency](#servicedependency) array_ | Dependencies contain dependent services | | Optional: {} <br /> |
| `contexts` _string array_ | Contexts contain dependent service context names | | Optional: {} <br /> |
Expand Down Expand Up @@ -2638,3 +2717,42 @@ _Appears in:_



#### VertexSettings







_Appears in:_
- [AISettings](#aisettings)

| Field | Description | Default | Validation |
| --- | --- | --- | --- |
| `model` _string_ | The Vertex AI model to use | | Optional: {} <br /> |
| `project` _string_ | The GCP project you'll be using | | Required: {} <br /> |
| `location` _string_ | The GCP region Vertex is queried from | | Required: {} <br /> |
| `endpoint` _string_ | A custom endpoint for self-deployed models | | Optional: {} <br /> |
| `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 /> |


#### YamlOverlay



YamlOverlay ...



_Appears in:_
- [PrAutomationUpdateConfiguration](#prautomationupdateconfiguration)

| Field | Description | Default | Validation |
| --- | --- | --- | --- |
| `file` _string_ | the file to execute the overlay on | | Required: {} <br /> |
| `yaml` _string_ | the (possibly templated) yaml to use as the overlayed yaml blob written to the file | | Required: {} <br /> |
| `templated` _boolean_ | Whether you want to apply templating to the yaml blob before overlaying | | Optional: {} <br /> |
| `listMerge` _[ListMerge](#listmerge)_ | How you want list merge to be performed, defaults to OVERWRITE | | Enum: [OVERWRITE APPEND] <br />Optional: {} <br /> |


37 changes: 35 additions & 2 deletions src/generated/graphql.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1814,6 +1814,8 @@ export type OidcAttributes = {
authMethod: OidcAuthMethod;
/** The users or groups that can login through the OIDC provider. */
bindings?: InputMaybe<Array<InputMaybe<BindingAttributes>>>;
description?: InputMaybe<Scalars['String']['input']>;
name?: InputMaybe<Scalars['String']['input']>;
/** The redirect URIs for the OIDC provider. */
redirectUris?: InputMaybe<Array<InputMaybe<Scalars['String']['input']>>>;
};
Expand Down Expand Up @@ -1859,9 +1861,12 @@ export type OidcProvider = {
clientSecret: Scalars['String']['output'];
configuration?: Maybe<OuathConfiguration>;
consent?: Maybe<ConsentRequest>;
description?: Maybe<Scalars['String']['output']>;
id: Scalars['ID']['output'];
insertedAt?: Maybe<Scalars['DateTime']['output']>;
invites?: Maybe<Array<Maybe<Invite>>>;
name?: Maybe<Scalars['String']['output']>;
owner?: Maybe<User>;
redirectUris?: Maybe<Array<Maybe<Scalars['String']['output']>>>;
updatedAt?: Maybe<Scalars['DateTime']['output']>;
};
Expand All @@ -1875,6 +1880,18 @@ export type OidcProviderBinding = {
user?: Maybe<User>;
};

export type OidcProviderConnection = {
__typename?: 'OidcProviderConnection';
edges?: Maybe<Array<Maybe<OidcProviderEdge>>>;
pageInfo: PageInfo;
};

export type OidcProviderEdge = {
__typename?: 'OidcProviderEdge';
cursor?: Maybe<Scalars['String']['output']>;
node?: Maybe<OidcProvider>;
};

export type OidcSettings = {
__typename?: 'OidcSettings';
authMethod: OidcAuthMethod;
Expand Down Expand Up @@ -2857,6 +2874,7 @@ export type RootMutationType = {
deleteInvite?: Maybe<Invite>;
deleteKeyBackup?: Maybe<KeyBackup>;
deleteMessage?: Maybe<IncidentMessage>;
deleteOidcProvider?: Maybe<OidcProvider>;
deletePaymentMethod?: Maybe<PaymentMethod>;
deletePlatformSubscription?: Maybe<Account>;
deletePublicKey?: Maybe<PublicKey>;
Expand Down Expand Up @@ -3073,7 +3091,7 @@ export type RootMutationTypeCreateOauthIntegrationArgs = {

export type RootMutationTypeCreateOidcProviderArgs = {
attributes: OidcAttributes;
installationId: Scalars['ID']['input'];
installationId?: InputMaybe<Scalars['ID']['input']>;
};


Expand Down Expand Up @@ -3289,6 +3307,11 @@ export type RootMutationTypeDeleteMessageArgs = {
};


export type RootMutationTypeDeleteOidcProviderArgs = {
id: Scalars['ID']['input'];
};


export type RootMutationTypeDeletePaymentMethodArgs = {
id: Scalars['ID']['input'];
};
Expand Down Expand Up @@ -3625,7 +3648,8 @@ export type RootMutationTypeUpdateMessageArgs = {

export type RootMutationTypeUpdateOidcProviderArgs = {
attributes: OidcAttributes;
installationId: Scalars['ID']['input'];
id?: InputMaybe<Scalars['ID']['input']>;
installationId?: InputMaybe<Scalars['ID']['input']>;
};


Expand Down Expand Up @@ -3786,6 +3810,7 @@ export type RootQueryType = {
oidcConsent?: Maybe<OidcStepResponse>;
oidcLogin?: Maybe<OidcStepResponse>;
oidcLogins?: Maybe<OidcLoginConnection>;
oidcProviders?: Maybe<OidcProviderConnection>;
oidcToken?: Maybe<Scalars['String']['output']>;
platformMetrics?: Maybe<PlatformMetrics>;
platformPlans?: Maybe<Array<Maybe<PlatformPlan>>>;
Expand Down Expand Up @@ -4141,6 +4166,14 @@ export type RootQueryTypeOidcLoginsArgs = {
};


export type RootQueryTypeOidcProvidersArgs = {
after?: InputMaybe<Scalars['String']['input']>;
before?: InputMaybe<Scalars['String']['input']>;
first?: InputMaybe<Scalars['Int']['input']>;
last?: InputMaybe<Scalars['Int']['input']>;
};


export type RootQueryTypeOidcTokenArgs = {
email: Scalars['String']['input'];
idToken: Scalars['String']['input'];
Expand Down
Loading