diff --git a/pages/overview/management-api-reference.md b/pages/overview/management-api-reference.md index a08702ab..6a994483 100644 --- a/pages/overview/management-api-reference.md +++ b/pages/overview/management-api-reference.md @@ -41,6 +41,7 @@ Package v1alpha1 contains API Schema definitions for the deployments v1alpha1 AP - [Provider](#provider) - [ScmConnection](#scmconnection) - [ServiceAccount](#serviceaccount) +- [ServiceContext](#servicecontext) - [ServiceDeployment](#servicedeployment) - [StackDefinition](#stackdefinition) @@ -1220,6 +1221,7 @@ _Appears in:_ | `cascade` _[Cascade](#cascade)_ | Cascade deletion options for this global service | | Optional: {}
| | `context` _[TemplateContext](#templatecontext)_ | Context to be used for dynamic template overrides of things like helm chart, version or values files | | Optional: {}
| | `distro` _[ClusterDistro](#clusterdistro)_ | Distro of kubernetes this cluster is running | | Enum: [GENERIC EKS AKS GKE RKE K3S]
Optional: {}
| +| `mgmt` _boolean_ | Whether to include management clusters in the target set | | Optional: {}
| | `serviceRef` _[ObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#objectreference-v1-core)_ | ServiceRef to replicate across clusters | | Optional: {}
| | `providerRef` _[ObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#objectreference-v1-core)_ | ProviderRef apply to clusters with this provider | | Optional: {}
| | `projectRef` _[ObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#objectreference-v1-core)_ | ProjectRef allows a global service to span a specific project only | | Optional: {}
| @@ -1491,9 +1493,10 @@ _Appears in:_ | Field | Description | Default | Validation | | --- | --- | --- | --- | | `enabled` _boolean_ | | | Optional: {}
| -| `driver` _[LogDriver](#logdriver)_ | The type of log aggregation solution you wish to use | VICTORIA | Enum: [VICTORIA ELASTIC]
Optional: {}
| +| `driver` _[LogDriver](#logdriver)_ | The type of log aggregation solution you wish to use | VICTORIA | Enum: [VICTORIA ELASTIC OPENSEARCH]
Optional: {}
| | `victoria` _[HTTPConnection](#httpconnection)_ | Configures a connection to victoria metrics | | Optional: {}
| | `elastic` _[ElasticsearchConnection](#elasticsearchconnection)_ | Configures a connection to elasticsearch | | Optional: {}
| +| `opensearch` _[OpensearchConnection](#opensearchconnection)_ | Configures a connection to opensearch | | Optional: {}
| #### MCPServer @@ -2093,6 +2096,46 @@ _Appears in:_ | `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: {}
| +#### OpensearchConnection + + + + + + + +_Appears in:_ +- [LoggingSettings](#loggingsettings) + +| Field | Description | Default | Validation | +| --- | --- | --- | --- | +| `host` _string_ | Host ... | | Required: {}
| +| `index` _string_ | Index to query in opensearch | | Optional: {}
| +| `awsAccessKeyId` _string_ | AWS Access Key ID to use, can also use IRSA to acquire credentials | | Optional: {}
| +| `awsSecretAccessKeySecretRef` _[SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#secretkeyselector-v1-core)_ | AWS Secret Access Key to use, can also use IRSA to acquire credentials | | Optional: {}
| +| `awsRegion` _string_ | AWS Region to use | | Optional: {}
| + + +#### OpensearchConnectionSettings + + + + + + + +_Appears in:_ +- [VectorStore](#vectorstore) + +| Field | Description | Default | Validation | +| --- | --- | --- | --- | +| `host` _string_ | | | | +| `index` _string_ | | | | +| `awsAccessKeyId` _string_ | | | Optional: {}
| +| `awsSecretAccessKeyRef` _[SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#secretkeyselector-v1-core)_ | | | Optional: {}
| +| `awsRegion` _string_ | | | Optional: {}
| + + #### Pipeline @@ -2345,7 +2388,7 @@ _Appears in:_ | Field | Description | Default | Validation | | --- | --- | --- | --- | | `name` _string_ | | | Required: {}
| -| `type` _[ConfigurationType](#configurationtype)_ | | | Enum: [STRING INT BOOL DOMAIN BUCKET FILE FUNCTION PASSWORD ENUM CLUSTER PROJECT]
Required: {}
| +| `type` _[ConfigurationType](#configurationtype)_ | | | Enum: [STRING INT BOOL PASSWORD ENUM CLUSTER PROJECT GROUP USER FLOW]
Required: {}
| | `condition` _[Condition](#condition)_ | | | Optional: {}
| | `default` _string_ | | | Optional: {}
| | `documentation` _string_ | | | Optional: {}
| @@ -2728,7 +2771,7 @@ _Appears in:_ -ScmConnection ... +ScmConnection is a container for credentials to a scm provider. You can also reference a SCM connection created in the Plural UI via the provider + name, leaving all other fields blank. @@ -2757,7 +2800,7 @@ _Appears in:_ | --- | --- | --- | --- | | `name` _string_ | Name is a human-readable name of the ScmConnection. | | Required: {}
| | `type` _[ScmType](#scmtype)_ | Type is the name of the scm service for the ScmConnection.
One of (ScmType): [github, gitlab] | | Enum: [GITHUB GITLAB BITBUCKET]
Required: {}
Type: string
| -| `tokenSecretRef` _[SecretReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#secretreference-v1-core)_ | Token ... | | Optional: {}
| +| `tokenSecretRef` _[SecretReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#secretreference-v1-core)_ | A secret containing this access token you will use, stored in the `token` data field. | | Optional: {}
| | `username` _string_ | Username ... | | Optional: {}
| | `baseUrl` _string_ | BaseUrl is a base URL for Git clones for self-hosted versions. | | Optional: {}
| | `apiUrl` _string_ | APIUrl is a base URL for HTTP apis for shel-hosted versions if different from BaseUrl. | | Optional: {}
| @@ -2801,6 +2844,25 @@ ServiceAccount is a type of non-human account that provides distinct identity. | `spec` _[ServiceAccountSpec](#serviceaccountspec)_ | Spec reflects a Console API service account spec. | | Required: {}
| +#### ServiceAccountScope + + + + + + + +_Appears in:_ +- [ServiceAccountSpec](#serviceaccountspec) + +| Field | Description | Default | Validation | +| --- | --- | --- | --- | +| `api` _string_ | API is a name of the Console API that this service account should be scoped to. | | Optional: {}
| +| `apis` _string array_ | Apis is a list of Console APIs that this service account should be scoped to. | | Optional: {}
| +| `identifier` _string_ | Identifier is a resource ID in the Console API that this service account should be scoped to.
Leave blank or use `*` to scope to all resources in the API. | | Optional: {}
| +| `ids` _string array_ | Ids is a list of Console API IDs that this service account should be scoped to. | | Optional: {}
| + + #### ServiceAccountSpec @@ -2815,6 +2877,7 @@ _Appears in:_ | Field | Description | Default | Validation | | --- | --- | --- | --- | | `email` _string_ | Email address to that will be bound to this service account. | | Required: {}
Type: string
| +| `scopes` _[ServiceAccountScope](#serviceaccountscope) array_ | Scopes defines the scope of this service account.
It can be used to limit the access of this service account to specific Console APIs or identifiers. | | Optional: {}
| | `tokenSecretRef` _[SecretReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#secretreference-v1-core)_ | TokenSecretRef is a secret reference that should contain token. | | Optional: {}
| @@ -2841,6 +2904,42 @@ _Appears in:_ | `version` _string_ | | | Optional: {}
| +#### ServiceContext + + + +ServiceContext is the Schema for the servicecontexts API + + + + + +| Field | Description | Default | Validation | +| --- | --- | --- | --- | +| `apiVersion` _string_ | `deployments.plural.sh/v1alpha1` | | | +| `kind` _string_ | `ServiceContext` | | | +| `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` _[ServiceContextSpec](#servicecontextspec)_ | | | | + + +#### ServiceContextSpec + + + +ServiceContextSpec defines the desired state of ServiceContext + + + +_Appears in:_ +- [ServiceContext](#servicecontext) + +| Field | Description | Default | Validation | +| --- | --- | --- | --- | +| `name` _string_ | the name of this service, if not provided ServiceContext's own name from ServiceContext.ObjectMeta will be used. | | Optional: {}
| +| `configuration` _[RawExtension](https://pkg.go.dev/k8s.io/apimachinery/pkg/runtime#RawExtension)_ | A reusable configuration context, useful for plumbing data from external tools like terraform, pulumi, etc. | | | +| `projectRef` _[ObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#objectreference-v1-core)_ | ProjectRef references project this service context belongs to.
If not provided, it will use the default project. | | Optional: {}
| + + #### ServiceDependency @@ -2919,6 +3018,7 @@ _Appears in:_ | `git` _[GitRef](#gitref)_ | A reference to a git folder/ref | | Optional: {}
| | `ignoreHooks` _boolean_ | whether you want to completely ignore any helm hooks when actualizing this service | | Optional: {}
| | `ignoreCrds` _boolean_ | whether you want to not include the crds in the /crds folder of the chart (useful if reinstantiating the same chart on the same cluster) | | Optional: {}
| +| `luaScript` _string_ | a lua script to use to generate helm configuration. This can ultimately return a lua table with keys "values" and "valuesFiles" to supply overlays for either dynamically
based on git state or other metadata | | Optional: {}
| #### ServiceImport @@ -3012,7 +3112,7 @@ _Appears in:_ | `templated` _boolean_ | | | Optional: {}
| | `repositoryRef` _[ObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#objectreference-v1-core)_ | | | Optional: {}
| | `protect` _boolean_ | Whether to protect this service from deletion. Protected services are also not drained on cluster deletion. | | Optional: {}
| -| `contexts` _string array_ | a list of context ids to add to this service | | Optional: {}
| +| `contexts` _string array_ | a list of context names to add to this service | | Optional: {}
| | `git` _[GitRef](#gitref)_ | Git settings to configure git for a service | | Optional: {}
| | `helm` _[ServiceHelm](#servicehelm)_ | Helm settings to configure helm for a service | | Optional: {}
| | `kustomize` _[ServiceKustomize](#servicekustomize)_ | Kustomize settings for service kustomization | | Optional: {}
| @@ -3099,6 +3199,7 @@ _Appears in:_ | `version` _string_ | Version the semver of the tool you wish to use | | Optional: {}
| | `tag` _string_ | Tag is the docker image tag you wish to use
if you're customizing the version | | Optional: {}
| | `hooks` _[StackHook](#stackhook) array_ | Hooks to run at various stages of the stack run | | Optional: {}
| +| `terraform` _[TerraformConfiguration](#terraformconfiguration)_ | Terraform is the terraform configuration for this stack | | Optional: {}
| #### StackCron @@ -3314,6 +3415,23 @@ _Appears in:_ | `raw` _[RawExtension](https://pkg.go.dev/k8s.io/apimachinery/pkg/runtime#RawExtension)_ | A raw yaml map to use for service template context | | Optional: {}
| +#### TerraformConfiguration + + + + + + + +_Appears in:_ +- [StackConfiguration](#stackconfiguration) + +| Field | Description | Default | Validation | +| --- | --- | --- | --- | +| `parallelism` _integer_ | Parallelism is the number of concurrent operations to run, equivalent to the -parallelism flag in terraform | | Optional: {}
| +| `refresh` _boolean_ | Refresh is whether to refresh the state of the stack, equivalent to the -refresh flag in terraform | | Optional: {}
| + + #### Tools @@ -3344,8 +3462,9 @@ _Appears in:_ | Field | Description | Default | Validation | | --- | --- | --- | --- | | `enabled` _boolean_ | | false | Optional: {}
| -| `vectorStore` _[VectorStore](#vectorstore)_ | | | Enum: [ELASTIC]
Optional: {}
| +| `vectorStore` _[VectorStore](#vectorstore)_ | | | Enum: [ELASTIC OPENSEARCH]
Optional: {}
| | `elastic` _[ElasticsearchConnectionSettings](#elasticsearchconnectionsettings)_ | | | Optional: {}
| +| `opensearch` _[OpensearchConnectionSettings](#opensearchconnectionsettings)_ | | | Optional: {}
| #### VertexSettings diff --git a/pages/plural-features/service-templating/supporting-liquid-filters.md b/pages/plural-features/service-templating/supporting-liquid-filters.md index a85dbd42..2b56b3b3 100644 --- a/pages/plural-features/service-templating/supporting-liquid-filters.md +++ b/pages/plural-features/service-templating/supporting-liquid-filters.md @@ -1129,16 +1129,6 @@ _Parameters_: _Implementation_: `path.IsAbs` -## `join` - - - - - - - -_Implementation_: `github.com/Masterminds/sprig/v3.join` - ## `kebabcase` Converts a string from camelCase to kebab-case.