charts/bitnami/drupal

Drupal

Drupal is one of the most versatile open source content management systems on the market.

TL;DR

$ helm repo add bitnami https://charts.bitnami.com/bitnami
$ helm install my-release bitnami/drupal

Introduction

This chart bootstraps a Drupal 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 Drupal 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.

Prerequisites

• Kubernetes 1.12+
• Helm 3.1.0
• PV provisioner support in the underlying infrastructure
• ReadWriteMany volumes for deployment scaling

Installing the Chart

To install the chart with the release name my-release:

$ helm install my-release bitnami/drupal

The command deploys Drupal 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

Uninstalling the Chart

To uninstall/delete the my-release deployment:

$ helm delete my-release

The command removes all the Kubernetes components associated with the chart and deletes the release.

Parameters

Global parameters

Name	Description	Value
global.imageRegistry	Global Docker image registry	""
global.imagePullSecrets	Global Docker registry secret names as an array	[]
global.storageClass	Global StorageClass for Persistent Volume(s)	""

Common parameters

Name	Description	Value
kubeVersion	Force target Kubernetes version (using Helm capabilities if not set)	""
nameOverride	String to partially override drupal.fullname template (will maintain the release name)	""
fullnameOverride	String to fully override drupal.fullname template	""
commonAnnotations	Common annotations to add to all Drupal resources (sub-charts are not considered). Evaluated as a template	{}
commonLabels	Common labels to add to all Drupal resources (sub-charts are not considered). Evaluated as a template	{}
extraDeploy	Array of extra objects to deploy with the release (evaluated as a template).	[]

Drupal parameters

Name	Description	Value
image.registry	Drupal image registry	docker.io
image.repository	Drupal Image name	bitnami/drupal
image.tag	Drupal Image tag	9.2.8-debian-10-r12
image.pullPolicy	Drupal 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 Drupal Pods to run (requires ReadWriteMany PVC support)	1
drupalProfile	Drupal installation profile	standard
drupalSkipInstall	Skip Drupal installation wizard. Useful for migrations and restoring from SQL dump	false
drupalUsername	User of the application	user
drupalPassword	Application password	""
drupalEmail	Admin email	user@example.com
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
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)	[]
sidecars	Attach additional containers to the pod (evaluated as a template)	[]
tolerations	Tolerations for pod assignment	[]
existingSecret	Name of a secret with the application password	""
smtpHost	SMTP host	""
smtpPort	SMTP port	""
smtpUser	SMTP user	""
smtpPassword	SMTP password	""
smtpProtocol	SMTP Protocol (options: ssl,tls, nil)	""
containerPorts	Container ports	{}
sessionAffinity	Control where client requests go, to the same pod or round-robin. Values: ClientIP or None	None
persistence.enabled	Enable persistence using PVC	true
persistence.storageClass	PVC Storage Class for Drupal volume	""
persistence.accessMode	PVC Access Mode for Drupal volume	ReadWriteOnce
persistence.size	PVC Storage Request for Drupal volume	8Gi
persistence.existingClaim	A manually managed Persistent Volume Claim	""
persistence.hostPath	If defined, the drupal-data volume will mount to the specified hostPath.	""
podAffinityPreset	Pod affinity preset. Ignored if affinity is set. Allowed values: soft or hard	""
podAntiAffinityPreset	Pod anti-affinity preset. Ignored if affinity is set. Allowed values: soft or hard	soft
nodeAffinityPreset.type	Node affinity preset type. Ignored if affinity is set. Allowed values: soft or hard	""
nodeAffinityPreset.key	Node label key to match Ignored if affinity is set.	""
nodeAffinityPreset.values	Node label values to match. Ignored if affinity is set.	[]
affinity	Affinity for pod assignment	{}
nodeSelector	Node labels for pod assignment. Evaluated as a template.	{}
resources	CPU/Memory resource requests/limits	{}
podSecurityContext.enabled	Enable Drupal pods' Security Context	true
podSecurityContext.fsGroup	Drupal pods' group ID	1001
containerSecurityContext.enabled	Enable Drupal containers' Security Context	true
containerSecurityContext.runAsUser	Drupal containers' Security Context	1001
livenessProbe.enabled	Enable livenessProbe	true
livenessProbe.path	Request path for livenessProbe	/user/login
livenessProbe.initialDelaySeconds	Initial delay seconds for livenessProbe	600
livenessProbe.periodSeconds	Period seconds for livenessProbe	10
livenessProbe.timeoutSeconds	Timeout seconds for livenessProbe	5
livenessProbe.failureThreshold	Failure threshold for livenessProbe	5
livenessProbe.successThreshold	Success threshold for livenessProbe	1
readinessProbe.enabled	Enable readinessProbe	true
readinessProbe.path	Request path for readinessProbe	/user/login
readinessProbe.initialDelaySeconds	Initial delay seconds for readinessProbe	30
readinessProbe.periodSeconds	Period seconds for readinessProbe	5
readinessProbe.timeoutSeconds	Timeout seconds for readinessProbe	1
readinessProbe.failureThreshold	Failure threshold for readinessProbe	5
readinessProbe.successThreshold	Success threshold for readinessProbe	1
customLivenessProbe	Override default liveness probe	{}
customReadinessProbe	Override default readiness probe	{}
lifecycleHooks	LifecycleHook to set additional configuration at startup Evaluated as a template	{}
podAnnotations	Pod annotations	{}
podLabels	Add additional labels to the pod (evaluated as a template)	{}

Traffic Exposure Parameters

Name	Description	Value
service.type	Kubernetes Service type	LoadBalancer
service.port	Service HTTP port	80
service.httpsPort	Service HTTPS port	443
service.loadBalancerSourceRanges	Restricts access for LoadBalancer (only with service.type: LoadBalancer)	[]
service.loadBalancerIP	loadBalancerIP for the Drupal Service (optional, cloud specific)	""
service.nodePorts	Kubernetes node port	{}
service.externalTrafficPolicy	Enable client source IP preservation	Cluster
ingress.enabled	Enable ingress controller resource	false
ingress.pathType	Ingress Path type	ImplementationSpecific
ingress.apiVersion	Override API Version (automatically detected if not set)	""
ingress.ingressClassName	IngressClass that will be be used to implement the Ingress (Kubernetes 1.18+)	""
ingress.hostname	Default host for the ingress resource	drupal.local
ingress.path	The Path to Drupal. You may need to set this to '/*' in order to use this	/
ingress.annotations	Additional annotations for the Ingress resource. To enable certificate autogeneration, place here your cert-manager annotations.	{}
ingress.tls	Enable TLS configuration for the hostname defined at ingress.hostname parameter	false
ingress.extraHosts	The list of additional hostnames to be covered with this ingress record.	[]
ingress.extraPaths	Any additional arbitrary paths that may need to be added to the ingress under the main host.	[]
ingress.extraTls	The tls configuration for additional hostnames to be covered with this ingress record.	[]
ingress.secrets	If you're providing your own certificates, please use this to add the certificates as secrets	[]

Database parameters

Name	Description	Value
mariadb.enabled	Whether to deploy a mariadb server to satisfy the applications database requirements	true
mariadb.architecture	MariaDB architecture (standalone or replication)	standalone
mariadb.auth.rootPassword	Password for the MariaDB root user	""
mariadb.auth.database	Database name to create	bitnami_drupal
mariadb.auth.username	Database user to create	bn_drupal
mariadb.auth.password	Password for the database	""
mariadb.primary.persistence.enabled	Enable database persistence using PVC	true
mariadb.primary.persistence.storageClass	MariaDB primary persistent volume storage Class	""
mariadb.primary.persistence.accessModes	Database Persistent Volume Access Modes	["ReadWriteOnce"]
mariadb.primary.persistence.size	Database Persistent Volume Size	8Gi
mariadb.primary.persistence.hostPath	Set path in case you want to use local host path volumes (not recommended in production)	""
mariadb.primary.persistence.existingClaim	Name of an existing PersistentVolumeClaim for MariaDB primary replicas	""
externalDatabase.host	Host of the existing database	""
externalDatabase.port	Port of the existing database	3306
externalDatabase.user	Existing username in the external db	bn_drupal
externalDatabase.password	Password for the above username	""
externalDatabase.database	Name of the existing database	bitnami_drupal

Volume Permissions parameters

Name	Description	Value
volumePermissions.enabled	Enable init container that changes volume permissions in the data directory (for cases where the default k8s runAsUser and fsUser values do not work)	false
volumePermissions.image.registry	Init container volume-permissions image registry	docker.io
volumePermissions.image.repository	Init container volume-permissions image name	bitnami/bitnami-shell
volumePermissions.image.tag	Init container volume-permissions image tag	10-debian-10-r253
volumePermissions.image.pullPolicy	Init container volume-permissions image pull policy	IfNotPresent
volumePermissions.image.pullSecrets	Specify docker-registry secret names as an array	[]
volumePermissions.resources.limits	The resources limits for the container	{}
volumePermissions.resources.requests	The requested resources for the container	{}

Metrics parameters

Name	Description	Value
metrics.enabled	Start a exporter side-car	false
metrics.image.registry	Apache exporter image registry	docker.io
metrics.image.repository	Apache exporter image repository	bitnami/apache-exporter
metrics.image.tag	Apache exporter image tag	0.10.1-debian-10-r55
metrics.image.pullPolicy	Image pull policy	IfNotPresent
metrics.image.pullSecrets	Specify docker-registry secret names as an array	[]
metrics.resources	Metrics exporter resource requests and limits	{}
metrics.podAnnotations	Additional annotations for Metrics exporter pod	{}

Certificate injection parameters

Name	Description	Value
certificates.customCertificate.certificateSecret	Secret containing the certificate and key to add	""
certificates.customCertificate.chainSecret.name	Name of the secret containing the certificate chain	secret-name
certificates.customCertificate.chainSecret.key	Key of the certificate chain file inside the secret	secret-key
certificates.customCertificate.certificateLocation	Location in the container to store the certificate	/etc/ssl/certs/ssl-cert-snakeoil.pem
certificates.customCertificate.keyLocation	Location in the container to store the private key	/etc/ssl/private/ssl-cert-snakeoil.key
certificates.customCertificate.chainLocation	Location in the container to store the certificate chain	/etc/ssl/certs/mychain.pem
certificates.customCAs	Defines a list of secrets to import into the container trust store	[]
certificates.command	Override default container command (useful when using custom images)	[]
certificates.args	Override default container args (useful when using custom images)	[]
certificates.extraEnvVars	Container sidecar extra environment variables (eg proxy)	[]
certificates.extraEnvVarsCM	ConfigMap containing extra env vars	""
certificates.extraEnvVarsSecret	Secret containing extra env vars (in case of sensitive data)	""
certificates.image.registry	Container sidecar registry	docker.io
certificates.image.repository	Container sidecar image	bitnami/bitnami-shell
certificates.image.tag	Container sidecar image tag	10-debian-10-r253
certificates.image.pullPolicy	Container sidecar image pull policy	IfNotPresent
certificates.image.pullSecrets	Container sidecar image pull secrets	[]

NetworkPolicy parameters

Name	Description	Value
networkPolicy.enabled	Enable network policies	false
networkPolicy.metrics.enabled	Enable network policy for metrics (prometheus)	false
networkPolicy.metrics.namespaceSelector	Monitoring namespace selector labels. These labels will be used to identify the prometheus' namespace.	{}
networkPolicy.metrics.podSelector	Monitoring pod selector labels. These labels will be used to identify the Prometheus pods.	{}
networkPolicy.ingress.enabled	Enable network policy for Ingress Proxies	false
networkPolicy.ingress.namespaceSelector	Ingress Proxy namespace selector labels. These labels will be used to identify the Ingress Proxy's namespace.	{}
networkPolicy.ingress.podSelector	Ingress Proxy pods selector labels. These labels will be used to identify the Ingress Proxy pods.	{}
networkPolicy.ingressRules.backendOnlyAccessibleByFrontend	Enable ingress rule that makes the backend (mariadb) only accessible by drupal's pods.	false
networkPolicy.ingressRules.customBackendSelector	Backend selector labels. These labels will be used to identify the backend pods.	{}
networkPolicy.ingressRules.accessOnlyFrom.enabled	Enable ingress rule that makes drupal only accessible from a particular origin	false
networkPolicy.ingressRules.accessOnlyFrom.namespaceSelector	Namespace selector label that is allowed to access drupal. This label will be used to identified the allowed namespace(s).	{}
networkPolicy.ingressRules.accessOnlyFrom.podSelector	Pods selector label that is allowed to access drupal. This label will be used to identified the allowed pod(s).	{}
networkPolicy.ingressRules.customRules	Custom network policy ingress rule	{}
networkPolicy.egressRules.denyConnectionsToExternal	Enable egress rule that denies outgoing traffic outside the cluster, except for DNS (port 53).	false
networkPolicy.egressRules.customRules	Custom network policy rule	{}

The above parameters map to the env variables defined in bitnami/drupal. For more information please refer to the bitnami/drupal image documentation.

Specify each parameter using the --set key=value[,key=value] argument to helm install. For example,

$ helm install my-release \
  --set drupalUsername=admin,drupalPassword=password,mariadb.auth.rootPassword=secretpassword \
    bitnami/drupal

The above command sets the Drupal administrator account username and password to admin and password respectively. Additionally, it sets the MariaDB root user password to secretpassword.

NOTE: Once this chart is deployed, it is not possible to change the application's access credentials, such as usernames or passwords, using Helm. To change these application credentials after deployment, delete any persistent volumes (PVs) used by the chart and re-deploy it, or use the application's built-in administrative tools if available.

Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. For example,

$ helm install my-release -f values.yaml bitnami/drupal

Tip

: You can use the default values.yaml

Configuration and installation details

Rolling VS Immutable tags

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.

Image

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.

1. 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.
2. 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

1. Install the chart

Setting Pod's affinity

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.

Persistence

The Bitnami Drupal image stores the Drupal data and configurations at the /bitnami/drupal 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.

Existing PersistentVolumeClaim

1. Create the PersistentVolume
2. Create the PersistentVolumeClaim
3. Install the chart

$ helm install my-release --set persistence.existingClaim=PVC_NAME bitnami/drupal

Host path

System compatibility

• The local filesystem accessibility to a container in a pod with hostPath has been tested on OSX/MacOS with xhyve, and Linux with VirtualBox.
• Windows has not been tested with the supported VM drivers. Minikube does however officially support Mounting Host Folders per pod. Or you may manually sync your container whenever host files are changed with tools like docker-sync or docker-bg-sync.

Mounting steps

1. The specified hostPath directory must already exist (create one if it does not).

2. Install the chart

   $ helm install my-release --set persistence.hostPath=/PATH/TO/HOST/MOUNT bitnami/drupal
   

   This will mount the drupal-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.

3. Because the container cannot control the host machine's directory permissions, you must set the Drupal file directory permissions yourself and disable or clear Drupal cache. See Drupal Core’s INSTALL.txt for setting file permissions, and see Drupal handbook page to disable the cache, or Drush handbook to clear cache.

Troubleshooting

Find more information about how to deal with common errors related to Bitnami’s Helm charts in this troubleshooting guide.

Upgrading

To 10.0.0

On November 13, 2020, Helm v2 support was formally finished, this major version is the result of the required changes applied to the Helm Chart to be able to incorporate the different features added in Helm v3 and to be consistent with the Helm project itself regarding the Helm v2 EOL.

What changes were introduced in this major version?

• Previous versions of this Helm Chart use apiVersion: v1 (installable by both Helm 2 and 3), this Helm Chart was updated to apiVersion: v2 (installable by Helm 3 only). Here you can find more information about the apiVersion field.
• Move dependency information from the requirements.yaml to the Chart.yaml
• After running helm dependency update, a Chart.lock file is generated containing the same structure used in the previous requirements.lock
• The different fields present in the Chart.yaml file has been ordered alphabetically in a homogeneous way for all the Bitnami Helm Charts

Considerations when upgrading to this version

• If you want to upgrade to this version from a previous one installed with Helm v3, you shouldn't face any issues
• If you want to upgrade to this version using Helm v2, this scenario is not supported as this version doesn't support Helm v2 anymore
• If you installed the previous version with Helm v2 and wants to upgrade to this version with Helm v3, please refer to the official Helm documentation about migrating from Helm v2 to v3

Useful links

• https://docs.bitnami.com/tutorials/resolve-helm2-helm3-post-migration-issues/
• https://helm.sh/docs/topics/v2_v3_migration/
• https://helm.sh/blog/migrate-from-helm-v2-to-helm-v3/

To 9.0.0

MariaDB dependency version was bumped to a new major version that introduces several incompatilibites. Therefore, backwards compatibility is not guaranteed unless an external database is used. Check MariaDB Upgrading Notes for more information.

To upgrade to 9.0.0, you have two alternatives:

• Install a new Drupal chart, and migrate your Drupal site using backup/restore tools such as Drupal Backup and Migrate.
• Reuse the PVC used to hold the MariaDB data on your previous release. To do so, follow the instructions below (the following example assumes that the release name is drupal):

NOTE: Please, create a backup of your database before running any of those actions. The steps below would be only valid if your application (e.g. any plugins or custom code) is compatible with MariaDB 10.5.x

Obtain the credentials and the name of the PVC used to hold the MariaDB data on your current release:

export DRUPAL_PASSWORD=$(kubectl get secret --namespace default drupal -o jsonpath="{.data.drupal-password}" | base64 --decode)
export MARIADB_ROOT_PASSWORD=$(kubectl get secret --namespace default drupal-mariadb -o jsonpath="{.data.mariadb-root-password}" | base64 --decode)
export MARIADB_PASSWORD=$(kubectl get secret --namespace default drupal-mariadb -o jsonpath="{.data.mariadb-password}" | base64 --decode)
export MARIADB_PVC=$(kubectl get pvc -l app=mariadb,component=master,release=drupal -o jsonpath="{.items[0].metadata.name}")

Upgrade your release (maintaining the version) disabling MariaDB and scaling Drupal replicas to 0:

$ helm upgrade drupal bitnami/drupal --set drupalPassword=$DRUPAL_PASSWORD --set replicaCount=0 --set mariadb.enabled=false --version 8.2.1

Finally, upgrade you release to 9.0.0 reusing the existing PVC, and enabling back MariaDB:

$ helm upgrade drupal bitnami/drupal --set mariadb.primary.persistence.existingClaim=$MARIADB_PVC --set mariadb.auth.rootPassword=$MARIADB_ROOT_PASSWORD --set mariadb.auth.password=$MARIADB_PASSWORD --set drupalPassword=$DRUPAL_PASSWORD

You should see the lines below in MariaDB container logs:

$ kubectl logs $(kubectl get pods -l app.kubernetes.io/instance=drupal,app.kubernetes.io/name=mariadb,app.kubernetes.io/component=primary -o jsonpath="{.items[0].metadata.name}")
...
mariadb 12:13:24.98 INFO  ==> Using persisted data
mariadb 12:13:25.01 INFO  ==> Running mysql_upgrade
...

To 8.0.0

The Bitnami Drupal image was migrated to a "non-root" user approach. Previously the container ran as the root user and the Apache daemon was started as the daemon user. From now on, both the container and the Apache daemon run as user 1001. You can revert this behavior by setting the parameters containerSecurityContext.runAsUser to root.

Consequences:

• The HTTP/HTTPS ports exposed by the container are now 8080/8443 instead of 80/443.
• Backwards compatibility is not guaranteed.

To upgrade to 8.0.0, backup Drupal data and the previous MariaDB databases, install a new Drupal chart and import the backups and data, ensuring the 1001 user has the appropriate permissions on the migrated volume.

This upgrade also adapts the chart to the latest Bitnami good practices. Check the Parameters section for more information.

To 6.0.0

Helm performs a lookup for the object based on its group (apps), version (v1), and kind (Deployment). Also known as its GroupVersionKind, or GVK. Changing the GVK is considered a compatibility breaker from Kubernetes' point of view, so you cannot "upgrade" those objects to the new GVK in-place. Earlier versions of Helm 3 did not perform the lookup correctly which has since been fixed to match the spec.

In https://github.com/helm/charts/pull/17295 the apiVersion of the deployment resources was updated to apps/v1 in tune with the api's deprecated, resulting in compatibility breakage.

This major version signifies this change.

To 2.0.0

Backwards compatibility is not guaranteed unless you modify the labels used on the chart's deployments. Use the workaround below to upgrade from versions previous to 2.0.0. The following example assumes that the release name is drupal:

$ kubectl patch deployment drupal-drupal --type=json -p='[{"op": "remove", "path": "/spec/selector/matchLabels/chart"}]'
$ kubectl delete statefulset drupal-mariadb --cascade=false

Community supported solution

Please, note this Helm chart is a community-supported solution. This means that the Bitnami team is not actively working on new features/improvements nor providing support through GitHub Issues for this Helm chart. Any new issue will stay open for 20 days to allow the community to contribute, after 15 days without activity the issue will be marked as stale being closed after 5 days.

The Bitnami team will review any PR that is created, feel free to create a PR if you find any issue or want to implement a new feature.

New versions are not going to be affected. Once a new version is released in the upstream project, the Bitnami container image will be updated to use the latest version.