Backend#

The backend runs the plone-backend image. It serves the REST API for the Volto frontend, or the whole site with the Classic UI.

Resources#

Resource

Name

Created when

StatefulSet

<release>-backend

always

Service

<release>-backend, port 8080, port name http

always

Headless service

<release>-backend-director, port 8080

always

PodDisruptionBudget

<release>-backend

backend.replicas is more than 1, and backend.podDisruptionBudget.enabled is true

The headless service is the governing service that StatefulSets require. It gives each pod a stable DNS name, <release>-backend-<n>.<release>-backend-director.

Image#

Value

Default

backend.image.repository

docker.io/plone/plone-backend

backend.image.tag

the appVersion of the chart, 6.2.2

backend.image.pullPolicy

IfNotPresent

Environment variables#

The chart sets these variables on the backend container:

Variable

Value

Set when

SITE

site.id

site.create is true

TYPE

volto with the frontend, classic without it

site.create is true

PROFILES

site.profiles

site.create is true, and site.profiles isn’t empty

SITE_DEFAULT_LANGUAGE

site.defaultLanguage

site.create is true, and site.defaultLanguage isn’t empty

ZODB_CACHE_SIZE

backend.zodbCacheSize

always

The storage variables depend on storage.type. With RelStorage, the chart sets DBHOST, DBPORT, DBNAME, DBUSER, DBPASSWORD, RELSTORAGE_DSN, RELSTORAGE_KEEP_HISTORY, and RELSTORAGE_BLOB_CACHE_SIZE. With ZEO, it sets ZEO_ADDRESS and ZEO_CLIENT_CACHE_SIZE. See Storage.

The backend.env list adds more variables, after the ones above.

Probes#

Probe

Request

Period

Timeout

Failure threshold

Startup

GET / on http

10 seconds

15 seconds

60, so up to 10 minutes for the first start

Readiness

GET / on http

10 seconds

15 seconds

3

Liveness

GET / on http

10 seconds

15 seconds

3

Site creation#

With site.create set to true (default), the chart creates the Job <release>-site, which creates the Plone site with the id site.id, if it doesn’t exist yet.

Setting

Value

Hook

post-install,post-upgrade, so Helm waits for it after each install and upgrade

Deletion

before a new run, and when it succeeds; a failed Job is kept for its logs

Retries

6

Image

the backend image

Site type

Volto with frontend.enabled, Classic UI without it

The backend pods only serve the site, and don’t go through the site creation of the plone-backend image, which isn’t meant for production. site.profiles and site.defaultLanguage only apply when the site is created.

Volume#

The backend mounts an emptyDir volume at /data, for the client home, the blob cache, and the ZEO client cache. The content of an emptyDir is lost when its pod is replaced.

Values#

The values of this component are under backend, see Values. Its pod options are podAnnotations, podSecurityContext, securityContext, nodeSelector, tolerations, and affinity.