Values#

This page describes the values of the chart. The defaults are the ones of charts/plone/values.yaml, written as YAML. Values that aren’t set by default are marked as not set.

Top-level values#

Key

Default

Description

nameOverride

""

Overrides the chart name in the labels of the resources.

fullnameOverride

""

Overrides the prefix of the resource names, which is the release name by default.

imagePullSecrets

[]

Pull secrets of all the pods.

global#

The VCL of Varnish only reads the global values, see Varnish. With varnish.enabled, the chart fails if they don’t match the values they mirror.

Key

Default

Description

global.plone.fullnameOverride

""

Must match fullnameOverride.

global.plone.backendPort

8080

Must match backend.service.port.

global.plone.frontendPort

3000

Must match frontend.service.port.

site#

Key

Default

Description

site.id

"Plone"

Id of the Plone site object in Zope.

site.create

true

Creates the site, if it doesn’t exist yet, with a Job that runs after each install and upgrade. Its type follows frontend.enabled.

site.profiles

""

Add-on profiles to apply when creating the site, comma separated.

site.defaultLanguage

""

Default language of the site, such as en or pt-br.

storage#

Key

Default

Description

storage.type

"relstorage"

relstorage for RelStorage on PostgreSQL, or zeo for a ZEO server.

storage.relstorage#

Key

Default

Description

storage.relstorage.host

""

PostgreSQL host. Defaults to <release>-postgresql-rw with postgresql.enabled, and is required without it.

storage.relstorage.port

5432

PostgreSQL port.

storage.relstorage.secret.name

""

Secret with the database name, user name, and password. Defaults to <release>-postgresql-app with postgresql.enabled, and is required without it.

storage.relstorage.secret.keys

{}

Keys of the database name (database), user name (user), and password (password) in the secret. Not set by default, see Storage.

storage.relstorage.keepHistory

true

Keeps the history of the objects, needed for undo.

storage.relstorage.blobCacheSize

"100mb"

Size of the blob cache of each backend pod.

storage.zeo#

Key

Default

Description

storage.zeo.address

""

host:port of an external ZEO server. Empty deploys a ZEO server with the chart.

storage.zeo.clientCacheSize

"128MB"

Size of the ZEO client cache of each backend pod.

storage.zeo.server#

Key

Default

Description

storage.zeo.server.image.repository

"docker.io/plone/plone-zeo"

Image of the ZEO server.

storage.zeo.server.image.tag

"6.0.0"

Tag of the ZEO server image.

storage.zeo.server.image.pullPolicy

"IfNotPresent"

Pull policy of the ZEO server image.

storage.zeo.server.persistence.enabled

true

Stores the data of the ZEO server in a persistent volume.

storage.zeo.server.persistence.accessMode

"ReadWriteOnce"

Access mode of the volume.

storage.zeo.server.persistence.size

"5Gi"

Size of the volume.

storage.zeo.server.persistence.storageClass

not set

Storage class of the volume. Unset uses the default class, and - sets an empty class name.

storage.zeo.server.env

[]

Extra environment variables of the ZEO server, see the plone-zeo image documentation.

storage.zeo.server.resources

{requests: {cpu: "50m", memory: "48Mi"}}

Resources of the ZEO server.

storage.zeo.server.podAnnotations

{}

Annotations of the ZEO server pod.

storage.zeo.server.podSecurityContext

{runAsNonRoot: true, runAsUser: 500, runAsGroup: 500, fsGroup: 500, fsGroupChangePolicy: OnRootMismatch, seccompProfile: {type: RuntimeDefault}}

Pod security context of the ZEO server pod. The defaults comply with the Pod Security restricted profile.

storage.zeo.server.securityContext

{allowPrivilegeEscalation: false, capabilities: {drop: [ALL]}}

Security context of the ZEO server container.

storage.zeo.server.nodeSelector

{}

Node selector of the ZEO server pod.

storage.zeo.server.tolerations

[]

Tolerations of the ZEO server pod.

storage.zeo.server.affinity

{}

Affinity of the ZEO server pod.

pack#

Key

Default

Description

pack.enabled

true

Creates the CronJob that packs the database.

pack.schedule

"45 9 * * *"

Cron schedule of the pack job.

pack.days

7

Keeps the history of the last days, so that undo works for them. 0 removes all of the history.

pack.backoffLimit

1

Retries of a failed pack, until the next schedule.

pack.activeDeadlineSeconds

82800

Stops a pack that runs for longer, 23 hours by default. Keep it below the schedule interval.

pack.resources

{}

Resources of the pack job.

backend#

Key

Default

Description

backend.image.repository

"docker.io/plone/plone-backend"

Image of the backend.

backend.image.tag

""

Tag of the backend image. Empty uses the appVersion of the chart.

backend.image.pullPolicy

"IfNotPresent"

Pull policy of the backend image.

backend.replicas

1

Number of backend pods.

backend.podDisruptionBudget.enabled

true

Creates a PodDisruptionBudget, when there is more than one replica.

backend.podDisruptionBudget.minAvailable

"50%"

Minimum number of available pods.

backend.podDisruptionBudget.maxUnavailable

not set

Maximum number of unavailable pods, as an alternative to minAvailable.

backend.zodbCacheSize

50000

Size of the ZODB object cache, in objects.

backend.env

[]

Extra environment variables of the backend, see the plone-backend image documentation.

backend.service.type

"ClusterIP"

Type of the backend service.

backend.service.port

8080

Port of the backend service.

backend.resources

{requests: {cpu: "100m", memory: "300Mi"}}

Resources of the backend pods.

backend.startupProbe

{httpGet: {path: "/", port: "http"}, periodSeconds: 10, timeoutSeconds: 15, failureThreshold: 60}

Startup probe. It allows up to 10 minutes for the first start, during which the database is initialized.

backend.readinessProbe

{httpGet: {path: "/", port: "http"}, periodSeconds: 10, timeoutSeconds: 15, failureThreshold: 3}

Readiness probe.

backend.livenessProbe

{httpGet: {path: "/", port: "http"}, periodSeconds: 10, timeoutSeconds: 15, failureThreshold: 3}

Liveness probe.

backend.podAnnotations

{}

Annotations of the backend pods.

backend.podSecurityContext

{}

Pod security context of the backend pods.

backend.securityContext

{}

Security context of the backend container.

backend.nodeSelector

{}

Node selector of the backend pods.

backend.tolerations

[]

Tolerations of the backend pods.

backend.affinity

{}

Affinity of the backend pods.

frontend#

Key

Default

Description

frontend.enabled

true

Installs the Volto frontend. Set it to false for the Classic UI.

frontend.image.repository

"docker.io/plone/plone-frontend"

Image of the frontend.

frontend.image.tag

"19.7.0"

Tag of the frontend image.

frontend.image.pullPolicy

"IfNotPresent"

Pull policy of the frontend image.

frontend.replicas

1

Number of frontend pods.

frontend.podDisruptionBudget.enabled

true

Creates a PodDisruptionBudget, when there is more than one replica.

frontend.podDisruptionBudget.minAvailable

"50%"

Minimum number of available pods.

frontend.podDisruptionBudget.maxUnavailable

not set

Maximum number of unavailable pods, as an alternative to minAvailable.

frontend.env

[]

Extra environment variables of the frontend, see the plone-frontend image documentation.

frontend.service.type

"ClusterIP"

Type of the frontend service.

frontend.service.port

3000

Port of the frontend service.

frontend.resources

{requests: {cpu: "50m", memory: "200Mi"}}

Resources of the frontend pods.

frontend.readinessProbe

{httpGet: {path: "/ok", port: "http"}, periodSeconds: 10}

Readiness probe.

frontend.livenessProbe

{httpGet: {path: "/ok", port: "http"}, periodSeconds: 10}

Liveness probe.

frontend.podAnnotations

{}

Annotations of the frontend pods.

frontend.podSecurityContext

{}

Pod security context of the frontend pods.

frontend.securityContext

{}

Security context of the frontend container.

frontend.nodeSelector

{}

Node selector of the frontend pods.

frontend.tolerations

[]

Tolerations of the frontend pods.

frontend.affinity

{}

Affinity of the frontend pods.

postgresql#

These values configure the PostgreSQL cluster of the CloudNativePG cluster chart. The chart accepts all the other values of that chart under postgresql too, see its documentation.

Key

Default

Description

postgresql.enabled

true

Creates the PostgreSQL cluster with the chart. Set it to false with ZEO, or with an external PostgreSQL server.

postgresql.cluster.instances

1

Number of PostgreSQL instances.

postgresql.cluster.enablePDB

false

Creates a PodDisruptionBudget for the cluster.

postgresql.cluster.enableSuperuserAccess

false

Enables the superuser access of the cluster. Plone only needs the database owner created by initdb.

postgresql.cluster.storage.size

"8Gi"

Size of the volume of each instance.

postgresql.cluster.initdb.database

"plone"

Name of the database.

postgresql.cluster.initdb.owner

"plone"

Owner of the database.

varnish#

These values configure the Varnish cache, which the varnish-cache chart installs. The chart accepts all the other values of that chart under varnish too, see its documentation.

Key

Default

Description

varnish.enabled

false

Installs Varnish in front of the site.

varnish.ploneFrontend

true

Whether the default VCL sends requests to the Volto frontend. It must match frontend.enabled. Set it to false for the Classic UI.

varnish.server.replicas

1

Number of Varnish pods.

varnish.server.pdb.enabled

false

Creates a PodDisruptionBudget for Varnish.

varnish.server.pdb.minAvailable

"50%"

Minimum number of available Varnish pods.

varnish.server.service.type

"ClusterIP"

Type of the Varnish service.

varnish.server.service.http.port

6081

Port of the Varnish service.

varnish.server.affinity

a preference for pod anti-affinity by node

Affinity of the Varnish pods. See Varnish.

varnish.server.vclConfig

the default VCL

VCL of Varnish, rendered as a template. See Varnish.

routing#

Key

Default

Description

routing.type

"gateway"

gateway for a Gateway API HTTPRoute, ingress-nginx for Ingress resources, or none for no routing resources.

routing.hostname

"localhost"

Public hostname of the site.

routing.https

false

Whether clients reach the site over HTTPS. Used to build the URLs, and doesn’t configure TLS.

routing.port

""

Public port of the site. Empty uses 443 with HTTPS, and 80 without.

routing.gateway#

Key

Default

Description

routing.gateway.name

""

Gateway of the HTTPRoute. Required with routing.type: gateway, unless parentRefs is set.

routing.gateway.namespace

""

The namespace of the Gateway. Empty uses the namespace of the release.

routing.gateway.sectionName

""

Listener of the Gateway. Empty accepts all the listeners that accept the route.

routing.gateway.parentRefs

[]

Gateways to attach to, as Gateway API parent references. Takes precedence over name, namespace, and sectionName.

routing.gateway.annotations

{}

Annotations of the HTTPRoute.

routing.ingressNginx#

Key

Default

Description

routing.ingressNginx.className

"nginx"

IngressClass of the Ingress resources.

routing.ingressNginx.annotations

{}

Annotations added to all the Ingress resources, for example for cert-manager.

routing.ingressNginx.tls

[]

TLS section of the Ingress resources, with secretName and hosts.

Validation#

The chart fails to install with an explanation when the values don’t make sense together:

  • storage.type must be relstorage or zeo.

  • routing.type must be gateway, ingress-nginx, or none.

  • With varnish.enabled, varnish.ploneFrontend must match frontend.enabled.

  • With routing.type: gateway, routing.gateway.name or routing.gateway.parentRefs must be set.

  • With postgresql.enabled set to false and storage.type: relstorage, storage.relstorage.host and storage.relstorage.secret.name must be set.

  • With storage.type: zeo, postgresql.enabled must be false.