@bluedynamics/cdk8s-plone 0.1.40 → 0.1.42

package/API.md

@@ -12,8 +12,8 @@ This construct creates all necessary Kubernetes resources for running Plone:
 - Optional PodDisruptionBudget for high availability
 
 Supports two deployment variants:
-- VOLTO: Modern React frontend with REST API backend (default)
-- CLASSICUI: Traditional server-side rendered Plone
+- VOLTO: React single-page frontend talking to the REST API backend (default)
+- BLICCA: the Plone backend renders the UI server-side and serves HTML directly
 
 *Example*
 
@@ -150,7 +150,7 @@ Any object.
 | <code><a href="#@bluedynamics/cdk8s-plone.Plone.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
 | <code><a href="#@bluedynamics/cdk8s-plone.Plone.property.backendServiceName">backendServiceName</a></code> | <code>string</code> | Name of the backend Kubernetes service. |
 | <code><a href="#@bluedynamics/cdk8s-plone.Plone.property.siteId">siteId</a></code> | <code>string</code> | The Plone site ID in ZODB. |
-| <code><a href="#@bluedynamics/cdk8s-plone.Plone.property.variant">variant</a></code> | <code><a href="#@bluedynamics/cdk8s-plone.PloneVariant">PloneVariant</a></code> | The deployment variant being used (VOLTO or CLASSICUI). |
+| <code><a href="#@bluedynamics/cdk8s-plone.Plone.property.variant">variant</a></code> | <code><a href="#@bluedynamics/cdk8s-plone.PloneVariant">PloneVariant</a></code> | The deployment variant being used (VOLTO or BLICCA). |
 | <code><a href="#@bluedynamics/cdk8s-plone.Plone.property.frontendServiceName">frontendServiceName</a></code> | <code>string</code> | Name of the frontend Kubernetes service. |
 
 ---
@@ -201,7 +201,7 @@ public readonly variant: PloneVariant;
 
 - *Type:* <a href="#@bluedynamics/cdk8s-plone.PloneVariant">PloneVariant</a>
 
-The deployment variant being used (VOLTO or CLASSICUI).
+The deployment variant being used (VOLTO or BLICCA).
 
 ---
 
@@ -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).
@@ -2632,25 +2835,37 @@ Plone deployment variants.
 
 | **Name** | **Description** |
 | --- | --- |
-| <code><a href="#@bluedynamics/cdk8s-plone.PloneVariant.VOLTO">VOLTO</a></code> | Volto variant: ReactJS frontend (Volto) with REST API backend. |
-| <code><a href="#@bluedynamics/cdk8s-plone.PloneVariant.CLASSICUI">CLASSICUI</a></code> | Classic UI variant: Traditional Plone with server-side rendering. |
+| <code><a href="#@bluedynamics/cdk8s-plone.PloneVariant.VOLTO">VOLTO</a></code> | Volto variant: ReactJS single-page frontend (Volto) talking to the Plone REST API. |
+| <code><a href="#@bluedynamics/cdk8s-plone.PloneVariant.BLICCA">BLICCA</a></code> | Blicca variant: the Plone backend renders the UI server-side and serves the HTML directly. |
+| <code><a href="#@bluedynamics/cdk8s-plone.PloneVariant.CLASSICUI">CLASSICUI</a></code> | Deprecated alias for the Blicca variant (formerly "Classic UI"). |
 
 ---
 
 ##### `VOLTO` <a name="VOLTO" id="@bluedynamics/cdk8s-plone.PloneVariant.VOLTO"></a>
 
-Volto variant: ReactJS frontend (Volto) with REST API backend.
+Volto variant: ReactJS single-page frontend (Volto) talking to the Plone REST API.
 
 Deploys both frontend and backend services.
 
 ---
 
 
-##### `CLASSICUI` <a name="CLASSICUI" id="@bluedynamics/cdk8s-plone.PloneVariant.CLASSICUI"></a>
+##### `BLICCA` <a name="BLICCA" id="@bluedynamics/cdk8s-plone.PloneVariant.BLICCA"></a>
 
-Classic UI variant: Traditional Plone with server-side rendering.
+Blicca variant: the Plone backend renders the UI server-side and serves the HTML directly.
 
 Deploys only the backend service.
 
 ---
 
+
+##### ~~`CLASSICUI`~~ <a name="CLASSICUI" id="@bluedynamics/cdk8s-plone.PloneVariant.CLASSICUI"></a>
+
+- *Deprecated:* Renamed to {@link BLICCA }. Kept for backward compatibility and selects the
+same backend-only deployment. Existing configuration using `CLASSICUI` (or the literal
+value `'classicui'`) keeps working unchanged. Will be removed in a future major release.
+
+Deprecated alias for the Blicca variant (formerly "Classic UI").
+
+---
+

package/CLAUDE.md

@@ -4,7 +4,7 @@ This document provides context and guidelines for Claude Code when working on th
 
 ## Project Overview
 
-**cdk8s-plone** is a TypeScript/Python library for deploying Plone CMS to Kubernetes using CDK8S constructs. It provides type-safe infrastructure as code with support for Volto (React frontend) and Classic UI deployments.
+**cdk8s-plone** is a TypeScript/Python library for deploying Plone CMS to Kubernetes using CDK8S constructs. It provides type-safe infrastructure as code with support for Volto (React frontend) and Blicca (server-side rendered, formerly Classic UI) deployments.
 
 ## Git Workflow
 

package/README.md

@@ -11,7 +11,7 @@
 cdk8s-plone provides CDK8S constructs for deploying [Plone CMS](https://plone.org/) on Kubernetes. Define your infrastructure using TypeScript or Python and generate Kubernetes manifests automatically.
 
 **Key Features:**
-- 🚀 Supports Volto (modern React frontend) and Classic UI
+- 🚀 Supports Volto (React frontend) and Blicca (formerly Classic UI)
 - 📦 High availability with configurable replicas
 - ⚡ Optional Varnish HTTP caching via kube-httpcache (`PloneHttpcache`) or cloud-vinyl VinylCache operator (`PloneVinylCache`)
 - 🔧 Fine-grained resource and probe configuration
@@ -75,14 +75,14 @@ kubectl apply -f dist/
 
 Complete working examples are available in the [`examples/`](examples/) directory:
 
-- **[Production Volto](examples/production-volto/)** - Production-ready Plone 6 deployment with modern UI:
+- **[Production Volto](examples/production-volto/)** - Production-ready Plone 6 deployment with the React single-page frontend:
   - Volto frontend (React) + REST API backend
   - PostgreSQL with RelStorage (CloudNativePG or Bitnami)
   - Varnish HTTP caching with kube-httpcache
   - Ingress support (Traefik/Kong) with TLS
 
-- **[Classic UI](examples/classic-ui/)** - Traditional Plone deployment with server-side rendering:
-  - Classic UI (traditional Plone interface)
+- **[Blicca](examples/blicca/)** - Plone deployment with server-side rendering (formerly Classic UI):
+  - Blicca (backend renders the UI, no separate frontend)
   - PostgreSQL with RelStorage (CloudNativePG or Bitnami)
   - Varnish HTTP caching with kube-httpcache
   - Ingress support (Traefik/Kong) with TLS