# API Reference
## Constructs
### Plone
Plone construct for deploying Plone CMS to Kubernetes.
This construct creates all necessary Kubernetes resources for running Plone:
- Deployment(s) for backend (and optionally frontend)
- Service(s) for network access
- Optional PodDisruptionBudget for high availability
Supports two deployment variants:
- 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*
```typescript
new Plone(chart, 'my-plone', {
variant: PloneVariant.VOLTO,
backend: {
image: 'plone/plone-backend:6.0.10',
replicas: 3,
},
frontend: {
image: 'plone/plone-frontend:16.0.0',
},
});
```
#### Initializers
```typescript
import { Plone } from '@bluedynamics/cdk8s-plone'
new Plone(scope: Construct, id: string, options?: PloneOptions)
```
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| scope | constructs.Construct | *No description.* |
| id | string | *No description.* |
| options | PloneOptions | *No description.* |
---
##### `scope`Required
- *Type:* constructs.Construct
---
##### `id`Required
- *Type:* string
---
##### `options`Optional
- *Type:* PloneOptions
---
#### Methods
| **Name** | **Description** |
| --- | --- |
| toString | Returns a string representation of this construct. |
| with | Applies one or more mixins to this construct. |
---
##### `toString`
```typescript
public toString(): string
```
Returns a string representation of this construct.
##### `with`
```typescript
public with(mixins: ...IMixin[]): IConstruct
```
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple `with()` calls if subsequent mixins should apply to added
constructs.
###### `mixins`Required
- *Type:* ...constructs.IMixin[]
The mixins to apply.
---
#### Static Functions
| **Name** | **Description** |
| --- | --- |
| isConstruct | Checks if `x` is a construct. |
---
##### `isConstruct`
```typescript
import { Plone } from '@bluedynamics/cdk8s-plone'
Plone.isConstruct(x: any)
```
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct`
instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on
disk are seen as independent, completely different libraries. As a
consequence, the class `Construct` in each copy of the `constructs` library
is seen as a different class, and an instance of one class will not test as
`instanceof` the other class. `npm install` will not create installations
like this, but users may manually symlink construct libraries together or
use a monorepo tool: in those cases, multiple copies of the `constructs`
library can be accidentally installed, and `instanceof` will behave
unpredictably. It is safest to avoid using `instanceof`, and using
this type-testing method instead.
###### `x`Required
- *Type:* any
Any object.
---
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| node | constructs.Node | The tree node. |
| backendServiceName | string | Name of the backend Kubernetes service. |
| siteId | string | The Plone site ID in ZODB. |
| variant | PloneVariant | The deployment variant being used (VOLTO or BLICCA). |
| frontendServiceName | string | Name of the frontend Kubernetes service. |
---
##### `node`Required
```typescript
public readonly node: Node;
```
- *Type:* constructs.Node
The tree node.
---
##### `backendServiceName`Required
```typescript
public readonly backendServiceName: string;
```
- *Type:* string
Name of the backend Kubernetes service.
Use this to reference the backend service from other constructs.
---
##### `siteId`Required
```typescript
public readonly siteId: string;
```
- *Type:* string
The Plone site ID in ZODB.
---
##### `variant`Required
```typescript
public readonly variant: PloneVariant;
```
- *Type:* PloneVariant
The deployment variant being used (VOLTO or BLICCA).
---
##### `frontendServiceName`Optional
```typescript
public readonly frontendServiceName: string;
```
- *Type:* string
Name of the frontend Kubernetes service.
Only set when variant is VOLTO, otherwise undefined.
---
### PloneHttpcache
PloneHttpcache construct for deploying Varnish HTTP caching layer.
Uses the mittwald/kube-httpcache Helm chart to deploy Varnish as a
caching proxy in front of Plone backend and/or frontend services.
The cache automatically connects to the Plone services and provides
HTTP cache invalidation capabilities.
*Example*
```typescript
const plone = new Plone(chart, 'plone');
const cache = new PloneHttpcache(chart, 'cache', {
plone: plone,
existingSecret: 'varnish-secret',
});
```
#### Initializers
```typescript
import { PloneHttpcache } from '@bluedynamics/cdk8s-plone'
new PloneHttpcache(scope: Construct, id: string, options: PloneHttpcacheOptions)
```
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| scope | constructs.Construct | *No description.* |
| id | string | *No description.* |
| options | PloneHttpcacheOptions | *No description.* |
---
##### `scope`Required
- *Type:* constructs.Construct
---
##### `id`Required
- *Type:* string
---
##### `options`Required
- *Type:* PloneHttpcacheOptions
---
#### Methods
| **Name** | **Description** |
| --- | --- |
| toString | Returns a string representation of this construct. |
| with | Applies one or more mixins to this construct. |
---
##### `toString`
```typescript
public toString(): string
```
Returns a string representation of this construct.
##### `with`
```typescript
public with(mixins: ...IMixin[]): IConstruct
```
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple `with()` calls if subsequent mixins should apply to added
constructs.
###### `mixins`Required
- *Type:* ...constructs.IMixin[]
The mixins to apply.
---
#### Static Functions
| **Name** | **Description** |
| --- | --- |
| isConstruct | Checks if `x` is a construct. |
---
##### `isConstruct`
```typescript
import { PloneHttpcache } from '@bluedynamics/cdk8s-plone'
PloneHttpcache.isConstruct(x: any)
```
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct`
instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on
disk are seen as independent, completely different libraries. As a
consequence, the class `Construct` in each copy of the `constructs` library
is seen as a different class, and an instance of one class will not test as
`instanceof` the other class. `npm install` will not create installations
like this, but users may manually symlink construct libraries together or
use a monorepo tool: in those cases, multiple copies of the `constructs`
library can be accidentally installed, and `instanceof` will behave
unpredictably. It is safest to avoid using `instanceof`, and using
this type-testing method instead.
###### `x`Required
- *Type:* any
Any object.
---
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| node | constructs.Node | The tree node. |
| httpcacheServiceName | string | Name of the Varnish service created by the Helm chart. |
---
##### `node`Required
```typescript
public readonly node: Node;
```
- *Type:* constructs.Node
The tree node.
---
##### `httpcacheServiceName`Required
```typescript
public readonly httpcacheServiceName: string;
```
- *Type:* string
Name of the Varnish service created by the Helm chart.
Use this to reference the cache service from ingress or other constructs.
---
### PloneVinylCache
PloneVinylCache construct for deploying Varnish Cache via cloud-vinyl operator.
Creates a VinylCache custom resource with Plone backend/frontend services
auto-configured as backends. The cloud-vinyl operator manages the full
Varnish lifecycle including VCL generation, agent delivery, and monitoring.
Requires the cloud-vinyl operator to be installed in the cluster.
*Example*
```typescript
const plone = new Plone(chart, 'plone');
const cache = new PloneVinylCache(chart, 'cache', {
plone: plone,
replicas: 2,
});
// Use cache.vinylCacheServiceName for IngressRoute
```
#### Initializers
```typescript
import { PloneVinylCache } from '@bluedynamics/cdk8s-plone'
new PloneVinylCache(scope: Construct, id: string, options: PloneVinylCacheOptions)
```
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| scope | constructs.Construct | *No description.* |
| id | string | *No description.* |
| options | PloneVinylCacheOptions | *No description.* |
---
##### `scope`Required
- *Type:* constructs.Construct
---
##### `id`Required
- *Type:* string
---
##### `options`Required
- *Type:* PloneVinylCacheOptions
---
#### Methods
| **Name** | **Description** |
| --- | --- |
| toString | Returns a string representation of this construct. |
| with | Applies one or more mixins to this construct. |
---
##### `toString`
```typescript
public toString(): string
```
Returns a string representation of this construct.
##### `with`
```typescript
public with(mixins: ...IMixin[]): IConstruct
```
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the
start of the call, so constructs added by a mixin will not be visited.
Use multiple `with()` calls if subsequent mixins should apply to added
constructs.
###### `mixins`Required
- *Type:* ...constructs.IMixin[]
The mixins to apply.
---
#### Static Functions
| **Name** | **Description** |
| --- | --- |
| isConstruct | Checks if `x` is a construct. |
---
##### `isConstruct`
```typescript
import { PloneVinylCache } from '@bluedynamics/cdk8s-plone'
PloneVinylCache.isConstruct(x: any)
```
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct`
instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on
disk are seen as independent, completely different libraries. As a
consequence, the class `Construct` in each copy of the `constructs` library
is seen as a different class, and an instance of one class will not test as
`instanceof` the other class. `npm install` will not create installations
like this, but users may manually symlink construct libraries together or
use a monorepo tool: in those cases, multiple copies of the `constructs`
library can be accidentally installed, and `instanceof` will behave
unpredictably. It is safest to avoid using `instanceof`, and using
this type-testing method instead.
###### `x`Required
- *Type:* any
Any object.
---
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| node | constructs.Node | The tree node. |
| vinylCacheServiceName | string | Name of the VinylCache service created by the operator. |
---
##### `node`Required
```typescript
public readonly node: Node;
```
- *Type:* constructs.Node
The tree node.
---
##### `vinylCacheServiceName`Required
```typescript
public readonly vinylCacheServiceName: string;
```
- *Type:* string
Name of the VinylCache service created by the operator.
Use this to reference the cache service from ingress or other constructs.
---
## Structs
### HttpcacheEnvVar
An environment variable to pass to the kube-httpcache container.
#### Initializer
```typescript
import { HttpcacheEnvVar } from '@bluedynamics/cdk8s-plone'
const httpcacheEnvVar: HttpcacheEnvVar = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| name | string | The name of the environment variable. |
| value | string | The value of the environment variable. |
---
##### `name`Required
```typescript
public readonly name: string;
```
- *Type:* string
The name of the environment variable.
---
##### `value`Required
```typescript
public readonly value: string;
```
- *Type:* string
The value of the environment variable.
---
### HttpcacheToleration
A Kubernetes toleration for the Varnish pods.
#### Initializer
```typescript
import { HttpcacheToleration } from '@bluedynamics/cdk8s-plone'
const httpcacheToleration: HttpcacheToleration = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| key | string | The taint key to tolerate. |
| effect | string | The taint effect to tolerate (NoSchedule, PreferNoSchedule, NoExecute). |
| operator | string | The operator (Equal or Exists). |
| value | string | The taint value to match (when operator is Equal). |
---
##### `key`Required
```typescript
public readonly key: string;
```
- *Type:* string
The taint key to tolerate.
---
##### `effect`Optional
```typescript
public readonly effect: string;
```
- *Type:* string
- *Default:* tolerate all effects
The taint effect to tolerate (NoSchedule, PreferNoSchedule, NoExecute).
---
##### `operator`Optional
```typescript
public readonly operator: string;
```
- *Type:* string
- *Default:* 'Equal'
The operator (Equal or Exists).
---
##### `value`Optional
```typescript
public readonly value: string;
```
- *Type:* string
- *Default:* no value
The taint value to match (when operator is Equal).
---
### PloneBaseOptions
Base options for Plone backend or frontend configuration.
These options control container image, replica count, resource limits,
environment variables, and health probes.
#### Initializer
```typescript
import { PloneBaseOptions } from '@bluedynamics/cdk8s-plone'
const ploneBaseOptions: PloneBaseOptions = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| annotations | {[ key: string ]: string} | Annotations to add to the Deployment metadata. |
| environment | cdk8s-plus-30.Env | Environment variables to set in the container. |
| image | string | Container image to use for the deployment. |
| imagePullPolicy | string | Image pull policy for the container. |
| limitCpu | string | CPU limit for the container. |
| limitMemory | string | Memory limit for the container. |
| livenessEnabled | boolean | Enable liveness probe for the container. |
| livenessFailureThreshold | number | Minimum consecutive failures for the liveness probe to be considered failed. |
| livenessInitialDelaySeconds | number | Number of seconds after container start before liveness probe is initiated. |
| livenessPeriodSeconds | number | How often (in seconds) to perform the liveness probe. |
| livenessSuccessThreshold | number | Minimum consecutive successes for the liveness probe to be considered successful. |
| livenessTimeoutSeconds | number | Number of seconds after which the liveness probe times out. |
| maxUnavailable | string \| number | Maximum number of pods that can be unavailable during updates. |
| metricsPath | string | Path to scrape metrics from. |
| metricsPort | string \| number | Port name or number to scrape metrics from. |
| minAvailable | string \| number | Minimum number of pods that must be available during updates. |
| nodeSelector | {[ key: string ]: string} | Node selector labels for pod scheduling. |
| podAnnotations | {[ key: string ]: string} | Annotations to add to the Pod template metadata. |
| readinessEnabled | boolean | Enable readiness probe for the container. |
| readinessFailureThreshold | number | Minimum consecutive failures for the readiness probe to be considered failed. |
| readinessInitialDelaySeconds | number | Number of seconds after container start before readiness probe is initiated. |
| readinessPeriodSeconds | number | How often (in seconds) to perform the readiness probe. |
| readinessSuccessThreshold | number | Minimum consecutive successes for the readiness probe to be considered successful. |
| readinessTimeoutSeconds | number | Number of seconds after which the readiness probe times out. |
| replicas | number | Number of pod replicas to run. |
| requestCpu | string | CPU request for the container. |
| requestMemory | string | Memory request for the container. |
| securityContext | PloneSecurityContext | Security context for the container. |
| service | PloneServiceSpec | Service configuration: type, trafficDistribution, sessionAffinity, annotations/labels, and a raw `overrides` escape hatch for any other ServiceSpec field. |
| serviceAnnotations | {[ key: string ]: string} | Annotations to add to the Service metadata. |
| servicemonitor | boolean | Enable Prometheus ServiceMonitor for metrics collection. |
---
##### `annotations`Optional
```typescript
public readonly annotations: {[ key: string ]: string};
```
- *Type:* {[ key: string ]: string}
- *Default:* no additional annotations
Annotations to add to the Deployment metadata.
---
*Example*
```typescript
{ 'deployment.kubernetes.io/revision': '1' }
```
##### `environment`Optional
```typescript
public readonly environment: Env;
```
- *Type:* cdk8s-plus-30.Env
- *Default:* undefined (no additional environment variables)
Environment variables to set in the container.
Use cdk8s-plus-30 Env class to define variables and sources.
---
##### `image`Optional
```typescript
public readonly image: string;
```
- *Type:* string
- *Default:* 'plone/plone-backend:latest' for backend, 'plone/plone-frontend:latest' for frontend
Container image to use for the deployment.
---
*Example*
```typescript
'plone/plone-backend:6.0.10' or 'plone/plone-frontend:16.0.0'
```
##### `imagePullPolicy`Optional
```typescript
public readonly imagePullPolicy: string;
```
- *Type:* string
- *Default:* 'IfNotPresent'
Image pull policy for the container.
---
##### `limitCpu`Optional
```typescript
public readonly limitCpu: string;
```
- *Type:* string
- *Default:* '500m' for both backend and frontend
CPU limit for the container.
---
*Example*
```typescript
'500m' or '1' or '2000m'
```
##### `limitMemory`Optional
```typescript
public readonly limitMemory: string;
```
- *Type:* string
- *Default:* '512Mi' for backend, '1Gi' for frontend
Memory limit for the container.
---
*Example*
```typescript
'512Mi' or '1Gi'
```
##### `livenessEnabled`Optional
```typescript
public readonly livenessEnabled: boolean;
```
- *Type:* boolean
- *Default:* false
Enable liveness probe for the container.
Liveness probes determine when to restart a container.
Recommended: true for frontend, false for backend (Zope has its own recovery).
---
##### `livenessFailureThreshold`Optional
```typescript
public readonly livenessFailureThreshold: number;
```
- *Type:* number
- *Default:* 3
Minimum consecutive failures for the liveness probe to be considered failed.
---
##### `livenessInitialDelaySeconds`Optional
```typescript
public readonly livenessInitialDelaySeconds: number;
```
- *Type:* number
- *Default:* 30
Number of seconds after container start before liveness probe is initiated.
---
##### `livenessPeriodSeconds`Optional
```typescript
public readonly livenessPeriodSeconds: number;
```
- *Type:* number
- *Default:* 10
How often (in seconds) to perform the liveness probe.
---
##### `livenessSuccessThreshold`Optional
```typescript
public readonly livenessSuccessThreshold: number;
```
- *Type:* number
- *Default:* 1
Minimum consecutive successes for the liveness probe to be considered successful.
---
##### `livenessTimeoutSeconds`Optional
```typescript
public readonly livenessTimeoutSeconds: number;
```
- *Type:* number
- *Default:* 5
Number of seconds after which the liveness probe times out.
---
##### `maxUnavailable`Optional
```typescript
public readonly maxUnavailable: string | number;
```
- *Type:* string | number
- *Default:* undefined (not set)
Maximum number of pods that can be unavailable during updates.
Can be an absolute number (e.g., 1) or a percentage (e.g., '50%').
Used in PodDisruptionBudget if specified.
---
##### `metricsPath`Optional
```typescript
public readonly metricsPath: string;
```
- *Type:* string
- *Default:* '/metrics'
Path to scrape metrics from.
Only used when servicemonitor is enabled.
---
##### `metricsPort`Optional
```typescript
public readonly metricsPort: string | number;
```
- *Type:* string | number
- *Default:* uses the main service port
Port name or number to scrape metrics from.
Only used when servicemonitor is enabled.
---
##### `minAvailable`Optional
```typescript
public readonly minAvailable: string | number;
```
- *Type:* string | number
- *Default:* undefined (not set)
Minimum number of pods that must be available during updates.
Can be an absolute number (e.g., 1) or a percentage (e.g., '50%').
Used in PodDisruptionBudget if specified.
---
##### `nodeSelector`Optional
```typescript
public readonly nodeSelector: {[ key: string ]: string};
```
- *Type:* {[ key: string ]: string}
- *Default:* no node selector
Node selector labels for pod scheduling.
Use to constrain pods to nodes with matching labels, e.g. for region affinity.
---
*Example*
```typescript
{ 'topology.kubernetes.io/region': 'fsn1' }
```
##### `podAnnotations`Optional
```typescript
public readonly podAnnotations: {[ key: string ]: string};
```
- *Type:* {[ key: string ]: string}
- *Default:* no additional annotations
Annotations to add to the Pod template metadata.
Common for Prometheus, Istio, backup policies, etc.
---
*Example*
```typescript
{ 'prometheus.io/scrape': 'true', 'prometheus.io/port': '8080' }
```
##### `readinessEnabled`Optional
```typescript
public readonly readinessEnabled: boolean;
```
- *Type:* boolean
- *Default:* true
Enable readiness probe for the container.
Readiness probes determine when a container is ready to accept traffic.
---
##### `readinessFailureThreshold`Optional
```typescript
public readonly readinessFailureThreshold: number;
```
- *Type:* number
- *Default:* 3
Minimum consecutive failures for the readiness probe to be considered failed.
---
##### `readinessInitialDelaySeconds`Optional
```typescript
public readonly readinessInitialDelaySeconds: number;
```
- *Type:* number
- *Default:* 10
Number of seconds after container start before readiness probe is initiated.
---
##### `readinessPeriodSeconds`Optional
```typescript
public readonly readinessPeriodSeconds: number;
```
- *Type:* number
- *Default:* 10
How often (in seconds) to perform the readiness probe.
---
##### `readinessSuccessThreshold`Optional
```typescript
public readonly readinessSuccessThreshold: number;
```
- *Type:* number
- *Default:* 1
Minimum consecutive successes for the readiness probe to be considered successful.
---
##### `readinessTimeoutSeconds`Optional
```typescript
public readonly readinessTimeoutSeconds: number;
```
- *Type:* number
- *Default:* 15
Number of seconds after which the readiness probe times out.
---
##### `replicas`Optional
```typescript
public readonly replicas: number;
```
- *Type:* number
- *Default:* 2
Number of pod replicas to run.
---
##### `requestCpu`Optional
```typescript
public readonly requestCpu: string;
```
- *Type:* string
- *Default:* '200m'
CPU request for the container.
---
*Example*
```typescript
'200m' or '0.5'
```
##### `requestMemory`Optional
```typescript
public readonly requestMemory: string;
```
- *Type:* string
- *Default:* '256Mi'
Memory request for the container.
---
*Example*
```typescript
'256Mi' or '512Mi'
```
##### `securityContext`Optional
```typescript
public readonly securityContext: PloneSecurityContext;
```
- *Type:* PloneSecurityContext
- *Default:* no security context
Security context for the container.
Use to set capabilities, run as non-root, read-only filesystem, etc.
---
*Example*
```typescript
{ capabilities: { add: ['SYS_PTRACE'] } }
```
##### `service`Optional
```typescript
public readonly service: PloneServiceSpec;
```
- *Type:* PloneServiceSpec
- *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`~~Optional
- *Deprecated:* use `service.annotations` instead
```typescript
public readonly serviceAnnotations: {[ key: string ]: string};
```
- *Type:* {[ key: string ]: string}
- *Default:* no additional annotations
Annotations to add to the Service metadata.
Common for external-dns, load balancers, service mesh, etc.
---
*Example*
```typescript
{ 'external-dns.alpha.kubernetes.io/hostname': 'plone.example.com' }
```
##### `servicemonitor`Optional
```typescript
public readonly servicemonitor: boolean;
```
- *Type:* boolean
- *Default:* false
Enable Prometheus ServiceMonitor for metrics collection.
Requires Prometheus Operator to be installed in the cluster.
When enabled, a ServiceMonitor resource will be created to scrape metrics.
---
### PloneCapabilities
Linux capabilities to add or drop on a container.
#### Initializer
```typescript
import { PloneCapabilities } from '@bluedynamics/cdk8s-plone'
const ploneCapabilities: PloneCapabilities = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| add | string[] | Capabilities to add (e.g. 'SYS_PTRACE', 'NET_ADMIN'). |
| drop | string[] | Capabilities to drop (e.g. 'ALL', 'NET_RAW'). |
---
##### `add`Optional
```typescript
public readonly add: string[];
```
- *Type:* string[]
- *Default:* no capabilities added
Capabilities to add (e.g. 'SYS_PTRACE', 'NET_ADMIN').
---
##### `drop`Optional
```typescript
public readonly drop: string[];
```
- *Type:* string[]
- *Default:* no capabilities dropped
Capabilities to drop (e.g. 'ALL', 'NET_RAW').
---
### PloneHttpcacheOptions
Configuration options for PloneHttpcache (Varnish caching layer).
#### Initializer
```typescript
import { PloneHttpcacheOptions } from '@bluedynamics/cdk8s-plone'
const ploneHttpcacheOptions: PloneHttpcacheOptions = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| plone | Plone | The Plone construct to attach the HTTP cache to. |
| appVersion | string | Version of the kube-httpcache Container Image to use. |
| chartVersion | string | Version of the kube-httpcache Helm chart to use. |
| existingSecret | string | Name of an existing Kubernetes secret containing Varnish admin credentials. |
| exporterEnabled | boolean | Enable the Prometheus exporter for Varnish metrics. |
| extraEnvVars | HttpcacheEnvVar[] | Additional environment variables to pass to the kube-httpcache container. |
| limitCpu | string | CPU limit for Varnish pods. |
| limitMemory | string | Memory limit for Varnish pods. |
| replicas | number | Number of Varnish pod replicas to run. |
| requestCpu | string | CPU request for Varnish pods. |
| requestMemory | string | Memory request for Varnish pods. |
| servicemonitor | boolean | Enable Prometheus ServiceMonitor for metrics collection. |
| tolerations | HttpcacheToleration[] | Tolerations for the Varnish pods. |
| varnishVcl | string | Varnish VCL configuration as a string. |
| varnishVclFile | string | Path to a Varnish VCL configuration file. |
---
##### `plone`Required
```typescript
public readonly plone: Plone;
```
- *Type:* Plone
The Plone construct to attach the HTTP cache to.
The cache will automatically connect to the backend and frontend services.
---
##### `appVersion`Optional
```typescript
public readonly appVersion: string;
```
- *Type:* string
- *Default:* undefined (chartVersion = with each chart release there is an image release too )
Version of the kube-httpcache Container Image to use.
If not specified, the latest version from the repository will be used.
---
##### `chartVersion`Optional
```typescript
public readonly chartVersion: string;
```
- *Type:* string
- *Default:* undefined (latest)
Version of the kube-httpcache Helm chart to use.
If not specified, the latest version from the repository will be used.
---
##### `existingSecret`Optional
```typescript
public readonly existingSecret: string;
```
- *Type:* string
- *Default:* undefined (no existing secret)
Name of an existing Kubernetes secret containing Varnish admin credentials.
The secret should be created separately in the same namespace.
---
##### `exporterEnabled`Optional
```typescript
public readonly exporterEnabled: boolean;
```
- *Type:* boolean
- *Default:* true
Enable the Prometheus exporter for Varnish metrics.
When enabled, the exporter sidecar container will be deployed alongside Varnish.
---
##### `extraEnvVars`Optional
```typescript
public readonly extraEnvVars: HttpcacheEnvVar[];
```
- *Type:* HttpcacheEnvVar[]
- *Default:* no additional env vars
Additional environment variables to pass to the kube-httpcache container.
These are appended to the built-in env vars (BACKEND_SERVICE_NAME, etc.)
and can be referenced in VCL templates using Go template syntax: {{ .Env.VAR_NAME }}
---
##### `limitCpu`Optional
```typescript
public readonly limitCpu: string;
```
- *Type:* string
- *Default:* '500m'
CPU limit for Varnish pods.
---
##### `limitMemory`Optional
```typescript
public readonly limitMemory: string;
```
- *Type:* string
- *Default:* '500Mi'
Memory limit for Varnish pods.
---
##### `replicas`Optional
```typescript
public readonly replicas: number;
```
- *Type:* number
- *Default:* 2
Number of Varnish pod replicas to run.
---
##### `requestCpu`Optional
```typescript
public readonly requestCpu: string;
```
- *Type:* string
- *Default:* '100m'
CPU request for Varnish pods.
---
##### `requestMemory`Optional
```typescript
public readonly requestMemory: string;
```
- *Type:* string
- *Default:* '100Mi'
Memory request for Varnish pods.
---
##### `servicemonitor`Optional
```typescript
public readonly servicemonitor: boolean;
```
- *Type:* boolean
- *Default:* false
Enable Prometheus ServiceMonitor for metrics collection.
Requires Prometheus Operator to be installed in the cluster.
---
##### `tolerations`Optional
```typescript
public readonly tolerations: HttpcacheToleration[];
```
- *Type:* HttpcacheToleration[]
- *Default:* no tolerations
Tolerations for the Varnish pods.
Use this to allow scheduling on nodes with specific taints,
e.g. nodes tainted with kubernetes.io/arch=amd64:NoSchedule.
---
##### `varnishVcl`Optional
```typescript
public readonly varnishVcl: string;
```
- *Type:* string
- *Default:* loaded from varnishVclFile or default config file
Varnish VCL configuration as a string.
If provided, this takes precedence over varnishVclFile.
---
##### `varnishVclFile`Optional
```typescript
public readonly varnishVclFile: string;
```
- *Type:* string
- *Default:* uses default config/varnish.tpl.vcl
Path to a Varnish VCL configuration file.
If not provided, uses the default VCL file included in the library.
---
### PloneOptions
Main configuration options for Plone deployment.
#### Initializer
```typescript
import { PloneOptions } from '@bluedynamics/cdk8s-plone'
const ploneOptions: PloneOptions = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| backend | PloneBaseOptions | Backend (Plone API) configuration. |
| frontend | PloneBaseOptions | Frontend (Volto) configuration. |
| imagePullSecrets | string[] | Names of Kubernetes secrets to use for pulling private container images. |
| siteId | string | Plone site ID in the ZODB. |
| variant | PloneVariant | Plone deployment variant to use. |
| version | string | Version string for labeling the deployment. |
---
##### `backend`Optional
```typescript
public readonly backend: PloneBaseOptions;
```
- *Type:* PloneBaseOptions
- *Default:* {} (uses default values from PloneBaseOptions)
Backend (Plone API) configuration.
---
##### `frontend`Optional
```typescript
public readonly frontend: PloneBaseOptions;
```
- *Type:* PloneBaseOptions
- *Default:* {} (uses default values from PloneBaseOptions)
Frontend (Volto) configuration.
Only used when variant is PloneVariant.VOLTO.
---
##### `imagePullSecrets`Optional
```typescript
public readonly imagePullSecrets: string[];
```
- *Type:* string[]
- *Default:* [] (no image pull secrets)
Names of Kubernetes secrets to use for pulling private container images.
These secrets must exist in the same namespace as the deployment.
---
*Example*
```typescript
['my-registry-secret']
```
##### `siteId`Optional
```typescript
public readonly siteId: string;
```
- *Type:* string
- *Default:* 'Plone'
Plone site ID in the ZODB.
This is used to construct the internal API path for Volto frontend.
---
##### `variant`Optional
```typescript
public readonly variant: PloneVariant;
```
- *Type:* PloneVariant
- *Default:* PloneVariant.VOLTO
Plone deployment variant to use.
---
##### `version`Optional
```typescript
public readonly version: string;
```
- *Type:* string
- *Default:* 'undefined'
Version string for labeling the deployment.
This is used in Kubernetes labels and doesn't affect the actual image versions.
---
### PloneSecurityContext
Security context for a Plone container.
Controls privilege and access settings.
#### Initializer
```typescript
import { PloneSecurityContext } from '@bluedynamics/cdk8s-plone'
const ploneSecurityContext: PloneSecurityContext = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| allowPrivilegeEscalation | boolean | Allow privilege escalation for the container process. |
| capabilities | PloneCapabilities | Linux capabilities to add or drop. |
| privileged | boolean | Run the container in privileged mode. |
| readOnlyRootFilesystem | boolean | Mount the root filesystem as read-only. |
| runAsGroup | number | Run the container as a specific group ID. |
| runAsNonRoot | boolean | Require the container to run as non-root. |
| runAsUser | number | Run the container as a specific user ID. |
---
##### `allowPrivilegeEscalation`Optional
```typescript
public readonly allowPrivilegeEscalation: boolean;
```
- *Type:* boolean
- *Default:* undefined
Allow privilege escalation for the container process.
---
##### `capabilities`Optional
```typescript
public readonly capabilities: PloneCapabilities;
```
- *Type:* PloneCapabilities
- *Default:* no capability changes
Linux capabilities to add or drop.
---
*Example*
```typescript
{ add: ['SYS_PTRACE'] }
```
##### `privileged`Optional
```typescript
public readonly privileged: boolean;
```
- *Type:* boolean
- *Default:* undefined
Run the container in privileged mode.
---
##### `readOnlyRootFilesystem`Optional
```typescript
public readonly readOnlyRootFilesystem: boolean;
```
- *Type:* boolean
- *Default:* undefined
Mount the root filesystem as read-only.
---
##### `runAsGroup`Optional
```typescript
public readonly runAsGroup: number;
```
- *Type:* number
- *Default:* container default
Run the container as a specific group ID.
---
##### `runAsNonRoot`Optional
```typescript
public readonly runAsNonRoot: boolean;
```
- *Type:* boolean
- *Default:* undefined
Require the container to run as non-root.
---
##### `runAsUser`Optional
```typescript
public readonly runAsUser: number;
```
- *Type:* number
- *Default:* container default
Run the container as a specific user ID.
---
### PloneServiceSpec
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
```typescript
import { PloneServiceSpec } from '@bluedynamics/cdk8s-plone'
const ploneServiceSpec: PloneServiceSpec = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| annotations | {[ key: string ]: string} | Annotations to add to the Service metadata. |
| externalTrafficPolicy | string | External traffic policy, 'Cluster' \| 'Local'. |
| internalTrafficPolicy | string | Internal traffic policy, 'Cluster' \| 'Local'. |
| labels | {[ key: string ]: string} | Extra labels to add to the Service metadata. |
| loadBalancerClass | string | Load balancer implementation class. |
| loadBalancerSourceRanges | string[] | Source IP ranges allowed to access a LoadBalancer service. |
| overrides | {[ key: string ]: any} | 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 | boolean | Publish not-ready addresses (e.g. for headless services with StatefulSets). |
| sessionAffinity | string | Session affinity, 'ClientIP' \| 'None'. |
| trafficDistribution | string | Traffic distribution preference, e.g. 'PreferClose' for topology-aware routing. |
| type | string | Service type, e.g. ClusterIP \| NodePort \| LoadBalancer \| ExternalName. |
---
##### `annotations`Optional
```typescript
public readonly annotations: {[ key: string ]: string};
```
- *Type:* {[ key: string ]: string}
- *Default:* none
Annotations to add to the Service metadata.
---
##### `externalTrafficPolicy`Optional
```typescript
public readonly externalTrafficPolicy: string;
```
- *Type:* string
- *Default:* Cluster (Kubernetes default)
External traffic policy, 'Cluster' | 'Local'.
---
##### `internalTrafficPolicy`Optional
```typescript
public readonly internalTrafficPolicy: string;
```
- *Type:* string
- *Default:* Cluster (Kubernetes default)
Internal traffic policy, 'Cluster' | 'Local'.
---
##### `labels`Optional
```typescript
public readonly labels: {[ key: string ]: string};
```
- *Type:* {[ key: string ]: string}
- *Default:* none
Extra labels to add to the Service metadata.
---
##### `loadBalancerClass`Optional
```typescript
public readonly loadBalancerClass: string;
```
- *Type:* string
- *Default:* none
Load balancer implementation class.
---
##### `loadBalancerSourceRanges`Optional
```typescript
public readonly loadBalancerSourceRanges: string[];
```
- *Type:* string[]
- *Default:* none
Source IP ranges allowed to access a LoadBalancer service.
---
##### `overrides`Optional
```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`Optional
```typescript
public readonly publishNotReadyAddresses: boolean;
```
- *Type:* boolean
- *Default:* false
Publish not-ready addresses (e.g. for headless services with StatefulSets).
---
##### `sessionAffinity`Optional
```typescript
public readonly sessionAffinity: string;
```
- *Type:* string
- *Default:* None (Kubernetes default)
Session affinity, 'ClientIP' | 'None'.
---
##### `trafficDistribution`Optional
```typescript
public readonly trafficDistribution: string;
```
- *Type:* string
- *Default:* none
Traffic distribution preference, e.g. 'PreferClose' for topology-aware routing.
---
##### `type`Optional
```typescript
public readonly type: string;
```
- *Type:* string
- *Default:* ClusterIP (Kubernetes default)
Service type, e.g. ClusterIP | NodePort | LoadBalancer | ExternalName.
---
### PloneVinylCacheOptions
Configuration options for PloneVinylCache (cloud-vinyl operator).
Creates a VinylCache custom resource that the cloud-vinyl operator
reconciles into a Varnish Cache cluster with agent-based VCL delivery.
Requires the cloud-vinyl operator to be installed in the cluster.
#### Initializer
```typescript
import { PloneVinylCacheOptions } from '@bluedynamics/cdk8s-plone'
const ploneVinylCacheOptions: PloneVinylCacheOptions = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| plone | Plone | The Plone construct to attach the cache to. |
| director | string | Director type for load distribution. |
| extraBackends | VinylCacheBackend[] | Additional backends to add after the auto-generated Plone backends. |
| image | string | Container image for the Varnish pods. |
| invalidation | boolean | Enable cache invalidation (PURGE, BAN, xkey). |
| limitCpu | string | CPU limit for Varnish pods. |
| limitMemory | string | Memory limit for Varnish pods. |
| monitoring | boolean | Enable Prometheus monitoring. |
| nodeSelector | {[ key: string ]: string} | Node selector labels for the Varnish pods. |
| replicas | number | Number of Varnish pod replicas. |
| requestCpu | string | CPU request for Varnish pods. |
| requestMemory | string | Memory request for Varnish pods. |
| shardBy | string | Shard director: what value is hashed for shard selection. |
| shardHealthy | string | Shard director: which backends the director considers when selecting a shard. |
| shardRampup | string | Shard director: time after adding a backend before it receives its full share of traffic, preventing thundering-herd. |
| shardReplicas | number | Shard director: number of Ketama replicas per backend in the hash ring. |
| storage | VinylCacheStorage[] | Varnish storage backends (`spec.storage`). |
| tolerations | VinylCacheToleration[] | Tolerations for the Varnish pods. |
| vclBackendErrorSnippet | string | Custom VCL snippet for vcl_backend_error subroutine. |
| vclBackendFetchSnippet | string | Custom VCL snippet for vcl_backend_fetch subroutine. |
| vclBackendResponseSnippet | string | Custom VCL snippet for vcl_backend_response subroutine. |
| vclDeliverSnippet | string | Custom VCL snippet for vcl_deliver subroutine. |
| vclFiniSnippet | string | Custom VCL snippet for vcl_fini subroutine. |
| vclHashSnippet | string | Custom VCL snippet for vcl_hash subroutine. |
| vclHitSnippet | string | Custom VCL snippet for vcl_hit subroutine. |
| vclInitSnippet | string | Custom VCL snippet for vcl_init subroutine. |
| vclMissSnippet | string | Custom VCL snippet for vcl_miss subroutine. |
| vclPassSnippet | string | Custom VCL snippet for vcl_pass subroutine. |
| vclPipeSnippet | string | Custom VCL snippet for vcl_pipe subroutine. |
| vclPurgeSnippet | string | Custom VCL snippet for vcl_purge subroutine. |
| vclRecvSnippet | string | Custom VCL snippet for vcl_recv subroutine. |
| vclSynthSnippet | string | Custom VCL snippet for vcl_synth subroutine. |
---
##### `plone`Required
```typescript
public readonly plone: Plone;
```
- *Type:* Plone
The Plone construct to attach the cache to.
Backends are auto-configured from the Plone services.
---
##### `director`Optional
```typescript
public readonly director: string;
```
- *Type:* string
- *Default:* 'shard'
Director type for load distribution.
---
##### `extraBackends`Optional
```typescript
public readonly extraBackends: VinylCacheBackend[];
```
- *Type:* VinylCacheBackend[]
- *Default:* no extra backends
Additional backends to add after the auto-generated Plone backends.
Uses the same backend type structure as the VinylCache CRD.
---
##### `image`Optional
```typescript
public readonly image: string;
```
- *Type:* string
- *Default:* 'varnish:7.6'
Container image for the Varnish pods.
---
##### `invalidation`Optional
```typescript
public readonly invalidation: boolean;
```
- *Type:* boolean
- *Default:* true
Enable cache invalidation (PURGE, BAN, xkey).
---
##### `limitCpu`Optional
```typescript
public readonly limitCpu: string;
```
- *Type:* string
- *Default:* '500m'
CPU limit for Varnish pods.
---
##### `limitMemory`Optional
```typescript
public readonly limitMemory: string;
```
- *Type:* string
- *Default:* '512Mi'
Memory limit for Varnish pods.
---
##### `monitoring`Optional
```typescript
public readonly monitoring: boolean;
```
- *Type:* boolean
- *Default:* false
Enable Prometheus monitoring.
When true this turns on operator metrics,
a ServiceMonitor, and the prometheus_varnish_exporter sidecar (required
for cache hit-ratio and backend-health metrics).
---
##### `nodeSelector`Optional
```typescript
public readonly nodeSelector: {[ key: string ]: string};
```
- *Type:* {[ key: string ]: string}
- *Default:* no node selector
Node selector labels for the Varnish pods.
Constrains pods to nodes matching all specified labels.
---
##### `replicas`Optional
```typescript
public readonly replicas: number;
```
- *Type:* number
- *Default:* 2
Number of Varnish pod replicas.
---
##### `requestCpu`Optional
```typescript
public readonly requestCpu: string;
```
- *Type:* string
- *Default:* '100m'
CPU request for Varnish pods.
---
##### `requestMemory`Optional
```typescript
public readonly requestMemory: string;
```
- *Type:* string
- *Default:* '256Mi'
Memory request for Varnish pods.
---
##### `shardBy`Optional
```typescript
public readonly shardBy: string;
```
- *Type:* string
- *Default:* operator default ("HASH")
Shard director: what value is hashed for shard selection.
"HASH" uses the Varnish hash (default); "URL" uses the request URL.
Only applied when director is "shard".
Requires cloud-vinyl operator >= 0.4.2.
---
##### `shardHealthy`Optional
```typescript
public readonly shardHealthy: string;
```
- *Type:* string
- *Default:* operator default ("CHOSEN")
Shard director: which backends the director considers when selecting a shard.
"CHOSEN" (default) only considers the chosen backend healthy; "ALL" requires all
backends to be healthy.
Only applied when director is "shard".
Requires cloud-vinyl operator >= 0.4.2.
---
##### `shardRampup`Optional
```typescript
public readonly shardRampup: string;
```
- *Type:* string
- *Default:* operator default ("30s")
Shard director: time after adding a backend before it receives its full share of traffic, preventing thundering-herd.
Only applied when director is "shard".
---
##### `shardReplicas`Optional
```typescript
public readonly shardReplicas: number;
```
- *Type:* number
- *Default:* operator default (67)
Shard director: number of Ketama replicas per backend in the hash ring.
Only applied when director is "shard".
---
##### `storage`Optional
```typescript
public readonly storage: VinylCacheStorage[];
```
- *Type:* VinylCacheStorage[]
- *Default:* no storage configured; operator uses varnishd default (~100MB malloc)
Varnish storage backends (`spec.storage`).
Each entry becomes a `-s =,` argument to varnishd.
If omitted, the operator ships varnishd with its stock default (~100 MB
malloc) — almost always too small. Set an explicit malloc size at least
matching the pod's memory request to use the allocated memory for caching.
---
*Example*
```typescript
storage: [{ name: 's0', type: 'malloc', size: '1Gi' }]
```
##### `tolerations`Optional
```typescript
public readonly tolerations: VinylCacheToleration[];
```
- *Type:* VinylCacheToleration[]
- *Default:* no tolerations
Tolerations for the Varnish pods.
---
##### `vclBackendErrorSnippet`Optional
```typescript
public readonly vclBackendErrorSnippet: string;
```
- *Type:* string
- *Default:* no snippet
Custom VCL snippet for vcl_backend_error subroutine.
---
##### `vclBackendFetchSnippet`Optional
```typescript
public readonly vclBackendFetchSnippet: string;
```
- *Type:* string
- *Default:* no snippet
Custom VCL snippet for vcl_backend_fetch subroutine.
---
##### `vclBackendResponseSnippet`Optional
```typescript
public readonly vclBackendResponseSnippet: string;
```
- *Type:* string
- *Default:* uses built-in plone-vinyl-backend-response.vcl
Custom VCL snippet for vcl_backend_response subroutine.
Replaces the default Plone backend_response snippet.
---
##### `vclDeliverSnippet`Optional
```typescript
public readonly vclDeliverSnippet: string;
```
- *Type:* string
- *Default:* no snippet
Custom VCL snippet for vcl_deliver subroutine.
---
##### `vclFiniSnippet`Optional
```typescript
public readonly vclFiniSnippet: string;
```
- *Type:* string
- *Default:* no snippet
Custom VCL snippet for vcl_fini subroutine.
---
##### `vclHashSnippet`Optional
```typescript
public readonly vclHashSnippet: string;
```
- *Type:* string
- *Default:* no snippet
Custom VCL snippet for vcl_hash subroutine.
---
##### `vclHitSnippet`Optional
```typescript
public readonly vclHitSnippet: string;
```
- *Type:* string
- *Default:* no snippet
Custom VCL snippet for vcl_hit subroutine.
---
##### `vclInitSnippet`Optional
```typescript
public readonly vclInitSnippet: string;
```
- *Type:* string
- *Default:* no snippet
Custom VCL snippet for vcl_init subroutine.
---
##### `vclMissSnippet`Optional
```typescript
public readonly vclMissSnippet: string;
```
- *Type:* string
- *Default:* no snippet
Custom VCL snippet for vcl_miss subroutine.
---
##### `vclPassSnippet`Optional
```typescript
public readonly vclPassSnippet: string;
```
- *Type:* string
- *Default:* no snippet
Custom VCL snippet for vcl_pass subroutine.
---
##### `vclPipeSnippet`Optional
```typescript
public readonly vclPipeSnippet: string;
```
- *Type:* string
- *Default:* no snippet
Custom VCL snippet for vcl_pipe subroutine.
---
##### `vclPurgeSnippet`Optional
```typescript
public readonly vclPurgeSnippet: string;
```
- *Type:* string
- *Default:* no snippet
Custom VCL snippet for vcl_purge subroutine.
---
##### `vclRecvSnippet`Optional
```typescript
public readonly vclRecvSnippet: string;
```
- *Type:* string
- *Default:* uses built-in plone-vinyl-recv.vcl
Custom VCL snippet for vcl_recv subroutine.
Replaces the default Plone recv snippet.
---
##### `vclSynthSnippet`Optional
```typescript
public readonly vclSynthSnippet: string;
```
- *Type:* string
- *Default:* no snippet
Custom VCL snippet for vcl_synth subroutine.
---
### VinylCacheBackend
An additional backend for the VinylCache.
#### Initializer
```typescript
import { VinylCacheBackend } from '@bluedynamics/cdk8s-plone'
const vinylCacheBackend: VinylCacheBackend = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| name | string | VCL identifier for this backend. |
| port | number | Port to use for this backend. |
| serviceName | string | Kubernetes Service name to use as backend. |
| probe | VinylCacheBackendProbe | Health probe configuration. |
| weight | number | Relative weight for the director. |
---
##### `name`Required
```typescript
public readonly name: string;
```
- *Type:* string
VCL identifier for this backend.
Must match ^[a-zA-Z][a-zA-Z0-9_]*$.
---
##### `port`Required
```typescript
public readonly port: number;
```
- *Type:* number
Port to use for this backend.
---
##### `serviceName`Required
```typescript
public readonly serviceName: string;
```
- *Type:* string
Kubernetes Service name to use as backend.
---
##### `probe`Optional
```typescript
public readonly probe: VinylCacheBackendProbe;
```
- *Type:* VinylCacheBackendProbe
- *Default:* no probe
Health probe configuration.
---
##### `weight`Optional
```typescript
public readonly weight: number;
```
- *Type:* number
- *Default:* operator default
Relative weight for the director.
0 means standby.
---
### VinylCacheBackendProbe
Health probe configuration for a VinylCache backend.
#### Initializer
```typescript
import { VinylCacheBackendProbe } from '@bluedynamics/cdk8s-plone'
const vinylCacheBackendProbe: VinylCacheBackendProbe = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| expectedResponse | number | Expected HTTP response status code. |
| interval | string | How often to probe the backend. |
| threshold | number | Minimum successful probes within window for healthy status. |
| timeout | string | Maximum time to wait for a probe response. |
| url | string | URL to probe. |
| window | number | Number of most recent probes to consider. |
---
##### `expectedResponse`Optional
```typescript
public readonly expectedResponse: number;
```
- *Type:* number
- *Default:* 200
Expected HTTP response status code.
---
##### `interval`Optional
```typescript
public readonly interval: string;
```
- *Type:* string
- *Default:* '5s'
How often to probe the backend.
---
##### `threshold`Optional
```typescript
public readonly threshold: number;
```
- *Type:* number
- *Default:* 8
Minimum successful probes within window for healthy status.
---
##### `timeout`Optional
```typescript
public readonly timeout: string;
```
- *Type:* string
- *Default:* '2s'
Maximum time to wait for a probe response.
---
##### `url`Optional
```typescript
public readonly url: string;
```
- *Type:* string
- *Default:* '/'
URL to probe.
---
##### `window`Optional
```typescript
public readonly window: number;
```
- *Type:* number
- *Default:* 10
Number of most recent probes to consider.
---
### VinylCacheStorage
A Varnish storage backend configuration.
Maps to `spec.storage[]` on the VinylCache CRD. The operator emits one
`-s =,` argument per entry to varnishd.
Without any storage entry the operator falls back to the varnishd default
(~100 MB malloc), which is almost always too small for real workloads.
#### Initializer
```typescript
import { VinylCacheStorage } from '@bluedynamics/cdk8s-plone'
const vinylCacheStorage: VinylCacheStorage = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| name | string | Internal storage identifier used in the varnishd `-s` argument. |
| type | string | Storage backend type. |
| path | string | Filesystem path for file-type storage. |
| size | string | Storage allocation as a Kubernetes resource quantity (e.g. "1Gi", "500M"). Required for malloc; required for file. |
---
##### `name`Required
```typescript
public readonly name: string;
```
- *Type:* string
Internal storage identifier used in the varnishd `-s` argument.
Must be unique within the VinylCache and match `^[a-zA-Z][a-zA-Z0-9_]*$`.
---
##### `type`Required
```typescript
public readonly type: string;
```
- *Type:* string
Storage backend type.
Only "malloc" and "file" are permitted by the
admission webhook.
---
##### `path`Optional
```typescript
public readonly path: string;
```
- *Type:* string
- *Default:* required for type "file"
Filesystem path for file-type storage.
Ignored for malloc.
---
##### `size`Optional
```typescript
public readonly size: string;
```
- *Type:* string
- *Default:* required for both malloc and file
Storage allocation as a Kubernetes resource quantity (e.g. "1Gi", "500M"). Required for malloc; required for file.
---
### VinylCacheToleration
A Kubernetes toleration for the Varnish pods.
#### Initializer
```typescript
import { VinylCacheToleration } from '@bluedynamics/cdk8s-plone'
const vinylCacheToleration: VinylCacheToleration = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| key | string | The taint key to tolerate. |
| effect | string | The taint effect to tolerate (NoSchedule, PreferNoSchedule, NoExecute). |
| operator | string | The operator (Equal or Exists). |
| value | string | The taint value to match (when operator is Equal). |
---
##### `key`Required
```typescript
public readonly key: string;
```
- *Type:* string
The taint key to tolerate.
---
##### `effect`Optional
```typescript
public readonly effect: string;
```
- *Type:* string
- *Default:* tolerate all effects
The taint effect to tolerate (NoSchedule, PreferNoSchedule, NoExecute).
---
##### `operator`Optional
```typescript
public readonly operator: string;
```
- *Type:* string
- *Default:* 'Equal'
The operator (Equal or Exists).
---
##### `value`Optional
```typescript
public readonly value: string;
```
- *Type:* string
- *Default:* no value
The taint value to match (when operator is Equal).
---
## Enums
### PloneVariant
Plone deployment variants.
#### Members
| **Name** | **Description** |
| --- | --- |
| VOLTO | Volto variant: ReactJS single-page frontend (Volto) talking to the Plone REST API. |
| BLICCA | Blicca variant: the Plone backend renders the UI server-side and serves the HTML directly. |
| CLASSICUI | Deprecated alias for the Blicca variant (formerly "Classic UI"). |
---
##### `VOLTO`
Volto variant: ReactJS single-page frontend (Volto) talking to the Plone REST API.
Deploys both frontend and backend services.
---
##### `BLICCA`
Blicca variant: the Plone backend renders the UI server-side and serves the HTML directly.
Deploys only the backend service.
---
##### ~~`CLASSICUI`~~
- *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").
---