@bluedynamics/cdk8s-plone 0.1.22 → 0.1.24

package/.jsii

@@ -7,7 +7,7 @@
     ]
   },
   "dependencies": {
-    "cdk8s": "^2.70.52",
+    "cdk8s": "^2.70.54",
     "cdk8s-plus-30": "^2.4.10",
     "constructs": "^10.4.2"
   },
@@ -96,7 +96,7 @@
     "stability": "stable"
   },
   "homepage": "https://github.com/bluedynamics/cdk8s-plone.git",
-  "jsiiVersion": "5.9.34 (build 8773a22)",
+  "jsiiVersion": "5.9.36 (build 27873df)",
   "license": "Apache-2.0",
   "metadata": {
     "jsii": {
@@ -108,7 +108,7 @@
   },
   "name": "@bluedynamics/cdk8s-plone",
   "readme": {
-    "markdown": "# CDK8S Plone\n\n> TypeScript and Python library for deploying Plone CMS to Kubernetes using CDK8S\n\n[![npm version](https://badge.fury.io/js/%40bluedynamics%2Fcdk8s-plone.svg)](https://www.npmjs.com/package/@bluedynamics/cdk8s-plone)\n[![PyPI version](https://badge.fury.io/py/cdk8s-plone.svg)](https://pypi.org/project/cdk8s-plone/)\n[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](LICENSE)\n\n## Overview\n\ncdk8s-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.\n\n**Key Features:**\n- 🚀 Supports Volto (modern React frontend) and Classic UI\n- 📦 High availability with configurable replicas\n- ⚡ Optional Varnish HTTP caching layer\n- 🔧 Fine-grained resource and probe configuration\n- 🌍 Multi-language support (TypeScript/JavaScript and Python)\n- ✅ Type-safe infrastructure as code\n\n## Quick Start\n\n### Installation\n\n**TypeScript/JavaScript:**\n```bash\nnpm install @bluedynamics/cdk8s-plone\n```\n\n**Python:**\n```bash\npip install cdk8s-plone\n```\n\n### Basic Example\n\n```typescript\nimport { App, Chart } from 'cdk8s';\nimport { Plone, PloneVariant } from '@bluedynamics/cdk8s-plone';\n\nconst app = new App();\nconst chart = new Chart(app, 'PloneDeployment');\n\nnew Plone(chart, 'my-plone', {\n  variant: PloneVariant.VOLTO,\n  backend: {\n    image: 'plone/plone-backend:6.1.3',\n    replicas: 3,\n  },\n  frontend: {\n    image: 'plone/plone-frontend:16.0.0',\n    replicas: 2,\n  },\n});\n\napp.synth();\n```\n\nGenerate Kubernetes manifests:\n```bash\ncdk8s synth\nkubectl apply -f dist/\n```\n\n## Documentation\n\n**📚 Full documentation:** https://bluedynamics.github.io/cdk8s-plone/\n\n- [Quick Start Tutorial](https://bluedynamics.github.io/cdk8s-plone/tutorials/01-quick-start.html)\n- [Configuration Reference](https://bluedynamics.github.io/cdk8s-plone/reference/configuration-options.html)\n- [Architecture Overview](https://bluedynamics.github.io/cdk8s-plone/explanation/architecture.html)\n- [Complete API Documentation](./API.md)\n\n## Examples\n\nComplete working examples are available in the [`examples/`](examples/) directory:\n\n- **[Production Volto](examples/production-volto/)** - Production-ready Plone 6 deployment with modern UI:\n  - Volto frontend (React) + REST API backend\n  - PostgreSQL with RelStorage (CloudNativePG or Bitnami)\n  - Varnish HTTP caching with kube-httpcache\n  - Ingress support (Traefik/Kong) with TLS\n\n- **[Classic UI](examples/classic-ui/)** - Traditional Plone deployment with server-side rendering:\n  - Classic UI (traditional Plone interface)\n  - PostgreSQL with RelStorage (CloudNativePG or Bitnami)\n  - Varnish HTTP caching with kube-httpcache\n  - Ingress support (Traefik/Kong) with TLS\n  - Simpler architecture (no separate frontend)\n\n### Prometheus Metrics\n\nEnable Prometheus ServiceMonitor for metrics collection (requires Prometheus Operator):\n\n```typescript\nnew Plone(chart, 'my-plone', {\n  backend: {\n    servicemonitor: true,\n    metricsPath: '/metrics',  // optional, defaults to '/metrics'\n  },\n  frontend: {\n    servicemonitor: true,\n    metricsPort: 9090,  // optional, defaults to service port\n  },\n});\n```\n\n**Note:** You must instrument your Plone backend/frontend to expose metrics at the configured endpoint. For Volto/Node.js frontends, consider using [prom-client](https://www.npmjs.com/package/prom-client) or [express-prometheus-middleware](https://www.npmjs.com/package/express-prometheus-middleware).\n\n## Requirements\n- **kubectl** - [Install kubectl](https://kubernetes.io/docs/tasks/tools/#kubectl)\n- **Node.js 16+** (for TypeScript/JavaScript) - [Install Node.js](https://nodejs.org/)\n- **Python 3.8+** (for Python) - [Install Python](https://www.python.org/)\n- **Kubernetes cluster** (local or cloud)\n\nFor detailed setup instructions, see [Setup Prerequisites](https://bluedynamics.github.io/cdk8s-plone/how-to/setup-prerequisites.html).\n\n## Development\n\nThis project uses [Projen](https://projen.io/) for project management.\n\n```bash\n# Install dependencies\nnpm install\n\n# Run tests\nnpm test\n\n# Build\nnpm run build\n\n# Update project configuration\n# Edit .projenrc.ts, then run:\nnpx projen\n```\n\nFor detailed development instructions, see [CONTRIBUTING.md](./CONTRIBUTING.md) (if available).\n\n## Resources\n\n- [CDK8S Documentation](https://cdk8s.io/)\n- [Plone CMS](https://plone.org/)\n- [kube-httpcache](https://github.com/mittwald/kube-httpcache) (for HTTP caching)\n- [CloudNativePG](https://cloudnative-pg.io/) (for PostgreSQL management)\n\n## License\n\n[Apache 2.0](LICENSE)\n\n## Maintainers\n\nMaintained by [Blue Dynamics Alliance](https://github.com/bluedynamics)\n\n**Author:** Jens W. Klein (jk@kleinundpartner.at)\n"
+    "markdown": "# CDK8S Plone\n\n> TypeScript and Python library for deploying Plone CMS to Kubernetes using CDK8S\n\n[![npm version](https://badge.fury.io/js/%40bluedynamics%2Fcdk8s-plone.svg)](https://www.npmjs.com/package/@bluedynamics/cdk8s-plone)\n[![PyPI version](https://badge.fury.io/py/cdk8s-plone.svg)](https://pypi.org/project/cdk8s-plone/)\n[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](LICENSE)\n\n## Overview\n\ncdk8s-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.\n\n**Key Features:**\n- 🚀 Supports Volto (modern React frontend) and Classic UI\n- 📦 High availability with configurable replicas\n- ⚡ Optional Varnish HTTP caching via kube-httpcache (`PloneHttpcache`) or cloud-vinyl VinylCache operator (`PloneVinylCache`)\n- 🔧 Fine-grained resource and probe configuration\n- 🌍 Multi-language support (TypeScript/JavaScript and Python)\n- ✅ Type-safe infrastructure as code\n\n## Quick Start\n\n### Installation\n\n**TypeScript/JavaScript:**\n```bash\nnpm install @bluedynamics/cdk8s-plone\n```\n\n**Python:**\n```bash\npip install cdk8s-plone\n```\n\n### Basic Example\n\n```typescript\nimport { App, Chart } from 'cdk8s';\nimport { Plone, PloneVariant } from '@bluedynamics/cdk8s-plone';\n\nconst app = new App();\nconst chart = new Chart(app, 'PloneDeployment');\n\nnew Plone(chart, 'my-plone', {\n  variant: PloneVariant.VOLTO,\n  backend: {\n    image: 'plone/plone-backend:6.1.3',\n    replicas: 3,\n  },\n  frontend: {\n    image: 'plone/plone-frontend:16.0.0',\n    replicas: 2,\n  },\n});\n\napp.synth();\n```\n\nGenerate Kubernetes manifests:\n```bash\ncdk8s synth\nkubectl apply -f dist/\n```\n\n## Documentation\n\n**📚 Full documentation:** https://bluedynamics.github.io/cdk8s-plone/\n\n- [Quick Start Tutorial](https://bluedynamics.github.io/cdk8s-plone/tutorials/01-quick-start.html)\n- [Configuration Reference](https://bluedynamics.github.io/cdk8s-plone/reference/configuration-options.html)\n- [Architecture Overview](https://bluedynamics.github.io/cdk8s-plone/explanation/architecture.html)\n- [Complete API Documentation](./API.md)\n\n## Examples\n\nComplete working examples are available in the [`examples/`](examples/) directory:\n\n- **[Production Volto](examples/production-volto/)** - Production-ready Plone 6 deployment with modern UI:\n  - Volto frontend (React) + REST API backend\n  - PostgreSQL with RelStorage (CloudNativePG or Bitnami)\n  - Varnish HTTP caching with kube-httpcache\n  - Ingress support (Traefik/Kong) with TLS\n\n- **[Classic UI](examples/classic-ui/)** - Traditional Plone deployment with server-side rendering:\n  - Classic UI (traditional Plone interface)\n  - PostgreSQL with RelStorage (CloudNativePG or Bitnami)\n  - Varnish HTTP caching with kube-httpcache\n  - Ingress support (Traefik/Kong) with TLS\n  - Simpler architecture (no separate frontend)\n\n### Prometheus Metrics\n\nEnable Prometheus ServiceMonitor for metrics collection (requires Prometheus Operator):\n\n```typescript\nnew Plone(chart, 'my-plone', {\n  backend: {\n    servicemonitor: true,\n    metricsPath: '/metrics',  // optional, defaults to '/metrics'\n  },\n  frontend: {\n    servicemonitor: true,\n    metricsPort: 9090,  // optional, defaults to service port\n  },\n});\n```\n\n**Note:** You must instrument your Plone backend/frontend to expose metrics at the configured endpoint. For Volto/Node.js frontends, consider using [prom-client](https://www.npmjs.com/package/prom-client) or [express-prometheus-middleware](https://www.npmjs.com/package/express-prometheus-middleware).\n\n## Requirements\n- **kubectl** - [Install kubectl](https://kubernetes.io/docs/tasks/tools/#kubectl)\n- **Node.js 16+** (for TypeScript/JavaScript) - [Install Node.js](https://nodejs.org/)\n- **Python 3.8+** (for Python) - [Install Python](https://www.python.org/)\n- **Kubernetes cluster** (local or cloud)\n\nFor detailed setup instructions, see [Setup Prerequisites](https://bluedynamics.github.io/cdk8s-plone/how-to/setup-prerequisites.html).\n\n## Development\n\nThis project uses [Projen](https://projen.io/) for project management.\n\n```bash\n# Install dependencies\nnpm install\n\n# Run tests\nnpm test\n\n# Build\nnpm run build\n\n# Update project configuration\n# Edit .projenrc.ts, then run:\nnpx projen\n```\n\nFor detailed development instructions, see [CONTRIBUTING.md](./CONTRIBUTING.md) (if available).\n\n## Resources\n\n- [CDK8S Documentation](https://cdk8s.io/)\n- [Plone CMS](https://plone.org/)\n- [kube-httpcache](https://github.com/mittwald/kube-httpcache) (for HTTP caching)\n- [CloudNativePG](https://cloudnative-pg.io/) (for PostgreSQL management)\n\n## License\n\n[Apache 2.0](LICENSE)\n\n## Maintainers\n\nMaintained by [Blue Dynamics Alliance](https://github.com/bluedynamics)\n\n**Author:** Jens W. Klein (jk@kleinundpartner.at)\n"
   },
   "repository": {
     "type": "git",
@@ -1498,8 +1498,420 @@
       ],
       "name": "PloneVariant",
       "symbolId": "src/plone:PloneVariant"
+    },
+    "@bluedynamics/cdk8s-plone.PloneVinylCache": {
+      "assembly": "@bluedynamics/cdk8s-plone",
+      "base": "constructs.Construct",
+      "docs": {
+        "example": "const plone = new Plone(chart, 'plone');\nconst cache = new PloneVinylCache(chart, 'cache', {\n  plone: plone,\n  replicas: 2,\n});\n// Use cache.vinylCacheServiceName for IngressRoute",
+        "remarks": "Creates a VinylCache custom resource with Plone backend/frontend services\nauto-configured as backends. The cloud-vinyl operator manages the full\nVarnish lifecycle including VCL generation, agent delivery, and monitoring.\n\nRequires the cloud-vinyl operator to be installed in the cluster.",
+        "stability": "stable",
+        "summary": "PloneVinylCache construct for deploying Varnish Cache via cloud-vinyl operator."
+      },
+      "fqn": "@bluedynamics/cdk8s-plone.PloneVinylCache",
+      "initializer": {
+        "docs": {
+          "stability": "stable"
+        },
+        "locationInModule": {
+          "filename": "src/vinylcache.ts",
+          "line": 155
+        },
+        "parameters": [
+          {
+            "name": "scope",
+            "type": {
+              "fqn": "constructs.Construct"
+            }
+          },
+          {
+            "name": "id",
+            "type": {
+              "primitive": "string"
+            }
+          },
+          {
+            "name": "options",
+            "type": {
+              "fqn": "@bluedynamics/cdk8s-plone.PloneVinylCacheOptions"
+            }
+          }
+        ]
+      },
+      "kind": "class",
+      "locationInModule": {
+        "filename": "src/vinylcache.ts",
+        "line": 148
+      },
+      "name": "PloneVinylCache",
+      "properties": [
+        {
+          "docs": {
+            "remarks": "Use this to reference the cache service from ingress or other constructs.",
+            "stability": "stable",
+            "summary": "Name of the VinylCache service created by the operator."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/vinylcache.ts",
+            "line": 153
+          },
+          "name": "vinylCacheServiceName",
+          "type": {
+            "primitive": "string"
+          }
+        }
+      ],
+      "symbolId": "src/vinylcache:PloneVinylCache"
+    },
+    "@bluedynamics/cdk8s-plone.PloneVinylCacheOptions": {
+      "assembly": "@bluedynamics/cdk8s-plone",
+      "datatype": true,
+      "docs": {
+        "remarks": "Creates a VinylCache custom resource that the cloud-vinyl operator\nreconciles into a Varnish Cache cluster with agent-based VCL delivery.\n\nRequires the cloud-vinyl operator to be installed in the cluster.",
+        "stability": "stable",
+        "summary": "Configuration options for PloneVinylCache (cloud-vinyl operator)."
+      },
+      "fqn": "@bluedynamics/cdk8s-plone.PloneVinylCacheOptions",
+      "kind": "interface",
+      "locationInModule": {
+        "filename": "src/vinylcache.ts",
+        "line": 49
+      },
+      "name": "PloneVinylCacheOptions",
+      "properties": [
+        {
+          "abstract": true,
+          "docs": {
+            "remarks": "Backends are auto-configured from the Plone services.",
+            "stability": "stable",
+            "summary": "The Plone construct to attach the cache to."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/vinylcache.ts",
+            "line": 54
+          },
+          "name": "plone",
+          "type": {
+            "fqn": "@bluedynamics/cdk8s-plone.Plone"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "'shard'",
+            "stability": "stable",
+            "summary": "Director type for load distribution."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/vinylcache.ts",
+            "line": 90
+          },
+          "name": "director",
+          "optional": true,
+          "type": {
+            "primitive": "string"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "'varnish:7.6'",
+            "stability": "stable",
+            "summary": "Container image for the Varnish pods."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/vinylcache.ts",
+            "line": 122
+          },
+          "name": "image",
+          "optional": true,
+          "type": {
+            "primitive": "string"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "true",
+            "stability": "stable",
+            "summary": "Enable cache invalidation (PURGE, BAN, xkey)."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/vinylcache.ts",
+            "line": 110
+          },
+          "name": "invalidation",
+          "optional": true,
+          "type": {
+            "primitive": "boolean"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "'500m'",
+            "stability": "stable",
+            "summary": "CPU limit for Varnish pods."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/vinylcache.ts",
+            "line": 78
+          },
+          "name": "limitCpu",
+          "optional": true,
+          "type": {
+            "primitive": "string"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "'512Mi'",
+            "stability": "stable",
+            "summary": "Memory limit for Varnish pods."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/vinylcache.ts",
+            "line": 84
+          },
+          "name": "limitMemory",
+          "optional": true,
+          "type": {
+            "primitive": "string"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "false",
+            "stability": "stable",
+            "summary": "Enable Prometheus monitoring (metrics + ServiceMonitor)."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/vinylcache.ts",
+            "line": 116
+          },
+          "name": "monitoring",
+          "optional": true,
+          "type": {
+            "primitive": "boolean"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "2",
+            "stability": "stable",
+            "summary": "Number of Varnish pod replicas."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/vinylcache.ts",
+            "line": 60
+          },
+          "name": "replicas",
+          "optional": true,
+          "type": {
+            "primitive": "number"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "'100m'",
+            "stability": "stable",
+            "summary": "CPU request for Varnish pods."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/vinylcache.ts",
+            "line": 66
+          },
+          "name": "requestCpu",
+          "optional": true,
+          "type": {
+            "primitive": "string"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "'256Mi'",
+            "stability": "stable",
+            "summary": "Memory request for Varnish pods."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/vinylcache.ts",
+            "line": 72
+          },
+          "name": "requestMemory",
+          "optional": true,
+          "type": {
+            "primitive": "string"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "- no tolerations",
+            "stability": "stable",
+            "summary": "Tolerations for the Varnish pods."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/vinylcache.ts",
+            "line": 128
+          },
+          "name": "tolerations",
+          "optional": true,
+          "type": {
+            "collection": {
+              "elementtype": {
+                "fqn": "@bluedynamics/cdk8s-plone.VinylCacheToleration"
+              },
+              "kind": "array"
+            }
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "- uses built-in plone-vinyl-backend-response.vcl",
+            "remarks": "Replaces the default Plone backend_response snippet.",
+            "stability": "stable",
+            "summary": "Custom VCL snippet for vcl_backend_response subroutine."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/vinylcache.ts",
+            "line": 104
+          },
+          "name": "vclBackendResponseSnippet",
+          "optional": true,
+          "type": {
+            "primitive": "string"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "- uses built-in plone-vinyl-recv.vcl",
+            "remarks": "Replaces the default Plone recv snippet.",
+            "stability": "stable",
+            "summary": "Custom VCL snippet for vcl_recv subroutine."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/vinylcache.ts",
+            "line": 97
+          },
+          "name": "vclRecvSnippet",
+          "optional": true,
+          "type": {
+            "primitive": "string"
+          }
+        }
+      ],
+      "symbolId": "src/vinylcache:PloneVinylCacheOptions"
+    },
+    "@bluedynamics/cdk8s-plone.VinylCacheToleration": {
+      "assembly": "@bluedynamics/cdk8s-plone",
+      "datatype": true,
+      "docs": {
+        "stability": "stable",
+        "summary": "A Kubernetes toleration for the Varnish pods."
+      },
+      "fqn": "@bluedynamics/cdk8s-plone.VinylCacheToleration",
+      "kind": "interface",
+      "locationInModule": {
+        "filename": "src/vinylcache.ts",
+        "line": 16
+      },
+      "name": "VinylCacheToleration",
+      "properties": [
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "stable",
+            "summary": "The taint key to tolerate."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/vinylcache.ts",
+            "line": 20
+          },
+          "name": "key",
+          "type": {
+            "primitive": "string"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "- tolerate all effects",
+            "stability": "stable",
+            "summary": "The taint effect to tolerate (NoSchedule, PreferNoSchedule, NoExecute)."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/vinylcache.ts",
+            "line": 38
+          },
+          "name": "effect",
+          "optional": true,
+          "type": {
+            "primitive": "string"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "'Equal'",
+            "stability": "stable",
+            "summary": "The operator (Equal or Exists)."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/vinylcache.ts",
+            "line": 26
+          },
+          "name": "operator",
+          "optional": true,
+          "type": {
+            "primitive": "string"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "- no value",
+            "stability": "stable",
+            "summary": "The taint value to match (when operator is Equal)."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/vinylcache.ts",
+            "line": 32
+          },
+          "name": "value",
+          "optional": true,
+          "type": {
+            "primitive": "string"
+          }
+        }
+      ],
+      "symbolId": "src/vinylcache:VinylCacheToleration"
     }
   },
-  "version": "0.1.22",
-  "fingerprint": "MErr+3NOqQxwjiF62c8NEwWic9mEdSBxie66Wca7B38="
+  "version": "0.1.24",
+  "fingerprint": "WV/clfbQeNyN9Tq2EqLMkoN9eeJd5aGpgXE8qocssAg="
 }