@bluedynamics/cdk8s-plone 0.1.43 → 0.1.45

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.
Files changed (73) hide show
  1. package/.jsii +25 -24
  2. package/API.md +6 -2
  3. package/README.md +3 -3
  4. package/documentation/sources/conf.py +55 -29
  5. package/documentation/sources/explanation/architecture.md +14 -16
  6. package/documentation/sources/explanation/cdk8s-workflow.md +66 -0
  7. package/documentation/sources/explanation/index.md +1 -27
  8. package/documentation/sources/how-to/backup-and-restore.md +107 -0
  9. package/documentation/sources/how-to/configure-env-and-secrets.md +184 -0
  10. package/documentation/sources/how-to/configure-ingress-tls.md +108 -0
  11. package/documentation/sources/how-to/configure-security-context.md +0 -5
  12. package/documentation/sources/how-to/deploy-blicca.md +8 -8
  13. package/documentation/sources/how-to/{deploy-production-volto.md → deploy-volto.md} +20 -25
  14. package/documentation/sources/how-to/deploy-with-httpcache.md +224 -0
  15. package/documentation/sources/how-to/deploy-with-vinyl-cache.md +0 -5
  16. package/documentation/sources/how-to/enable-prometheus-monitoring.md +4 -5
  17. package/documentation/sources/how-to/index.md +15 -8
  18. package/documentation/sources/how-to/scale-and-high-availability.md +122 -0
  19. package/documentation/sources/how-to/schedule-pods.md +0 -5
  20. package/documentation/sources/how-to/troubleshooting.md +113 -0
  21. package/documentation/sources/how-to/upgrade-and-rollout.md +89 -0
  22. package/documentation/sources/index.md +3 -11
  23. package/documentation/sources/reference/api/index.md +6 -4
  24. package/documentation/sources/reference/configuration-options.md +85 -516
  25. package/documentation/sources/reference/index.md +16 -43
  26. package/documentation/sources/tutorials/01-quick-start.md +1 -1
  27. package/documentation/sources/tutorials/index.md +7 -11
  28. package/examples/blicca/.env.example +3 -2
  29. package/examples/blicca/README.md +21 -24
  30. package/examples/blicca/__snapshots__/main.test.ts.snap +138 -345
  31. package/examples/blicca/main.test.ts +7 -0
  32. package/examples/blicca/main.ts +8 -7
  33. package/examples/blicca/postgres.plain.ts +115 -0
  34. package/examples/blicca/tsconfig.json +33 -0
  35. package/examples/{production-volto → volto}/.env.example +3 -2
  36. package/examples/{production-volto → volto}/README.md +20 -23
  37. package/examples/{production-volto → volto}/__snapshots__/main.test.ts.snap +139 -345
  38. package/examples/{production-volto → volto}/main.test.ts +7 -0
  39. package/examples/{production-volto → volto}/main.ts +8 -7
  40. package/examples/{production-volto → volto}/package.json +1 -1
  41. package/examples/volto/postgres.plain.ts +115 -0
  42. package/examples/volto/tsconfig.json +33 -0
  43. package/lib/httpcache.js +1 -1
  44. package/lib/imports/vinyl.bluedynamics.eu.d.ts +4011 -53
  45. package/lib/imports/vinyl.bluedynamics.eu.js +1786 -157
  46. package/lib/plone.js +1 -1
  47. package/lib/vinylcache.d.ts +3 -1
  48. package/lib/vinylcache.js +3 -2
  49. package/package.json +6 -6
  50. package/documentation/sources/_static/brand-theme.css +0 -685
  51. package/documentation/sources/_static/custom-icons.css +0 -123
  52. package/documentation/sources/_static/fonts/hack/Hack-Regular.woff2 +0 -0
  53. package/documentation/sources/_static/fonts/orbitron/Orbitron-Black.woff2 +0 -11
  54. package/documentation/sources/_static/fonts/orbitron/Orbitron-Bold.woff2 +0 -11
  55. package/documentation/sources/_static/fonts/orbitron/Orbitron-Regular.woff2 +0 -0
  56. package/documentation/sources/_static/fonts/rajdhani/Rajdhani-Bold.woff2 +0 -11
  57. package/documentation/sources/_static/fonts/rajdhani/Rajdhani-Medium.woff2 +0 -11
  58. package/documentation/sources/_static/fonts/rajdhani/Rajdhani-Regular.woff2 +0 -11
  59. package/documentation/sources/_static/fonts/rajdhani/Rajdhani-SemiBold.woff2 +0 -11
  60. package/documentation/sources/_static/kup6s-icon-explanation.svg +0 -32
  61. package/documentation/sources/_static/kup6s-icon-howto.svg +0 -34
  62. package/documentation/sources/_static/kup6s-icon-reference.svg +0 -34
  63. package/documentation/sources/_static/kup6s-icon-tutorials.svg +0 -30
  64. package/documentation/sources/_static/logo-fix.js +0 -12
  65. package/documentation/sources/reference/api/.gitkeep +0 -1
  66. package/examples/blicca/postgres.bitnami.ts +0 -49
  67. package/examples/production-volto/postgres.bitnami.ts +0 -49
  68. /package/documentation/sources/_static/{kup6s-icon-plone.svg → logo.svg} +0 -0
  69. /package/examples/{production-volto → volto}/cdk8s.yaml +0 -0
  70. /package/examples/{production-volto → volto}/config/varnish.tpl.vcl +0 -0
  71. /package/examples/{production-volto → volto}/ingress.ts +0 -0
  72. /package/examples/{production-volto → volto}/jest.config.js +0 -0
  73. /package/examples/{production-volto → volto}/postgres.cloudnativepg.ts +0 -0
package/documentation/sources/index.md CHANGED
@@ -9,7 +9,9 @@ myst:
9
9
 
10
10
  # cdk8s-plone documentation
11
11
 
12
- ```{image} _static/kup6s-icon-plone.svg
12
+ <!-- diataxis: landing -->
13
+
14
+ ```{image} _static/logo.svg
13
15
  :alt: cdk8s-plone logo
14
16
  :width: 200px
15
17
  :align: center
@@ -39,7 +41,6 @@ This documentation follows the [Diátaxis framework](https://diataxis.fr/), orga
39
41
  :gutter: 3
40
42
 
41
43
  :::{grid-item-card} Tutorials
42
- :img-top: _static/kup6s-icon-tutorials.svg
43
44
  :link: tutorials/index
44
45
  :link-type: doc
45
46
 
@@ -49,7 +50,6 @@ This documentation follows the [Diátaxis framework](https://diataxis.fr/), orga
49
50
  :::
50
51
 
51
52
  :::{grid-item-card} How-To Guides
52
- :img-top: _static/kup6s-icon-howto.svg
53
53
  :link: how-to/index
54
54
  :link-type: doc
55
55
 
@@ -59,7 +59,6 @@ This documentation follows the [Diátaxis framework](https://diataxis.fr/), orga
59
59
  :::
60
60
 
61
61
  :::{grid-item-card} Reference
62
- :img-top: _static/kup6s-icon-reference.svg
63
62
  :link: reference/index
64
63
  :link-type: doc
65
64
 
@@ -69,7 +68,6 @@ This documentation follows the [Diátaxis framework](https://diataxis.fr/), orga
69
68
  :::
70
69
 
71
70
  :::{grid-item-card} Explanation
72
- :img-top: _static/kup6s-icon-explanation.svg
73
71
  :link: explanation/index
74
72
  :link-type: doc
75
73
 
@@ -109,9 +107,3 @@ how-to/index
109
107
  reference/index
110
108
  explanation/index
111
109
  ```
112
-
113
- ---
114
-
115
- **Last updated:** 2025-01-12
116
- **cdk8s-plone version:** 0.0.0
117
- **CDK8S version:** ^2.70.27
package/documentation/sources/reference/api/index.md CHANGED
@@ -9,14 +9,16 @@ myst:
9
9
 
10
10
  # API reference
11
11
 
12
- Complete API reference for cdk8s-plone constructs, generated from TypeScript source code.
12
+ Complete API reference for cdk8s-plone constructs, generated from the TypeScript source code.
13
+ This is the authoritative reference for every option, type, default, and required flag.
13
14
 
14
15
  ## Overview
15
16
 
16
- The cdk8s-plone library provides the following main constructs:
17
+ The cdk8s-plone library provides the following constructs:
17
18
 
18
- - **Plone**: Main construct for deploying Plone CMS with support for both Volto (React frontend) and Blicca (server-side rendered) variants
19
- - **PloneHttpcache**: HTTP caching layer using Varnish for improved performance
19
+ - **Plone**: main construct for deploying Plone CMS, with support for both the Volto (React frontend) and Blicca (server-side rendered) variants
20
+ - **PloneHttpcache**: Varnish caching layer via the mittwald kube-httpcache Helm chart (self-contained)
21
+ - **PloneVinylCache**: Varnish caching layer via the cloud-vinyl operator (requires the operator in-cluster)
20
22
 
21
23
  ## Language support
22
24