cdk8s-plone documentation#

CDK8S Construct Library for Plone CMS Deployment

Welcome to the cdk8s-plone documentation. This documentation covers everything from initial setup to advanced configuration and architectural concepts for deploying Plone CMS using CDK8S.

About cdk8s-plone#

cdk8s-plone is a TypeScript construct library for CDK8S that enables programmatic deployment of Plone CMS on Kubernetes. It provides type-safe, reusable constructs for Plone Backend and Frontend with production-grade defaults.

Key Features:

Type-safe TypeScript constructs for Plone Backend and Frontend
Production-grade defaults with full customization
Support for PostgreSQL backends
Comprehensive resource management (CPU, memory, storage)
Component-level configuration options
Built on CDK8S for infrastructure as code

Documentation structure#

This documentation follows the Diátaxis framework, organizing content into four categories based on what you need:

Tutorials

Learning-oriented: Step-by-step lessons to build skills

Start here if you’re new to cdk8s-plone

Tutorials

How-To Guides

Goal-oriented: Solutions to specific problems

Use these when you need to accomplish something

How-to guides

Reference

Information-oriented: Technical specifications and configurations

Consult when you need detailed information

Reference

Explanation

Understanding-oriented: Concepts and design decisions

Read to deepen your understanding

Explanation

Quick links#

Getting started#

Quick start — Deploy your first Plone instance
Setup prerequisites — Prepare cluster infrastructure
Features — Explore capabilities

Configuration#

Configuration guide — Complete configuration reference
Architecture overview — High-level design

Common tasks#

Configure security context — Harden backend and frontend pods
Enable Prometheus monitoring — Wire up ServiceMonitor
Schedule pods to specific nodes — nodeSelector and tolerations