helm-charts/drupal

Drupal

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

This chart bootstraps a Drupal deployment on a Kubernetes cluster using the Helm package manager.

It is inspired by the [upstream drupal chart](https://github.com/kubernetes/charts/tree/master/stable/drupal, but, by default, utilizes Open Service Broker for Azure to provision an Azure Database for MySQL database for the Drupal server to use.

Basic Installation

Installation of this chart is simple. First, ensure that you've added the azure repository. Then, install from the azure repo:

$ helm install azure/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 for the database requirements of the Drupal application.

Prerequisites

You will need the following before you can install this chart:

• Kubernetes 1.7+ with RBAC turned on and beta APIs enabled
• Service Catalog installed
• Open Service Broker for Azure version v0.9.0-alpha or later installed
• Support for persistent volumes in the underlying infrastructure

Please see the prerequisities document for details on how to install everything.

Installing the Chart

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

$ helm install --name my-release --namespace drupal azure/drupal

The command deploys Drupal on the Kubernetes cluster in the default configuration. The configuration 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.

Configuration

The following tables lists the configurable parameters of the Drupal chart and their default values.

Parameter	Description	Default
image	Drupal image	bitnami/drupal:{VERSION}
imagePullSecrets	Specify image pull secrets	nil (does not add image pull secrets to deployed pods)
imagePullPolicy	Image pull policy	IfNotPresent
drupalUsername	User of the application	user
drupalPassword	Application password	random 10 character long alphanumeric string
drupalEmail	Admin email	user@example.com
extraVars	Extra environment variables	nil
ingress.annotations	Specify ingress class	kubernetes.io/ingress.class: nginx
ingress.enabled	Enable ingress controller resource	false
ingress.hostname	URL for your Drupal installation	drupal.local
ingress.tls	Ingress TLS configuration	[]
mysql.embeddedMaria	Whether to fulfill the dependency on MySQL using an embedded (on-cluster) MariaDB database instead of Azure Database for MySQL. This option is available to enable local or no-cost evaluation of this chart.	false
serviceType	Kubernetes Service type	LoadBalancer
persistence.enabled	Enable persistence using PVC	true
persistence.apache.storageClass	PVC Storage Class for Apache volume	nil (uses alpha storage class annotation)
persistence.apache.accessMode	PVC Access Mode for Apache volume	ReadWriteOnce
persistence.apache.size	PVC Storage Request for Apache volume	1Gi
persistence.drupal.storageClass	PVC Storage Class for Drupal volume	nil (uses alpha storage class annotation)
persistence.drupal.accessMode	PVC Access Mode for Drupal volume	ReadWriteOnce
persistence.drupal.existingClaim	An Existing PVC name	nil
persistence.drupal.hostPath	Host mount path for Drupal volume	nil (will not mount to a host path)
persistence.drupal.size	PVC Storage Request for Drupal volume	8Gi
resources	CPU/Memory resource requests/limits	Memory: 512Mi, CPU: 300m
volumeMounts.drupal.mountPath	Drupal data volume mount path	/bitnami/drupal
volumeMounts.apache.mountPath	Apache data volume mount path	/bitnami/apache

The following configuration options are utilized only if mysql.embeddedMaria is set to false (the default):

Parameter	Description	Default
mysql.azure.location	The Azure region in which to deploy Azure Database for MySQL	eastus
mysql.azure.servicePlan	The plan to request for Azure Database for MySQL	standard100

The following configuration options are utilized only if mysql.embeddedMaria is set to true:

Parameter	Description	Default
mariadb.mariadbRootPassword	MariaDB admin password	nil
mariadb.mariadbDatabase	Database name to create	bitnami_drupal
mariadb.mariadbUser	Database user to create	bn_drupal
mariadb.mariadbPassword	Password for the database	random 10 character long alphanumeric string

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 --name my-release \
  --set drupalUsername=admin,drupalPassword=password,mariadb.mariadbRootPassword=secretpassword \
    stable/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.

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

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

Tip: You can use the default values.yaml

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

helm install --name my-release -f values.yaml stable/drupal

Persistence

The configured image must store Drupal data and Apache configurations in separate paths of the container.

The Bitnami Drupal image stores the Drupal data and Apache configurations at the /bitnami/drupal and /bitnami/apache paths of the container. If you wish to override the image value, and your image stores this data and configurations in different paths, you may specify these paths with volumeMounts.drupal.mountPath and volumeMounts.apache.mountPath.

Persistent Volume Claims are used to keep the data across deployments. This is known to work in GCE, AWS, and minikube. See the Configuration 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 --name my-release --set persistence.drupal.existingClaim=PVC_NAME stable/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 --name my-release --set persistence.drupal.hostPath=/PATH/TO/HOST/MOUNT stable/drupal
   

   This will mount the drupal-data volume into the hostPath directory, if the site has not already been initialized. If it has, your host machine changes will persist.
3. Because the container can not 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 cache, or Drush handbook to clear cache.