Skip to main content

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.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:

</code></pre>
<p>nvm use lts/*
npm install yarn
projen</p>
<pre><code>
Then run the following command to run the test:

```bash
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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cdk8s_plone-0.0.22.tar.gz (579.0 kB view details)

Uploaded Source

Built Distribution

cdk8s_plone-0.0.22-py3-none-any.whl (576.7 kB view details)

Uploaded Python 3

File details

Details for the file cdk8s_plone-0.0.22.tar.gz.

File metadata

  • Download URL: cdk8s_plone-0.0.22.tar.gz
  • Upload date:
  • Size: 579.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.5

File hashes

Hashes for cdk8s_plone-0.0.22.tar.gz
Algorithm Hash digest
SHA256 61f253f1acccf4202f20d5979c5bd4a5991617c8a81e84d0e8e03c0587956ba0
MD5 e5f0edb8cc5d5b78df77f85d15eb020f
BLAKE2b-256 7d60b71b3aa7c465fb0e7298e4d84be67a939ab83b91e32a147039933cd4b61d

See more details on using hashes here.

File details

Details for the file cdk8s_plone-0.0.22-py3-none-any.whl.

File metadata

  • Download URL: cdk8s_plone-0.0.22-py3-none-any.whl
  • Upload date:
  • Size: 576.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.5

File hashes

Hashes for cdk8s_plone-0.0.22-py3-none-any.whl
Algorithm Hash digest
SHA256 5bf8c53f3283a56622786f018258d0d6275a58fee7f28e508160186fc6b50b8f
MD5 1ff187c509e746812d880f95e8c14b0c
BLAKE2b-256 8f3d71856fd7b808e07ec238a46ec01bbe96ba0b2dab3050aaf9938f1c976eb9

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page