Skip to content

Commit

Permalink
fix: API reference and liquid templating docs updated paths in makefi…
Browse files Browse the repository at this point in the history
…le (#409)

* fix: API reference and liquid templating docs updated paths in makefile

* fix: rename files to use title fallback properly
  • Loading branch information
nickcernera authored Feb 21, 2025
1 parent e2d9ae5 commit b152c73
Show file tree
Hide file tree
Showing 6 changed files with 2,916 additions and 16 deletions.
6 changes: 3 additions & 3 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,10 @@ web: ## runs the docs site locally
sync-docs: sync-console-crd-docs sync-operator-crd-docs sync-liquid-docs

sync-console-crd-docs:
curl -L https://raw.githubusercontent.com/pluralsh/console/master/go/controller/docs/api.md --output pages/deployments/operator/api.md
curl -L https://raw.githubusercontent.com/pluralsh/console/master/go/controller/docs/api.md --output pages/01-overview/03-api-reference.md

sync-operator-crd-docs:
curl -L https://raw.githubusercontent.com/pluralsh/deployment-operator/main/docs/api.md --output pages/deployments/operator/agent-api.md
curl -L https://raw.githubusercontent.com/pluralsh/deployment-operator/main/docs/api.md --output pages/01-overview/04-agent-api.md

sync-liquid-docs:
curl -L https://raw.githubusercontent.com/pluralsh/polly/main/docs/liquid-filters.md --output pages/deployments/templating-filters.md
curl -L https://raw.githubusercontent.com/pluralsh/polly/main/docs/liquid-filters.md --output pages/03-plural-features/08-service-templating/01-templating-filters.mdi
Original file line number Diff line number Diff line change
@@ -1,9 +1,4 @@
---
title: API Reference
description: API reference for Plural
---


# API Reference

## Packages
- [deployments.plural.sh/v1alpha1](#deploymentspluralshv1alpha1)
Expand Down Expand Up @@ -61,6 +56,7 @@ _Appears in:_
| --- | --- | --- | --- |
| `model` _string_ | Model is the LLM model name to use. | | Optional: {} <br /> |
| `toolModel` _string_ | Model to use for tool calling, which is less frequent and often requires more advanced reasoning | | Optional: {} <br /> |
| `embeddingModel` _string_ | Model to use for generating embeddings | | 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 @@ -82,6 +78,7 @@ _Appears in:_
| `tools` _[Tools](#tools)_ | | | 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 /> |
| `toolProvider` _[AiProvider](#aiprovider)_ | Provider to use for tool calling, in case you want to use a different LLM more optimized to those tasks | | Enum: [OPENAI ANTHROPIC OLLAMA AZURE BEDROCK VERTEX] <br />Optional: {} <br /> |
| `embeddingProvider` _[AiProvider](#aiprovider)_ | Provider to use for generating embeddings. Oftentimes foundational model providers do not have embeddings models, and it's better to simply use 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 /> |
Expand Down Expand Up @@ -109,6 +106,7 @@ _Appears in:_
| `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 /> |
| `toolModel` _string_ | Model to use for tool calling, which is less frequent and often requires more advanced reasoning | | Optional: {} <br /> |
| `embeddingModel` _string_ | Model to use for generating embeddings | | 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 Down Expand Up @@ -826,6 +824,8 @@ _Appears in:_
| `ai` _[AISettings](#aisettings)_ | AI settings specifies a configuration for LLM provider clients | | Optional: {} <br /> |
| `logging` _[LoggingSettings](#loggingsettings)_ | Settings for connections to log aggregation datastores | | Optional: {} <br /> |
| `cost` _[CostSettings](#costsettings)_ | Settings for managing Plural's cost management features | | Optional: {} <br /> |
| `deploymentRepositoryRef` _[NamespacedName](#namespacedname)_ | pointer to the deployment GIT repository to use | | Optional: {} <br /> |
| `scaffoldsRepositoryRef` _[NamespacedName](#namespacedname)_ | pointer to the Scaffolds GIT repository to use | | Optional: {} <br /> |


#### ElasticsearchConnection
Expand Down Expand Up @@ -1260,6 +1260,7 @@ _Appears in:_
| `observableMetrics` _[ObservableMetric](#observablemetric) array_ | | | Optional: {} <br /> |
| `tags` _object (keys:string, values:string)_ | Tags used to filter stacks. | | Optional: {} <br /> |
| `variables` _[RawExtension](https://pkg.go.dev/k8s.io/apimachinery/pkg/runtime#RawExtension)_ | Variables represents a file with variables in the stack run environment.<br />It will be automatically passed to the specific tool depending on the<br />stack Type (except [console.StackTypeCustom]). | | Optional: {} <br /> |
| `policyEngine` _[PolicyEngine](#policyengine)_ | PolicyEngine is a configuration for applying policy enforcement to a stack. | | Optional: {} <br /> |


#### JobSpec
Expand Down Expand Up @@ -1395,6 +1396,7 @@ with the addition of kubebuilder/json annotations for better schema support.


_Appears in:_
- [DeploymentSettingsSpec](#deploymentsettingsspec)
- [ServiceHelm](#servicehelm)

| Field | Description | Default | Validation |
Expand Down Expand Up @@ -1974,6 +1976,23 @@ _Appears in:_
| `urgent` _boolean_ | Whether to immediately deliver the notification via SMTP | | Optional: {} <br /> |


#### PolicyEngine







_Appears in:_
- [InfrastructureStackSpec](#infrastructurestackspec)

| Field | Description | Default | Validation |
| --- | --- | --- | --- |
| `type` _[PolicyEngineType](#policyenginetype)_ | Type is the policy engine to use with this stack | | Enum: [TRIVY] <br />Required: {} <br /> |
| `maxSeverity` _[VulnSeverity](#vulnseverity)_ | MaxSeverity is the maximum allowed severity without failing the stack run | | Enum: [UNKNOWN LOW MEDIUM HIGH CRITICAL NONE] <br />Optional: {} <br /> |


#### PrAutomation


Expand Down Expand Up @@ -2402,6 +2421,7 @@ _Appears in:_
| `baseUrl` _string_ | BaseUrl is a base URL for Git clones for self-hosted versions. | | Optional: {} <br /> |
| `apiUrl` _string_ | APIUrl is a base URL for HTTP apis for shel-hosted versions if different from BaseUrl. | | Optional: {} <br /> |
| `github` _[ScmGithubConnection](#scmgithubconnection)_ | | | Optional: {} <br /> |
| `default` _boolean_ | | | Optional: {} <br /> |


#### ScmGithubConnection
Expand Down
File renamed without changes.
Loading

0 comments on commit b152c73

Please sign in to comment.