Helm Values reference

This page contains a reference table for Magnolia helm values.

The latest helm chart version is 1.6.2.

Check out the Magnolia helm repo for more details.
Key Type Default Description

bootstrap.enabled

bool

true

Do enable bootstrapping via REST.

deploy.directory

string

"/usr/local/tomcat/webapps"

Deploy into this directory innside the app server container.

deploy.extraLibs

string

"/usr/local/tomcat/lib2"

deploy.securityContext.fsGroup

int

1000

Fixup file permissions for volumes mounted to the Magnolia pod.

deploy.securityContext.runAsGroup

int

1000

Group ID.

deploy.securityContext.runAsUser

int

1000

Run application pod under this user ID. Note: Do not use a privileged user here.

deploy.tempDir

string

"/usr/local/tomcat/temp"

fullnameOverride

string

""

image.pullSecrets

list

[]

image.tomcat.pullPolicy

string

"IfNotPresent"

Tomcat repo pull policy.

image.tomcat.repository

string

"tomcat"

The tomcat image we’re going to use.

image.tomcat.tag

string

"9.0-jre11-temurin"

Tomcat repo tag.

ingress.annotations

object

{}

Additional annotations for the ingress object.

ingress.enabled

bool

false

Enable/disable ingress configuration.

ingress.hosts

list

[]

Specify hosts here as an array.

ingress.tls

list

[]

jars[0].env[0].name

string

"INIT_DEST"

jars[0].env[0].value

string

"/app/magnolia/WEB-INF/lib"

jars[0].initScript

string

"/init.sh"

Where to find the init script which copies .jar files into tomcat/lib.

jars[0].name

string

"postgres-jdbc"

jars[0].repository

string

"registry.gitlab.com/mironet/magnolia-jar/postgres-42.2.8"

Example of additional jar, here the Postgres JDBC driver.

jars[0].tag

string

"v0.0.2"

jars[1].env[0].name

string

"INIT_DEST"

jars[1].env[0].value

string

"/extraLibs/"

jars[1].initScript

string

"/init.sh"

jars[1].name

string

"jmx-exporter"

jars[1].repository

string

"registry.gitlab.com/mironet/magnolia-jar/jmx_prometheus_javaagent-0.13.0"

jars[1].tag

string

"v0.0.2"

jars[2].env[0].name

string

"INIT_DEST"

jars[2].env[0].value

string

"/app/magnolia/WEB-INF/lib"

jars[2].initScript

string

"/init.sh"

jars[2].name

string

"jjwt-jackson"

jars[2].repository

string

"registry.gitlab.com/mironet/magnolia-jar/jjwt-jackson-0.11.2"

jars[2].tag

string

"v0.0.2"

jars[3].env[0].name

string

"INIT_DEST"

jars[3].env[0].value

string

"/app/magnolia/WEB-INF/lib"

jars[3].initScript

string

"/init.sh"

jars[3].name

string

"jjwt-impl"

jars[3].repository

string

"registry.gitlab.com/mironet/magnolia-jar/jjwt-impl-0.11.2"

jars[3].tag

string

"v0.0.2"

jars[4].env[0].name

string

"INIT_DEST"

jars[4].env[0].value

string

"/app/magnolia/WEB-INF/lib"

jars[4].initScript

string

"/init.sh"

jars[4].name

string

"jjwt-api"

jars[4].repository

string

"registry.gitlab.com/mironet/magnolia-jar/jjwt-api-0.11.2"

jars[4].tag

string

"v0.0.2"

jars[5].env[0].name

string

"INIT_DEST"

jars[5].env[0].value

string

"/app/magnolia/WEB-INF/lib"

jars[5].initScript

string

"/init.sh"

jars[5].name

string

"magnolia-rest-security-core"

jars[5].repository

string

"registry.gitlab.com/mironet/magnolia-jar/magnolia-rest-security-core-1.0.3"

jars[5].tag

string

"v0.0.2"

jars[6].env[0].name

string

"INIT_DEST"

jars[6].env[0].value

string

"/app/magnolia/WEB-INF/lib"

jars[6].initScript

string

"/init.sh"

jars[6].name

string

"magnolia-cloud-bootstrapper"

jars[6].repository

string

"registry.gitlab.com/mironet/magnolia-jar/magnolia-cloud-bootstrapper-1.0.2"

jars[6].tag

string

"v0.0.2"

magnoliaAuthor

object

See values below …​

This is the author’s configuration. It should not use H2 data base (the default).

magnoliaAuthor.activation.useExistingSecret

bool

false

Set this to true in case you want to use an existing activation key stored as a secret and provide its name.

magnoliaAuthor.bootstrap.instructions

string

""

Verbatim content of the instructions for this instance. If empty use a default. This is intended to be used with the --set-file flag of "helm install".

magnoliaAuthor.catalinaExtraEnv

object

{}

These key/value pairs will be added to CATALINA_OPTS.

magnoliaAuthor.contextPath

string

"/author"

The context path of this Magnolia instance. Always use a leading slash.

magnoliaAuthor.db.backup.autoconfig.enabled

bool

false

Configures the backup for pg_wal automatically in a k8s environment. It does this by including a configmap via the envFrom: directive which will be injected into the pod. You can override or pass other environment variables via the env: or the extraEnv: directive below.

magnoliaAuthor.db.backup.enabled

bool

false

Enable db backup sidecar.

magnoliaAuthor.db.contentsync.address

string

":9998"

TLS port of the backup sidecar.

magnoliaAuthor.db.jackrabbit.autoRepair

bool

true

Errors detected by a consistency check are automatically repaired. If false, errors are only written to the log.

magnoliaAuthor.db.jackrabbit.enableConsistencyCheck

bool

false

If set to true a consistency check is performed depending on the parameter forceConsistencyCheck. If set to false no consistency check is performed on startup, even if a redo log had been applied.

magnoliaAuthor.db.jackrabbit.extraSearchIndexParameters

object

{}

Extra search index parameters for jackrabbit configuration (e.g. overwrite search excerpt provider class with excerptProviderClass)

magnoliaAuthor.db.jackrabbit.forceConsistencyCheck

bool

false

Runs a consistency check on every startup. If false, a consistency check is only performed when the search index detects a prior forced shutdown.

magnoliaAuthor.db.jackrabbit.onWorkspaceInconsistency

string

"log"

If set to log, the process will just log the inconsistency during the re-indexing on startup. If set to fail, the process will fail the re-indexing on startup.

magnoliaAuthor.db.persistence.mountPath

string

"/db"

Mount point is /db, PGDATA=/db/data

magnoliaAuthor.db.persistence.subPath

string

"data"

Mount point is /db, PGDATA=/db/data

magnoliaAuthor.db.podAnnotations

object

{}

Custom annotations added to db pods.

magnoliaAuthor.db.restore.bundle_url

string

"https://s3…​"

URL to backup bundle JSON file to use for restore.

magnoliaAuthor.db.restore.enabled

bool

false

Enable restore operations.

magnoliaAuthor.enabled

bool

true

If false, does not deploy the author instance.

magnoliaAuthor.extraContainers

list

[]

Extra sidecar containers added to the Magnolia pod.

magnoliaAuthor.extraInitContainers

list

[]

Extra init containers added to the Magnolia pod.

magnoliaAuthor.jndiResources

list

[]

Additional JDNI resources to be added in tomcat’s server.xml. The key/value pairs will be mapped to xml.

magnoliaAuthor.persistence.enabled

bool

true

Enable persistence for indexes, cache, tmp files. If this is enabled the MGNL_HOME_DIR env var will be set and a volume will be mounted to the default location unless it’s specified here as mountPath.

magnoliaAuthor.persistence.existingClaim

string

nil

Existing volumes can be mounted into the container. If not specified, helm will create a new PVC.

magnoliaAuthor.persistence.size

string

"10Gi"

In case of local-path provisioners this is not enforced.

magnoliaAuthor.persistence.storageClassName

string

""

Empty string means: Use the default storage class.

magnoliaAuthor.podAnnotations

object

{}

Custom annotations added to pod.

magnoliaAuthor.redeploy

bool

false

If true, redeploy on "helm upgrade/install" even if no changes were made.

magnoliaAuthor.rescueMode

bool

false

Enable Groovy rescue console.

magnoliaAuthor.resources.limits.memory

string

"512Mi"

Maximum amount of memory this pod is allowed to use. This is not the heap size, the heap size is smaller, see setenv.memory for details.

magnoliaAuthor.resources.requests.memory

string

"512Mi"

Minimum amount of memory this pod requests.

magnoliaAuthor.setenv.memory.maxPercentage

int

60

Maximum amount allocated to heap as a percentage of the pod’s resources.

magnoliaAuthor.setenv.memory.minPercentage

int

25

Minimum amount allocated to heap as a percentage of the pod’s resources.

magnoliaAuthor.setenv.update.auto

string

"true"

Auto-update Magnolia if repositories are empty (usually on the first run).

magnoliaAuthor.strategy.type

string

"Recreate"

Kubernetes rollout strategy on helm upgrade …​.

magnoliaAuthor.tomcat

object

{"activateWebsockets":false,"error":{"showReport":false,"showServerInfo":false},"logArgs":false,"maxHttpHeaderSize":8192}

Tomcat configuration

magnoliaAuthor.tomcat.activateWebsockets

bool

false

Activate the websockets

magnoliaAuthor.tomcat.error

object

{"showReport":false,"showServerInfo":false}

Error valve configuration

magnoliaAuthor.tomcat.error.showReport

bool

false

Show error report

magnoliaAuthor.tomcat.error.showServerInfo

bool

false

Show server info

magnoliaAuthor.tomcat.logArgs

bool

false

Log JVM arguments

magnoliaAuthor.tomcat.maxHttpHeaderSize

int

8192

The maximum permitted size of the request line and headers associated with an HTTP request and response

magnoliaAuthor.webarchive.repository

string

"registry.gitlab.com/mironet/magnolia-demo"

The docker image where to fetch compiled Magnolia libs from.

magnoliaAuthor.webarchive.tag

string

"latest"

Do not use 'latest' in production.

magnoliaPublic

object

See values below …​

This is the public instance.

magnoliaPublic.redirects.enabled

boolean

false

Boolean that specifies whether the redirects server is enabled or not.

You should trigger a pipeline after a change to this parameter to ensure the redirects server is installed on your cluster.

magnoliaPublic.activation.useExistingSecret

bool

false

Set this to true in case you want to use an existing activation key stored as a secret and provide its name.

magnoliaPublic.bootstrap.instructions

string

""

Verbatim content of the instructions for this instance. If empty use a default. This is intended to be used with the --set-file flag of "helm install".

magnoliaPublic.catalinaExtraEnv

object

{}

These key/value pairs will be added to CATALINA_OPTS.

magnoliaPublic.contextPath

string

"/"

The context path of this Magnolia instance. Always use a leading slash.

magnoliaPublic.db.backup.autoconfig.enabled

bool

false

Configures the backup for pg_wal automatically in a k8s environment. It does this by including a configmap via the envFrom: directive which will be injected into the pod. You can override or pass other environment variables via the env: or the extraEnv: directive below.

magnoliaPublic.db.backup.enabled

bool

false

Enable db backup sidecar.

magnoliaPublic.db.contentsync.address

string

":9998"

TLS port of the backup sidecar.

magnoliaPublic.db.contentsync.enabled

bool

false

Enable content sync on public instances. Depends on the backup being enabled and configured correctly for pg_wal log shipping.

magnoliaPublic.db.jackrabbit.autoRepair

bool

true

Errors detected by a consistency check are automatically repaired. If false, errors are only written to the log.

magnoliaPublic.db.jackrabbit.enableConsistencyCheck

bool

false

If set to true a consistency check is performed depending on the parameter forceConsistencyCheck. If set to false no consistency check is performed on startup, even if a redo log had been applied.

magnoliaPublic.db.jackrabbit.extraSearchIndexParameters

object

{}

Extra search index parameters for jackrabbit configuration (e.g. overwrite search excerpt provider class with excerptProviderClass)

magnoliaPublic.db.jackrabbit.forceConsistencyCheck

bool

false

Runs a consistency check on every startup. If false, a consistency check is only performed when the search index detects a prior forced shutdown.

magnoliaPublic.db.jackrabbit.onWorkspaceInconsistency

string

"log"

If set to log, the process will just log the inconsistency during the re-indexing on startup. If set to fail, the process will fail the re-indexing on startup.

magnoliaPublic.db.persistence.mountPath

string

"/db"

Mount point is /db, PGDATA=/db/data

magnoliaPublic.db.persistence.subPath

string

"data"

Mount point is /db, PGDATA=/db/data

magnoliaPublic.db.restore.bundle_url

string

"https://s3…​"

URL to backup bundle JSON file to use for restore.

magnoliaPublic.db.restore.enabled

bool

false

Enable restore operations.

magnoliaPublic.extraContainers

list

[]

Extra sidecar containers added to the Magnolia pod.

magnoliaPublic.extraInitContainers

list

[]

Extra init containers added to the Magnolia pod.

magnoliaPublic.jndiResources

list

[]

Additional JDNI resources to be added in tomcat’s server.xml. The key/value pairs will be mapped to xml.

magnoliaPublic.persistence.enabled

bool

true

Enable persistence for indexes, cache, tmp files. If this is enabled the MGNL_HOME_DIR env var will be set and a volume will be mounted to the default location unless it’s specified here as mountPath.

magnoliaPublic.persistence.existingClaim

string

nil

Existing volumes can be mounted into the container. If not specified, helm will create a new PVC.

magnoliaPublic.persistence.size

string

"10Gi"

In case of local-path provisioners this is not enforced.

magnoliaPublic.persistence.storageClassName

string

""

Empty string means: Use the default storage class.

magnoliaPublic.podAnnotations

object

{}

Custom annotations added to pods.

magnoliaPublic.redeploy

bool

true

If true, redeploy on "helm upgrade/install" even if no changes were made.

magnoliaPublic.replicas

int

1

How many public instances to deploy.

magnoliaPublic.rescueMode

bool

false

Enable Groovy rescue console.

magnoliaPublic.resources.limits.memory

string

"512Mi"

Maximum amount of memory this pod is allowed to use. This is not the heap size, the heap size is smaller, see setenv.memory for details.

magnoliaPublic.resources.requests.memory

string

"512Mi"

Minimum amount of memory this pod requests.

magnoliaPublic.setenv.memory.maxPercentage

int

60

Maximum amount allocated to heap as a percentage of the pod’s resources.

magnoliaPublic.setenv.memory.minPercentage

int

25

Minimum amount allocated to heap as a percentage of the pod’s resources.

magnoliaPublic.setenv.update.auto

string

"true"

Auto-update Magnolia if repositories are empty (usually on the first run).

magnoliaPublic.strategy.type

string

"Recreate"

Kubernetes rollout strategy on helm upgrade …​.

magnoliaPublic.tomcat

object

{"activateWebsockets":false,"error":{"showReport":false,"showServerInfo":false},"logArgs":false,"maxHttpHeaderSize":8192}

Tomcat configuration

magnoliaPublic.tomcat.activateWebsockets

bool

false

Activate the websockets

magnoliaPublic.tomcat.error

object

{"showReport":false,"showServerInfo":false}

Error valve configuration

magnoliaPublic.tomcat.error.showReport

bool

false

Show error report

magnoliaPublic.tomcat.error.showServerInfo

bool

false

Show server info

magnoliaPublic.tomcat.logArgs

bool

false

Log JVM arguments

magnoliaPublic.tomcat.maxHttpHeaderSize

int

8192

The maximum permitted size of the request line and headers associated with an HTTP request and response

magnoliaPublic.webarchive.repository

string

"registry.gitlab.com/mironet/magnolia-demo"

The docker image where to fetch compiled Magnolia libs from.

magnoliaPublic.webarchive.tag

string

"latest"

Do not use 'latest' in production.

metrics.enabled

bool

true

Enable JMX exporters.

metrics.metricsServerPort

int

8000

metrics.setPrometheusAnnotations

bool

true

nameOverride

string

""

postjob.image

string

"registry.gitlab.com/mironet/magnolia-bootstrap"

Where to get the bootstrapper from. This should not be changed under normal circumstances.

postjob.imagePullPolicy

string

"IfNotPresent"

postjob.tag

string

"v0.2.6"

postjob.waitFor

string

"10m"

service.annotations

object

{}

service.clusterIP

string

"None"

service.ports[0].name

string

"http"

service.ports[0].port

int

80

service.ports[0].protocol

string

"TCP"

service.ports[0].targetPort

int

8080

service.type

string

"ClusterIP"

sharedDb

object

See values below …​

Shared database (jackrabbit "clustering").

sharedDb.db.contentsync.address

string

":9998"

TLS port of the backup sidecar.

sharedDb.db.jackrabbit.autoRepair

bool

true

Errors detected by a consistency check are automatically repaired. If false, errors are only written to the log.

sharedDb.db.jackrabbit.enableConsistencyCheck

bool

false

If set to true a consistency check is performed depending on the parameter forceConsistencyCheck. If set to false no consistency check is performed on startup, even if a redo log had been applied.

sharedDb.db.jackrabbit.extraSearchIndexParameters

object

{}

Extra search index parameters for jackrabbit configuration (e.g. overwrite search excerpt provider class with excerptProviderClass)

sharedDb.db.jackrabbit.forceConsistencyCheck

bool

false

Runs a consistency check on every startup. If false, a consistency check is only performed when the search index detects a prior forced shutdown.

sharedDb.db.jackrabbit.onWorkspaceInconsistency

string

"log"

If set to log, the process will just log the inconsistency during the re-indexing on startup. If set to fail, the process will fail the re-indexing on startup.

sharedDb.db.persistence.subPath

string

"data"

Mount point is /db, PGDATA=/db/data

sharedDb.db.podAnnotations

object

{}

Custom annotations added to db pods.

sharedDb.db.restore.bundle_url

string

"https://s3…​"

URL to backup bundle JSON file to use for restore.

sharedDb.db.restore.enabled

bool

false

Enable restore operations.

sharedDb.enabled

bool

false

Enable shared db

timezone

string

"Europe/Zurich"

Timezone for Magnolia.

Feedback