Skip to content

bluedynamics/cdk8s-plone

Folders and files

NameName
Last commit message
Last commit date

Latest commit

374bd76 · Jan 10, 2025

History

97 Commits
Oct 31, 2024
Jan 10, 2025
Nov 6, 2024
Nov 6, 2024
Nov 11, 2024
Sep 16, 2024
Jun 27, 2024
Oct 23, 2024
Jun 17, 2024
Nov 6, 2024
Nov 6, 2024
Jun 17, 2024
Nov 6, 2024
Jan 10, 2025
Jun 17, 2024
Jan 10, 2025

Repository files navigation

CMS Plone Chart for CDK8S

This chart provides a library to bootstrap a Plone deployment on a Kubernetes cluster using the CDK8S framework.

It provides

  • Backend (as API with plone.volto or as Classic-UI)
  • Frontend (Plone-Volto, a ReactJS based user interface)
  • Varnish using kube-httpcache. It includes a way to invalidate varnish cluster (optional)

Typescript

To use this library, create a new CDK8S project (or use an existing one)

cdk8s init typescript-app

Then add the following dependency to package.json:

{
  "dependencies": {
    "@bluedynamics/cdk8s-plone": "*"
  }
}

Run npm install to install the new dependency.

Python

Todo: Document in details how to install.

cdk8s init python-app

Python package name is cdk8s-plone.

Usage

With cdk8s-cli installed, create a new project:

cdk8s sythn

Add the following code to your main.ts:

...
import { Plone } from '@bluedynamics/cdk8s-plone';
...
    super(scope, id, props);

    // define resources here
    new Plone(this, 'Plone', {});
...

Run npm run build to generate the Kubernetes manifests. The manifests are stored in the dist directory.

For more have a look at the example project.

Development

Clone the repository and install the dependencies:

nvm use lts/* corepack enable npx projen


Then run the following command to run the test:

```bash
npx projen test