XWiki Helm Chart

Last modified by Guilherme Sautner on 2024/12/06 19:15

Provide a helm chart to install and configure XWiki in a Kubernetes environment

Type	Other
Category	Other
Developed by	xwiki:XWiki.ashish, Ludovic Dubost, Guilherme Sautner, Arsène Fougerouse, Martin Moreira de Jesus
Rating	0.0 1 2 3 4 5 0 Votes
License	GNU Lesser General Public License 2.1

Sources

Description

This contrib extension provides Helm Chart aiming to ease the deployment in both Local and Highly Available setups.

TL/DR

helm repo add xwiki-helm https://xwiki-contrib.github.io/xwiki-helm
# Use --devel install most recent released (beta/alpha) version
helm upgrade -i xwiki xwiki-helm/xwiki

XWiki <1.0.0 Install from source.

Complete guide to see Requirements/Install instructions.

Know Limitations

Follow features are available but are considered as experimental/incomplete:

Enable HA (Cluster/Autoscale Settings)
Custom internal Solr instance
Prometheus Metrics

Parameters

XWiki

Name	Description	Value
image.name	XWiki docker image name	xwiki
image.tag	XWiki docker image tag	lts-mysql-tomcat
image.pullPolicy	XWiki docker image pull policy	IfNotPresent
workloadStateful	XWiki 1.0.0+ Define if workload will be (true) StatefulSet or Deployment	true
customConfigs.xwiki.cfg	XWiki 1.0.0+ Key/Value preferences to be replaced or inserted on xwiki.cfg file	[]
customConfigs.xwiki.properties	XWiki 1.0.0+ Key/Value preferences to be replaced or inserted on xwiki.properties file	[]
properties	XWiki 1.0.0+ Key/Value preferences to be passed to Java process with -D parameters using JAVA_OPTS	[]
javaOpts	XWiki 1.0.0+ Custom JVM parameters	[]
extraEnvVars	XWiki 1.0.0+ Array with extra environment variables	[]
nodeSelector	XWiki 1.0.0+ Node labels for XWiki pods assignment	{}
tolerations	XWiki 1.0.0+ Tolerations for XWiki pods assignment	[]
affinity	XWiki 1.0.0+ Affinity for XWiki pods assignment	{}
resources.limits	The resources limits for XWiki	{}
resources.requests	The requested resources for XWiki	{}
securityContext.enabled	XWiki 1.2.0+ Enable XWiki pods security context	false
securityContext.fsGroup	XWiki 1.2.0+ Set XWiki pods FS user group	101
containerSecurityContext.enabled	XWiki 1.2.0+ Enable XWiki container security context	false
containerSecurityContext.runAsUser	XWiki 1.2.0+ Set XWiki container user to use on run	100
containerSecurityContext.runAsNonRoot	XWiki 1.2.0+ Set XWiki container to run as non-root user	true
infinispan.enabled	XWiki 1.3.0+ Enable the provision of custom settings for the infinispan configuration file.	false
infinispan.customConfig	XWiki 1.3.0+ Use custom settings for the infinispan configuration file.	""
infinispan.defaultMemoryMaxCount	XWiki 1.3.0+ Use custom memory maximum count from the default infinispan configuration file.	10000

Persistence

Name	Description	Value
persistence.enabled	XWiki 1.0.0+ Enable XWiki data persistence using PVC	true
persistence.existingClaim	XWiki 1.0.0+ Name of an existing PVC to use	""
persistence.storageClass	XWiki 1.0.0+ PVC Storage Class for XWiki data volume	""
persistence.accessModes	XWiki 1.0.0+ PVC Access Mode for XWiki data volume	["ReadWriteOnce"]
persistence.size	XWiki 1.0.0+ PVC Storage Request for XWiki data volume	500Mi
persistence.annotations	XWiki 1.0.0+ Annotations for the PVC	{}
persistence.labels	XWiki 1.0.0+ Labels for the PVC	{}
persistence.selector	XWiki 1.0.0+ Selector to match an existing Persistent Volume	{}
persistence.dataSource	XWiki 1.0.0+ Custom PVC data source	{}
extraVolumes	XWiki 1.3.1+ Optionally specify an extra list of additional volumes.	[]
extraVolumeMounts	XWiki 1.3.1+ Optionally specify an extra list of additional volumeMounts.	[]

Traffic

Name	Description	Value
ingress.enabled	Enable ingress rule that makes XWiki service accessible	false
ingress.className	IngressClass that implement the Ingress	""
ingress.annotations	Additional annotations for the Ingress.	{}
ingress.hosts[0].host	XWiki 1.0.0+ Host for the ingress	""
ingress.hosts[0].paths[0].path	XWiki 1.0.0+ Path for the ingress	"/"
ingress.hosts[0].paths[0].pathType	XWiki 1.0.0+ Path Type fo the ingress	"ImplementationSpecific"
ingress.tls	XWiki 1.0.0+ TLS configuration	[]
service.portName	Port name of service	'node'
service.name	Name of service	'http'
service.type	Kubernetes service type	'ClusterIP'
service.externalPort	External port	80
service.internalPort	Internal/Container port	8080
service.externalIPs	An array of externalIPs	[]
service.sessionAffinity	Specific Session Affinity	ClientIP
istio.enabled	Enable istio virtual service	false
istio.host	Host to configured on istio virtual service	"*"
istio.httpCookie.name	XWiki 1.1.0+ Name of cookie used for sticksession	"xistio"
istio.httpCookie.path	XWiki 1.1.0+ Path of cookie used for sticksession	"/"
istio.httpCookie.ttl	XWiki 1.1.0+ Time to live of cookie used for sticksession	"1800s"
istio.externalGatewayName	XWiki 1.1.0+ Use custom gateway name	""
istio.gateway.enabled	XWiki 1.1.0+ Enable creating gateway	"false"
istio.gateway.selectorIstio	XWiki 1.1.0+ Selector for istio gateway, some cases the default selector is "ingressgateway".	"ingress"
istio.tls.enabled	XWiki 1.1.0+ Enable TLS usage	"false"
istio.tls.httpsRedirect	XWiki 1.1.0+ Force redirect to https on http 'service'	"false"
istio.tls.secretName	XWiki 1.1.0+ Use custom secret/certificate	""
istio.tls.minProtocolVersion	XWiki 1.1.0+ Minimal TLS protocol to be used	"TLSV1_2"
istio.tls.mode	XWiki 1.1.0+ Minimal TLS protocol to be used	"TLSV1_2"
istio.tls.certificate.enabled	XWiki 1.1.0+ Enable certificate creation to be issued (using certmanager) on same namespace of istio ingress	"false"
istio.tls.certificate.namespace	XWiki 1.1.0+ Namespace of istio ingress is located	"istio-ingress"
istio.tls.certificate.issuerRef	XWiki 1.1.0+ Certmanager issuer reference	{}

Database

In case deploy a database with xwiki chart, the database options are PostgreSQL, XWiki 1.0.0+ MariaDB and MySQL provided by bitnami.

Name	Description	Value
externalDB.host	Host to external/existing database instance to use	''
externalDB.database	Database to use	''
externalDB.user	User to use	''
externalDB.password	Password for the above user	''
externalDB.custommKeyRef.enable	XWiki 1.2.4+ Enable usage of external secret with database password.	false
externalDB.custommKeyRef.name	XWiki 1.2.4+ Secret name that contains password	''
externalDB.custommKeyRef.key	XWiki 1.2.4+ Key for password	''
mysql.enabled	Whether to deploy new MySQL server	true
mysql.auth.rootPassword	Password for the MySQL 'root' user	xwiki
mysql.auth.username	Database user to create	xwiki
mysql.auth.password	Database password for username above	xwiki
mysql.auth.database	Database name to create	xwiki
mariadb.enabled	XWiki 1.0.0+ Whether to deploy new MySQL server	false
mariadb.auth.rootPassword	XWiki 1.0.0+ Password for the MySQL 'root' user	xwiki
mariadb.auth.username	XWiki 1.0.0+ Database user to create	xwiki
mariadb.auth.password	XWiki 1.0.0+ Database password for username above	xwiki
mariadb.auth.database	XWiki 1.0.0+ Database name to create	xwiki
postgresql.enabled	Whether to deploy new PostgreSQL server	false
postgresql.auth.postgresPassword	Password for the 'postgres' user	xwiki
postgresql.auth.username	Database user to create	xwiki
postgresql.auth.password	Database password for username above	xwiki
postgresql.auth.database	Database name to create	xwiki
initContainers.database.enabled	XWiki 1.4.0+ Enable initialization container to check if the database is ready to receive connections.	false
initContainers.database.image	XWiki 1.4.0+ Can use a custom image to check if the database is up/running. If externalDB is used, an image needs to be provided	""
initContainers.database.command	XWiki 1.4.0+ Can use a custom command to check if database is up/running. If externalDB is used, a command needs to be provided. Check on _helpers.tpl to see commands used.	""
initContainers.database.containerSecurityContext	XWiki 1.4.0+ Custom container security context to be used on init container to check database.	{}

For MySQL and MariaDB an initialization script and custom config are made to grant permission and use the correct character set.

Cluster

XWiki 1.2.0+ The cluster setup is in a beta/experimental version. It needs a version of XWiki 15.0+ XWiki.

Name	Description	Value
cluster.enabled	Enable usage of Glowroot agent	false
cluster.replicas	Number of XWiki instances	1
cluster.jgroups.port	Jgroups TCP port to be used	7800
cluster.jgroups.kube_ping.version	Kubernetes Ping extension version to be used	"2.0.1.Final"
cluster.jgroups.kube_ping.url	Use custom external URL to download kube_ping JAR file	""
autoscaling.enabled	Enable the HorizontalPodScaler	false
autoscaling.minReplicas	Minimium number of replicas	1
autoscaling.maxReplicas	Maximum number of replicas	3
autoscaling.metrics	Custom metrics to trigger the Autoscaling	{}
autoscaling.status	Define custom grain tuned metrics	{}

Monitoring

Name	Description	Value
glowroot.enabled	XWiki 1.1.0+ Enable usage of Glowroot agent	false
glowroot.properties	XWiki 1.1.0+ Custom properties. Ex.: use custom central collector	{}
glowroot.url	XWiki 1.2.0+ Use custom external URL to download Glowroot dist. file	""
logback.enabled	XWiki 1.2.0+ Enable to use custom values on logback file configurations.	false
logback.customConfiguration	XWiki 1.2.0+ Use custom entire configuration inside logback xml file.	""
logback.extraConfiguration	XWiki 1.2.0+ Add on end of logback xml file extra elements.	""
prometheus.javaagent.enabled	XWiki 1.3.0+ Enable usage of Prometheus Java Agent to expose prometheus metrics from JMX.	false
prometheus.javaagent.port	XWiki 1.3.0+ Port used to expose prometheus metrics	12345
prometheus.javaagent.version	XWiki 1.3.0+ Agent version	"0.20.0"
prometheus.javaagent.url	XWiki 1.3.0+ URL that is used to download agent JAR file.	""...""
prometheus.javaagent.config	XWiki 1.3.0+ Custom Prometheus Java Agent configurations	rules: - pattern: ".*"
prometheus.javaagent.podmonitor.enabled	XWiki 1.3.0+ Enable creation of PodMonitor resource	true
prometheus.javaagent.podmonitor.labels	XWiki 1.3.0+ Labels used on PodMonitor resource	{}

Probes

XWiki 1.2.3+ Options configure liveness and readiness probes.

Depending on the number of pages or other characteristics of the environment, certain times and quantities will need to be adjusted.

probes.startup.enabled	XWiki 1.2.4+ Enable startup probes. If this probe fails, the container will be recreated.	true
probes.startup.httpGet.enabled	XWiki 1.2.4+ Use http GET request to check probe. If false, test will be made with TCP socket	false
probes.startup.httpGet.path	XWiki 1.2.4+ If httpGet enabled, witch path will be used.	/
probes.startup.initialDelaySeconds	XWiki 1.2.4+ Seconds wait for the container startup.	120
probes.startup.timeoutSeconds	XWiki 1.2.4+ Seconds for probe times out.	60
probes.startup.periodSeconds	XWiki 1.2.4+ Time in seconds between checks.	30
probes.startup.failureThreshold	XWiki 1.2.4+ Quantity of failures check before restart container.	5
probes.startup.successThreshold	XWiki 1.2.4+ Quantity of successful check to reset failure threshold.	1
probes.liveness.enabled	Enable liveness probes. If this probe fails, the container will be restarted.	true
probes.liveness.httpGet.enabled	XWiki 1.2.4+ Use http GET request to check probe. If false, test will be made with TCP socket	true
probes.liveness.httpGet.path	XWiki 1.2.4+ If httpGet enabled, witch path will be used.	/rest
probes.liveness.initialDelaySeconds	Seconds wait for the container startup.	30
probes.liveness.timeoutSeconds	Seconds for probe times out.	3
probes.liveness.periodSeconds	Time in seconds between checks.	30
probes.liveness.failureThreshold	Quantity of failures check before restart container.	10
probes.liveness.successThreshold	Quantity of successful check to reset failure threshold.	1
probes.readiness.enabled	Enable readiness probes. If this probe fails, no traffic will be routed to the container.	true
probes.readiness.httpGet.enabled	XWiki 1.2.4+ Use http GET request to check probe. If false, test will be made with TCP socket	true
probes.readiness.httpGet.path	XWiki 1.2.4+ If httpGet enabled, witch path will be used.	/rest/wikis/xwiki/spaces
probes.readiness.initialDelaySeconds	Seconds wait for the container startup.	30
probes.readiness.timeoutSeconds	Seconds for probe times out.	3
probes.readiness.periodSeconds	Time in seconds between checks.	30
probes.readiness.failureThreshold	Quantity of failures check before stop send traffic.	10
probes.readiness.successThreshold	Quantity of successful check return to send traffic.	1

Solr

When enabled, deploy an internal Solr instance.
This feature is available since XWiki 1.2.0+ version, but it is a beta/experimental feature. Not production ready.

Name	Description	Value
solr.enabled	Deploy a Solr instance. By default, use an internal instance	"false"
solr.replicaCount	Number of replica	1
solr.image	The name of the Solr Docker image	"gridexx/xwiki:solr8"
solr.extraEnvVars	XWiki 1.2.4+ Mapping extra ENV variables	[]
solr.resources.limits	The resources limits for Solr	{}
solr.resources.requests	The requested resources for Solr	{}
solr.service.portName	Port name of service	'solr-node'
solr.service.name	Name of service	'http'
solr.service.type	Kubernetes service type	'ClusterIP'
solr.service.externalPort	External port	8983
solr.service.internalPort	Internal/Container port	8983
solr.persistence.enabled	Enable Solr data persistence using PVC	"true"
solr.persistence.existingClaim	Name of an existing PVC to use	""
solr.persistence.storageClass	PVC Storage Class for Solr data volume	""
solr.persistence.accessModes	PVC Access Mode for Solr data volume	["ReadWriteOnce"]
solr.persistence.size	PVC Storage Request for Solr data volume	500Mi
solr.persistence.annotations	Annotations for the PVC	{}
solr.persistence.labels	Labels for the PVC	{}
solr.persistence.selector	Selector to match an existing Persistent Volume	{}
solr.persistence.dataSource	Custom PVC data source	{}
initContainers.solr.enabled	XWiki 1.4.0+ Enable initialization container to check if the solr instance is ready to receive connections.	false
initContainers.solr.containerSecurityContext	XWiki 1.4.0+ Custom container security context to be used on init container to check solr instance.	{}

Examples

Custom Properties

# Custom configuration files for xwiki
customConfigs:
# Properties key that exists, replace in line is done with value here defined.
# If key don't exists, this key and value will be appended in that specific file.
# This files are list of key: value that are translated as key=value in that file.
xwiki.cfg:
   xwiki.superadminpassword: "s3cr3t"
# Extension repository should be writed as items of the array value extension.repositories
xwiki.properties:
   extension.repositories:
      - "xwiki-extensions-xxx:maven:http://172.25.128.67:8081/repository/xwiki/"
      - store.xwiki.com:xwiki:https://store.xwiki.com/xwiki/rest/

# Properties to be passed to Java process with -D parameters using JAVA_OPTS
properties:
http.proxyHost: "proxy.mycompany.com"
http.proxyPort: 7777
https.proxyHost: "proxy.mycompany.com"
https.proxyPort: 7777

As part of project XWiki for OpenDesk, it's possible to use System Property Updater extension, that's enable to change object properties or attachment references using helm chart properties.

Example that changes logo to a new logo and some preferences on XWiki settings page:

# Properties to be passed to Java process with -D parameters using JAVA_OPTS
properties:
"attachment:xwiki:[email protected]": "data:image/svg+xml;base64,AAA....=="
"property:xwiki:XWiki.XWikiPreferences^XWiki.XWikiPreferences.colorTheme": "FlamingoThemes.Iceberg"
"property:xwiki:XWiki.XWikiPreferences^XWiki.XWikiPreferences.timezone": "Europe/Berlin"
"property:xwiki:XWiki.XWikiPreferences^XWiki.XWikiPreferences.default_language": "de"
"property:xwiki:XWiki.XWikiPreferences^XWiki.XWikiPreferences.languages": "de"

Cluster

XWiki 1.2.0+ The cluster setup is in a beta/experimental version. It needs a version of XWiki 15.0+ XWiki.

To have a single XWiki data volume shared with all replicas, on this example we use NSF Ganesha server Provisioner.

To discover all pods, it is required that the service account (is created automatically) used if cluster is enabled have pod permission to "get", "list" and "watch" inside the namespace that release was installed. It's recommended to use a dedicated namespace if you want to isolate some XWiki cluster from other workloads -n namespace --create-namespace
.

helm repo add nfs-ganesha-server-provisioner https://kubernetes-sigs.github.io/nfs-ganesha-server-and-external-provisioner/
helm install nfs-server-provisioner nfs-ganesha-server-provisioner/nfs-server-provisioner --set persistence.enabled=true

Minimal values to enable cluster settings:

image:
tag: 15-mysql-tomcat

cluster:
enabled: true
replicas: 1

persistence:
enabled: true
storageClass: "nfs"
accessModes:
- ReadWriteMany

solr:
enabled: true
persistence:
enabled: true

Monitoring

There is a preconfigured Glowroot on this chart that can be used for tracing, error log and reporting system. To enable, set XWiki 1.1.0+ glowroot.enabled to true.

Follow one example of how to access service/dashboard using port forward:
kubectl port-forward xwiki-0 4000:4000

To see more details about other tools to monitoring XWiki, check Administrator Guide/Monitoring page.

Logging

To change the logging settings of XWiki, it's possible to override the entire logback config file or simply add extra elements at the end of the configuration. To see more details about XWiki logging system, check Administrator Guide/Logging page.

logback:
enabled: true
extraConfiguration: |
   <logger name="org.xwiki" level="debug"/>
   <logger name="com.xwiki" level="debug"/>
# Example to override all other configs elements, you can use:
# customConfiguration: |
#    <appender name="stdout" class="ch.qos.logback.core.ConsoleAppender">
#      
#      <Target>System.out</Target>
#      <encoder>
#        <pattern>%d [%t] %-5p %-30.30c{2} - %m %n</pattern>
#      </encoder>
#    </appender>

Backup

There are some tools that can manage the backups on k8s workloads. We can suggest Velero, as we already used on some internal clusters.

XWiki backup needs to be viewed to see all paths/components that needs to be saved.

Important volumes/paths to be considered:

xwiki volume, or /usr/local/xwiki/data path.
Database volume/Database dump. If PostgreSQL, there is some backup parameters that can be used.
If using an external solr: xwiki-solr-data volume, or another volume if using a custom external solr instance.

Prerequisites & Installation Instructions

Requirements

Kubernetes 1.23+
kubectl https://kubernetes.io/docs/tasks/tools/
Helm 3.x https://helm.sh/docs/intro/install/

Install

To install chart with the release name xwiki:

helm repo add xwiki-helm https://xwiki-contrib.github.io/xwiki-helm
# Use --devel install most recent released (beta/alpha) version
helm install xwiki xwiki-helm/xwiki

Source

To install using local chart definitions or other not released version:

git clone https://github.com/xwiki-contrib/xwiki-helm
# git checkout branch-name
cd xwiki-helm/charts/xwiki
helm dependency update
helm install xwiki .

Tests

Current tests are unit tests created to run with helm-unittest plugin:

helm plugin install https://github.com/helm-unittest/helm-unittest
helm unittest charts/xwiki

Signing

This chart is signed using Chart Releaser Action that runs on GitHub Actions. Instructions about how to use can be found in this tutorial. You can verify this chart against this GPG key:

Example:

# Download and convert key from ASCII armor format to binary.
curl https://extensions.xwiki.org/xwiki/bin/download/Extension/XWikiHelm/WebHome/helm-charts.asc | gpg --dearmor > helm-charts.gpg
# Verify thatthe signed chart:
helm fetch --verify xwiki-helm/xwiki --version 1.2.4 --keyring helm-charts.gpg

Sizing

Check XWiki Performance guide that contains more detailed options and settings related to sizes and performance.

Minimal

Current product recommended initial resources are equivalent to 1 CPU unit and 2G of memory. Where is 1G is minimal for XWiki instance and another 1G for other process, activities that can use additional memory.

On XWiki Cloud Demo instances, currently XWiki instance (Java/Tomcat) runs with 564m max memory, sharing 1484m between Java, LibreOffice, Database (MariaDB) and OS (Debian).

The default (chart) persistence size (XWiki Data) is low, it's recommended to give more space if usage will be with large pages/attachments.

Recommendations

These values may vary depending on the XWiki use case.

All-in-One is considered deployment using XWiki Image using embedded Solr, LibreOffice and database sharing same resources.
Distributed is considering some components being deployed separately.

All-In-One

Internal estimations for Kubernetes, based on 10% of users visiting 20 pages in spike hours (3 page / minute for 100 users, 2 pages / second for 3000 users).

Scenario Description	CPU (Request/Limit)	RAM (Request/Limit)	JVM¹
Simple/Normal usage	1 / 2	1GB / 2GB	1G
Minimal users but with more pageviews	2 / 4	3GB / 6GB	3G
More users (~100) and more pageviews	4 / 8	4GB / 8GB	4G
Bigger user quantities (>3000) and huge pageviews	6 / 12	6GB / 12GB	6G

¹ Java minimal (-Xms) memory and maximum (-Xmx) equal, but maybe some scenarios are intended to run with different values for minimal and maximal heap.

Documents/Pages quantity can affect sizing if theses are frequently accessed or are using heavily other features like macros, scripts etc. If resource increase on Database or Storage speed are not possible or sufficient, can be necessary to increase document caching and/or rendering cache.

Any cache change, needs to be aligned with the CPU/Memory profile. More memory requires more CPU for the JVM to be able to manage more data. Lower JVM heap will increase CPU usage to run more often GC. Then it's possible to run with less memory, but with the penalty of more GC and CPU usage.

Events that need to be monitored for sizing changes:

In case of any “Out of Memory” error, proper increase on memory needs to be done. Important note that in some cases this error can be released with memory leeks or other issues. And the huge Java memory heap, requires more CPU unit to proper run without pressure on GC.
Long processing time (Waiting long time for page to load/save), can be released with lack of CPU units or pressure on Memory. If memory is low and CPU is high, maybe only CPU unit increase is required. If memory usage is height, perhaps there are height GC activities and sometimes more memory can help.
Error save page, or adding new attachments. It can be out of space problem, check Database available size and XWiki data volume.

Distributed

There are some use cases that it is better to isolate/separate some components to have better stability/performance.

Apache Solr

See Performance Guide in Solr module documentation.

By default, a standalone Default Solr instance memory is 512M heap. Size can be increased to fit with volume/quantity of search/index requests, but is common that for installations benefiting of external instance will start at least 1GB of memory.

LibreOffice

There is no alternative/support to run external LibreOffice instance XWIKI-22481XWIKI-22664.

Database Tuning

See Administrator Guide / Performance / Database Administration.

Follow are listed some initial values that can be used as start point to improve the database used by a XWiki instance.

MariaDB/MySQL

See https://mariadb.com/kb/en/configuring-mariadb-for-optimal-performance/

Settings example with 384M of memory dedicated to workload:

innodb_buffer_pool_size=254M
innodb_log_file_size=64M
innodb_log_buffer_size=6M

PostgreSQL

See https://www.postgresql.org/docs/current/runtime-config-resource.html

Default settings are already good for memory allocation up to 4G. A good start point to try to improve PG performance are settings (work_mem, maintenance_work_mem, shared_buffers and effective_cache_size).

Upgrading

v1.2.x to v1.3.0

There are no upgrade restrictions or major changes break. But this version introduced service account by default. In case of a fallback or backup restore, a direct fix to Workload might be required to manage service account reference.

v1.1.x to v1.2.0

In this version, external Solr usage changed. If enabled, a preconfigured workload will be created. To use another external instance as previous version, you need to disable this and use only the properties settings to configure the external instance using the official guide.

Option replicaCount was renamed to cluster.replicas

v0.X to v1.0.0

In this version some persistent mappings have been modified, so it is strongly recommended to perform a backup. Velero is a useful tool for managing Kubernetes backups.

For releases that utilize database settings/install, the recommended approach is to install new Helm release and perform data migration accordingly. See Import/Export.

Release Notes

v1.4.0

v1.3.1

v1.3.0

v1.2.6

v1.2.5

v1.2.4

v1.2.3

v1.2.2

v1.2.1

v1.1.3

v1.2.0

v1.1.2

v1.1.1

v1.1.0

v1.0.0

Here are the updates in this release:

Support for Kubernetes v1.23+
Upgrade of the Helm definition to use v2 API.
Changed the repository for MySQL and PostgreSQL to use Bitnami.
Added MariaDB (10.11.2) as database option using chart version 12.1.4.
Updated the MySQL (8.0.33) chart version to 9.9.0.
Updated the PostgreSQL (15.2.0) chart version to 12.4.2.
Upgraded unittesting to lasted version.
Added new persistent options for XWiki data.
Introduced Github workflow actions to perform testing and release.
Added support config xwiki properties and cfg using helm chart values.

Jira issues solved:

XWiki Helm Chart

Description

TL/DR

Know Limitations

Parameters

XWiki

Persistence

Traffic

Database

Cluster

Monitoring

Probes

Solr

Examples

Custom Properties

Cluster

Monitoring

Logging

Backup

Prerequisites & Installation Instructions

Requirements

Install

Source

Tests

Signing

Sizing

Minimal

Recommendations

All-In-One

Distributed

Apache Solr

LibreOffice

Database Tuning

MariaDB/MySQL

PostgreSQL

Upgrading

v1.2.x to v1.3.0

v1.1.x to v1.2.0

v0.X to v1.0.0

Release Notes

v1.4.0

v1.3.1

v1.3.0

v1.2.6

v1.2.5

v1.2.4

v1.2.3

v1.2.2

v1.2.1

v1.1.3

v1.2.0

v1.1.2

v1.1.1

v1.1.0

v1.0.0

Quick Links

My Recent Modifications

About

About

Support

Platform

User Guide

Admin Guide

Developer Guide

Projects

XWiki

Extensions

Other

Contribute

Status

Practices

Under the Hood

Get Involved

Get Connected