@bluedynamics/cdk8s-plone 0.0.81 → 0.1.0

package/.jsii

@@ -7,8 +7,8 @@
     ]
   },
   "dependencies": {
-    "cdk8s": "^2.70.2",
-    "cdk8s-plus-30": "^2.4.8",
+    "cdk8s": "^2.70.20",
+    "cdk8s-plus-30": "^2.4.10",
     "constructs": "^10.0.3"
   },
   "dependencyClosure": {
@@ -96,7 +96,7 @@
     "stability": "stable"
   },
   "homepage": "https://github.com/bluedynamics/cdk8s-plone.git",
-  "jsiiVersion": "5.8.16 (build 1632665)",
+  "jsiiVersion": "5.8.21 (build 0b7c0ba)",
   "license": "Apache-2.0",
   "metadata": {
     "jsii": {
@@ -108,7 +108,7 @@
   },
   "name": "@bluedynamics/cdk8s-plone",
   "readme": {
-    "markdown": "# CMS Plone Chart for CDK8S\n\nThis chart provides a library to bootstrap a Plone deployment on a Kubernetes cluster using the [CDK8S](https://cdk8s.io) framework.\n\nIt provides\n- Backend (as API with `plone.volto` or as Classic-UI)\n- Frontend (Plone-Volto, a ReactJS based user interface)\n- Varnish using kube-httpcache. It includes a way to invalidate varnish cluster (optional)\n\n\n### Typescript\n\nTo use this library, create a new CDK8S project (or use an existing one)\n\n```bash\ncdk8s init typescript-app\n```\n\nThen add the following dependency to `package.json`:\n\n```json\n{\n  \"dependencies\": {\n    \"@bluedynamics/cdk8s-plone\": \"*\"\n  }\n}\n```\nRun `npm install` to install [cdk8s-plone](https://www.npmjs.com/package/@bluedynamics/cdk8s-plone).\n\n### Python\n\nTodo: Document in details how to install.\n\n```bash\ncdk8s init python-app\n```\n\nPython package name is [cdk8s-plone](https://pypi.org/project/cdk8s-plone/).\n\n\n## Usage\n\nWith `cdk8s-cli` installed, create a new project:\n\n```bash\ncdk8s sythn\n```\n\nAdd the following code to your `main.ts`:\n\n```typescript\n...\nimport { Plone } from '@bluedynamics/cdk8s-plone';\n...\n    super(scope, id, props);\n\n    // define resources here\n    new Plone(this, 'Plone', {});\n...\n```\n\nRun `npm run build ` to generate the Kubernetes manifests.\nThe manifests are stored in the `dist` directory.\n\nFor more have a look at the [example project](https://github.com/bluedynamics/cdk8s-plone-example).\n\n### Prerequisites\n\nFor using cdk8s-plone, we assume you already have following tools installed:\n\n* kubectl – A command-line tool for interacting with Kubernetes clusters. For deploying the Kubernetes manifest you will need a tool like this. Take a look at the [Install Tools](https://kubernetes.io/docs/tasks/tools/#kubectl) for kubectl.\n\n* (optional) Helm – A Kubernetes package manager for managing Plone/Volto deployments. This tool is optional and only needed if you generate helm charts as output with cdk8s synth - instead of pure manifests. There are several ways to install it see the [install section](https://helm.sh/docs/intro/install/) for Helm.\n\n\n### References\n[Kubernetes Documentation](https://kubernetes.io/docs/concepts/configuration/liveness-readiness-startup-probes/) relevant for ressource management, readiness and liveness\n\n#### PloneBaseOptions\n*Interface*\n\n\n\n- `image`(string):\n  - The used Plone image\n  - e.g. `plone/plone-backend:6.1.0`\n- `imagePullPolicy`(string):\n  - default `IfNotPresent`\n- `replicas`(numbers)\n- `maxUnavailable`(number|string)\n- `minAvailable`(number|string)\n- `limitCpu`(string)\n- `limitMemory`(string)\n- `requestCpu`(string)\n- `requestMemory`(string)\n- `environment`(kplus.Env)\n- `readinessEnabled`(boolean)\n- `readinessInitialDelaySeconds`(number)\n- `readinessIimeoutSeconds`(number)\n- `readinessPeriodSeconds`(number)\n- `readinessSuccessThreshold`(number)\n- `readinessFailureThreshold`(number)\n- `livenessEnabled`(boolean)\n  - should be `true` for `volto`\n  - should be `false` for `backend/classicui`\n- `livenessInitialDelaySeconds`(number)\n- `livenessIimeoutSeconds`(number)\n- `livenessPeriodSeconds`(number)\n- `livenessSuccessThreshold`(number)\n- `livenessFailureThreshold`(number)\n\n\n#### PloneOptions\n*Interface*\n\n- `version`(string):\n  - version of your project\n- `siteId`(string):\n  - default `Plone`\n- `variant`(PloneVariant):\n  - default `PloneVariant.VOLTO`\n- `backend` (PloneBaseOptions):\n  - default `{}`\n  - needs `image` and `enviroment`\n- `frontend` (PloneBaseOptions):\n  - default `{}`\n  - needs `image` if `PloneVariant.VOLTO`\n- `imagePullSecrets`(string[])\n\n#### PloneVariants\n*Enum*\n\n- VOLTO = 'volto'\n- CLASSICUI  = 'classicui'\n  - no frontend options/image needed\n\n#### Plone\n*class*\n\nbuilds the `Plone` Construct\n\n- `backendServiceName`(string)\n- `frontendServiceName`(string)\n- `variant`(PloneVariant)\n  - default `Volto`\n- `siteId`(string)\n  - default `Plone`\n\n#### PloneHttpcacheOptions\n*Interface*\n\n- `plone`(Plone):\n  - Plone chart\n- `varnishVcl`{string}:\n  - varnishfile\n  - per default `varnishVclFile` should be used\n- `varnishVclFile`(string):\n  - File in config folder\n- `existingSecret`(string)\n- `limitCpu`(string)\n- `limitMemory`(string)\n- `requestCpu`(string)\n- `requestMemory`(string)\n- `servicemonitor`(string)\n  - default `false` used for metrics\n\n#### PloneHttpcache\n*class*\n\nuses helmchart [kube-httpcache](https://github.com/mittwald/kube-httpcache) and builds the `PloneHttpCache` Construct\n- `scope`(Construct)\n- `id`(string)\n- `options`(PloneHttpcacheOptions)\n\n\n## Development\n\nClone the repository and install the dependencies:\n\n```bash\nnvm use lts/*\ncorepack enable\nnpx projen\n```\n\nThen run the following command to run the test:\n\n```bash\nnpx projen test\n```\n\n## ToDo\n- [ ] Option to enable Servicemonitor"
+    "markdown": "# CDK8S Plone\n\nA CDK8S library for deploying Plone CMS to Kubernetes.\n\nThis library provides constructs to bootstrap a Plone deployment on a Kubernetes cluster using the [CDK8S](https://cdk8s.io) framework.\n\n## Features\n\n- **Backend**: Plone backend (API with `plone.volto` or Classic-UI)\n- **Frontend**: Plone Volto (modern React-based user interface)\n- **Varnish Caching**: Optional HTTP caching layer using [kube-httpcache](https://github.com/mittwald/kube-httpcache) with cluster-wide cache invalidation\n- **High Availability**: Configurable replicas with PodDisruptionBudgets\n- **Multi-language Support**: Published to npm (TypeScript/JavaScript) and PyPI (Python)\n\n\n## Installation\n\n### TypeScript/JavaScript\n\nCreate a new CDK8S project (or use an existing one):\n\n```bash\ncdk8s init typescript-app\n```\n\nInstall the library:\n\n```bash\nnpm install @bluedynamics/cdk8s-plone\n```\n\nPackage: [@bluedynamics/cdk8s-plone](https://www.npmjs.com/package/@bluedynamics/cdk8s-plone)\n\n### Python\n\nCreate a new CDK8S project:\n\n```bash\ncdk8s init python-app\n```\n\nInstall the library:\n\n```bash\npip install cdk8s-plone\n```\n\nPackage: [cdk8s-plone](https://pypi.org/project/cdk8s-plone/)\n\n\n## Quick Start\n\n### Basic Plone Deployment\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.0.10',\n    replicas: 3,\n  },\n  frontend: {\n    image: 'plone/plone-frontend:16.0.0',\n    replicas: 2,\n  },\n});\n\napp.synth();\n```\n\n### With Varnish HTTP Cache\n\n```typescript\nimport { PloneHttpcache } from '@bluedynamics/cdk8s-plone';\n\nconst plone = new Plone(chart, 'my-plone', {\n  variant: PloneVariant.VOLTO,\n  backend: { image: 'plone/plone-backend:6.0.10' },\n  frontend: { image: 'plone/plone-frontend:16.0.0' },\n});\n\nnew PloneHttpcache(chart, 'cache', {\n  plone: plone,\n  existingSecret: 'varnish-secret',\n  replicas: 2,\n});\n```\n\n### Generate Kubernetes Manifests\n\n```bash\ncdk8s synth\n```\n\nThe manifests are stored in the `dist/` directory.\n\nFor a complete example, see the [example project](https://github.com/bluedynamics/cdk8s-plone-example).\n\n## Prerequisites\n\n- **kubectl** - Command-line tool for deploying Kubernetes manifests. [Install kubectl](https://kubernetes.io/docs/tasks/tools/#kubectl)\n- **Helm** (optional) - Only needed if generating Helm charts. [Install Helm](https://helm.sh/docs/intro/install/)\n- **Node.js** - For TypeScript/JavaScript development\n- **Python 3.8+** - For Python development\n\n\n## API Documentation\n\nFor complete API documentation, see [API.md](./API.md).\n\n### Key Constructs\n\n#### `Plone`\n\nMain construct for deploying Plone CMS. Supports two variants:\n- **VOLTO**: Modern React frontend with REST API backend (default)\n- **CLASSICUI**: Traditional server-side rendered Plone\n\nProperties:\n- `backendServiceName` - Name of the backend Kubernetes service\n- `frontendServiceName` - Name of the frontend service (VOLTO only)\n- `variant` - Deployment variant (VOLTO or CLASSICUI)\n- `siteId` - Plone site ID in ZODB (default: 'Plone')\n\n#### `PloneHttpcache`\n\nVarnish HTTP caching layer using the [kube-httpcache](https://github.com/mittwald/kube-httpcache) Helm chart.\n\nProperties:\n- `httpcacheServiceName` - Name of the Varnish service\n\n### Configuration Options\n\n#### `PloneOptions`\n\n- `version` - Version of your project\n- `siteId` - Plone site ID (default: 'Plone')\n- `variant` - PloneVariant.VOLTO or PloneVariant.CLASSICUI (default: VOLTO)\n- `backend` - Backend configuration (PloneBaseOptions)\n- `frontend` - Frontend configuration (PloneBaseOptions, required for VOLTO)\n- `imagePullSecrets` - Image pull secrets for private registries\n\n#### `PloneBaseOptions`\n\nConfiguration for backend or frontend:\n\n**Container:**\n- `image` - Container image (e.g., 'plone/plone-backend:6.0.10')\n- `imagePullPolicy` - Pull policy (default: 'IfNotPresent')\n- `replicas` - Number of replicas (default: 2)\n- `environment` - Environment variables (cdk8s-plus-30.Env)\n\n**Resources:**\n- `requestCpu` / `limitCpu` - CPU requests/limits\n- `requestMemory` / `limitMemory` - Memory requests/limits\n\n**High Availability:**\n- `minAvailable` - Min pods during updates (for PodDisruptionBudget)\n- `maxUnavailable` - Max unavailable pods during updates\n\n**Health Probes:**\n- `readinessEnabled` - Enable readiness probe (default: true)\n- `readinessInitialDelaySeconds` / `readinessTimeoutSeconds` / `readinessPeriodSeconds`\n- `readinessSuccessThreshold` / `readinessFailureThreshold`\n- `livenessEnabled` - Enable liveness probe (default: false, recommended true for frontend)\n- `livenessInitialDelaySeconds` / `livenessTimeoutSeconds` / `livenessPeriodSeconds`\n- `livenessSuccessThreshold` / `livenessFailureThreshold`\n\n**Annotations:**\n- `annotations` - Deployment metadata annotations\n- `podAnnotations` - Pod template annotations (e.g., for Prometheus)\n- `serviceAnnotations` - Service annotations (e.g., for external-dns)\n\n#### `PloneHttpcacheOptions`\n\n- `plone` - Plone construct to attach cache to (required)\n- `varnishVcl` - VCL configuration as string\n- `varnishVclFile` - Path to VCL configuration file\n- `existingSecret` - Kubernetes secret for Varnish admin credentials\n- `replicas` - Number of Varnish replicas (default: 2)\n- `requestCpu` / `limitCpu` - CPU resources\n- `requestMemory` / `limitMemory` - Memory resources\n- `servicemonitor` - Enable Prometheus ServiceMonitor (default: false)\n\n\n## Development\n\nThis project uses [Projen](https://projen.io/) to manage project configuration. **Do not edit generated files directly.**\n\n### Setup\n\nClone the repository and install dependencies:\n\n```bash\nnvm use lts/*\ncorepack enable\nnpx projen\n```\n\n### Common Commands\n\n```bash\n# Run tests\nnpx projen test\n\n# Run tests in watch mode\nnpx projen test:watch\n\n# Build (compile TypeScript + generate JSII bindings)\nnpx projen build\n\n# Lint\nnpx projen eslint\n\n# Generate API documentation\nnpx projen docgen\n\n# Package for distribution\nnpx projen package-all\n```\n\n### Making Changes\n\n1. Edit `.projenrc.ts` for project configuration changes\n2. Run `npx projen` to regenerate project files\n3. Make code changes in `src/`\n4. Run tests and update snapshots if needed: `npx projen test -- -u`\n\n## References\n\n- [CDK8S Documentation](https://cdk8s.io/)\n- [Kubernetes Probes Documentation](https://kubernetes.io/docs/concepts/configuration/liveness-readiness-startup-probes/)\n- [kube-httpcache Helm Chart](https://github.com/mittwald/kube-httpcache)\n- [Example Project](https://github.com/bluedynamics/cdk8s-plone-example)\n\n## License\n\nSee [LICENSE](./LICENSE) file."
   },
   "repository": {
     "type": "git",
@@ -129,7 +129,10 @@
       "assembly": "@bluedynamics/cdk8s-plone",
       "base": "constructs.Construct",
       "docs": {
-        "stability": "stable"
+        "example": "new Plone(chart, 'my-plone', {\n  variant: PloneVariant.VOLTO,\n  backend: {\n    image: 'plone/plone-backend:6.0.10',\n    replicas: 3,\n  },\n  frontend: {\n    image: 'plone/plone-frontend:16.0.0',\n  },\n});",
+        "remarks": "This construct creates all necessary Kubernetes resources for running Plone:\n- Deployment(s) for backend (and optionally frontend)\n- Service(s) for network access\n- Optional PodDisruptionBudget for high availability\n\nSupports two deployment variants:\n- VOLTO: Modern React frontend with REST API backend (default)\n- CLASSICUI: Traditional server-side rendered Plone",
+        "stability": "stable",
+        "summary": "Plone construct for deploying Plone CMS to Kubernetes."
       },
       "fqn": "@bluedynamics/cdk8s-plone.Plone",
       "initializer": {
@@ -138,7 +141,7 @@
         },
         "locationInModule": {
           "filename": "src/plone.ts",
-          "line": 67
+          "line": 293
         },
         "parameters": [
           {
@@ -165,18 +168,20 @@
       "kind": "class",
       "locationInModule": {
         "filename": "src/plone.ts",
-        "line": 52
+        "line": 270
       },
       "name": "Plone",
       "properties": [
         {
           "docs": {
-            "stability": "stable"
+            "remarks": "Use this to reference the backend service from other constructs.",
+            "stability": "stable",
+            "summary": "Name of the backend Kubernetes service."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/plone.ts",
-            "line": 62
+            "line": 275
           },
           "name": "backendServiceName",
           "type": {
@@ -185,12 +190,13 @@
         },
         {
           "docs": {
-            "stability": "stable"
+            "stability": "stable",
+            "summary": "The Plone site ID in ZODB."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/plone.ts",
-            "line": 65
+            "line": 291
           },
           "name": "siteId",
           "type": {
@@ -199,12 +205,13 @@
         },
         {
           "docs": {
-            "stability": "stable"
+            "stability": "stable",
+            "summary": "The deployment variant being used (VOLTO or CLASSICUI)."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/plone.ts",
-            "line": 64
+            "line": 286
           },
           "name": "variant",
           "type": {
@@ -213,12 +220,14 @@
         },
         {
           "docs": {
-            "stability": "stable"
+            "remarks": "Only set when variant is VOLTO, otherwise undefined.",
+            "stability": "stable",
+            "summary": "Name of the frontend Kubernetes service."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/plone.ts",
-            "line": 63
+            "line": 281
           },
           "name": "frontendServiceName",
           "optional": true,
@@ -233,25 +242,54 @@
       "assembly": "@bluedynamics/cdk8s-plone",
       "datatype": true,
       "docs": {
-        "stability": "stable"
+        "remarks": "These options control container image, replica count, resource limits,\nenvironment variables, and health probes.",
+        "stability": "stable",
+        "summary": "Base options for Plone backend or frontend configuration."
       },
       "fqn": "@bluedynamics/cdk8s-plone.PloneBaseOptions",
       "kind": "interface",
       "locationInModule": {
         "filename": "src/plone.ts",
-        "line": 9
+        "line": 14
       },
       "name": "PloneBaseOptions",
       "properties": [
         {
           "abstract": true,
           "docs": {
-            "stability": "stable"
+            "default": "- no additional annotations",
+            "example": "{ 'deployment.kubernetes.io/revision': '1' }",
+            "stability": "stable",
+            "summary": "Annotations to add to the Deployment metadata."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/plone.ts",
-            "line": 22
+            "line": 165
+          },
+          "name": "annotations",
+          "optional": true,
+          "type": {
+            "collection": {
+              "elementtype": {
+                "primitive": "string"
+              },
+              "kind": "map"
+            }
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "- undefined (no additional environment variables)",
+            "remarks": "Use cdk8s-plus-30 Env class to define variables and sources.",
+            "stability": "stable",
+            "summary": "Environment variables to set in the container."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/plone.ts",
+            "line": 83
           },
           "name": "environment",
           "optional": true,
@@ -262,12 +300,15 @@
         {
           "abstract": true,
           "docs": {
-            "stability": "stable"
+            "default": "- 'plone/plone-backend:latest' for backend, 'plone/plone-frontend:latest' for frontend",
+            "example": "'plone/plone-backend:6.0.10' or 'plone/plone-frontend:16.0.0'",
+            "stability": "stable",
+            "summary": "Container image to use for the deployment."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/plone.ts",
-            "line": 11
+            "line": 20
           },
           "name": "image",
           "optional": true,
@@ -278,12 +319,14 @@
         {
           "abstract": true,
           "docs": {
-            "stability": "stable"
+            "default": "'IfNotPresent'",
+            "stability": "stable",
+            "summary": "Image pull policy for the container."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/plone.ts",
-            "line": 12
+            "line": 26
           },
           "name": "imagePullPolicy",
           "optional": true,
@@ -294,12 +337,15 @@
         {
           "abstract": true,
           "docs": {
-            "stability": "stable"
+            "default": "'500m' for both backend and frontend",
+            "example": "'500m' or '1' or '2000m'",
+            "stability": "stable",
+            "summary": "CPU limit for the container."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/plone.ts",
-            "line": 18
+            "line": 55
           },
           "name": "limitCpu",
           "optional": true,
@@ -310,12 +356,15 @@
         {
           "abstract": true,
           "docs": {
-            "stability": "stable"
+            "default": "'512Mi' for backend, '1Gi' for frontend",
+            "example": "'512Mi' or '1Gi'",
+            "stability": "stable",
+            "summary": "Memory limit for the container."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/plone.ts",
-            "line": 19
+            "line": 62
           },
           "name": "limitMemory",
           "optional": true,
@@ -326,12 +375,15 @@
         {
           "abstract": true,
           "docs": {
-            "stability": "stable"
+            "default": "false",
+            "remarks": "Liveness probes determine when to restart a container.\nRecommended: true for frontend, false for backend (Zope has its own recovery).",
+            "stability": "stable",
+            "summary": "Enable liveness probe for the container."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/plone.ts",
-            "line": 31
+            "line": 128
           },
           "name": "livenessEnabled",
           "optional": true,
@@ -342,12 +394,14 @@
         {
           "abstract": true,
           "docs": {
-            "stability": "stable"
+            "default": "3",
+            "stability": "stable",
+            "summary": "Minimum consecutive failures for the liveness probe to be considered failed."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/plone.ts",
-            "line": 36
+            "line": 158
           },
           "name": "livenessFailureThreshold",
           "optional": true,
@@ -358,14 +412,16 @@
         {
           "abstract": true,
           "docs": {
-            "stability": "stable"
+            "default": "30",
+            "stability": "stable",
+            "summary": "Number of seconds after container start before liveness probe is initiated."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/plone.ts",
-            "line": 33
+            "line": 134
           },
-          "name": "livenessIimeoutSeconds",
+          "name": "livenessInitialDelaySeconds",
           "optional": true,
           "type": {
             "primitive": "number"
@@ -374,14 +430,16 @@
         {
           "abstract": true,
           "docs": {
-            "stability": "stable"
+            "default": "10",
+            "stability": "stable",
+            "summary": "How often (in seconds) to perform the liveness probe."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/plone.ts",
-            "line": 32
+            "line": 146
           },
-          "name": "livenessInitialDelaySeconds",
+          "name": "livenessPeriodSeconds",
           "optional": true,
           "type": {
             "primitive": "number"
@@ -390,14 +448,16 @@
         {
           "abstract": true,
           "docs": {
-            "stability": "stable"
+            "default": "1",
+            "stability": "stable",
+            "summary": "Minimum consecutive successes for the liveness probe to be considered successful."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/plone.ts",
-            "line": 34
+            "line": 152
           },
-          "name": "livenessPeriodSeconds",
+          "name": "livenessSuccessThreshold",
           "optional": true,
           "type": {
             "primitive": "number"
@@ -406,14 +466,16 @@
         {
           "abstract": true,
           "docs": {
-            "stability": "stable"
+            "default": "5",
+            "stability": "stable",
+            "summary": "Number of seconds after which the liveness probe times out."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/plone.ts",
-            "line": 35
+            "line": 140
           },
-          "name": "livenessSuccessThreshold",
+          "name": "livenessTimeoutSeconds",
           "optional": true,
           "type": {
             "primitive": "number"
@@ -422,12 +484,15 @@
         {
           "abstract": true,
           "docs": {
-            "stability": "stable"
+            "default": "- undefined (not set)",
+            "remarks": "Can be an absolute number (e.g., 1) or a percentage (e.g., '50%').\nUsed in PodDisruptionBudget if specified.",
+            "stability": "stable",
+            "summary": "Maximum number of pods that can be unavailable during updates."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/plone.ts",
-            "line": 15
+            "line": 40
           },
           "name": "maxUnavailable",
           "optional": true,
@@ -447,12 +512,15 @@
         {
           "abstract": true,
           "docs": {
-            "stability": "stable"
+            "default": "- undefined (not set)",
+            "remarks": "Can be an absolute number (e.g., 1) or a percentage (e.g., '50%').\nUsed in PodDisruptionBudget if specified.",
+            "stability": "stable",
+            "summary": "Minimum number of pods that must be available during updates."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/plone.ts",
-            "line": 16
+            "line": 48
           },
           "name": "minAvailable",
           "optional": true,
@@ -472,12 +540,40 @@
         {
           "abstract": true,
           "docs": {
-            "stability": "stable"
+            "default": "- no additional annotations",
+            "example": "{ 'prometheus.io/scrape': 'true', 'prometheus.io/port': '8080' }",
+            "remarks": "Common for Prometheus, Istio, backup policies, etc.",
+            "stability": "stable",
+            "summary": "Annotations to add to the Pod template metadata."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/plone.ts",
+            "line": 173
+          },
+          "name": "podAnnotations",
+          "optional": true,
+          "type": {
+            "collection": {
+              "elementtype": {
+                "primitive": "string"
+              },
+              "kind": "map"
+            }
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "true",
+            "remarks": "Readiness probes determine when a container is ready to accept traffic.",
+            "stability": "stable",
+            "summary": "Enable readiness probe for the container."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/plone.ts",
-            "line": 24
+            "line": 90
           },
           "name": "readinessEnabled",
           "optional": true,
@@ -488,12 +584,14 @@
         {
           "abstract": true,
           "docs": {
-            "stability": "stable"
+            "default": "3",
+            "stability": "stable",
+            "summary": "Minimum consecutive failures for the readiness probe to be considered failed."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/plone.ts",
-            "line": 29
+            "line": 120
           },
           "name": "readinessFailureThreshold",
           "optional": true,
@@ -504,14 +602,16 @@
         {
           "abstract": true,
           "docs": {
-            "stability": "stable"
+            "default": "10",
+            "stability": "stable",
+            "summary": "Number of seconds after container start before readiness probe is initiated."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/plone.ts",
-            "line": 26
+            "line": 96
           },
-          "name": "readinessIimeoutSeconds",
+          "name": "readinessInitialDelaySeconds",
           "optional": true,
           "type": {
             "primitive": "number"
@@ -520,14 +620,16 @@
         {
           "abstract": true,
           "docs": {
-            "stability": "stable"
+            "default": "10",
+            "stability": "stable",
+            "summary": "How often (in seconds) to perform the readiness probe."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/plone.ts",
-            "line": 25
+            "line": 108
           },
-          "name": "readinessInitialDelaySeconds",
+          "name": "readinessPeriodSeconds",
           "optional": true,
           "type": {
             "primitive": "number"
@@ -536,14 +638,16 @@
         {
           "abstract": true,
           "docs": {
-            "stability": "stable"
+            "default": "1",
+            "stability": "stable",
+            "summary": "Minimum consecutive successes for the readiness probe to be considered successful."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/plone.ts",
-            "line": 27
+            "line": 114
           },
-          "name": "readinessPeriodSeconds",
+          "name": "readinessSuccessThreshold",
           "optional": true,
           "type": {
             "primitive": "number"
@@ -552,14 +656,16 @@
         {
           "abstract": true,
           "docs": {
-            "stability": "stable"
+            "default": "15",
+            "stability": "stable",
+            "summary": "Number of seconds after which the readiness probe times out."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/plone.ts",
-            "line": 28
+            "line": 102
           },
-          "name": "readinessSuccessThreshold",
+          "name": "readinessTimeoutSeconds",
           "optional": true,
           "type": {
             "primitive": "number"
@@ -568,12 +674,14 @@
         {
           "abstract": true,
           "docs": {
-            "stability": "stable"
+            "default": "2",
+            "stability": "stable",
+            "summary": "Number of pod replicas to run."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/plone.ts",
-            "line": 14
+            "line": 32
           },
           "name": "replicas",
           "optional": true,
@@ -584,12 +692,15 @@
         {
           "abstract": true,
           "docs": {
-            "stability": "stable"
+            "default": "'200m'",
+            "example": "'200m' or '0.5'",
+            "stability": "stable",
+            "summary": "CPU request for the container."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/plone.ts",
-            "line": 20
+            "line": 69
           },
           "name": "requestCpu",
           "optional": true,
@@ -600,18 +711,46 @@
         {
           "abstract": true,
           "docs": {
-            "stability": "stable"
+            "default": "'256Mi'",
+            "example": "'256Mi' or '512Mi'",
+            "stability": "stable",
+            "summary": "Memory request for the container."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/plone.ts",
-            "line": 21
+            "line": 76
           },
           "name": "requestMemory",
           "optional": true,
           "type": {
             "primitive": "string"
           }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "- no additional annotations",
+            "example": "{ 'external-dns.alpha.kubernetes.io/hostname': 'plone.example.com' }",
+            "remarks": "Common for external-dns, load balancers, service mesh, etc.",
+            "stability": "stable",
+            "summary": "Annotations to add to the Service metadata."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/plone.ts",
+            "line": 181
+          },
+          "name": "serviceAnnotations",
+          "optional": true,
+          "type": {
+            "collection": {
+              "elementtype": {
+                "primitive": "string"
+              },
+              "kind": "map"
+            }
+          }
         }
       ],
       "symbolId": "src/plone:PloneBaseOptions"
@@ -620,7 +759,10 @@
       "assembly": "@bluedynamics/cdk8s-plone",
       "base": "constructs.Construct",
       "docs": {
-        "stability": "stable"
+        "example": "const plone = new Plone(chart, 'plone');\nconst cache = new PloneHttpcache(chart, 'cache', {\n  plone: plone,\n  existingSecret: 'varnish-secret',\n});",
+        "remarks": "Uses the mittwald/kube-httpcache Helm chart to deploy Varnish as a\ncaching proxy in front of Plone backend and/or frontend services.\n\nThe cache automatically connects to the Plone services and provides\nHTTP cache invalidation capabilities.",
+        "stability": "stable",
+        "summary": "PloneHttpcache construct for deploying Varnish HTTP caching layer."
       },
       "fqn": "@bluedynamics/cdk8s-plone.PloneHttpcache",
       "initializer": {
@@ -629,7 +771,7 @@
         },
         "locationInModule": {
           "filename": "src/httpcache.ts",
-          "line": 43
+          "line": 99
         },
         "parameters": [
           {
@@ -655,18 +797,20 @@
       "kind": "class",
       "locationInModule": {
         "filename": "src/httpcache.ts",
-        "line": 39
+        "line": 92
       },
       "name": "PloneHttpcache",
       "properties": [
         {
           "docs": {
-            "stability": "stable"
+            "remarks": "Use this to reference the cache service from ingress or other constructs.",
+            "stability": "stable",
+            "summary": "Name of the Varnish service created by the Helm chart."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/httpcache.ts",
-            "line": 41
+            "line": 97
           },
           "name": "httpcacheServiceName",
           "type": {
@@ -680,27 +824,28 @@
       "assembly": "@bluedynamics/cdk8s-plone",
       "datatype": true,
       "docs": {
-        "stability": "stable"
+        "stability": "stable",
+        "summary": "Configuration options for PloneHttpcache (Varnish caching layer)."
       },
       "fqn": "@bluedynamics/cdk8s-plone.PloneHttpcacheOptions",
       "kind": "interface",
       "locationInModule": {
         "filename": "src/httpcache.ts",
-        "line": 7
+        "line": 10
       },
       "name": "PloneHttpcacheOptions",
       "properties": [
         {
           "abstract": true,
           "docs": {
-            "default": "- none",
+            "remarks": "The cache will automatically connect to the backend and frontend services.",
             "stability": "stable",
-            "summary": "plone chart."
+            "summary": "The Plone construct to attach the HTTP cache to."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/httpcache.ts",
-            "line": 12
+            "line": 15
           },
           "name": "plone",
           "type": {
@@ -710,14 +855,15 @@
         {
           "abstract": true,
           "docs": {
-            "default": "- undefined",
+            "default": "- undefined (no existing secret)",
+            "remarks": "The secret should be created separately in the same namespace.",
             "stability": "stable",
-            "summary": "existingSecret - Read admin credentials from user provided secret."
+            "summary": "Name of an existing Kubernetes secret containing Varnish admin credentials."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/httpcache.ts",
-            "line": 27
+            "line": 36
           },
           "name": "existingSecret",
           "optional": true,
@@ -728,12 +874,14 @@
         {
           "abstract": true,
           "docs": {
-            "stability": "stable"
+            "default": "'500m'",
+            "stability": "stable",
+            "summary": "CPU limit for Varnish pods."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/httpcache.ts",
-            "line": 31
+            "line": 42
           },
           "name": "limitCpu",
           "optional": true,
@@ -744,12 +892,14 @@
         {
           "abstract": true,
           "docs": {
-            "stability": "stable"
+            "default": "'500Mi'",
+            "stability": "stable",
+            "summary": "Memory limit for Varnish pods."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/httpcache.ts",
-            "line": 32
+            "line": 48
           },
           "name": "limitMemory",
           "optional": true,
@@ -760,12 +910,32 @@
         {
           "abstract": true,
           "docs": {
-            "stability": "stable"
+            "default": "2",
+            "stability": "stable",
+            "summary": "Number of Varnish pod replicas to run."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/httpcache.ts",
-            "line": 33
+            "line": 73
+          },
+          "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/httpcache.ts",
+            "line": 54
           },
           "name": "requestCpu",
           "optional": true,
@@ -776,12 +946,14 @@
         {
           "abstract": true,
           "docs": {
-            "stability": "stable"
+            "default": "'100Mi'",
+            "stability": "stable",
+            "summary": "Memory request for Varnish pods."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/httpcache.ts",
-            "line": 34
+            "line": 60
           },
           "name": "requestMemory",
           "optional": true,
@@ -792,12 +964,15 @@
         {
           "abstract": true,
           "docs": {
-            "stability": "stable"
+            "default": "false",
+            "remarks": "Requires Prometheus Operator to be installed in the cluster.",
+            "stability": "stable",
+            "summary": "Enable Prometheus ServiceMonitor for metrics collection."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/httpcache.ts",
-            "line": 36
+            "line": 67
           },
           "name": "servicemonitor",
           "optional": true,
@@ -808,14 +983,15 @@
         {
           "abstract": true,
           "docs": {
-            "default": "- file in config folder",
+            "default": "- loaded from varnishVclFile or default config file",
+            "remarks": "If provided, this takes precedence over varnishVclFile.",
             "stability": "stable",
-            "summary": "varnishVcl."
+            "summary": "Varnish VCL configuration as a string."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/httpcache.ts",
-            "line": 17
+            "line": 22
           },
           "name": "varnishVcl",
           "optional": true,
@@ -826,14 +1002,15 @@
         {
           "abstract": true,
           "docs": {
-            "default": "- undefined",
+            "default": "- uses default config/varnish.tpl.vcl",
+            "remarks": "If not provided, uses the default VCL file included in the library.",
             "stability": "stable",
-            "summary": "varnishVclFile."
+            "summary": "Path to a Varnish VCL configuration file."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/httpcache.ts",
-            "line": 22
+            "line": 29
           },
           "name": "varnishVclFile",
           "optional": true,
@@ -848,25 +1025,28 @@
       "assembly": "@bluedynamics/cdk8s-plone",
       "datatype": true,
       "docs": {
-        "stability": "stable"
+        "stability": "stable",
+        "summary": "Main configuration options for Plone deployment."
       },
       "fqn": "@bluedynamics/cdk8s-plone.PloneOptions",
       "kind": "interface",
       "locationInModule": {
         "filename": "src/plone.ts",
-        "line": 42
+        "line": 203
       },
       "name": "PloneOptions",
       "properties": [
         {
           "abstract": true,
           "docs": {
-            "stability": "stable"
+            "default": "{} (uses default values from PloneBaseOptions)",
+            "stability": "stable",
+            "summary": "Backend (Plone API) configuration."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/plone.ts",
-            "line": 46
+            "line": 228
           },
           "name": "backend",
           "optional": true,
@@ -877,12 +1057,15 @@
         {
           "abstract": true,
           "docs": {
-            "stability": "stable"
+            "default": "{} (uses default values from PloneBaseOptions)",
+            "remarks": "Only used when variant is PloneVariant.VOLTO.",
+            "stability": "stable",
+            "summary": "Frontend (Volto) configuration."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/plone.ts",
-            "line": 47
+            "line": 235
           },
           "name": "frontend",
           "optional": true,
@@ -893,12 +1076,16 @@
         {
           "abstract": true,
           "docs": {
-            "stability": "stable"
+            "default": "[] (no image pull secrets)",
+            "example": "['my-registry-secret']",
+            "remarks": "These secrets must exist in the same namespace as the deployment.",
+            "stability": "stable",
+            "summary": "Names of Kubernetes secrets to use for pulling private container images."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/plone.ts",
-            "line": 48
+            "line": 243
           },
           "name": "imagePullSecrets",
           "optional": true,
@@ -914,12 +1101,15 @@
         {
           "abstract": true,
           "docs": {
-            "stability": "stable"
+            "default": "'Plone'",
+            "remarks": "This is used to construct the internal API path for Volto frontend.",
+            "stability": "stable",
+            "summary": "Plone site ID in the ZODB."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/plone.ts",
-            "line": 44
+            "line": 216
           },
           "name": "siteId",
           "optional": true,
@@ -930,12 +1120,14 @@
         {
           "abstract": true,
           "docs": {
-            "stability": "stable"
+            "default": "PloneVariant.VOLTO",
+            "stability": "stable",
+            "summary": "Plone deployment variant to use."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/plone.ts",
-            "line": 45
+            "line": 222
           },
           "name": "variant",
           "optional": true,
@@ -946,12 +1138,15 @@
         {
           "abstract": true,
           "docs": {
-            "stability": "stable"
+            "default": "'undefined'",
+            "remarks": "This is used in Kubernetes labels and doesn't affect the actual image versions.",
+            "stability": "stable",
+            "summary": "Version string for labeling the deployment."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/plone.ts",
-            "line": 43
+            "line": 209
           },
           "name": "version",
           "optional": true,
@@ -965,24 +1160,29 @@
     "@bluedynamics/cdk8s-plone.PloneVariant": {
       "assembly": "@bluedynamics/cdk8s-plone",
       "docs": {
-        "stability": "stable"
+        "stability": "stable",
+        "summary": "Plone deployment variants."
       },
       "fqn": "@bluedynamics/cdk8s-plone.PloneVariant",
       "kind": "enum",
       "locationInModule": {
         "filename": "src/plone.ts",
-        "line": 38
+        "line": 186
       },
       "members": [
         {
           "docs": {
-            "stability": "stable"
+            "remarks": "Deploys both frontend and backend services.",
+            "stability": "stable",
+            "summary": "Volto variant: ReactJS frontend (Volto) with REST API backend."
           },
           "name": "VOLTO"
         },
         {
           "docs": {
-            "stability": "stable"
+            "remarks": "Deploys only the backend service.",
+            "stability": "stable",
+            "summary": "Classic UI variant: Traditional Plone with server-side rendering."
           },
           "name": "CLASSICUI"
         }
@@ -991,6 +1191,6 @@
       "symbolId": "src/plone:PloneVariant"
     }
   },
-  "version": "0.0.81",
-  "fingerprint": "t+2WkNwxxmBu5DGK7dWBByXVFR0mXDSNK07R2TzB/SA="
+  "version": "0.1.0",
+  "fingerprint": "ObcEWIyyMxbUwjQu4nAHh/HAHbKOKwctDZrOkMNlV8w="
 }