Provides a CMS Plone Backend and Frontend for Kubernetes with cdk8s
Project description
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 (for API with
plone.voltoor as Classic-UI) - Frontend (Plone-Volto, a ReactJS based user interface)
- Varnish using kube-httpcache. It includes a way to invalidate varnish cluster (optional)
Installation
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:
yarn install
Then run the following command to run the test:
npx projen test
Feature Wishlist:
Each step need to be implemented with tests!
-
Support Variants for ClassicUI or Volto
-
Start Backend
- deployment
- service
- pdb
- init container running
plone-site-create - lifecycle checks (readiness, liveness)
- generic way to inject sidecars
- metrics sidecar
-
Start Frontend
- deployment
- service
- pdb
- lifecycle checks (readiness, liveness)
- generic way to inject sidecars
- metrics sidecar
-
Start Varnish (using
kube-httpcache) optional in separate chart- provide a default VCL for Volto with routing to backend and frontend
- provide a default VCL for ClassicUI
-
Configure Ingress, optional in separate chart
- Traefik
- Konq
-
Release packages for other Languages
- Python
- Golang
- Java
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for cdk8s_plone-0.0.20-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 581f9501729f22bf70fc796cb50fdb1674357a340c17ae7119e31866a5662802 |
|
| MD5 | e06cfd0d792b239c43de84d029fcc0bf |
|
| BLAKE2b-256 | c6bc33602b4dae6e7191fd3c0861a298dd264e672b7d549fde92b60365e0cb87 |
