You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: pages/overview/management-api-reference.md
+125-6Lines changed: 125 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -41,6 +41,7 @@ Package v1alpha1 contains API Schema definitions for the deployments v1alpha1 AP
41
41
-[Provider](#provider)
42
42
-[ScmConnection](#scmconnection)
43
43
-[ServiceAccount](#serviceaccount)
44
+
-[ServiceContext](#servicecontext)
44
45
-[ServiceDeployment](#servicedeployment)
45
46
-[StackDefinition](#stackdefinition)
46
47
@@ -1220,6 +1221,7 @@ _Appears in:_
1220
1221
|`cascade`_[Cascade](#cascade)_| Cascade deletion options for this global service || Optional: {} <br /> |
1221
1222
|`context`_[TemplateContext](#templatecontext)_| Context to be used for dynamic template overrides of things like helm chart, version or values files || Optional: {} <br /> |
1222
1223
|`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 /> |
1223
1225
|`serviceRef`_[ObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#objectreference-v1-core)_| ServiceRef to replicate across clusters || Optional: {} <br /> |
1224
1226
|`providerRef`_[ObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#objectreference-v1-core)_| ProviderRef apply to clusters with this provider || Optional: {} <br /> |
1225
1227
|`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:_
1491
1493
| Field | Description | Default | Validation |
1492
1494
| --- | --- | --- | --- |
1493
1495
|`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 /> |
1495
1497
|`victoria`_[HTTPConnection](#httpconnection)_| Configures a connection to victoria metrics || Optional: {} <br /> |
1496
1498
|`elastic`_[ElasticsearchConnection](#elasticsearchconnection)_| Configures a connection to elasticsearch || Optional: {} <br /> |
1499
+
|`opensearch`_[OpensearchConnection](#opensearchconnection)_| Configures a connection to opensearch || Optional: {} <br /> |
1497
1500
1498
1501
1499
1502
#### MCPServer
@@ -2093,6 +2096,46 @@ _Appears in:_
2093
2096
|`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 /> |
|`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 /> |
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.
2732
2775
2733
2776
2734
2777
@@ -2757,7 +2800,7 @@ _Appears in:_
2757
2800
| --- | --- | --- | --- |
2758
2801
|`name`_string_| Name is a human-readable name of the ScmConnection. || Required: {} <br /> |
2759
2802
|`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 /> |
|`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 /> |
|`baseUrl`_string_| BaseUrl is a base URL for Git clones for self-hosted versions. || Optional: {} <br /> |
2763
2806
|`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.
2801
2844
|`spec`_[ServiceAccountSpec](#serviceaccountspec)_| Spec reflects a Console API service account spec. || Required: {} <br /> |
2802
2845
2803
2846
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
+
2804
2866
#### ServiceAccountSpec
2805
2867
2806
2868
@@ -2815,6 +2877,7 @@ _Appears in:_
2815
2877
| Field | Description | Default | Validation |
2816
2878
| --- | --- | --- | --- |
2817
2879
|`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 /> |
2818
2881
|`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 /> |
2819
2882
2820
2883
@@ -2841,6 +2904,42 @@ _Appears in:_
2841
2904
|`version`_string_||| Optional: {} <br /> |
2842
2905
2843
2906
2907
+
#### ServiceContext
2908
+
2909
+
2910
+
2911
+
ServiceContext is the Schema for the servicecontexts API
|`metadata`_[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#objectmeta-v1-meta)_| Refer to Kubernetes API documentation for fields of `metadata`. |||
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
+
2844
2943
#### ServiceDependency
2845
2944
2846
2945
@@ -2919,6 +3018,7 @@ _Appears in:_
2919
3018
|`git`_[GitRef](#gitref)_| A reference to a git folder/ref || Optional: {} <br /> |
2920
3019
|`ignoreHooks`_boolean_| whether you want to completely ignore any helm hooks when actualizing this service || Optional: {} <br /> |
2921
3020
|`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 /> |
|`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 /> |
3016
3116
|`git`_[GitRef](#gitref)_| Git settings to configure git for a service || Optional: {} <br /> |
3017
3117
|`helm`_[ServiceHelm](#servicehelm)_| Helm settings to configure helm for a service || Optional: {} <br /> |
3018
3118
|`kustomize`_[ServiceKustomize](#servicekustomize)_| Kustomize settings for service kustomization || Optional: {} <br /> |
@@ -3099,6 +3199,7 @@ _Appears in:_
3099
3199
|`version`_string_| Version the semver of the tool you wish to use || Optional: {} <br /> |
3100
3200
|`tag`_string_| Tag is the docker image tag you wish to use<br />if you're customizing the version || Optional: {} <br /> |
3101
3201
|`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 /> |
3102
3203
3103
3204
3104
3205
#### StackCron
@@ -3314,6 +3415,23 @@ _Appears in:_
3314
3415
|`raw`_[RawExtension](https://pkg.go.dev/k8s.io/apimachinery/pkg/runtime#RawExtension)_| A raw yaml map to use for service template context || Optional: {} <br /> |
3315
3416
3316
3417
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 /> |
0 commit comments