Skip to content

Commit 0fc397e

Browse files
sync docs (#460)
Co-authored-by: michaeljguarino <michaeljguarino@users.noreply.github.com>
1 parent c5b5f49 commit 0fc397e

1 file changed

Lines changed: 240 additions & 7 deletions

File tree

pages/overview/management-api-reference.md

Lines changed: 240 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@ Package v1alpha1 contains API Schema definitions for the deployments v1alpha1 AP
1414
- [Cluster](#cluster)
1515
- [ClusterRestore](#clusterrestore)
1616
- [ClusterRestoreTrigger](#clusterrestoretrigger)
17+
- [ClusterSync](#clustersync)
18+
- [ComplianceReportGenerator](#compliancereportgenerator)
1719
- [CustomStackRun](#customstackrun)
1820
- [DeploymentSettings](#deploymentsettings)
1921
- [Flow](#flow)
@@ -34,6 +36,7 @@ Package v1alpha1 contains API Schema definitions for the deployments v1alpha1 AP
3436
- [PipelineContext](#pipelinecontext)
3537
- [PrAutomation](#prautomation)
3638
- [PrAutomationTrigger](#prautomationtrigger)
39+
- [PreviewEnvironmentTemplate](#previewenvironmenttemplate)
3740
- [Project](#project)
3841
- [Provider](#provider)
3942
- [ScmConnection](#scmconnection)
@@ -143,6 +146,7 @@ Binding ...
143146
_Appears in:_
144147
- [Bindings](#bindings)
145148
- [CatalogBindings](#catalogbindings)
149+
- [ComplianceReportGeneratorSpec](#compliancereportgeneratorspec)
146150
- [DeploymentSettingsBindings](#deploymentsettingsbindings)
147151
- [NotificationSinkSpec](#notificationsinkspec)
148152
- [PrAutomationBindings](#prautomationbindings)
@@ -170,6 +174,7 @@ _Appears in:_
170174
- [ClusterSpec](#clusterspec)
171175
- [FlowSpec](#flowspec)
172176
- [InfrastructureStackSpec](#infrastructurestackspec)
177+
- [MCPServerSpec](#mcpserverspec)
173178
- [PipelineSpec](#pipelinespec)
174179
- [ProjectSpec](#projectspec)
175180
- [ServiceSpec](#servicespec)
@@ -180,6 +185,23 @@ _Appears in:_
180185
| `write` _[Binding](#binding) array_ | Write bindings. | | Optional: {} <br /> |
181186

182187

188+
#### BindingsTemplate
189+
190+
191+
192+
193+
194+
195+
196+
_Appears in:_
197+
- [SpecTemplate](#spectemplate)
198+
199+
| Field | Description | Default | Validation |
200+
| --- | --- | --- | --- |
201+
| `read` _string_ | Read bindings. | | Optional: {} <br /> |
202+
| `write` _string_ | Write bindings. | | Optional: {} <br /> |
203+
204+
183205
#### BootstrapToken
184206

185207

@@ -569,6 +591,59 @@ _Appears in:_
569591
| `nodePools` _[ClusterNodePool](#clusternodepool) array_ | NodePools contains specs of node pools managed by this cluster. | | Optional: {} <br /> |
570592

571593

594+
#### ClusterSpecTemplate
595+
596+
597+
598+
599+
600+
601+
602+
_Appears in:_
603+
- [ClusterSyncSpec](#clustersyncspec)
604+
605+
| Field | Description | Default | Validation |
606+
| --- | --- | --- | --- |
607+
| `metadata` _[MetadataTemplate](#metadatatemplate)_ | Refer to Kubernetes API documentation for fields of `metadata`. | | |
608+
| `spec` _[SpecTemplate](#spectemplate)_ | | | |
609+
610+
611+
612+
613+
#### ClusterSync
614+
615+
616+
617+
ClusterSync is the Schema for the clustersyncs API
618+
619+
620+
621+
622+
623+
| Field | Description | Default | Validation |
624+
| --- | --- | --- | --- |
625+
| `apiVersion` _string_ | `deployments.plural.sh/v1alpha1` | | |
626+
| `kind` _string_ | `ClusterSync` | | |
627+
| `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. | | |
628+
| `spec` _[ClusterSyncSpec](#clustersyncspec)_ | | | |
629+
630+
631+
#### ClusterSyncSpec
632+
633+
634+
635+
ClusterSyncSpec defines the desired state of ClusterSync
636+
637+
638+
639+
_Appears in:_
640+
- [ClusterSync](#clustersync)
641+
642+
| Field | Description | Default | Validation |
643+
| --- | --- | --- | --- |
644+
| `projectRef` _[ObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#objectreference-v1-core)_ | | | Optional: {} <br /> |
645+
| `tags` _object (keys:string, values:string)_ | | | Optional: {} <br /> |
646+
| `clusterSpec` _[ClusterSpecTemplate](#clusterspectemplate)_ | | | |
572647

573648

574649
#### ClusterTarget
@@ -606,6 +681,42 @@ _Appears in:_
606681
| `dir` _string_ | | | Optional: {} <br /> |
607682

608683

684+
#### ComplianceReportGenerator
685+
686+
687+
688+
689+
690+
691+
692+
693+
694+
| Field | Description | Default | Validation |
695+
| --- | --- | --- | --- |
696+
| `apiVersion` _string_ | `deployments.plural.sh/v1alpha1` | | |
697+
| `kind` _string_ | `ComplianceReportGenerator` | | |
698+
| `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. | | |
699+
| `spec` _[ComplianceReportGeneratorSpec](#compliancereportgeneratorspec)_ | | | |
700+
701+
702+
#### ComplianceReportGeneratorSpec
703+
704+
705+
706+
ComplianceReportGeneratorSpec defines the desired state of the resource.
707+
708+
709+
710+
_Appears in:_
711+
- [ComplianceReportGenerator](#compliancereportgenerator)
712+
713+
| Field | Description | Default | Validation |
714+
| --- | --- | --- | --- |
715+
| `name` _string_ | Name, if not provided name from object meta will be used. | | Optional: {} <br /> |
716+
| `format` _[ComplianceReportFormat](#compliancereportformat)_ | Format of the report to be generated. | | Enum: [CSV JSON] <br />Required: {} <br /> |
717+
| `readBindings` _[Binding](#binding) array_ | ReadBindings represent the download policy for this report. | | Optional: {} <br /> |
718+
719+
609720
#### ComponentState
610721

611722
_Underlying type:_ _string_
@@ -922,11 +1033,11 @@ _Appears in:_
9221033
| Field | Description | Default | Validation |
9231034
| --- | --- | --- | --- |
9241035
| `name` _string_ | Name of this Flow. If not provided Flow's own name from Flow.ObjectMeta will be used. | | Optional: {} <br /> |
925-
| `description` _string_ | | | Optional: {} <br /> |
926-
| `icon` _string_ | | | Optional: {} <br /> |
1036+
| `description` _string_ | Longform description of the service managed by this flow | | Optional: {} <br /> |
1037+
| `icon` _string_ | Optional image icon for the flow to apply branding or improve identification | | Optional: {} <br /> |
9271038
| `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 /> |
928-
| `bindings` _[Bindings](#bindings)_ | Bindings contain read and write policies of this cluster | | Optional: {} <br /> |
929-
| `serverAssociations` _[FlowServerAssociation](#flowserverassociation) array_ | | | Optional: {} <br /> |
1039+
| `bindings` _[Bindings](#bindings)_ | Bindings contain read and write policies of this Flow | | Optional: {} <br /> |
1040+
| `serverAssociations` _[FlowServerAssociation](#flowserverassociation) array_ | ServerAssociations contains a list of MCP services you wish to associate with this flow. Can also be managed within the Plural Console UI securely. | | Optional: {} <br /> |
9301041

9311042

9321043
#### GateSpec
@@ -1107,6 +1218,7 @@ _Appears in:_
11071218
| `tags` _object (keys:string, values:string)_ | Tags a set of tags to select clusters for this global service | | Optional: {} <br /> |
11081219
| `reparent` _boolean_ | Whether you'd want this global service to take ownership of existing Plural services | | Optional: {} <br /> |
11091220
| `cascade` _[Cascade](#cascade)_ | Cascade deletion options for this global service | | Optional: {} <br /> |
1221+
| `context` _[TemplateContext](#templatecontext)_ | Context to be used for dynamic template overrides of things like helm chart, version or values files | | Optional: {} <br /> |
11101222
| `distro` _[ClusterDistro](#clusterdistro)_ | Distro of kubernetes this cluster is running | | Enum: [GENERIC EKS AKS GKE RKE K3S] <br />Optional: {} <br /> |
11111223
| `serviceRef` _[ObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#objectreference-v1-core)_ | ServiceRef to replicate across clusters | | Optional: {} <br /> |
11121224
| `providerRef` _[ObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#objectreference-v1-core)_ | ProviderRef apply to clusters with this provider | | Optional: {} <br /> |
@@ -1434,6 +1546,7 @@ _Appears in:_
14341546
| --- | --- | --- | --- |
14351547
| `name` _string_ | Name, if not provided name from object meta will be used. | | Optional: {} <br /> |
14361548
| `url` _string_ | URL is the HTTP URL the server is hosted on. | | Required: {} <br /> |
1549+
| `bindings` _[Bindings](#bindings)_ | Bindings contain read and write policies of this MCP server | | Optional: {} <br /> |
14371550
| `authentication` _[MCPServerAuthentication](#mcpserverauthentication)_ | Authentication specs for this server. | | Optional: {} <br /> |
14381551
| `confirm` _boolean_ | Confirm whether a tool call against this server should require user confirmation. | | Optional: {} <br /> |
14391552

@@ -1480,6 +1593,24 @@ _Appears in:_
14801593
| `projectRef` _[ObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#objectreference-v1-core)_ | ProjectRef allows a managed namespace to span a specific project only | | Optional: {} <br /> |
14811594

14821595

1596+
#### MetadataTemplate
1597+
1598+
1599+
1600+
1601+
1602+
1603+
1604+
_Appears in:_
1605+
- [ClusterSpecTemplate](#clusterspectemplate)
1606+
- [ObjectReferenceTemplate](#objectreferencetemplate)
1607+
1608+
| Field | Description | Default | Validation |
1609+
| --- | --- | --- | --- |
1610+
| `name` _string_ | | | |
1611+
| `namespace` _string_ | Namespace specifies an optional namespace for categorizing or scoping related resources.<br />If empty then the ClusterSync's namespace will be used. | | Optional: {} <br /> |
1612+
1613+
14831614
#### NamespaceCredentials
14841615

14851616

@@ -1650,6 +1781,23 @@ _Appears in:_
16501781
| `credentialsSecretRef` _[LocalObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#localobjectreference-v1-core)_ | CredentialsSecretRef is a local reference to the secret that contains OIDC provider credentials.<br />It will be created once OIDCProvider is created in the Console API.<br /><br />Secret will contain 2 keys:<br />- 'clientId'<br />- 'clientSecret' | | Required: {} <br /> |
16511782

16521783

1784+
#### ObjectReferenceTemplate
1785+
1786+
1787+
1788+
1789+
1790+
1791+
1792+
_Appears in:_
1793+
- [SpecTemplate](#spectemplate)
1794+
1795+
| Field | Description | Default | Validation |
1796+
| --- | --- | --- | --- |
1797+
| `name` _string_ | | | |
1798+
| `namespace` _string_ | Namespace specifies an optional namespace for categorizing or scoping related resources.<br />If empty then the ClusterSync's namespace will be used. | | Optional: {} <br /> |
1799+
1800+
16531801
#### ObservabilityProvider
16541802

16551803

@@ -1771,7 +1919,8 @@ _Appears in:_
17711919
| Field | Description | Default | Validation |
17721920
| --- | --- | --- | --- |
17731921
| `name` _string_ | The name of the add-on you want to poll | | |
1774-
| `kubernetesVersion` _string_ | The Kubernetes Version you want to ensure this add-on is compatible with | | Optional: {} <br /> |
1922+
| `kubernetesVersion` _string_ | The Kubernetes version you want to ensure this add-on is compatible with | | Optional: {} <br /> |
1923+
| `kubernetesVersions` _string array_ | The Kubernetes versions you want to ensure this add-on is compatible with, useful if working with a kubernetes version boundary during upgrade | | Optional: {} <br /> |
17751924

17761925

17771926
#### ObserverConfiguration
@@ -2289,7 +2438,7 @@ _Appears in:_
22892438

22902439
| Field | Description | Default | Validation |
22912440
| --- | --- | --- | --- |
2292-
| `role` _[PrRole](#prrole)_ | | | Enum: [CLUSTER SERVICE PIPELINE UPDATE UPGRADE] <br />Optional: {} <br /> |
2441+
| `role` _[PrRole](#prrole)_ | | | Enum: [CLUSTER SERVICE PIPELINE UPDATE UPGRADE COST] <br />Optional: {} <br /> |
22932442
| `addon` _string_ | Addon is a link to an addon name | | Optional: {} <br /> |
22942443
| `branch` _string_ | The base branch this pr will be based on (defaults to the repo's main branch) | | Optional: {} <br /> |
22952444
| `icon` _string_ | An icon url to annotate this pr automation | | Optional: {} <br /> |
@@ -2423,6 +2572,45 @@ _Appears in:_
24232572
| `label` _string_ | The label of this checkbox | | |
24242573

24252574

2575+
#### PreviewEnvironmentTemplate
2576+
2577+
2578+
2579+
PreviewEnvironmentTemplate is the Schema for the previewenvironmenttemplates API
2580+
2581+
2582+
2583+
2584+
2585+
| Field | Description | Default | Validation |
2586+
| --- | --- | --- | --- |
2587+
| `apiVersion` _string_ | `deployments.plural.sh/v1alpha1` | | |
2588+
| `kind` _string_ | `PreviewEnvironmentTemplate` | | |
2589+
| `metadata` _[ObjectMeta](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#objectmeta-v1-meta)_ | Refer to Kubernetes API documentation for fields of `metadata`. | | |
2590+
| `spec` _[PreviewEnvironmentTemplateSpec](#previewenvironmenttemplatespec)_ | | | |
2591+
2592+
2593+
#### PreviewEnvironmentTemplateSpec
2594+
2595+
2596+
2597+
PreviewEnvironmentTemplateSpec defines the desired state of PreviewEnvironmentTemplate
2598+
2599+
2600+
2601+
_Appears in:_
2602+
- [PreviewEnvironmentTemplate](#previewenvironmenttemplate)
2603+
2604+
| Field | Description | Default | Validation |
2605+
| --- | --- | --- | --- |
2606+
| `name` _string_ | Name, if not provided name from object meta will be used. | | Optional: {} <br /> |
2607+
| `commentTemplate` _string_ | CommentTemplate liquid template for custom information. | | Optional: {} <br /> |
2608+
| `scmConnectionRef` _[ObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#objectreference-v1-core)_ | ScmConnectionRef the SCM connection. | | Optional: {} <br /> |
2609+
| `referenceServiceRef` _[ObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#objectreference-v1-core)_ | ReferenceServiceRef specifies a reference to a Service Deployment object associated with the environment template. | | Required: {} <br /> |
2610+
| `flowRef` _[ObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#objectreference-v1-core)_ | reference to a Flow this pipeline belongs within | | Required: {} <br /> |
2611+
| `template` _[ServiceTemplate](#servicetemplate)_ | Template set of service configuration overrides to use while cloning | | Required: {} <br /> |
2612+
2613+
24262614
#### Project
24272615

24282616

@@ -2730,6 +2918,7 @@ _Appears in:_
27302918
| `repository` _[NamespacedName](#namespacedname)_ | pointer to the FluxCD helm repository to use | | Optional: {} <br /> |
27312919
| `git` _[GitRef](#gitref)_ | A reference to a git folder/ref | | Optional: {} <br /> |
27322920
| `ignoreHooks` _boolean_ | whether you want to completely ignore any helm hooks when actualizing this service | | Optional: {} <br /> |
2921+
| `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 /> |
27332922

27342923

27352924
#### ServiceImport
@@ -2762,7 +2951,8 @@ _Appears in:_
27622951

27632952
| Field | Description | Default | Validation |
27642953
| --- | --- | --- | --- |
2765-
| `path` _string_ | | | |
2954+
| `path` _string_ | The path to the kustomization file to use | | |
2955+
| `enableHelm` _boolean_ | whether to enable helm for this kustomize deployment, used for inflating helm charts | | Optional: {} <br /> |
27662956

27672957

27682958
#### ServiceSpec
@@ -2813,6 +3003,7 @@ Attributes for configuring a service in something like a managed namespace
28133003
_Appears in:_
28143004
- [GlobalServiceSpec](#globalservicespec)
28153005
- [ManagedNamespaceSpec](#managednamespacespec)
3006+
- [PreviewEnvironmentTemplateSpec](#previewenvironmenttemplatespec)
28163007

28173008
| Field | Description | Default | Validation |
28183009
| --- | --- | --- | --- |
@@ -2828,6 +3019,7 @@ _Appears in:_
28283019
| `syncConfig` _[SyncConfigAttributes](#syncconfigattributes)_ | SyncConfig attributes to configure sync settings for this service | | Optional: {} <br /> |
28293020
| `dependencies` _[ObjectReference](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.29/#objectreference-v1-core) array_ | Dependencies contain dependent services | | Optional: {} <br /> |
28303021
| `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 /> |
3022+
| `configuration` _object (keys:string, values:string)_ | Configuration is a set of non-secret service specific configuration useful for templating | | Optional: {} <br /> |
28313023

28323024

28333025
#### SinkConfiguration
@@ -2864,6 +3056,31 @@ _Appears in:_
28643056
| `url` _string_ | | | |
28653057

28663058

3059+
#### SpecTemplate
3060+
3061+
3062+
3063+
3064+
3065+
3066+
3067+
_Appears in:_
3068+
- [ClusterSpecTemplate](#clusterspectemplate)
3069+
3070+
| Field | Description | Default | Validation |
3071+
| --- | --- | --- | --- |
3072+
| `handle` _string_ | Handle is a short, unique human-readable name used to identify this cluster.<br />Does not necessarily map to the cloud resource name.<br />This has to be specified in order to adopt existing cluster. | | Optional: {} <br />Type: string <br /> |
3073+
| `version` _string_ | Version of Kubernetes to use for this cluster. Can be skipped only for BYOK. | | Optional: {} <br />Type: string <br /> |
3074+
| `providerRef` _[ObjectReferenceTemplate](#objectreferencetemplate)_ | ProviderRef references provider to use for this cluster. Can be skipped only for BYOK. | | Optional: {} <br /> |
3075+
| `projectRef` _[ObjectReferenceTemplate](#objectreferencetemplate)_ | ProjectRef references project this cluster belongs to.<br />If not provided, it will use the default project. | | Optional: {} <br /> |
3076+
| `cloud` _string_ | Cloud provider to use for this cluster. | | Optional: {} <br />Type: string <br /> |
3077+
| `protect` _string_ | Protect cluster from being deleted. | | Optional: {} <br /> |
3078+
| `tags` _string_ | Tags used to filter clusters. | | Optional: {} <br /> |
3079+
| `metadata` _string_ | Refer to Kubernetes API documentation for fields of `metadata`. | | Optional: {} <br /> |
3080+
| `bindings` _[BindingsTemplate](#bindingstemplate)_ | Bindings contain read and write policies of this cluster | | Optional: {} <br /> |
3081+
| `nodePools` _string_ | NodePools contains specs of node pools managed by this cluster. | | Optional: {} <br /> |
3082+
3083+
28673084
#### StackConfiguration
28683085

28693086

@@ -3081,6 +3298,22 @@ _Appears in:_
30813298

30823299

30833300

3301+
#### TemplateContext
3302+
3303+
3304+
3305+
TemplateContext is a spec for describing data for templating the metadata of the services spawned by a global service
3306+
3307+
3308+
3309+
_Appears in:_
3310+
- [GlobalServiceSpec](#globalservicespec)
3311+
3312+
| Field | Description | Default | Validation |
3313+
| --- | --- | --- | --- |
3314+
| `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+
3316+
30843317
#### Tools
30853318

30863319

0 commit comments

Comments
 (0)