charts/upstreamed/moodle

Moodle

Moodle is a learning platform designed to provide educators, administrators and learners with a single robust, secure and integrated system to create personalized learning environments

TL;DR;

$ helm install stable/moodle

Introduction

This chart bootstraps a Moodle 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 Moodle 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.4+ with Beta APIs enabled
• PV provisioner support in the underlying infrastructure

Installing the Chart

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

$ helm install --name my-release stable/moodle

The command deploys Moodle 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 table lists the configurable parameters of the Moodle chart and their default values.

Parameter	Description	Default
global.imageRegistry	Global Docker image registry	nil
global.imagePullSecrets	Global Docker registry secret names as an array	[] (does not add image pull secrets to deployed pods)
global.storageClass	Global storage class for dynamic provisioning	nil
image.registry	Moodle image registry	docker.io
image.repository	Moodle Image name	bitnami/moodle
image.tag	Moodle Image tag	{TAG_NAME}
image.pullPolicy	Image pull policy	IfNotPresent
image.pullSecrets	Specify docker-registry secret names as an array	[] (does not add image pull secrets to deployed pods)
nameOverride	String to partially override moodle.fullname template with a string (will prepend the release name)	nil
fullnameOverride	String to fully override moodle.fullname template with a string	nil
moodleUsername	User of the application	user
moodlePassword	Application password	random 10 character alphanumeric string
moodleEmail	Admin email	user@example.com
smtpHost	SMTP host	nil
smtpPort	SMTP port	nil (but moodle internal default is 25)
smtpProtocol	SMTP Protocol (options: ssl,tls, nil)	nil
smtpUser	SMTP user	nil
smtpPassword	SMTP password	nil
service.type	Kubernetes Service type	LoadBalancer
service.port	Service HTTP port	80
service.httpsPort	Service HTTPS port	443
service.externalTrafficPolicy	Enable client source IP preservation	Cluster
service.nodePorts.http	Kubernetes http node port	""
service.nodePorts.https	Kubernetes https node port	""
ingress.enabled	Enable ingress controller resource	false
ingress.hosts[0].name	Hostname to your Moodle installation	moodle.local
ingress.hosts[0].path	Path within the url structure	/
ingress.hosts[0].tls	Utilize TLS backend in ingress	false
ingress.hosts[0].certManager	Add annotations for cert-manager	false
ingress.hosts[0].tlsSecret	TLS Secret (certificates)	moodle.local-tls-secret
ingress.hosts[0].annotations	Annotations for this host's ingress record	[]
ingress.secrets[0].name	TLS Secret Name	nil
ingress.secrets[0].certificate	TLS Secret Certificate	nil
ingress.secrets[0].key	TLS Secret Key	nil
affinity	Set affinity for the moodle pods	nil
resources	CPU/Memory resource requests/limits	Memory: 512Mi, CPU: 300m
persistence.enabled	Enable persistence using PVC	true
persistence.storageClass	PVC Storage Class for Moodle volume	nil (uses alpha storage class annotation)
persistence.accessMode	PVC Access Mode for Moodle volume	ReadWriteOnce
persistence.size	PVC Storage Request for Moodle volume	8Gi
persistence.existingClaim	If PVC exists&bounded for Moodle	nil (when nil, new one is requested)
allowEmptyPassword	Allow DB blank passwords	yes
externalDatabase.host	Host of the external database	nil
externalDatabase.port	Port of the external database	3306
externalDatabase.user	Existing username in the external db	bn_moodle
externalDatabase.password	Password for the above username	nil
externalDatabase.database	Name of the existing database	bitnami_moodle
mariadb.enabled	Whether to install the MariaDB chart	true
mariadb.db.name	Database name to create	bitnami_moodle
mariadb.db.user	Database user to create	bn_moodle
mariadb.db.password	Password for the database	nil
mariadb.rootUser.password	MariaDB admin password	nil
mariadb.persistence.enabled	Enable MariaDB persistence using PVC	true
mariadb.persistence.storageClass	PVC Storage Class for MariaDB volume	generic
mariadb.persistence.accessMode	PVC Access Mode for MariaDB volume	ReadWriteOnce
mariadb.persistence.size	PVC Storage Request for MariaDB volume	8Gi
mariadb.persistence.existingClaim	If PVC exists&bounded for MariaDB	nil (when nil, new one is requested)
mariadb.affinity	Set affinity for the MariaDB pods	nil
mariadb.resources	CPU/Memory resource requests/limits	Memory: 256Mi, CPU: 250m
livenessProbe.initialDelaySeconds	Delay before liveness probe is initiated	600
livenessProbe.periodSeconds	How often to perform the probe	3
livenessProbe.timeoutSeconds	When the probe times out	5
livenessProbe.failureThreshold	Minimum consecutive failures for the probe to be considered failed after having succeeded.	6
livenessProbe.successThreshold	Minimum consecutive successes for the probe to be considered successful after having failed.	1
readinessProbe.initialDelaySeconds	Delay before readiness probe is initiated	30
readinessProbe.periodSeconds	How often to perform the probe	3
readinessProbe.timeoutSeconds	When the probe times out	5
readinessProbe.failureThreshold	Minimum consecutive failures for the probe to be considered failed after having succeeded.	6
readinessProbe.successThreshold	Minimum consecutive successes for the probe to be considered successful after having failed.	1
podAnnotations	Pod annotations	{}
metrics.enabled	Start a side-car prometheus exporter	false
metrics.image.registry	Apache exporter image registry	docker.io
metrics.image.repository	Apache exporter image name	bitnami/apache-exporter
metrics.image.tag	Apache exporter image tag	{TAG_NAME}
metrics.image.pullPolicy	Image pull policy	IfNotPresent
metrics.image.pullSecrets	Specify docker-registry secret names as an array	[] (does not add image pull secrets to deployed pods)
metrics.podAnnotations	Additional annotations for Metrics exporter pod	{prometheus.io/scrape: "true", prometheus.io/port: "9117"}
metrics.resources	Exporter resource requests/limit	{}

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

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

$ helm install --name my-release \
  --set moodleUsername=admin,moodlePassword=password,mariadb.mariadbRootPassword=secretpassword \
    stable/moodle

The above command sets the Moodle 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/moodle

Tip

: You can use the default values.yaml

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.

Ingress without TLS

For using ingress (example without TLS):

$ helm install --name my-release \
  --set ingress.enabled=True,ingress.hosts[0]=moodle.domain.com,serviceType=ClusterIP,moodleUsername=admin,moodlePassword=password,mariadb.mariadbRootPassword=secretpassword stable/moodle

These are the 3 mandatory parameters when Ingress is desired: ingress.enabled=True,ingress.hosts[0]=moodle.domain.com,serviceType=ClusterIP

Ingress TLS

If your cluster allows automatic creation/retrieval of TLS certificates (e.g. kube-lego), please refer to the documentation for that mechanism.

To manually configure TLS, first create/retrieve a key & certificate pair for the address(es) you wish to protect. Then create a TLS secret in the namespace:

$ kubectl create secret tls moodle-server-tls --cert=path/to/tls.cert --key=path/to/tls.key

Include the secret's name, along with the desired hostnames, in the Ingress TLS section of your custom values.yaml file:

ingress:
  ## If true, Moodle server Ingress will be created
  ##
  enabled: true

  ## Moodle server Ingress annotations
  ##
  annotations: {}
  #   kubernetes.io/ingress.class: nginx
  #   kubernetes.io/tls-acme: 'true'

  ## Moodle server Ingress hostnames
  ## Must be provided if Ingress is enabled
  ##
  hosts:
    - moodle.domain.com

  ## Moodle server Ingress TLS configuration
  ## Secrets must be manually created in the namespace
  ##
  tls:
    - secretName: moodle-server-tls
      hosts:
        - moodle.domain.com

Persistence

The Bitnami Moodle image stores the Moodle data and configurations at the /bitnami/moodle and /bitnami/apache paths of the container.

Persistent Volume Claims are used to keep the data across deployments. This is known to work in GCE, AWS, vpshere, and minikube. See the Configuration section to configure the PVC or to disable persistence. You may want to review the PV reclaim policy and update as required. By default, it's set to delete, and when Moodle is uninstalled, data is also removed.

Upgrading

To 3.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 3.0.0. The following example assumes that the release name is moodle:

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