@bluedynamics/cdk8s-plone 0.1.40 → 0.1.41

package/.jsii

@@ -279,7 +279,7 @@
         },
         "locationInModule": {
           "filename": "src/plone.ts",
-          "line": 398
+          "line": 408
         },
         "parameters": [
           {
@@ -306,7 +306,7 @@
       "kind": "class",
       "locationInModule": {
         "filename": "src/plone.ts",
-        "line": 375
+        "line": 385
       },
       "name": "Plone",
       "properties": [
@@ -319,7 +319,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/plone.ts",
-            "line": 380
+            "line": 390
           },
           "name": "backendServiceName",
           "type": {
@@ -334,7 +334,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/plone.ts",
-            "line": 396
+            "line": 406
           },
           "name": "siteId",
           "type": {
@@ -349,7 +349,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/plone.ts",
-            "line": 391
+            "line": 401
           },
           "name": "variant",
           "type": {
@@ -365,7 +365,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/plone.ts",
-            "line": 386
+            "line": 396
           },
           "name": "frontendServiceName",
           "optional": true,
@@ -658,7 +658,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/plone.ts",
-            "line": 270
+            "line": 280
           },
           "name": "metricsPath",
           "optional": true,
@@ -677,7 +677,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/plone.ts",
-            "line": 263
+            "line": 273
           },
           "name": "metricsPort",
           "optional": true,
@@ -734,7 +734,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/plone.ts",
-            "line": 278
+            "line": 288
           },
           "name": "nodeSelector",
           "optional": true,
@@ -949,7 +949,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/plone.ts",
-            "line": 286
+            "line": 296
           },
           "name": "securityContext",
           "optional": true,
@@ -957,19 +957,40 @@
             "fqn": "@bluedynamics/cdk8s-plone.PloneSecurityContext"
           }
         },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "- construct-managed defaults only",
+            "example": "{ type: 'LoadBalancer', trafficDistribution: 'PreferClose' }",
+            "remarks": "Applies to this component's Service.",
+            "stability": "stable",
+            "summary": "Service configuration: type, trafficDistribution, sessionAffinity, annotations/labels, and a raw `overrides` escape hatch for any other ServiceSpec field."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/plone.ts",
+            "line": 258
+          },
+          "name": "service",
+          "optional": true,
+          "type": {
+            "fqn": "@bluedynamics/cdk8s-plone.PloneServiceSpec"
+          }
+        },
         {
           "abstract": true,
           "docs": {
             "default": "- no additional annotations",
+            "deprecated": "use `service.annotations` instead",
             "example": "{ 'external-dns.alpha.kubernetes.io/hostname': 'plone.example.com' }",
             "remarks": "Common for external-dns, load balancers, service mesh, etc.",
-            "stability": "stable",
+            "stability": "deprecated",
             "summary": "Annotations to add to the Service metadata."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/plone.ts",
-            "line": 248
+            "line": 249
           },
           "name": "serviceAnnotations",
           "optional": true,
@@ -993,7 +1014,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/plone.ts",
-            "line": 256
+            "line": 266
           },
           "name": "servicemonitor",
           "optional": true,
@@ -1450,7 +1471,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/plone.ts",
-        "line": 308
+        "line": 318
       },
       "name": "PloneOptions",
       "properties": [
@@ -1464,7 +1485,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/plone.ts",
-            "line": 333
+            "line": 343
           },
           "name": "backend",
           "optional": true,
@@ -1483,7 +1504,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/plone.ts",
-            "line": 340
+            "line": 350
           },
           "name": "frontend",
           "optional": true,
@@ -1503,7 +1524,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/plone.ts",
-            "line": 348
+            "line": 358
           },
           "name": "imagePullSecrets",
           "optional": true,
@@ -1527,7 +1548,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/plone.ts",
-            "line": 321
+            "line": 331
           },
           "name": "siteId",
           "optional": true,
@@ -1545,7 +1566,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/plone.ts",
-            "line": 327
+            "line": 337
           },
           "name": "variant",
           "optional": true,
@@ -1564,7 +1585,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/plone.ts",
-            "line": 314
+            "line": 324
           },
           "name": "version",
           "optional": true,
@@ -1721,6 +1742,243 @@
       ],
       "symbolId": "src/plone:PloneSecurityContext"
     },
+    "@bluedynamics/cdk8s-plone.PloneServiceSpec": {
+      "assembly": "@bluedynamics/cdk8s-plone",
+      "datatype": true,
+      "docs": {
+        "remarks": "Curated fields cover the common cases; use `overrides` as an escape hatch\nfor any other `ServiceSpec` field. `overrides` has the highest precedence and\ncan override every field, including the construct-managed `ports`/`selector`\n(at your own risk).",
+        "stability": "stable",
+        "summary": "Configuration for the generated Kubernetes Service spec."
+      },
+      "fqn": "@bluedynamics/cdk8s-plone.PloneServiceSpec",
+      "kind": "interface",
+      "locationInModule": {
+        "filename": "src/service.ts",
+        "line": 13
+      },
+      "name": "PloneServiceSpec",
+      "properties": [
+        {
+          "abstract": true,
+          "docs": {
+            "default": "- none",
+            "stability": "stable",
+            "summary": "Annotations to add to the Service metadata."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/service.ts",
+            "line": 66
+          },
+          "name": "annotations",
+          "optional": true,
+          "type": {
+            "collection": {
+              "elementtype": {
+                "primitive": "string"
+              },
+              "kind": "map"
+            }
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "- Cluster (Kubernetes default)",
+            "stability": "stable",
+            "summary": "External traffic policy, 'Cluster' | 'Local'."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/service.ts",
+            "line": 36
+          },
+          "name": "externalTrafficPolicy",
+          "optional": true,
+          "type": {
+            "primitive": "string"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "- Cluster (Kubernetes default)",
+            "stability": "stable",
+            "summary": "Internal traffic policy, 'Cluster' | 'Local'."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/service.ts",
+            "line": 42
+          },
+          "name": "internalTrafficPolicy",
+          "optional": true,
+          "type": {
+            "primitive": "string"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "- none",
+            "stability": "stable",
+            "summary": "Extra labels to add to the Service metadata."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/service.ts",
+            "line": 72
+          },
+          "name": "labels",
+          "optional": true,
+          "type": {
+            "collection": {
+              "elementtype": {
+                "primitive": "string"
+              },
+              "kind": "map"
+            }
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "- none",
+            "stability": "stable",
+            "summary": "Load balancer implementation class."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/service.ts",
+            "line": 54
+          },
+          "name": "loadBalancerClass",
+          "optional": true,
+          "type": {
+            "primitive": "string"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "- none",
+            "stability": "stable",
+            "summary": "Source IP ranges allowed to access a LoadBalancer service."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/service.ts",
+            "line": 60
+          },
+          "name": "loadBalancerSourceRanges",
+          "optional": true,
+          "type": {
+            "collection": {
+              "elementtype": {
+                "primitive": "string"
+              },
+              "kind": "array"
+            }
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "- none",
+            "stability": "stable",
+            "summary": "Raw ServiceSpec overrides as a free-form map (e.g. `{ ipFamilyPolicy: 'PreferDualStack' }`). Highest precedence — merged on top of all curated fields and the construct-managed base. Use for any ServiceSpec field not covered above. Keys and values are passed through to the Service spec verbatim and are not validated by this construct."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/service.ts",
+            "line": 82
+          },
+          "name": "overrides",
+          "optional": true,
+          "type": {
+            "collection": {
+              "elementtype": {
+                "primitive": "any"
+              },
+              "kind": "map"
+            }
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "- false",
+            "stability": "stable",
+            "summary": "Publish not-ready addresses (e.g. for headless services with StatefulSets)."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/service.ts",
+            "line": 48
+          },
+          "name": "publishNotReadyAddresses",
+          "optional": true,
+          "type": {
+            "primitive": "boolean"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "- None (Kubernetes default)",
+            "stability": "stable",
+            "summary": "Session affinity, 'ClientIP' | 'None'."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/service.ts",
+            "line": 30
+          },
+          "name": "sessionAffinity",
+          "optional": true,
+          "type": {
+            "primitive": "string"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "- none",
+            "stability": "stable",
+            "summary": "Traffic distribution preference, e.g. 'PreferClose' for topology-aware routing."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/service.ts",
+            "line": 24
+          },
+          "name": "trafficDistribution",
+          "optional": true,
+          "type": {
+            "primitive": "string"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "- ClusterIP (Kubernetes default)",
+            "stability": "stable",
+            "summary": "Service type, e.g. ClusterIP | NodePort | LoadBalancer | ExternalName."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/service.ts",
+            "line": 18
+          },
+          "name": "type",
+          "optional": true,
+          "type": {
+            "primitive": "string"
+          }
+        }
+      ],
+      "symbolId": "src/service:PloneServiceSpec"
+    },
     "@bluedynamics/cdk8s-plone.PloneVariant": {
       "assembly": "@bluedynamics/cdk8s-plone",
       "docs": {
@@ -1731,7 +1989,7 @@
       "kind": "enum",
       "locationInModule": {
         "filename": "src/plone.ts",
-        "line": 291
+        "line": 301
       },
       "members": [
         {
@@ -2852,6 +3110,6 @@
       "symbolId": "src/vinylcache:VinylCacheToleration"
     }
   },
-  "version": "0.1.40",
-  "fingerprint": "RD48uDt8wjb2dYP+IUClJ3iHIkNYZ/vLu2zMbysrhSo="
+  "version": "0.1.41",
+  "fingerprint": "9JNj9g1Gsl0Yh2odzC98CZU0Me9K8FN1awRs39FwVc0="
 }

package/API.md

@@ -727,6 +727,7 @@ const ploneBaseOptions: PloneBaseOptions = { ... }
 | <code><a href="#@bluedynamics/cdk8s-plone.PloneBaseOptions.property.requestCpu">requestCpu</a></code> | <code>string</code> | CPU request for the container. |
 | <code><a href="#@bluedynamics/cdk8s-plone.PloneBaseOptions.property.requestMemory">requestMemory</a></code> | <code>string</code> | Memory request for the container. |
 | <code><a href="#@bluedynamics/cdk8s-plone.PloneBaseOptions.property.securityContext">securityContext</a></code> | <code><a href="#@bluedynamics/cdk8s-plone.PloneSecurityContext">PloneSecurityContext</a></code> | Security context for the container. |
+| <code><a href="#@bluedynamics/cdk8s-plone.PloneBaseOptions.property.service">service</a></code> | <code><a href="#@bluedynamics/cdk8s-plone.PloneServiceSpec">PloneServiceSpec</a></code> | Service configuration: type, trafficDistribution, sessionAffinity, annotations/labels, and a raw `overrides` escape hatch for any other ServiceSpec field. |
 | <code><a href="#@bluedynamics/cdk8s-plone.PloneBaseOptions.property.serviceAnnotations">serviceAnnotations</a></code> | <code>{[ key: string ]: string}</code> | Annotations to add to the Service metadata. |
 | <code><a href="#@bluedynamics/cdk8s-plone.PloneBaseOptions.property.servicemonitor">servicemonitor</a></code> | <code>boolean</code> | Enable Prometheus ServiceMonitor for metrics collection. |
 
@@ -1182,7 +1183,31 @@ Use to set capabilities, run as non-root, read-only filesystem, etc.
 ```
 
 
-##### `serviceAnnotations`<sup>Optional</sup> <a name="serviceAnnotations" id="@bluedynamics/cdk8s-plone.PloneBaseOptions.property.serviceAnnotations"></a>
+##### `service`<sup>Optional</sup> <a name="service" id="@bluedynamics/cdk8s-plone.PloneBaseOptions.property.service"></a>
+
+```typescript
+public readonly service: PloneServiceSpec;
+```
+
+- *Type:* <a href="#@bluedynamics/cdk8s-plone.PloneServiceSpec">PloneServiceSpec</a>
+- *Default:* construct-managed defaults only
+
+Service configuration: type, trafficDistribution, sessionAffinity, annotations/labels, and a raw `overrides` escape hatch for any other ServiceSpec field.
+
+Applies to this component's Service.
+
+---
+
+*Example*
+
+```typescript
+{ type: 'LoadBalancer', trafficDistribution: 'PreferClose' }
+```
+
+
+##### ~~`serviceAnnotations`~~<sup>Optional</sup> <a name="serviceAnnotations" id="@bluedynamics/cdk8s-plone.PloneBaseOptions.property.serviceAnnotations"></a>
+
+- *Deprecated:* use `service.annotations` instead
 
 ```typescript
 public readonly serviceAnnotations: {[ key: string ]: string};
@@ -1761,6 +1786,184 @@ Run the container as a specific user ID.
 
 ---
 
+### PloneServiceSpec <a name="PloneServiceSpec" id="@bluedynamics/cdk8s-plone.PloneServiceSpec"></a>
+
+Configuration for the generated Kubernetes Service spec.
+
+Curated fields cover the common cases; use `overrides` as an escape hatch
+for any other `ServiceSpec` field. `overrides` has the highest precedence and
+can override every field, including the construct-managed `ports`/`selector`
+(at your own risk).
+
+#### Initializer <a name="Initializer" id="@bluedynamics/cdk8s-plone.PloneServiceSpec.Initializer"></a>
+
+```typescript
+import { PloneServiceSpec } from '@bluedynamics/cdk8s-plone'
+
+const ploneServiceSpec: PloneServiceSpec = { ... }
+```
+
+#### Properties <a name="Properties" id="Properties"></a>
+
+| **Name** | **Type** | **Description** |
+| --- | --- | --- |
+| <code><a href="#@bluedynamics/cdk8s-plone.PloneServiceSpec.property.annotations">annotations</a></code> | <code>{[ key: string ]: string}</code> | Annotations to add to the Service metadata. |
+| <code><a href="#@bluedynamics/cdk8s-plone.PloneServiceSpec.property.externalTrafficPolicy">externalTrafficPolicy</a></code> | <code>string</code> | External traffic policy, 'Cluster' \| 'Local'. |
+| <code><a href="#@bluedynamics/cdk8s-plone.PloneServiceSpec.property.internalTrafficPolicy">internalTrafficPolicy</a></code> | <code>string</code> | Internal traffic policy, 'Cluster' \| 'Local'. |
+| <code><a href="#@bluedynamics/cdk8s-plone.PloneServiceSpec.property.labels">labels</a></code> | <code>{[ key: string ]: string}</code> | Extra labels to add to the Service metadata. |
+| <code><a href="#@bluedynamics/cdk8s-plone.PloneServiceSpec.property.loadBalancerClass">loadBalancerClass</a></code> | <code>string</code> | Load balancer implementation class. |
+| <code><a href="#@bluedynamics/cdk8s-plone.PloneServiceSpec.property.loadBalancerSourceRanges">loadBalancerSourceRanges</a></code> | <code>string[]</code> | Source IP ranges allowed to access a LoadBalancer service. |
+| <code><a href="#@bluedynamics/cdk8s-plone.PloneServiceSpec.property.overrides">overrides</a></code> | <code>{[ key: string ]: any}</code> | Raw ServiceSpec overrides as a free-form map (e.g. `{ ipFamilyPolicy: 'PreferDualStack' }`). Highest precedence — merged on top of all curated fields and the construct-managed base. Use for any ServiceSpec field not covered above. Keys and values are passed through to the Service spec verbatim and are not validated by this construct. |
+| <code><a href="#@bluedynamics/cdk8s-plone.PloneServiceSpec.property.publishNotReadyAddresses">publishNotReadyAddresses</a></code> | <code>boolean</code> | Publish not-ready addresses (e.g. for headless services with StatefulSets). |
+| <code><a href="#@bluedynamics/cdk8s-plone.PloneServiceSpec.property.sessionAffinity">sessionAffinity</a></code> | <code>string</code> | Session affinity, 'ClientIP' \| 'None'. |
+| <code><a href="#@bluedynamics/cdk8s-plone.PloneServiceSpec.property.trafficDistribution">trafficDistribution</a></code> | <code>string</code> | Traffic distribution preference, e.g. 'PreferClose' for topology-aware routing. |
+| <code><a href="#@bluedynamics/cdk8s-plone.PloneServiceSpec.property.type">type</a></code> | <code>string</code> | Service type, e.g. ClusterIP \| NodePort \| LoadBalancer \| ExternalName. |
+
+---
+
+##### `annotations`<sup>Optional</sup> <a name="annotations" id="@bluedynamics/cdk8s-plone.PloneServiceSpec.property.annotations"></a>
+
+```typescript
+public readonly annotations: {[ key: string ]: string};
+```
+
+- *Type:* {[ key: string ]: string}
+- *Default:* none
+
+Annotations to add to the Service metadata.
+
+---
+
+##### `externalTrafficPolicy`<sup>Optional</sup> <a name="externalTrafficPolicy" id="@bluedynamics/cdk8s-plone.PloneServiceSpec.property.externalTrafficPolicy"></a>
+
+```typescript
+public readonly externalTrafficPolicy: string;
+```
+
+- *Type:* string
+- *Default:* Cluster (Kubernetes default)
+
+External traffic policy, 'Cluster' | 'Local'.
+
+---
+
+##### `internalTrafficPolicy`<sup>Optional</sup> <a name="internalTrafficPolicy" id="@bluedynamics/cdk8s-plone.PloneServiceSpec.property.internalTrafficPolicy"></a>
+
+```typescript
+public readonly internalTrafficPolicy: string;
+```
+
+- *Type:* string
+- *Default:* Cluster (Kubernetes default)
+
+Internal traffic policy, 'Cluster' | 'Local'.
+
+---
+
+##### `labels`<sup>Optional</sup> <a name="labels" id="@bluedynamics/cdk8s-plone.PloneServiceSpec.property.labels"></a>
+
+```typescript
+public readonly labels: {[ key: string ]: string};
+```
+
+- *Type:* {[ key: string ]: string}
+- *Default:* none
+
+Extra labels to add to the Service metadata.
+
+---
+
+##### `loadBalancerClass`<sup>Optional</sup> <a name="loadBalancerClass" id="@bluedynamics/cdk8s-plone.PloneServiceSpec.property.loadBalancerClass"></a>
+
+```typescript
+public readonly loadBalancerClass: string;
+```
+
+- *Type:* string
+- *Default:* none
+
+Load balancer implementation class.
+
+---
+
+##### `loadBalancerSourceRanges`<sup>Optional</sup> <a name="loadBalancerSourceRanges" id="@bluedynamics/cdk8s-plone.PloneServiceSpec.property.loadBalancerSourceRanges"></a>
+
+```typescript
+public readonly loadBalancerSourceRanges: string[];
+```
+
+- *Type:* string[]
+- *Default:* none
+
+Source IP ranges allowed to access a LoadBalancer service.
+
+---
+
+##### `overrides`<sup>Optional</sup> <a name="overrides" id="@bluedynamics/cdk8s-plone.PloneServiceSpec.property.overrides"></a>
+
+```typescript
+public readonly overrides: {[ key: string ]: any};
+```
+
+- *Type:* {[ key: string ]: any}
+- *Default:* none
+
+Raw ServiceSpec overrides as a free-form map (e.g. `{ ipFamilyPolicy: 'PreferDualStack' }`). Highest precedence — merged on top of all curated fields and the construct-managed base. Use for any ServiceSpec field not covered above. Keys and values are passed through to the Service spec verbatim and are not validated by this construct.
+
+---
+
+##### `publishNotReadyAddresses`<sup>Optional</sup> <a name="publishNotReadyAddresses" id="@bluedynamics/cdk8s-plone.PloneServiceSpec.property.publishNotReadyAddresses"></a>
+
+```typescript
+public readonly publishNotReadyAddresses: boolean;
+```
+
+- *Type:* boolean
+- *Default:* false
+
+Publish not-ready addresses (e.g. for headless services with StatefulSets).
+
+---
+
+##### `sessionAffinity`<sup>Optional</sup> <a name="sessionAffinity" id="@bluedynamics/cdk8s-plone.PloneServiceSpec.property.sessionAffinity"></a>
+
+```typescript
+public readonly sessionAffinity: string;
+```
+
+- *Type:* string
+- *Default:* None (Kubernetes default)
+
+Session affinity, 'ClientIP' | 'None'.
+
+---
+
+##### `trafficDistribution`<sup>Optional</sup> <a name="trafficDistribution" id="@bluedynamics/cdk8s-plone.PloneServiceSpec.property.trafficDistribution"></a>
+
+```typescript
+public readonly trafficDistribution: string;
+```
+
+- *Type:* string
+- *Default:* none
+
+Traffic distribution preference, e.g. 'PreferClose' for topology-aware routing.
+
+---
+
+##### `type`<sup>Optional</sup> <a name="type" id="@bluedynamics/cdk8s-plone.PloneServiceSpec.property.type"></a>
+
+```typescript
+public readonly type: string;
+```
+
+- *Type:* string
+- *Default:* ClusterIP (Kubernetes default)
+
+Service type, e.g. ClusterIP | NodePort | LoadBalancer | ExternalName.
+
+---
+
 ### PloneVinylCacheOptions <a name="PloneVinylCacheOptions" id="@bluedynamics/cdk8s-plone.PloneVinylCacheOptions"></a>
 
 Configuration options for PloneVinylCache (cloud-vinyl operator).