Skip to content

Commit 815a512

Browse files
sync docs (#464)
Co-authored-by: michaeljguarino <michaeljguarino@users.noreply.github.com>
1 parent 992d5fe commit 815a512

2 files changed

Lines changed: 125 additions & 16 deletions

File tree

pages/overview/management-api-reference.md

Lines changed: 125 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,7 @@ Package v1alpha1 contains API Schema definitions for the deployments v1alpha1 AP
4141
- [Provider](#provider)
4242
- [ScmConnection](#scmconnection)
4343
- [ServiceAccount](#serviceaccount)
44+
- [ServiceContext](#servicecontext)
4445
- [ServiceDeployment](#servicedeployment)
4546
- [StackDefinition](#stackdefinition)
4647

@@ -1220,6 +1221,7 @@ _Appears in:_
12201221
| `cascade` _[Cascade](#cascade)_ | Cascade deletion options for this global service | | Optional: {} <br /> |
12211222
| `context` _[TemplateContext](#templatecontext)_ | Context to be used for dynamic template overrides of things like helm chart, version or values files | | Optional: {} <br /> |
12221223
| `distro` _[ClusterDistro](#clusterdistro)_ | Distro of kubernetes this cluster is running | | Enum: [GENERIC EKS AKS GKE RKE K3S] <br />Optional: {} <br /> |
1224+
| `mgmt` _boolean_ | Whether to include management clusters in the target set | | Optional: {} <br /> |
12231225
| `serviceRef` _[ObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#objectreference-v1-core)_ | ServiceRef to replicate across clusters | | Optional: {} <br /> |
12241226
| `providerRef` _[ObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#objectreference-v1-core)_ | ProviderRef apply to clusters with this provider | | Optional: {} <br /> |
12251227
| `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: {} <br /> |
@@ -1491,9 +1493,10 @@ _Appears in:_
14911493
| Field | Description | Default | Validation |
14921494
| --- | --- | --- | --- |
14931495
| `enabled` _boolean_ | | | Optional: {} <br /> |
1494-
| `driver` _[LogDriver](#logdriver)_ | The type of log aggregation solution you wish to use | VICTORIA | Enum: [VICTORIA ELASTIC] <br />Optional: {} <br /> |
1496+
| `driver` _[LogDriver](#logdriver)_ | The type of log aggregation solution you wish to use | VICTORIA | Enum: [VICTORIA ELASTIC OPENSEARCH] <br />Optional: {} <br /> |
14951497
| `victoria` _[HTTPConnection](#httpconnection)_ | Configures a connection to victoria metrics | | Optional: {} <br /> |
14961498
| `elastic` _[ElasticsearchConnection](#elasticsearchconnection)_ | Configures a connection to elasticsearch | | Optional: {} <br /> |
1499+
| `opensearch` _[OpensearchConnection](#opensearchconnection)_ | Configures a connection to opensearch | | Optional: {} <br /> |
14971500

14981501

14991502
#### MCPServer
@@ -2093,6 +2096,46 @@ _Appears in:_
20932096
| `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 /> |
20942097

20952098

2099+
#### OpensearchConnection
2100+
2101+
2102+
2103+
2104+
2105+
2106+
2107+
_Appears in:_
2108+
- [LoggingSettings](#loggingsettings)
2109+
2110+
| Field | Description | Default | Validation |
2111+
| --- | --- | --- | --- |
2112+
| `host` _string_ | Host ... | | Required: {} <br /> |
2113+
| `index` _string_ | Index to query in opensearch | | Optional: {} <br /> |
2114+
| `awsAccessKeyId` _string_ | AWS Access Key ID to use, can also use IRSA to acquire credentials | | Optional: {} <br /> |
2115+
| `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: {} <br /> |
2116+
| `awsRegion` _string_ | AWS Region to use | | Optional: {} <br /> |
2117+
2118+
2119+
#### OpensearchConnectionSettings
2120+
2121+
2122+
2123+
2124+
2125+
2126+
2127+
_Appears in:_
2128+
- [VectorStore](#vectorstore)
2129+
2130+
| Field | Description | Default | Validation |
2131+
| --- | --- | --- | --- |
2132+
| `host` _string_ | | | |
2133+
| `index` _string_ | | | |
2134+
| `awsAccessKeyId` _string_ | | | Optional: {} <br /> |
2135+
| `awsSecretAccessKeyRef` _[SecretKeySelector](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#secretkeyselector-v1-core)_ | | | Optional: {} <br /> |
2136+
| `awsRegion` _string_ | | | Optional: {} <br /> |
2137+
2138+
20962139
#### Pipeline
20972140

20982141

@@ -2345,7 +2388,7 @@ _Appears in:_
23452388
| Field | Description | Default | Validation |
23462389
| --- | --- | --- | --- |
23472390
| `name` _string_ | | | Required: {} <br /> |
2348-
| `type` _[ConfigurationType](#configurationtype)_ | | | Enum: [STRING INT BOOL DOMAIN BUCKET FILE FUNCTION PASSWORD ENUM CLUSTER PROJECT] <br />Required: {} <br /> |
2391+
| `type` _[ConfigurationType](#configurationtype)_ | | | Enum: [STRING INT BOOL PASSWORD ENUM CLUSTER PROJECT GROUP USER FLOW] <br />Required: {} <br /> |
23492392
| `condition` _[Condition](#condition)_ | | | Optional: {} <br /> |
23502393
| `default` _string_ | | | Optional: {} <br /> |
23512394
| `documentation` _string_ | | | Optional: {} <br /> |
@@ -2728,7 +2771,7 @@ _Appears in:_
27282771

27292772

27302773

2731-
ScmConnection ...
2774+
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.
27322775

27332776

27342777

@@ -2757,7 +2800,7 @@ _Appears in:_
27572800
| --- | --- | --- | --- |
27582801
| `name` _string_ | Name is a human-readable name of the ScmConnection. | | Required: {} <br /> |
27592802
| `type` _[ScmType](#scmtype)_ | Type is the name of the scm service for the ScmConnection.<br />One of (ScmType): [github, gitlab] | | Enum: [GITHUB GITLAB BITBUCKET] <br />Required: {} <br />Type: string <br /> |
2760-
| `tokenSecretRef` _[SecretReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#secretreference-v1-core)_ | Token ... | | Optional: {} <br /> |
2803+
| `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: {} <br /> |
27612804
| `username` _string_ | Username ... | | Optional: {} <br /> |
27622805
| `baseUrl` _string_ | BaseUrl is a base URL for Git clones for self-hosted versions. | | Optional: {} <br /> |
27632806
| `apiUrl` _string_ | APIUrl is a base URL for HTTP apis for shel-hosted versions if different from BaseUrl. | | Optional: {} <br /> |
@@ -2801,6 +2844,25 @@ ServiceAccount is a type of non-human account that provides distinct identity.
28012844
| `spec` _[ServiceAccountSpec](#serviceaccountspec)_ | Spec reflects a Console API service account spec. | | Required: {} <br /> |
28022845

28032846

2847+
#### ServiceAccountScope
2848+
2849+
2850+
2851+
2852+
2853+
2854+
2855+
_Appears in:_
2856+
- [ServiceAccountSpec](#serviceaccountspec)
2857+
2858+
| Field | Description | Default | Validation |
2859+
| --- | --- | --- | --- |
2860+
| `api` _string_ | API is a name of the Console API that this service account should be scoped to. | | Optional: {} <br /> |
2861+
| `apis` _string array_ | Apis is a list of Console APIs that this service account should be scoped to. | | Optional: {} <br /> |
2862+
| `identifier` _string_ | Identifier is a resource ID in the Console API that this service account should be scoped to.<br />Leave blank or use `*` to scope to all resources in the API. | | Optional: {} <br /> |
2863+
| `ids` _string array_ | Ids is a list of Console API IDs that this service account should be scoped to. | | Optional: {} <br /> |
2864+
2865+
28042866
#### ServiceAccountSpec
28052867

28062868

@@ -2815,6 +2877,7 @@ _Appears in:_
28152877
| Field | Description | Default | Validation |
28162878
| --- | --- | --- | --- |
28172879
| `email` _string_ | Email address to that will be bound to this service account. | | Required: {} <br />Type: string <br /> |
2880+
| `scopes` _[ServiceAccountScope](#serviceaccountscope) array_ | Scopes defines the scope of this service account.<br />It can be used to limit the access of this service account to specific Console APIs or identifiers. | | Optional: {} <br /> |
28182881
| `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: {} <br /> |
28192882

28202883

@@ -2841,6 +2904,42 @@ _Appears in:_
28412904
| `version` _string_ | | | Optional: {} <br /> |
28422905

28432906

2907+
#### ServiceContext
2908+
2909+
2910+
2911+
ServiceContext is the Schema for the servicecontexts API
2912+
2913+
2914+
2915+
2916+
2917+
| Field | Description | Default | Validation |
2918+
| --- | --- | --- | --- |
2919+
| `apiVersion` _string_ | `deployments.plural.sh/v1alpha1` | | |
2920+
| `kind` _string_ | `ServiceContext` | | |
2921+
| `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. | | |
2922+
| `spec` _[ServiceContextSpec](#servicecontextspec)_ | | | |
2923+
2924+
2925+
#### ServiceContextSpec
2926+
2927+
2928+
2929+
ServiceContextSpec defines the desired state of ServiceContext
2930+
2931+
2932+
2933+
_Appears in:_
2934+
- [ServiceContext](#servicecontext)
2935+
2936+
| Field | Description | Default | Validation |
2937+
| --- | --- | --- | --- |
2938+
| `name` _string_ | the name of this service, if not provided ServiceContext's own name from ServiceContext.ObjectMeta will be used. | | Optional: {} <br /> |
2939+
| `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. | | |
2940+
| `projectRef` _[ObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#objectreference-v1-core)_ | ProjectRef references project this service context belongs to.<br />If not provided, it will use the default project. | | Optional: {} <br /> |
2941+
2942+
28442943
#### ServiceDependency
28452944

28462945

@@ -2919,6 +3018,7 @@ _Appears in:_
29193018
| `git` _[GitRef](#gitref)_ | A reference to a git folder/ref | | Optional: {} <br /> |
29203019
| `ignoreHooks` _boolean_ | whether you want to completely ignore any helm hooks when actualizing this service | | Optional: {} <br /> |
29213020
| `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: {} <br /> |
3021+
| `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<br />based on git state or other metadata | | Optional: {} <br /> |
29223022

29233023

29243024
#### ServiceImport
@@ -3012,7 +3112,7 @@ _Appears in:_
30123112
| `templated` _boolean_ | | | Optional: {} <br /> |
30133113
| `repositoryRef` _[ObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#objectreference-v1-core)_ | | | Optional: {} <br /> |
30143114
| `protect` _boolean_ | Whether to protect this service from deletion. Protected services are also not drained on cluster deletion. | | Optional: {} <br /> |
3015-
| `contexts` _string array_ | a list of context ids to add to this service | | Optional: {} <br /> |
3115+
| `contexts` _string array_ | a list of context names to add to this service | | Optional: {} <br /> |
30163116
| `git` _[GitRef](#gitref)_ | Git settings to configure git for a service | | Optional: {} <br /> |
30173117
| `helm` _[ServiceHelm](#servicehelm)_ | Helm settings to configure helm for a service | | Optional: {} <br /> |
30183118
| `kustomize` _[ServiceKustomize](#servicekustomize)_ | Kustomize settings for service kustomization | | Optional: {} <br /> |
@@ -3099,6 +3199,7 @@ _Appears in:_
30993199
| `version` _string_ | Version the semver of the tool you wish to use | | Optional: {} <br /> |
31003200
| `tag` _string_ | Tag is the docker image tag you wish to use<br />if you're customizing the version | | Optional: {} <br /> |
31013201
| `hooks` _[StackHook](#stackhook) array_ | Hooks to run at various stages of the stack run | | Optional: {} <br /> |
3202+
| `terraform` _[TerraformConfiguration](#terraformconfiguration)_ | Terraform is the terraform configuration for this stack | | Optional: {} <br /> |
31023203

31033204

31043205
#### StackCron
@@ -3314,6 +3415,23 @@ _Appears in:_
33143415
| `raw` _[RawExtension](https://pkg.go.dev/k8s.io/apimachinery/pkg/runtime#RawExtension)_ | A raw yaml map to use for service template context | | Optional: {} <br /> |
33153416

33163417

3418+
#### TerraformConfiguration
3419+
3420+
3421+
3422+
3423+
3424+
3425+
3426+
_Appears in:_
3427+
- [StackConfiguration](#stackconfiguration)
3428+
3429+
| Field | Description | Default | Validation |
3430+
| --- | --- | --- | --- |
3431+
| `parallelism` _integer_ | Parallelism is the number of concurrent operations to run, equivalent to the -parallelism flag in terraform | | Optional: {} <br /> |
3432+
| `refresh` _boolean_ | Refresh is whether to refresh the state of the stack, equivalent to the -refresh flag in terraform | | Optional: {} <br /> |
3433+
3434+
33173435
#### Tools
33183436

33193437

@@ -3344,8 +3462,9 @@ _Appears in:_
33443462
| Field | Description | Default | Validation |
33453463
| --- | --- | --- | --- |
33463464
| `enabled` _boolean_ | | false | Optional: {} <br /> |
3347-
| `vectorStore` _[VectorStore](#vectorstore)_ | | | Enum: [ELASTIC] <br />Optional: {} <br /> |
3465+
| `vectorStore` _[VectorStore](#vectorstore)_ | | | Enum: [ELASTIC OPENSEARCH] <br />Optional: {} <br /> |
33483466
| `elastic` _[ElasticsearchConnectionSettings](#elasticsearchconnectionsettings)_ | | | Optional: {} <br /> |
3467+
| `opensearch` _[OpensearchConnectionSettings](#opensearchconnectionsettings)_ | | | Optional: {} <br /> |
33493468

33503469

33513470
#### VertexSettings

pages/plural-features/service-templating/supporting-liquid-filters.md

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1129,16 +1129,6 @@ _Parameters_:
11291129

11301130
_Implementation_: `path.IsAbs`
11311131

1132-
## `join`
1133-
1134-
1135-
1136-
1137-
1138-
1139-
1140-
_Implementation_: `github.com/Masterminds/sprig/v3.join`
1141-
11421132
## `kebabcase`
11431133
Converts a string from camelCase to kebab-case.
11441134

0 commit comments

Comments
 (0)