Helm Values reference
This page contains a reference table for Magnolia helm values.
The latest helm chart version is 1.10.0
.
Check out the Magnolia helm repo for more details. |
Key | Type | Default | Description | ||
---|---|---|---|---|---|
|
|
|
Do enable bootstrapping via REST. |
||
|
|
|
Deploy into this directory innside the app server container. |
||
|
|
|
|||
|
|
|
Fixup file permissions for volumes mounted to the Magnolia pod. |
||
|
|
|
Group ID. |
||
|
|
|
Run application pod under this user ID. Note: Do not use a privileged user here. |
||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
Tomcat repo pull policy. |
||
|
|
|
The tomcat image we’re going to use. |
||
|
|
|
Tomcat repo tag. |
||
|
|
|
Additional annotations for the ingress object. |
||
|
|
|
Enable/disable ingress configuration. |
||
|
|
|
Specify hosts here as an array. |
||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
Where to find the init script which copies .jar files into tomcat/lib. |
||
|
|
|
|||
|
|
|
Example of additional jar, here the Postgres JDBC driver. |
||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
This is the author’s configuration. It should not use H2 data base (the default). |
||
|
|
Pass the base URL to be set as the Magnolia
|
|||
|
|
|
Set this to true in case you want to use an existing activation key stored as a secret and provide its name. |
||
|
|
|
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". |
||
|
|
|
These key/value pairs will be added to CATALINA_OPTS. |
||
|
|
|
The context path of this Magnolia instance. Always use a leading slash. |
||
|
|
|
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. |
||
|
|
|
Enable db backup sidecar. |
||
|
|
|
TLS port of the backup sidecar. |
||
|
|
|
Errors detected by a consistency check are automatically repaired. If false, errors are only written to the log. |
||
|
|
|
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. |
||
|
|
|
Extra search index parameters for jackrabbit configuration (e.g. overwrite search excerpt provider class with excerptProviderClass) |
||
|
|
|
Runs a consistency check on every startup. If false, a consistency check is only performed when the search index detects a prior forced shutdown. |
||
|
|
|
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. |
||
|
|
|
Mount point is /db, PGDATA=/db/data |
||
|
|
|
Mount point is /db, PGDATA=/db/data |
||
|
|
|
Custom annotations added to db pods. |
||
|
|
|
URL to backup bundle JSON file to use for restore. |
||
|
|
|
Enable restore operations. |
||
|
|
|
If false, does not deploy the author instance. |
||
|
|
|
Extra sidecar containers added to the Magnolia pod. |
||
|
|
|
Extra init containers added to the Magnolia pod. |
||
|
|
|
Additional JDNI resources to be added in tomcat’s server.xml. The key/value pairs will be mapped to xml. |
||
|
|
|
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. |
||
|
|
|
Existing volumes can be mounted into the container. If not specified, helm will create a new PVC. |
||
|
|
|
In case of local-path provisioners this is not enforced. |
||
|
|
|
Empty string means: Use the default storage class. |
||
|
|
|
Custom annotations added to pod. |
||
|
|
|
If true, redeploy on "helm upgrade/install" even if no changes were made. |
||
|
|
|
Enable Groovy rescue console. |
||
|
|
|
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. |
||
|
|
|
Minimum amount of memory this pod requests. |
||
|
|
|
Maximum amount allocated to heap as a percentage of the pod’s resources. |
||
|
|
|
Minimum amount allocated to heap as a percentage of the pod’s resources. |
||
|
|
|
Auto-update Magnolia if repositories are empty (usually on the first run). |
||
|
|
|
Kubernetes rollout strategy on helm upgrade …. |
||
|
|
|
Tomcat configuration |
||
|
|
|
Activate the websockets |
||
|
|
|
Error valve configuration |
||
|
|
|
Show error report |
||
|
|
|
Show server info |
||
|
|
|
Log JVM arguments |
||
|
|
|
The maximum permitted size of the request line and headers associated with an HTTP request and response |
||
|
|
|
The docker image where to fetch compiled Magnolia libs from. |
||
|
|
|
Do not use 'latest' in production. |
||
|
|
|
This is the public instance. |
||
|
|
Pass the base URL to be set as the Magnolia
|
|||
|
|
|
Boolean that specifies whether the redirects server is enabled or not.
|
||
|
|
|
Set this to true in case you want to use an existing activation key stored as a secret and provide its name. |
||
|
|
|
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". |
||
|
|
|
These key/value pairs will be added to CATALINA_OPTS. |
||
|
|
|
The context path of this Magnolia instance. Always use a leading slash. |
||
|
|
|
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. |
||
|
|
|
Enable db backup sidecar. |
||
|
|
|
TLS port of the backup sidecar. |
||
|
|
|
Enable content sync on public instances. Depends on the backup being enabled and configured correctly for pg_wal log shipping. |
||
|
|
|
Errors detected by a consistency check are automatically repaired. If false, errors are only written to the log. |
||
|
|
|
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. |
||
|
|
|
Extra search index parameters for jackrabbit configuration (e.g. overwrite search excerpt provider class with excerptProviderClass) |
||
|
|
|
Runs a consistency check on every startup. If false, a consistency check is only performed when the search index detects a prior forced shutdown. |
||
|
|
|
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. |
||
|
|
|
Mount point is /db, PGDATA=/db/data |
||
|
|
|
Mount point is /db, PGDATA=/db/data |
||
|
|
|
URL to backup bundle JSON file to use for restore. |
||
|
|
|
Enable restore operations. |
||
|
|
|
Extra sidecar containers added to the Magnolia pod. |
||
|
|
|
Extra init containers added to the Magnolia pod. |
||
|
|
|
Additional JDNI resources to be added in tomcat’s server.xml. The key/value pairs will be mapped to xml. |
||
|
|
|
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. |
||
|
|
|
Existing volumes can be mounted into the container. If not specified, helm will create a new PVC. |
||
|
|
|
In case of local-path provisioners this is not enforced. |
||
|
|
|
Empty string means: Use the default storage class. |
||
|
|
|
Custom annotations added to pods. |
||
|
|
|
If true, redeploy on "helm upgrade/install" even if no changes were made. |
||
|
|
|
How many public instances to deploy. |
||
|
|
|
Enable Groovy rescue console. |
||
|
|
|
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. |
||
|
|
|
Minimum amount of memory this pod requests. |
||
|
|
|
Maximum amount allocated to heap as a percentage of the pod’s resources. |
||
|
|
|
Minimum amount allocated to heap as a percentage of the pod’s resources. |
||
|
|
|
Auto-update Magnolia if repositories are empty (usually on the first run). |
||
|
|
|
Kubernetes rollout strategy on helm upgrade …. |
||
|
|
|
Tomcat configuration |
||
|
|
|
Activate the websockets |
||
|
|
|
Error valve configuration |
||
|
|
|
Show error report |
||
|
|
|
Show server info |
||
|
|
|
Log JVM arguments |
||
|
|
|
The maximum permitted size of the request line and headers associated with an HTTP request and response |
||
|
|
|
The docker image where to fetch compiled Magnolia libs from. |
||
|
|
|
Do not use 'latest' in production. |
||
|
|
|
Enable JMX exporters. |
||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
Where to get the bootstrapper from. This should not be changed under normal circumstances. |
||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
|||
|
|
|
Shared database (jackrabbit "clustering"). |
||
|
|
|
TLS port of the backup sidecar. |
||
|
|
|
Errors detected by a consistency check are automatically repaired. If false, errors are only written to the log. |
||
|
|
|
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. |
||
|
|
|
Extra search index parameters for jackrabbit configuration (e.g. overwrite search excerpt provider class with excerptProviderClass) |
||
|
|
|
Runs a consistency check on every startup. If false, a consistency check is only performed when the search index detects a prior forced shutdown. |
||
|
|
|
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. |
||
|
|
|
Mount point is /db, PGDATA=/db/data |
||
|
|
|
Custom annotations added to db pods. |
||
|
|
|
URL to backup bundle JSON file to use for restore. |
||
|
|
|
Enable restore operations. |
||
|
|
|
Enable shared db |
||
|
|
|
Timezone for Magnolia. |