@bluedynamics/cdk8s-plone 0.1.35 → 0.1.37

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,4 +1,13 @@
1
- # API Reference
1
+ ---
2
+ myst:
3
+ html_meta:
4
+ "description": "Auto-generated API reference for cdk8s-plone constructs, interfaces, and enums."
5
+ "property=og:description": "Auto-generated API reference for cdk8s-plone constructs, interfaces, and enums."
6
+ "property=og:title": "API reference"
7
+ "keywords": "Plone, cdk8s, Kubernetes, API, reference, TypeScript, Python"
8
+ ---
9
+
10
+ # API reference
2
11
 
3
12
  Complete API reference for cdk8s-plone constructs, generated from TypeScript source code.
4
13
 
@@ -9,7 +18,7 @@ The cdk8s-plone library provides the following main constructs:
9
18
  - **Plone**: Main construct for deploying Plone CMS with support for both Volto (React frontend) and Classic UI variants
10
19
  - **PloneHttpcache**: HTTP caching layer using Varnish for improved performance
11
20
 
12
- ## Language Support
21
+ ## Language support
13
22
 
14
23
  This API documentation shows TypeScript usage examples. The library is also available for Python via JSII transpilation:
15
24
 
@@ -1,8 +1,17 @@
1
- # Configuration Options
1
+ ---
2
+ myst:
3
+ html_meta:
4
+ "description": "Complete reference for cdk8s-plone constructs and configuration options: Plone, PloneHttpcache, PloneVinylCache."
5
+ "property=og:description": "Complete reference for cdk8s-plone constructs and configuration options: Plone, PloneHttpcache, PloneVinylCache."
6
+ "property=og:title": "Configuration options"
7
+ "keywords": "Plone, cdk8s, Kubernetes, configuration, reference, Volto, Varnish"
8
+ ---
9
+
10
+ # Configuration options
2
11
 
3
12
  Complete reference for all configuration options in cdk8s-plone.
4
13
 
5
- ## Key Constructs
14
+ ## Key constructs
6
15
 
7
16
  ### `Plone`
8
17
 
@@ -56,7 +65,7 @@ new PloneHttpcache(chart, 'cache', {
56
65
 
57
66
  ---
58
67
 
59
- ## Configuration Interfaces
68
+ ## Configuration interfaces
60
69
 
61
70
  ### `PloneOptions`
62
71
 
@@ -89,14 +98,14 @@ const options: PloneOptions = {
89
98
 
90
99
  Configuration for backend or frontend components.
91
100
 
92
- #### Container Configuration
101
+ #### Container configuration
93
102
 
94
103
  | Property | Type | Required | Default | Description |
95
104
  |----------|------|----------|---------|-------------|
96
- | `image` | `string` | Yes | - | Container image (e.g., 'plone/plone-backend:6.1.3') |
97
- | `imagePullPolicy` | `string` | No | `'IfNotPresent'` | Image pull policy |
105
+ | `image` | `string` | No | `plone/plone-backend:latest` (backend) / `plone/plone-frontend:latest` (frontend) | Container image |
106
+ | `imagePullPolicy` | `string` | No | `IfNotPresent` | Image pull policy |
98
107
  | `replicas` | `number` | No | `2` | Number of pod replicas |
99
- | `environment` | `Env` | No | - | Environment variables (cdk8s-plus-30.Env) |
108
+ | `environment` | `Env` | No | - | Environment variables (cdk8s-plus-30 `Env`) |
100
109
 
101
110
  **Example:**
102
111
  ```typescript
@@ -115,14 +124,14 @@ backend: {
115
124
  }
116
125
  ```
117
126
 
118
- #### Resource Configuration
127
+ #### Resource configuration
119
128
 
120
- | Property | Type | Description |
121
- |----------|------|-------------|
122
- | `requestCpu` | `string` | CPU request (e.g., '500m', '1') |
123
- | `limitCpu` | `string` | CPU limit |
124
- | `requestMemory` | `string` | Memory request (e.g., '512Mi', '1Gi') |
125
- | `limitMemory` | `string` | Memory limit |
129
+ | Property | Type | Default | Description |
130
+ |----------|------|---------|-------------|
131
+ | `requestCpu` | `string` | `200m` | CPU request |
132
+ | `limitCpu` | `string` | `500m` | CPU limit |
133
+ | `requestMemory` | `string` | `256Mi` | Memory request |
134
+ | `limitMemory` | `string` | `512Mi` (backend) / `1Gi` (frontend) | Memory limit |
126
135
 
127
136
  **Example:**
128
137
  ```typescript
@@ -135,12 +144,12 @@ backend: {
135
144
  }
136
145
  ```
137
146
 
138
- #### High Availability
147
+ #### High availability
139
148
 
140
149
  | Property | Type | Description |
141
150
  |----------|------|-------------|
142
- | `minAvailable` | `number` | Minimum pods available during updates (for PodDisruptionBudget) |
143
- | `maxUnavailable` | `number` | Maximum unavailable pods during updates |
151
+ | `minAvailable` | `number \| string` | Minimum pods available during updates (for PodDisruptionBudget). Accepts an absolute number or a percentage string such as `"50%"`. |
152
+ | `maxUnavailable` | `number \| string` | Maximum unavailable pods during updates. Accepts an absolute number or a percentage string such as `"50%"`. |
144
153
 
145
154
  **Example:**
146
155
  ```typescript
@@ -151,16 +160,16 @@ backend: {
151
160
  }
152
161
  ```
153
162
 
154
- #### Readiness Probe
163
+ #### Readiness probe
155
164
 
156
165
  | Property | Type | Default | Description |
157
166
  |----------|------|---------|-------------|
158
167
  | `readinessEnabled` | `boolean` | `true` | Enable readiness probe |
159
- | `readinessInitialDelaySeconds` | `number` | - | Seconds before first probe |
160
- | `readinessTimeoutSeconds` | `number` | - | Probe timeout |
161
- | `readinessPeriodSeconds` | `number` | - | Probe frequency |
162
- | `readinessSuccessThreshold` | `number` | - | Consecutive successes required |
163
- | `readinessFailureThreshold` | `number` | - | Consecutive failures before marking unready |
168
+ | `readinessInitialDelaySeconds` | `number` | `10` | Seconds before first probe |
169
+ | `readinessTimeoutSeconds` | `number` | `15` | Probe timeout |
170
+ | `readinessPeriodSeconds` | `number` | `10` | Probe frequency |
171
+ | `readinessSuccessThreshold` | `number` | `1` | Consecutive successes required |
172
+ | `readinessFailureThreshold` | `number` | `3` | Consecutive failures before marking unready |
164
173
 
165
174
  **Example:**
166
175
  ```typescript
@@ -174,16 +183,16 @@ backend: {
174
183
  }
175
184
  ```
176
185
 
177
- #### Liveness Probe
186
+ #### Liveness probe
178
187
 
179
188
  | Property | Type | Default | Description |
180
189
  |----------|------|---------|-------------|
181
190
  | `livenessEnabled` | `boolean` | `false` | Enable liveness probe (recommended `true` for frontend) |
182
- | `livenessInitialDelaySeconds` | `number` | - | Seconds before first probe |
183
- | `livenessTimeoutSeconds` | `number` | - | Probe timeout |
184
- | `livenessPeriodSeconds` | `number` | - | Probe frequency |
185
- | `livenessSuccessThreshold` | `number` | - | Consecutive successes required |
186
- | `livenessFailureThreshold` | `number` | - | Consecutive failures before restart |
191
+ | `livenessInitialDelaySeconds` | `number` | `30` | Seconds before first probe |
192
+ | `livenessTimeoutSeconds` | `number` | `5` | Probe timeout |
193
+ | `livenessPeriodSeconds` | `number` | `10` | Probe frequency |
194
+ | `livenessSuccessThreshold` | `number` | `1` | Consecutive successes required |
195
+ | `livenessFailureThreshold` | `number` | `3` | Consecutive failures before restart |
187
196
 
188
197
  **Example:**
189
198
  ```typescript
@@ -219,6 +228,94 @@ backend: {
219
228
  }
220
229
  ```
221
230
 
231
+ (monitoring)=
232
+
233
+ #### Prometheus monitoring
234
+
235
+ | Property | Type | Default | Description |
236
+ |----------|------|---------|-------------|
237
+ | `servicemonitor` | `boolean` | `false` | Create a Prometheus `ServiceMonitor` for this component. Requires the Prometheus Operator. |
238
+ | `metricsPort` | `string \| number` | main service port | Service port name or number that exposes metrics. |
239
+ | `metricsPath` | `string` | `/metrics` | HTTP path the Prometheus scraper requests. |
240
+
241
+ You must instrument the backend or frontend container to expose metrics at the configured endpoint.
242
+ For step-by-step setup, see {doc}`/how-to/enable-prometheus-monitoring`.
243
+
244
+ **Example:**
245
+ ```typescript
246
+ backend: {
247
+ image: 'plone/plone-backend:6.1.3',
248
+ servicemonitor: true,
249
+ metricsPath: '/metrics',
250
+ },
251
+ frontend: {
252
+ image: 'plone/plone-frontend:16.0.0',
253
+ servicemonitor: true,
254
+ metricsPort: 9090,
255
+ }
256
+ ```
257
+
258
+ #### Scheduling
259
+
260
+ | Property | Type | Default | Description |
261
+ |----------|------|---------|-------------|
262
+ | `nodeSelector` | `Record<string, string>` | - | Constrain pods to nodes whose labels match all entries. |
263
+
264
+ For tainted nodes and taint-based scheduling, see {doc}`/how-to/schedule-pods`.
265
+
266
+ **Example:**
267
+ ```typescript
268
+ backend: {
269
+ image: 'plone/plone-backend:6.1.3',
270
+ nodeSelector: {
271
+ 'topology.kubernetes.io/region': 'fsn1',
272
+ },
273
+ }
274
+ ```
275
+
276
+ #### Security context
277
+
278
+ | Property | Type | Default | Description |
279
+ |----------|------|---------|-------------|
280
+ | `securityContext` | `PloneSecurityContext` | - | Container security settings (capabilities, UID/GID, read-only root, privilege escalation). |
281
+
282
+ **`PloneSecurityContext` fields:**
283
+
284
+ | Property | Type | Description |
285
+ |----------|------|-------------|
286
+ | `capabilities` | `PloneCapabilities` | Linux capabilities to add or drop. |
287
+ | `runAsUser` | `number` | Run the container as this UID. |
288
+ | `runAsGroup` | `number` | Run the container as this GID. |
289
+ | `runAsNonRoot` | `boolean` | Require the container to run as non-root. |
290
+ | `readOnlyRootFilesystem` | `boolean` | Mount the root filesystem read-only. |
291
+ | `allowPrivilegeEscalation` | `boolean` | Allow the process to gain more privileges than its parent. |
292
+ | `privileged` | `boolean` | Run the container in privileged mode. |
293
+
294
+ **`PloneCapabilities` fields:**
295
+
296
+ | Property | Type | Description |
297
+ |----------|------|-------------|
298
+ | `add` | `string[]` | Capabilities to add (e.g., `'SYS_PTRACE'`). |
299
+ | `drop` | `string[]` | Capabilities to drop (e.g., `'ALL'`). |
300
+
301
+ For a hardening walk-through, see {doc}`/how-to/configure-security-context`.
302
+
303
+ **Example:**
304
+ ```typescript
305
+ backend: {
306
+ image: 'plone/plone-backend:6.1.3',
307
+ securityContext: {
308
+ runAsNonRoot: true,
309
+ runAsUser: 500,
310
+ readOnlyRootFilesystem: true,
311
+ allowPrivilegeEscalation: false,
312
+ capabilities: {
313
+ drop: ['ALL'],
314
+ },
315
+ },
316
+ }
317
+ ```
318
+
222
319
  ---
223
320
 
224
321
  ### `PloneHttpcacheOptions`
@@ -228,18 +325,36 @@ Configuration for the Varnish HTTP cache layer.
228
325
  | Property | Type | Required | Default | Description |
229
326
  |----------|------|----------|---------|-------------|
230
327
  | `plone` | `Plone` | Yes | - | Plone construct to attach cache to |
231
- | `varnishVcl` | `string` | No | - | VCL configuration as string |
232
- | `varnishVclFile` | `string` | No | - | Path to VCL configuration file |
328
+ | `varnishVcl` | `string` | No | - | VCL configuration as string. Takes precedence over `varnishVclFile`. |
329
+ | `varnishVclFile` | `string` | No | built-in `config/varnish.tpl.vcl` | Path to a VCL template file |
233
330
  | `existingSecret` | `string` | No | - | Kubernetes secret for Varnish admin credentials |
234
331
  | `replicas` | `number` | No | `2` | Number of Varnish replicas |
235
- | `requestCpu` | `string` | No | - | CPU request |
236
- | `limitCpu` | `string` | No | - | CPU limit |
237
- | `requestMemory` | `string` | No | - | Memory request |
238
- | `limitMemory` | `string` | No | - | Memory limit |
239
- | `servicemonitor` | `boolean` | No | `false` | Enable Prometheus ServiceMonitor |
332
+ | `requestCpu` | `string` | No | `100m` | CPU request |
333
+ | `limitCpu` | `string` | No | `500m` | CPU limit |
334
+ | `requestMemory` | `string` | No | `100Mi` | Memory request |
335
+ | `limitMemory` | `string` | No | `500Mi` | Memory limit |
336
+ | `servicemonitor` | `boolean` | No | `false` | Enable Prometheus `ServiceMonitor` |
240
337
  | `exporterEnabled` | `boolean` | No | `true` | Enable Prometheus exporter sidecar |
241
- | `chartVersion` | `string` | No | latest | kube-httpcache Helm chart version |
242
- | `extraEnvVars` | `HttpcacheEnvVar[]` | No | - | Additional env vars for kube-httpcache container |
338
+ | `chartVersion` | `string` | No | chart latest | kube-httpcache Helm chart version |
339
+ | `appVersion` | `string` | No | matches `chartVersion` | kube-httpcache container image tag |
340
+ | `extraEnvVars` | `HttpcacheEnvVar[]` | No | - | Additional env vars for the kube-httpcache container |
341
+ | `tolerations` | `HttpcacheToleration[]` | No | - | Pod tolerations for tainted nodes |
342
+
343
+ **`HttpcacheEnvVar` fields:**
344
+
345
+ | Property | Type | Description |
346
+ |----------|------|-------------|
347
+ | `name` | `string` | Environment variable name |
348
+ | `value` | `string` | Environment variable value |
349
+
350
+ **`HttpcacheToleration` fields:**
351
+
352
+ | Property | Type | Default | Description |
353
+ |----------|------|---------|-------------|
354
+ | `key` | `string` | - | Taint key to tolerate |
355
+ | `operator` | `string` | `Equal` | `Equal` or `Exists` |
356
+ | `value` | `string` | - | Taint value (required for `Equal`) |
357
+ | `effect` | `string` | - | `NoSchedule`, `PreferNoSchedule`, or `NoExecute`. Omit to tolerate all effects. |
243
358
 
244
359
  **Example:**
245
360
  ```typescript
@@ -302,18 +417,37 @@ Requires the [cloud-vinyl operator](https://github.com/bluedynamics/cloud-vinyl)
302
417
  | Property | Type | Required | Default | Description |
303
418
  |----------|------|----------|---------|-------------|
304
419
  | `plone` | `Plone` | Yes | - | Plone construct to attach cache to |
420
+ | `image` | `string` | No | `varnish:7.6` | Container image for the Varnish pods |
305
421
  | `replicas` | `number` | No | `2` | Number of Varnish replicas |
306
422
  | `requestCpu` | `string` | No | `100m` | CPU request |
307
423
  | `limitCpu` | `string` | No | `500m` | CPU limit |
308
424
  | `requestMemory` | `string` | No | `256Mi` | Memory request |
309
425
  | `limitMemory` | `string` | No | `512Mi` | Memory limit |
310
426
  | `storage` | `VinylCacheStorage[]` | No | - | Varnish storage backends. If omitted, the operator falls back to the varnishd default (~100 MB malloc), which is almost always too small. |
311
- | `director` | `string` | No | `shard` | Director type: shard, round_robin, random, hash |
312
- | `vclRecvSnippet` | `string` | No | built-in | Custom VCL snippet for vcl_recv |
313
- | `vclBackendResponseSnippet` | `string` | No | built-in | Custom VCL snippet for vcl_backend_response |
427
+ | `extraBackends` | `VinylCacheBackend[]` | No | - | Additional backends appended after the auto-generated Plone backends. |
428
+ | `director` | `string` | No | `shard` | Director type: `shard`, `round_robin`, `random`, `hash` |
429
+ | `shardBy` | `string` | No | operator default (`HASH`) | Shard director: value to hash (`HASH` or `URL`). Requires cloud-vinyl ≥ 0.4.2. |
430
+ | `shardHealthy` | `string` | No | operator default (`CHOSEN`) | Shard director: backend health requirement (`CHOSEN` or `ALL`). Requires cloud-vinyl ≥ 0.4.2. |
431
+ | `shardRampup` | `string` | No | operator default (`30s`) | Shard director: ramp-up window for newly added backends. |
432
+ | `shardReplicas` | `number` | No | operator default (`67`) | Shard director: Ketama replicas per backend. |
433
+ | `vclRecvSnippet` | `string` | No | built-in `plone-vinyl-recv.vcl` | Custom VCL snippet for `vcl_recv` |
434
+ | `vclBackendResponseSnippet` | `string` | No | built-in `plone-vinyl-backend-response.vcl` | Custom VCL snippet for `vcl_backend_response` |
435
+ | `vclDeliverSnippet` | `string` | No | - | Custom VCL snippet for `vcl_deliver` |
436
+ | `vclHitSnippet` | `string` | No | - | Custom VCL snippet for `vcl_hit` |
437
+ | `vclMissSnippet` | `string` | No | - | Custom VCL snippet for `vcl_miss` |
438
+ | `vclPassSnippet` | `string` | No | - | Custom VCL snippet for `vcl_pass` |
439
+ | `vclPipeSnippet` | `string` | No | - | Custom VCL snippet for `vcl_pipe` |
440
+ | `vclSynthSnippet` | `string` | No | - | Custom VCL snippet for `vcl_synth` |
441
+ | `vclPurgeSnippet` | `string` | No | - | Custom VCL snippet for `vcl_purge` |
442
+ | `vclHashSnippet` | `string` | No | - | Custom VCL snippet for `vcl_hash` |
443
+ | `vclInitSnippet` | `string` | No | - | Custom VCL snippet for `vcl_init` |
444
+ | `vclFiniSnippet` | `string` | No | - | Custom VCL snippet for `vcl_fini` |
445
+ | `vclBackendFetchSnippet` | `string` | No | - | Custom VCL snippet for `vcl_backend_fetch` |
446
+ | `vclBackendErrorSnippet` | `string` | No | - | Custom VCL snippet for `vcl_backend_error` |
314
447
  | `invalidation` | `boolean` | No | `true` | Enable PURGE/BAN/xkey cache invalidation |
315
- | `monitoring` | `boolean` | No | `false` | Enable Prometheus metrics and ServiceMonitor |
316
- | `tolerations` | `VinylCacheToleration[]` | No | - | Node tolerations for Varnish pods |
448
+ | `monitoring` | `boolean` | No | `false` | Enable Prometheus metrics and `ServiceMonitor` |
449
+ | `tolerations` | `VinylCacheToleration[]` | No | - | Pod tolerations for tainted nodes |
450
+ | `nodeSelector` | `Record<string, string>` | No | - | Constrain Varnish pods to nodes matching all labels. |
317
451
 
318
452
  **`VinylCacheStorage` fields:**
319
453
 
@@ -324,6 +458,36 @@ Requires the [cloud-vinyl operator](https://github.com/bluedynamics/cloud-vinyl)
324
458
  | `size` | `string` | Yes | Kubernetes resource quantity (e.g. `"1Gi"`, `"500M"`) |
325
459
  | `path` | `string` | for `file` | Filesystem path for file-type storage |
326
460
 
461
+ **`VinylCacheBackend` fields:**
462
+
463
+ | Property | Type | Required | Default | Description |
464
+ |----------|------|----------|---------|-------------|
465
+ | `name` | `string` | Yes | - | VCL identifier (must match `^[a-zA-Z][a-zA-Z0-9_]*$`) |
466
+ | `serviceName` | `string` | Yes | - | Kubernetes Service name to use as backend |
467
+ | `port` | `number` | Yes | - | Service port |
468
+ | `probe` | `VinylCacheBackendProbe` | No | - | Health probe configuration |
469
+ | `weight` | `number` | No | operator default | Relative weight in the director. `0` marks the backend as standby. |
470
+
471
+ **`VinylCacheBackendProbe` fields:**
472
+
473
+ | Property | Type | Default | Description |
474
+ |----------|------|---------|-------------|
475
+ | `url` | `string` | `/` | URL to probe |
476
+ | `interval` | `string` | `5s` | Probe interval |
477
+ | `timeout` | `string` | `2s` | Probe timeout |
478
+ | `window` | `number` | `10` | Number of recent probes evaluated |
479
+ | `threshold` | `number` | `8` | Healthy threshold within the window |
480
+ | `expectedResponse` | `number` | `200` | Expected HTTP status code |
481
+
482
+ **`VinylCacheToleration` fields:**
483
+
484
+ | Property | Type | Default | Description |
485
+ |----------|------|---------|-------------|
486
+ | `key` | `string` | - | Taint key to tolerate |
487
+ | `operator` | `string` | `Equal` | `Equal` or `Exists` |
488
+ | `value` | `string` | - | Taint value (required for `Equal`) |
489
+ | `effect` | `string` | - | `NoSchedule`, `PreferNoSchedule`, or `NoExecute`. Omit to tolerate all effects. |
490
+
327
491
  **Example:**
328
492
  ```typescript
329
493
  const cache = new PloneVinylCache(chart, 'cache', {
@@ -373,7 +537,7 @@ Without an explicit `storage` entry, varnishd runs with its stock default (~100
373
537
 
374
538
  ---
375
539
 
376
- ## PloneVariant Enum
540
+ ## PloneVariant enum
377
541
 
378
542
  Defines the deployment variant:
379
543
 
@@ -395,7 +559,7 @@ variant: PloneVariant.CLASSICUI
395
559
 
396
560
  ---
397
561
 
398
- ## Complete Example
562
+ ## Complete example
399
563
 
400
564
  ```typescript
401
565
  import { App, Chart } from 'cdk8s';
@@ -457,9 +621,12 @@ app.synth();
457
621
 
458
622
  ---
459
623
 
460
- ## See Also
624
+ ## See also
461
625
 
462
- - [API Documentation](api/) - Complete API reference
463
- - [Quick Start Tutorial](../tutorials/01-quick-start.md) - Get started guide
464
- - [Scale Resources](../how-to/scale-resources.md) - How to adjust resources
465
- - [Configure Monitoring](../how-to/configure-monitoring.md) - Prometheus setup
626
+ - {doc}`/tutorials/01-quick-start` Get started guide
627
+ - {doc}`/how-to/deploy-production-volto` — Production-ready Volto deployment
628
+ - {doc}`/how-to/deploy-classic-ui` Classic UI deployment
629
+ - {doc}`/how-to/deploy-with-vinyl-cache` `PloneVinylCache` walk-through
630
+ - {doc}`/how-to/enable-prometheus-monitoring` — Wire up `ServiceMonitor`
631
+ - {doc}`/how-to/configure-security-context` — Harden backend and frontend pods
632
+ - {doc}`/how-to/schedule-pods` — `nodeSelector` and `tolerations`
@@ -1,3 +1,12 @@
1
+ ---
2
+ myst:
3
+ html_meta:
4
+ "description": "Information-oriented technical reference for cdk8s-plone constructs, configuration options, and APIs."
5
+ "property=og:description": "Information-oriented technical reference for cdk8s-plone constructs, configuration options, and APIs."
6
+ "property=og:title": "Reference"
7
+ "keywords": "Plone, cdk8s, Kubernetes, reference, API, configuration"
8
+ ---
9
+
1
10
  ```{image} ../_static/kup6s-icon-reference.svg
2
11
  :align: center
3
12
  :class: section-icon-large
@@ -9,7 +18,7 @@
9
18
 
10
19
  Reference guides provide detailed technical information about cdk8s-plone's API, configuration options, and component specifications. They describe how things work and what parameters are available.
11
20
 
12
- ## API Reference
21
+ ## API reference
13
22
 
14
23
  *This section will contain auto-generated or detailed documentation for:*
15
24
  - Main chart classes
@@ -17,7 +26,7 @@ Reference guides provide detailed technical information about cdk8s-plone's API,
17
26
  - Individual construct classes
18
27
  - Utility functions and validators
19
28
 
20
- ## Configuration Reference
29
+ ## Configuration reference
21
30
 
22
31
  ```{toctree}
23
32
  ---
@@ -27,7 +36,7 @@ titlesonly: true
27
36
  configuration-options
28
37
  ```
29
38
 
30
- ## Component Specifications
39
+ ## Component specifications
31
40
 
32
41
  ```{toctree}
33
42
  ---
@@ -38,7 +47,7 @@ titlesonly: true
38
47
 
39
48
  *Component specifications will be added in future releases.*
40
49
 
41
- ## API Documentation
50
+ ## API documentation
42
51
 
43
52
  See the `api/` directory for detailed construct documentation:
44
53
 
@@ -1,4 +1,13 @@
1
- # Quick Start
1
+ ---
2
+ myst:
3
+ html_meta:
4
+ "description": "Deploy your first Plone instance to Kubernetes using cdk8s-plone, from project setup to a running Volto site."
5
+ "property=og:description": "Deploy your first Plone instance to Kubernetes using cdk8s-plone, from project setup to a running Volto site."
6
+ "property=og:title": "Quick start"
7
+ "keywords": "Plone, cdk8s, Kubernetes, tutorial, Volto, getting started"
8
+ ---
9
+
10
+ # Quick start
2
11
 
3
12
  This tutorial will guide you through deploying your first Plone instance using cdk8s-plone.
4
13
 
@@ -13,11 +22,11 @@ Before you start, ensure you have:
13
22
 
14
23
  For detailed prerequisites, see [Setup Prerequisites](../how-to/setup-prerequisites.md).
15
24
 
16
- ## Step 1: Create a CDK8S Project
25
+ ## Step 1: Create a CDK8S project
17
26
 
18
27
  Create a new CDK8S TypeScript project:
19
28
 
20
- ```bash
29
+ ```shell
21
30
  # Create project directory
22
31
  mkdir my-plone-deployment
23
32
  cd my-plone-deployment
@@ -32,17 +41,17 @@ This creates a basic CDK8S project structure.
32
41
 
33
42
  Install the cdk8s-plone library:
34
43
 
35
- ```bash
44
+ ```shell
36
45
  npm install @bluedynamics/cdk8s-plone
37
46
  ```
38
47
 
39
48
  The library is also available for Python via PyPI:
40
49
 
41
- ```bash
50
+ ```shell
42
51
  pip install cdk8s-plone
43
52
  ```
44
53
 
45
- ## Step 3: Create a Basic Plone Deployment
54
+ ## Step 3: Create a basic Plone deployment
46
55
 
47
56
  Edit `main.ts` with the following code:
48
57
 
@@ -73,11 +82,11 @@ This creates:
73
82
  - A Volto frontend with 2 replicas
74
83
  - All necessary Kubernetes services and deployments
75
84
 
76
- ## Step 4: Generate Kubernetes Manifests
85
+ ## Step 4: Generate Kubernetes manifests
77
86
 
78
87
  Generate the Kubernetes manifests:
79
88
 
80
- ```bash
89
+ ```shell
81
90
  cdk8s synth
82
91
  ```
83
92
 
@@ -87,22 +96,22 @@ This creates YAML files in the `dist/` directory containing all Kubernetes resou
87
96
 
88
97
  Apply the generated manifests to your cluster:
89
98
 
90
- ```bash
99
+ ```shell
91
100
  kubectl apply -f dist/
92
101
  ```
93
102
 
94
103
  Check the deployment status:
95
104
 
96
- ```bash
105
+ ```shell
97
106
  kubectl get pods
98
107
  kubectl get services
99
108
  ```
100
109
 
101
- ## Step 6: Access Your Plone Site
110
+ ## Step 6: Access your Plone site
102
111
 
103
112
  Once all pods are running, access your Plone site:
104
113
 
105
- ```bash
114
+ ```shell
106
115
  # Port-forward to the frontend service
107
116
  kubectl port-forward service/my-plone-frontend 3000:3000
108
117
 
@@ -110,7 +119,7 @@ kubectl port-forward service/my-plone-frontend 3000:3000
110
119
  open http://localhost:3000
111
120
  ```
112
121
 
113
- ## Adding HTTP Caching (Optional)
122
+ ## Adding HTTP caching (optional)
114
123
 
115
124
  For production deployments, add Varnish HTTP caching:
116
125
 
@@ -132,13 +141,14 @@ new PloneHttpcache(chart, 'cache', {
132
141
 
133
142
  This adds a Varnish caching layer with cluster-wide cache invalidation using [kube-httpcache](https://github.com/mittwald/kube-httpcache).
134
143
 
135
- ## Next Steps
144
+ ## Next steps
136
145
 
137
146
  Now that you have a basic Plone deployment:
138
147
 
139
- - **Configure resources**: See [Scale Resources](../how-to/scale-resources.md) to adjust CPU and memory
140
- - **Add monitoring**: Configure [Prometheus metrics](../how-to/configure-monitoring.md)
141
- - **Explore variants**: Learn about [Classic UI vs Volto](../explanation/plone-variants.md)
148
+ - **Configure resources**: See {doc}`/reference/configuration-options` for CPU and memory options.
149
+ - **Add monitoring**: Follow {doc}`/how-to/enable-prometheus-monitoring`.
150
+ - **Explore variants**: Read about Volto and Classic UI in {doc}`/explanation/features`.
151
+ - **Harden pods**: Apply {doc}`/how-to/configure-security-context`.
142
152
 
143
153
  ## Troubleshooting
144
154
 
@@ -150,8 +160,6 @@ Now that you have a basic Plone deployment:
150
160
  - Ensure port-forward is running
151
161
  - Check service endpoints: `kubectl get endpoints`
152
162
 
153
- For more help, see the [Troubleshooting guide](../how-to/troubleshooting.md).
154
-
155
163
  ---
156
164
 
157
165
  **Complete example**: See the [cdk8s-plone-example](https://github.com/bluedynamics/cdk8s-plone-example) repository for a full working example.
@@ -1,3 +1,12 @@
1
+ ---
2
+ myst:
3
+ html_meta:
4
+ "description": "Learning-oriented tutorials that guide you through using cdk8s-plone to deploy Plone CMS on Kubernetes."
5
+ "property=og:description": "Learning-oriented tutorials that guide you through using cdk8s-plone to deploy Plone CMS on Kubernetes."
6
+ "property=og:title": "Tutorials"
7
+ "keywords": "Plone, cdk8s, Kubernetes, tutorials, getting started"
8
+ ---
9
+
1
10
  ```{image} ../_static/kup6s-icon-tutorials.svg
2
11
  :align: center
3
12
  :class: section-icon-large
@@ -18,7 +27,7 @@ These tutorials will teach you how to:
18
27
  - Customize component resources and settings
19
28
  - Test your deployment
20
29
 
21
- ## Available Tutorials
30
+ ## Available tutorials
22
31
 
23
32
  ```{toctree}
24
33
  ---
package/lib/httpcache.js CHANGED
@@ -118,5 +118,5 @@ class PloneHttpcache extends constructs_1.Construct {
118
118
  }
119
119
  exports.PloneHttpcache = PloneHttpcache;
120
120
  _a = JSII_RTTI_SYMBOL_1;
121
- PloneHttpcache[_a] = { fqn: "@bluedynamics/cdk8s-plone.PloneHttpcache", version: "0.1.35" };
121
+ PloneHttpcache[_a] = { fqn: "@bluedynamics/cdk8s-plone.PloneHttpcache", version: "0.1.37" };
122
122
  //# sourceMappingURL=data:application/json;base64,{"version":3,"file":"httpcache.js","sourceRoot":"","sources":["../src/httpcache.ts"],"names":[],"mappings":";;;;;AAAA,yBAAyB;AACzB,6BAA6B;AAC7B,iCAA6B;AAC7B,2CAAuC;AAwJvC;;;;;;;;;;;;;;;GAeG;AACH,MAAa,cAAe,SAAQ,sBAAS;IAO3C,YAAY,KAAgB,EAAE,EAAU,EAAE,OAA8B;QACtE,KAAK,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;QACjB,IAAI,UAAkB,CAAC;QACvB,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,CAAC;YACxB,IAAI,OAAe,CAAC;YACpB,IAAI,CAAC,OAAO,CAAC,cAAc,EAAE,CAAC;gBAC5B,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,QAAQ,EAAE,iBAAiB,CAAC,CAAC;YAC9D,CAAC;iBAAM,CAAC;gBACN,OAAO,GAAG,OAAO,CAAC,cAAc,CAAC;YACnC,CAAC;YACD,UAAU,GAAG,EAAE,CAAC,YAAY,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;QAChD,CAAC;aAAM,CAAC;YACN,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC;QAClC,CAAC;QACD,MAAM,QAAQ,GAAG,OAAO,CAAC,UAAU,IAAI,OAAO,CAAC,YAAY,CAAC;QAC5D,MAAM,SAAS,GAAG,IAAI,YAAI,CAAC,IAAI,EAAE,WAAW,EAAE;YAC5C,uDAAuD;YACvD,IAAI,EAAE,0BAA0B;YAChC,KAAK,EAAE,gBAAgB;YACvB,OAAO,EAAE,OAAO,CAAC,YAAY;YAC7B,MAAM,EAAE;gBACN,YAAY,EAAE,OAAO,CAAC,QAAQ,IAAI,CAAC;gBACnC,GAAG,CAAC,QAAQ,IAAI,EAAE,KAAK,EAAE,EAAE,GAAG,EAAE,QAAQ,EAAE,EAAE,CAAC;gBAC7C,KAAK,EAAE;oBACL,cAAc,EAAE,OAAO,CAAC,KAAK,CAAC,kBAAkB;oBAChD,aAAa,EAAE,KAAK;oBACpB,YAAY,EAAE,IAAI;oBAClB,cAAc,EAAE,OAAO,CAAC,cAAc,IAAI,SAAS;iBACpD;gBACD,+DAA+D;gBAC/D,0DAA0D;gBAC1D,cAAc,EAAE,kCAAkC;gBAClD,WAAW,EAAE,UAAU;gBACvB,YAAY,EAAE;oBACZ,EAAE,IAAI,EAAE,sBAAsB,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,CAAC,kBAAkB,EAAE;oBACzE,EAAE,IAAI,EAAE,sBAAsB,EAAE,KAAK,EAAE,MAAM,EAAE;oBAC/C,EAAE,IAAI,EAAE,iBAAiB,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,CAAC,MAAM,EAAE;oBACxD,EAAE,IAAI,EAAE,uBAAuB,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,CAAC,mBAAmB,EAAE;oBAC3E,EAAE,IAAI,EAAE,uBAAuB,EAAE,KAAK,EAAE,MAAM,EAAE;oBAChD,GAAG,CAAC,OAAO,CAAC,YAAY,IAAI,EAAE,CAAC;iBAChC;gBACD,4DAA4D;gBAC5D,YAAY,EAAE;oBACZ,oBAAoB,EAAE,OAAO;iBAC9B;gBACD,GAAG,CAAC,OAAO,CAAC,WAAW,IAAI,EAAE,WAAW,EAAE,OAAO,CAAC,WAAW,EAAE,CAAC;gBAChE,SAAS,EAAE;oBACT,MAAM,EAAE;wBACN,GAAG,EAAE,OAAO,CAAC,QAAQ,IAAI,MAAM;wBAC/B,MAAM,EAAE,OAAO,CAAC,WAAW,IAAI,OAAO;qBACvC;oBACD,QAAQ,EAAE;wBACR,GAAG,EAAE,OAAO,CAAC,UAAU,IAAI,MAAM;wBACjC,MAAM,EAAE,OAAO,CAAC,aAAa,IAAI,OAAO;qBACzC;iBACF;gBACD,IAAI,EAAE;oBACJ,OAAO,EAAE,IAAI;iBACd;gBACD,QAAQ,EAAE;oBACR,OAAO,EAAE,OAAO,CAAC,eAAe,IAAI,IAAI;oBACxC,SAAS,EAAE;wBACT,MAAM,EAAE;4BACN,GAAG,EAAE,MAAM;4BACX,MAAM,EAAE,OAAO;yBAChB;wBACD,QAAQ,EAAE;4BACR,GAAG,EAAE,KAAK;4BACV,MAAM,EAAE,MAAM;yBACf;qBACF;iBACF;gBACD,cAAc,EAAE;oBACd,OAAO,EAAE,OAAO,CAAC,cAAc,IAAI,KAAK;oBACxC,eAAe,EAAE,OAAO,CAAC,cAAc,IAAI,KAAK;iBACjD;aACF;SACF,CAAC,CAAC;QACH,MAAM,gBAAgB,GAAG,SAAS,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,EAAE;YAC/D,IAAI,CAAC,SAAS,CAAC,IAAI,KAAK,SAAS,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC,gBAAgB,CAAC,CAAC,EAAE,CAAC;gBAC5F,OAAO,SAAS,CAAC,IAAI,CAAC;YACxB,CAAC;YACD,OAAO,SAAS,CAAC;QACnB,CAAC,CAAC,CAAC;QACH,IAAI,gBAAgB,KAAK,SAAS,EAAE,CAAC;YACnC,MAAM,IAAI,KAAK,CAAC,kCAAkC,CAAC,CAAC;QACtD,CAAC;QACD,IAAI,CAAC,oBAAoB,GAAG,gBAAgB,CAAC,IAAI,CAAC;IACpD,CAAC;;AA/FH,wCAgGC","sourcesContent":["import * as fs from 'fs';\nimport * as path from 'path';\nimport { Helm } from 'cdk8s';\nimport { Construct } from 'constructs';\nimport { Plone } from './plone';\n\n/**\n * An environment variable to pass to the kube-httpcache container.\n */\nexport interface HttpcacheEnvVar {\n  /**\n   * The name of the environment variable.\n   */\n  readonly name: string;\n\n  /**\n   * The value of the environment variable.\n   */\n  readonly value: string;\n}\n\n/**\n * A Kubernetes toleration for the Varnish pods.\n */\nexport interface HttpcacheToleration {\n  /**\n   * The taint key to tolerate.\n   */\n  readonly key: string;\n\n  /**\n   * The operator (Equal or Exists).\n   * @default 'Equal'\n   */\n  readonly operator?: string;\n\n  /**\n   * The taint value to match (when operator is Equal).\n   * @default - no value\n   */\n  readonly value?: string;\n\n  /**\n   * The taint effect to tolerate (NoSchedule, PreferNoSchedule, NoExecute).\n   * @default - tolerate all effects\n   */\n  readonly effect?: string;\n}\n\n/**\n * Configuration options for PloneHttpcache (Varnish caching layer).\n */\nexport interface PloneHttpcacheOptions {\n  /**\n   * The Plone construct to attach the HTTP cache to.\n   * The cache will automatically connect to the backend and frontend services.\n   */\n  readonly plone: Plone;\n\n  /**\n   * Varnish VCL configuration as a string.\n   * If provided, this takes precedence over varnishVclFile.\n   * @default - loaded from varnishVclFile or default config file\n   */\n  readonly varnishVcl?: string;\n\n  /**\n   * Path to a Varnish VCL configuration file.\n   * If not provided, uses the default VCL file included in the library.\n   * @default - uses default config/varnish.tpl.vcl\n   */\n  readonly varnishVclFile?: string | undefined;\n\n  /**\n   * Name of an existing Kubernetes secret containing Varnish admin credentials.\n   * The secret should be created separately in the same namespace.\n   * @default - undefined (no existing secret)\n   */\n  readonly existingSecret?: string;\n\n  /**\n   * CPU limit for Varnish pods.\n   * @default '500m'\n   */\n  readonly limitCpu?: string;\n\n  /**\n   * Memory limit for Varnish pods.\n   * @default '500Mi'\n   */\n  readonly limitMemory?: string;\n\n  /**\n   * CPU request for Varnish pods.\n   * @default '100m'\n   */\n  readonly requestCpu?: string;\n\n  /**\n   * Memory request for Varnish pods.\n   * @default '100Mi'\n   */\n  readonly requestMemory?: string;\n\n  /**\n   * Enable Prometheus ServiceMonitor for metrics collection.\n   * Requires Prometheus Operator to be installed in the cluster.\n   * @default false\n   */\n  readonly servicemonitor?: boolean;\n\n  /**\n   * Enable the Prometheus exporter for Varnish metrics.\n   * When enabled, the exporter sidecar container will be deployed alongside Varnish.\n   * @default true\n   */\n  readonly exporterEnabled?: boolean;\n\n  /**\n   * Version of the kube-httpcache Helm chart to use.\n   * If not specified, the latest version from the repository will be used.\n   * @default undefined (latest)\n   */\n  readonly chartVersion?: string;\n\n  /**\n   * Version of the kube-httpcache Container Image to use.\n   * If not specified, the latest version from the repository will be used.\n   * @default undefined (chartVersion = with each chart release there is an image release too )\n   */\n  readonly appVersion?: string;\n\n  /**\n   * Number of Varnish pod replicas to run.\n   * @default 2\n   */\n  readonly replicas?: number;\n\n  /**\n   * Additional environment variables to pass to the kube-httpcache container.\n   * These are appended to the built-in env vars (BACKEND_SERVICE_NAME, etc.)\n   * and can be referenced in VCL templates using Go template syntax: {{ .Env.VAR_NAME }}\n   * @default - no additional env vars\n   */\n  readonly extraEnvVars?: HttpcacheEnvVar[];\n\n  /**\n   * Tolerations for the Varnish pods.\n   * Use this to allow scheduling on nodes with specific taints,\n   * e.g. nodes tainted with kubernetes.io/arch=amd64:NoSchedule.\n   * @default - no tolerations\n   */\n  readonly tolerations?: HttpcacheToleration[];\n}\n\n/**\n * PloneHttpcache construct for deploying Varnish HTTP caching layer.\n *\n * Uses the mittwald/kube-httpcache Helm chart to deploy Varnish as a\n * caching proxy in front of Plone backend and/or frontend services.\n *\n * The cache automatically connects to the Plone services and provides\n * HTTP cache invalidation capabilities.\n *\n * @example\n * const plone = new Plone(chart, 'plone');\n * const cache = new PloneHttpcache(chart, 'cache', {\n *   plone: plone,\n *   existingSecret: 'varnish-secret',\n * });\n */\nexport class PloneHttpcache extends Construct {\n  /**\n   * Name of the Varnish service created by the Helm chart.\n   * Use this to reference the cache service from ingress or other constructs.\n   */\n  public readonly httpcacheServiceName: string;\n\n  constructor(scope: Construct, id: string, options: PloneHttpcacheOptions) {\n    super(scope, id);\n    let varnishVcl: string;\n    if (!options.varnishVcl) {\n      let vclPath: string;\n      if (!options.varnishVclFile) {\n        vclPath = path.join(__dirname, 'config', 'varnish.tpl.vcl');\n      } else {\n        vclPath = options.varnishVclFile;\n      }\n      varnishVcl = fs.readFileSync(vclPath, 'utf8');\n    } else {\n      varnishVcl = options.varnishVcl;\n    }\n    const imageTag = options.appVersion ?? options.chartVersion;\n    const httpcache = new Helm(this, 'httpcache', {\n      // see https://github.com/mittwald/kube-httpcache/chart\n      repo: 'https://helm.mittwald.de',\n      chart: 'kube-httpcache',\n      version: options.chartVersion,\n      values: {\n        replicaCount: options.replicas ?? 2,\n        ...(imageTag && { image: { tag: imageTag } }),\n        cache: {\n          backendService: options.plone.backendServiceName,\n          frontendWatch: false,\n          backendWatch: true,\n          existingSecret: options.existingSecret ?? undefined,\n        },\n        // Workaround: upstream chart accepts backendPortName but never\n        // renders it as CLI arg. Pass via cacheExtraArgs instead.\n        cacheExtraArgs: '- -backend-portname=backend-http',\n        vclTemplate: varnishVcl,\n        extraEnvVars: [\n          { name: 'BACKEND_SERVICE_NAME', value: options.plone.backendServiceName },\n          { name: 'BACKEND_SERVICE_PORT', value: '8080' },\n          { name: 'BACKEND_SITE_ID', value: options.plone.siteId },\n          { name: 'FRONTEND_SERVICE_NAME', value: options.plone.frontendServiceName },\n          { name: 'FRONTEND_SERVICE_PORT', value: '3000' },\n          ...(options.extraEnvVars ?? []),\n        ],\n        // see https://github.com/mittwald/kube-httpcache/issues/253\n        nodeSelector: {\n          'kubernetes.io/arch': 'amd64',\n        },\n        ...(options.tolerations && { tolerations: options.tolerations }),\n        resources: {\n          limits: {\n            cpu: options.limitCpu || '500m',\n            memory: options.limitMemory || '500Mi',\n          },\n          requests: {\n            cpu: options.requestCpu || '100m',\n            memory: options.requestMemory || '100Mi',\n          },\n        },\n        rbac: {\n          enabled: true,\n        },\n        exporter: {\n          enabled: options.exporterEnabled ?? true,\n          resources: {\n            limits: {\n              cpu: '100m',\n              memory: '100Mi',\n            },\n            requests: {\n              cpu: '10m',\n              memory: '50Mi',\n            },\n          },\n        },\n        serviceMonitor: {\n          enabled: options.servicemonitor || false,\n          scrapeSignaller: options.servicemonitor || false,\n        },\n      },\n    });\n    const httpcacheService = httpcache.apiObjects.find((construct) => {\n      if ((construct.kind === 'Service') && (construct.metadata.name?.endsWith('kube-httpcache'))) {\n        return construct.name;\n      }\n      return undefined;\n    });\n    if (httpcacheService === undefined) {\n      throw new Error('Could not find httpcache service');\n    }\n    this.httpcacheServiceName = httpcacheService.name;\n  }\n}"]}