bitnamicharts/matomo
Bitnami Helm chart for Matomo
100K+
Matomo, formerly known as Piwik, is a real time web analytics program. It provides detailed reports on website visitors.
Trademarks: This software listing is packaged by Bitnami. The respective trademarks mentioned in the offering are owned by the respective companies, and use of them does not imply any affiliation or endorsement.
helm install my-release oci://registry-1.docker.io/bitnamicharts/matomo
Looking to use Matomo in production? Try VMware Tanzu Application Catalog, the commercial edition of the Bitnami catalog.
This chart bootstraps a Matomo deployment on a Kubernetes cluster using the Helm package manager.
It also packages the Bitnami MariaDB chart which is required for bootstrapping a MariaDB deployment as a database for the Matomo application.
Bitnami charts can be used with Kubeapps for deployment and management of Helm Charts in clusters. This chart has been tested to work with NGINX Ingress, cert-manager, fluentd and Prometheus on top of the BKPR.
To install the chart with the release name my-release
:
helm install my-release oci://REGISTRY_NAME/REPOSITORY_NAME/matomo
Note: You need to substitute the placeholders
REGISTRY_NAME
andREPOSITORY_NAME
with a reference to your Helm chart registry and repository. For example, in the case of Bitnami, you need to useREGISTRY_NAME=registry-1.docker.io
andREPOSITORY_NAME=bitnamicharts
.
The command deploys Matomo on the Kubernetes cluster in the default configuration. The Parameters section lists the parameters that can be configured during installation.
Tip: List all releases using
helm list
Bitnami charts allow setting resource requests and limits for all containers inside the chart deployment. These are inside the resources
value (check parameter table). Setting requests is essential for production workloads and these should be adapted to your specific use case.
To make this process easier, the chart contains the resourcesPreset
values, which automatically sets the resources
section according to different presets. Check these presets in the bitnami/common chart. However, in production workloads using resourcesPreset
is discouraged as it may not fully adapt to your specific needs. Find more information on container resource management in the official Kubernetes documentation.
Bitnami charts configure credentials at first boot. Any further change in the secrets or credentials require manual intervention. Follow these instructions:
kubectl create secret generic SECRET_NAME --from-literal=matomo-password=PASSWORD --from-literal=smtp-password=SMTP_PASSWORD --dry-run -o yaml | kubectl apply -f -
This chart can be integrated with Prometheus by setting metrics.enabled
to true
. This will deploy a sidecar container with apache-exporter in all pods and a metrics
service, which can be configured under the metrics.service
section. This metrics
service will have the necessary annotations to be automatically scraped by Prometheus.
Prometheus requirements
It is necessary to have a working installation of Prometheus or Prometheus Operator for the integration to work. Install the Bitnami Prometheus helm chart or the Bitnami Kube Prometheus helm chart to easily have a working Prometheus in your cluster.
Integration with Prometheus Operator
The chart can deploy ServiceMonitor
objects for integration with Prometheus Operator installations. To do so, set the value metrics.serviceMonitor.enabled=true
. Ensure that the Prometheus Operator CustomResourceDefinitions
are installed in the cluster or it will fail with the following error:
no matches for kind "ServiceMonitor" in version "monitoring.coreos.com/v1"
Install the Bitnami Kube Prometheus helm chart for having the necessary CRDs and the Prometheus Operator.
It is strongly recommended to use immutable tags in a production environment. This ensures your deployment does not change automatically if the same tag is updated with a different image.
Bitnami will release a new chart updating its containers if a new version of the main container, significant changes, or critical vulnerabilities exist.
The image
parameter allows specifying which image will be pulled for the chart.
Private registry
If you configure the image
value to one in a private registry, you will need to specify an image pull secret.
Manually create image pull secret(s) in the namespace. See this YAML example reference. Consult your image registry's documentation about getting the appropriate secret.
Note that the imagePullSecrets
configuration value cannot currently be passed to helm using the --set
parameter, so you must supply these using a values.yaml
file, such as:
imagePullSecrets:
- name: SECRET_NAME
Install the chart
This chart allows you to set your custom affinity using the affinity
parameter. Find more information about Pod's affinity in the kubernetes documentation.
As an alternative, you can use of the preset configurations for pod affinity, pod anti-affinity, and node affinity available at the bitnami/common chart. To do so, set the podAffinityPreset
, podAntiAffinityPreset
, or nodeAffinityPreset
parameters.
To back up and restore Helm chart deployments on Kubernetes, you need to back up the persistent volumes from the source deployment and attach them to a new deployment using Velero, a Kubernetes backup/restore tool. Find the instructions for using Velero in this guide.
The Bitnami Matomo image stores the Matomo data and configurations at the /bitnami/matomo
path of the container.
Persistent Volume Claims are used to keep the data across deployments. This is known to work in GCE, AWS, and minikube. See the Parameters section to configure the PVC or to disable persistence.
helm install my-release --set persistence.existingClaim=PVC_NAME oci://REGISTRY_NAME/REPOSITORY_NAME/matomo
Note: You need to substitute the placeholders
REGISTRY_NAME
andREPOSITORY_NAME
with a reference to your Helm chart registry and repository. For example, in the case of Bitnami, you need to useREGISTRY_NAME=registry-1.docker.io
andREPOSITORY_NAME=bitnamicharts
.
System compatibility
hostPath
has been tested on OSX/MacOS with xhyve, and Linux with VirtualBox.Mounting steps
The specified hostPath
directory must already exist (create one if it does not).
Install the chart
helm install my-release --set persistence.hostPath=/PATH/TO/HOST/MOUNT oci://REGISTRY_NAME/REPOSITORY_NAME/matomo
Note: You need to substitute the placeholders
REGISTRY_NAME
andREPOSITORY_NAME
with a reference to your Helm chart registry and repository. For example, in the case of Bitnami, you need to useREGISTRY_NAME=registry-1.docker.io
andREPOSITORY_NAME=bitnamicharts
.
This will mount the matomo-data
volume into the hostPath
directory. The site data will be persisted if the mount path contains valid data, else the site data will be initialized at first launch.
Because the container cannot control the host machine's directory permissions, you must set the Matomo file directory permissions yourself
Name | Description | Value |
---|---|---|
global.imageRegistry | Global Docker image registry | "" |
global.imagePullSecrets | Global Docker registry secret names as an array | [] |
global.defaultStorageClass | Global default StorageClass for Persistent Volume(s) | "" |
global.security.allowInsecureImages | Allows skipping image verification | false |
global.compatibility.openshift.adaptSecurityContext | Adapt the securityContext sections of the deployment to make them compatible with Openshift restricted-v2 SCC: remove runAsUser, runAsGroup and fsGroup and let the platform use their allowed default IDs. Possible values: auto (apply if the detected running cluster is Openshift), force (perform the adaptation always), disabled (do not perform adaptation) | auto |
Name | Description | Value |
---|---|---|
kubeVersion | Force target Kubernetes version (using Helm capabilities if not set) | "" |
nameOverride | String to partially override matomo.fullname template (will maintain the release name) | "" |
fullnameOverride | String to fully override matomo.fullname template | "" |
namespaceOverride | String to fully override common.names.namespace | "" |
commonAnnotations | Common annotations to add to all Matomo resources (sub-charts are not considered). Evaluated as a template | {} |
commonLabels | Common labels to add to all Matomo resources (sub-charts are not considered). Evaluated as a template | {} |
extraDeploy | Array of extra objects to deploy with the release (evaluated as a template). | [] |
Name | Description | Value |
---|---|---|
image.registry | Matomo image registry | REGISTRY_NAME |
image.repository | Matomo Image name | REPOSITORY_NAME/matomo |
image.digest | Matomo image digest in the way sha256:aa.... Please note this parameter, if set, will override the tag | "" |
image.pullPolicy | Matomo image pull policy | IfNotPresent |
image.pullSecrets | Specify docker-registry secret names as an array | [] |
image.debug | Specify if debug logs should be enabled | false |
replicaCount | Number of Matomo Pods to run (requires ReadWriteMany PVC support) | 1 |
matomoUsername | User of the application | user |
matomoPassword | Application password | "" |
matomoEmail | Admin email | user@example.com |
matomoWebsiteName | Matomo application name | example |
matomoWebsiteHost | Matomo application host | https://example.org |
matomoSkipInstall | Skip Matomo installation wizard. Useful for migrations and restoring from SQL dump | false |
customPostInitScripts | Custom post-init.d user scripts | {} |
allowEmptyPassword | Allow DB blank passwords | true |
command | Override default container command (useful when using custom images) | [] |
args | Override default container args (useful when using custom images) | [] |
updateStrategy.type | Update strategy - only really applicable for deployments with RWO PVs attached | RollingUpdate |
priorityClassName | Matomo pods' priorityClassName | "" |
schedulerName | Name of the k8s scheduler (other than default) | "" |
topologySpreadConstraints | Topology Spread Constraints for pod assignment | [] |
automountServiceAccountToken | Mount Service Account token in pod | true |
hostAliases | Add deployment host aliases | [] |
extraEnvVars | Extra environment variables | [] |
extraEnvVarsCM | ConfigMap containing extra env vars | "" |
extraEnvVarsSecret | Secret containing extra env vars (in case of sensitive data) | "" |
extraVolumes | Array of extra volumes to be added to the deployment (evaluated as template). Requires setting extraVolumeMounts | [] |
extraVolumeMounts | Array of extra volume mounts to be added to the container (evaluated as template). Normally used with extraVolumes . | [] |
initContainers | Add additional init containers to the pod (evaluated as a template) | [] |
pdb.create | Enable/disable a Pod Disruption Budget creation | true |
pdb.minAvailable | Minimum number/percentage of pods that should remain scheduled | "" |
pdb.maxUnavailable | Maximum number/percentage of pods that may be made unavailable. Defaults to 1 if both pdb.minAvailable and pdb.maxUnavailable are empty. | "" |
sidecars | Attach additional containers to the pod (evaluated as a template) | [] |
Note: the README for this chart is longer than the DockerHub length limit of 25000, so it has been trimmed. The full README can be found at https://github.com/bitnami/charts/blob/main/bitnami/matomo/README.md