bitnami/moodle

Chart version: 11.0.0
Api version: v2
App version: 3.10.0
Moodle(TM) is a learning platform designed to provide educators...
application
Chart Type
Active
Status
Unknown
License
18647
Downloads
https://charts.bitnami.com/bitnami
Set me up:
helm repo add center https://repo.chartcenter.io
Install Chart:
helm install moodle center/bitnami/moodle
Versions (0)

MoodleTM LMS

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

Disclaimer: The respective trademarks mentioned in the offering are owned by the respective companies. Bitnami does not provide commercial license of any of these products. This listing has an open source license. MoodleTM LMS is run and maintained by Moodle HQ, that is a completely and separate project from Bitnami.

TL;DR

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

Introduction

This chart bootstraps a MoodleTM 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 MoodleTM 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.0-beta3+
  • 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/moodle

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

The following table lists the configurable parameters of the MoodleTM chart and their default values per section/component:

Global parameters

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

Common parameters

Parameter Description Default
image.registry MoodleTM image registry docker.io
image.repository MoodleTM Image name bitnami/moodle
image.tag MoodleTM Image tag {TAG_NAME}
image.pullPolicy MoodleTM image pull policy IfNotPresent
image.pullSecrets Specify docker-registry secret names as an array [] (does not add image pull secrets to deployed pods)
image.debug Specify if debug logs should be enabled false
nameOverride String to partially override moodle.fullname template nil
fullnameOverride String to fully override moodle.fullname template nil
commonLabels Labels to add to all deployed objects nil
commonAnnotations Annotations to add to all deployed objects []
extraDeploy Array of extra objects to deploy with the release (evaluated as a template). nil
kubeVersion Force target Kubernetes version (using Helm capabilities if not set) nil

MoodleTM parameters

Parameter Description Default
affinity Map of node/pod affinities {}
allowEmptyPassword Allow DB blank passwords true
args Override default container args (useful when using custom images) nil
command Override default container command (useful when using custom images) nil
containerPorts.http Sets http port inside MoodleTM container 8080
containerPorts.https Sets https port inside MoodleTM container 8443
containerSecurityContext.enabled Enable MoodleTM containers’ Security Context true
containerSecurityContext.runAsUser MoodleTM containers’ Security Context 1001
customLivenessProbe Override default liveness probe nil
customReadinessProbe Override default readiness probe nil
existingSecret Name of a secret with the application password nil
extraEnvVarsCM ConfigMap containing extra env vars nil
extraEnvVarsSecret Secret containing extra env vars (in case of sensitive data) nil
extraEnvVars Extra environment variables nil
extraVolumeMounts Array of extra volume mounts to be added to the container (evaluated as template). Normally used with extraVolumes. nil
extraVolumes Array of extra volumes to be added to the deployment (evaluated as template). Requires setting extraVolumeMounts nil
initContainers Add additional init containers to the pod (evaluated as a template) nil
lifecycleHooks LifecycleHook to set additional configuration at startup Evaluated as a template
livenessProbe Liveness probe configuration Check values.yaml file
moodleSkipInstall Skip MoodleTM installation wizard (true / false) false
moodleSiteName Site Name ""
moodleUsername User of the application user
moodlePassword Application password random 10 character alphanumeric string
moodleEmail Admin email user@example.com
nodeSelector Node labels for pod assignment {} (The value is evaluated as a template)
persistence.accessMode PVC Access Mode for MoodleTM volume ReadWriteOnce
persistence.enabled Enable persistence using PVC true
persistence.existingClaim An Existing PVC name nil
persistence.hostPath Host mount path for MoodleTM volume nil (will not mount to a host path)
persistence.size PVC Storage Request for MoodleTM volume 8Gi
persistence.storageClass PVC Storage Class for MoodleTM volume nil (uses alpha storage class annotation)
podAnnotations Pod annotations {}
podLabels Add additional labels to the pod (evaluated as a template) nil
podSecurityContext.enabled Enable MoodleTM pods’ Security Context true
podSecurityContext.fsGroup MoodleTM pods’ group ID 1001
readinessProbe Readiness probe configuration Check values.yaml file
replicaCount Number of MoodleTM Pods to run 1
resources CPU/Memory resource requests/limits Memory: 512Mi, CPU: 300m
sidecars Attach additional containers to the pod (evaluated as a template) nil
smtpHost SMTP host nil
smtpPort SMTP port nil (but MoodleTM internal default is 25)
smtpProtocol SMTP Protocol (options: ssl,tls, nil) nil
smtpUser SMTP user nil
smtpPassword SMTP password nil
tolerations Tolerations for pod assignment [] (The value is evaluated as a template)
updateStrategy Deployment update strategy nil

Traffic Exposure Parameters

Parameter Description Default
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.certManager Add annotations for cert-manager false
ingress.hostname Default host for the ingress resource minio.local
ingress.path Default path for the ingress resource /
ingress.tls Create TLS Secret false
ingress.annotations Ingress annotations [] (evaluated as a template)
ingress.extraHosts[0].name Additional hostnames to be covered nil
ingress.extraHosts[0].path Additional hostnames to be covered nil
ingress.extraPaths Additional arbitrary path/backend objects nil
ingress.extraTls[0].hosts[0] TLS configuration for additional hostnames to be covered nil
ingress.extraTls[0].secretName TLS configuration for additional hostnames to be covered nil
ingress.secrets[0].name TLS Secret Name nil
ingress.secrets[0].certificate TLS Secret Certificate nil
ingress.secrets[0].key TLS Secret Key nil

Database parameters

Parameter Description Default
mariadb.enabled Whether to use the MariaDB chart true
mariadb.architecture MariaDB architecture (standalone or replication) standalone
mariadb.auth.rootPassword Password for the MariaDB root user random 10 character alphanumeric string
mariadb.auth.database Database name to create bitnami_moodle
mariadb.auth.username Database user to create bn_moodle
mariadb.auth.password Password for the database random 10 character long alphanumeric string
mariadb.primary.persistence.enabled Enable database persistence using PVC true
mariadb.primary.persistence.existingClaim Name of an existing PersistentVolumeClaim for MariaDB primary replicas nil
mariadb.primary.persistence.accessMode Database Persistent Volume Access Modes [ReadWriteOnce]
mariadb.primary.persistence.size Database Persistent Volume Size 8Gi
mariadb.primary.persistence.storageClass MariaDB primary persistent volume storage Class nil (uses alpha storage class annotation)
mariadb.primary.persistence.hostPath Host mount path for MariaDB volume nil (will not mount to a host path)
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
externalDatabase.host Host of the existing database nil
externalDatabase.port Port of the existing database 3306

Volume Permissions parameters

Parameter Description Default
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/minideb
volumePermissions.image.tag Init container volume-permissions image tag buster
volumePermissions.image.pullSecrets Specify docker-registry secret names as an array [] (does not add image pull secrets to deployed pods)
volumePermissions.image.pullPolicy Init container volume-permissions image pull policy Always
volumePermissions.resources Init container resource requests/limit nil

Metrics parameters

Parameter Description Default
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.service.type Prometheus metrics service type LoadBalancer
metrics.service.port Prometheus metrics service port 9117
metrics.service.loadBalancerIP Load Balancer IP if the Prometheus metrics server type is LoadBalancer nil
metrics.service.annotations Annotations for Prometheus metrics service {prometheus.io/scrape: "true", prometheus.io/port: "9117"}
metrics.podAnnotations Additional annotations for Metrics exporter pod {prometheus.io/scrape: "true", prometheus.io/port: "9117"}
metrics.resources Exporter resource requests/limit {}

Certificate injection parameters

Parameter Description Default
certificates.customCertificate.certificateSecret Secret containing the certificate and key to add ""
certificates.customCertificate.chainSecret.name Name of the secret containing the certificate chain ""
certificates.customCertificate.chainSecret.key Key of the certificate chain file inside the secret ""
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/chain.pem
certificates.customCAs Defines a list of secrets to import into the container trust store []
certificates.image.registry Container sidecar registry docker.io
certificates.image.repository Container sidecar image bitnami/minideb
certificates.image.tag Container sidecar image tag buster
certificates.image.pullPolicy Container sidecar image pull policy IfNotPresent
certificates.image.pullSecrets Container sidecar image pull secrets image.pullSecrets
certificates.args Override default container args (useful when using custom images) nil
certificates.command Override default container command (useful when using custom images) nil
certificates.extraEnvVars Container sidecar extra environment variables (eg proxy) []
certificates.extraEnvVarsCM ConfigMap containing extra env vars nil
certificates.extraEnvVarsSecret Secret containing extra env vars (in case of sensitive data) nil

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 my-release \
  --set moodleUsername=admin,moodlePassword=password,mariadb.auth.rootPassword=secretpassword \
    bitnami/moodle

The above command sets the MoodleTM 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 my-release -f values.yaml bitnami/moodle

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.

Ingress without TLS

For using ingress (example without TLS):

ingress.enabled=True
ingress.hosts[0]=moodle.domain.com
serviceType=ClusterIP
moodleUsername=admin
moodlePassword=password
mariadb.mariadbRootPassword=secretpassword

These are the 3 mandatory parameters when Ingress is desired: ingress.enabled=True, ingress.hosts[0]=moodle.domain.com and 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 (named moodle-server-tls in this example) in the namespace. 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(TM) server Ingress will be created
  ##
  enabled: true

  ## Moodle(TM) 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(TM) server Ingress TLS configuration
  ## Secrets must be manually created in the namespace
  ##
  tls:
    - secretName: moodle-server-tls
      hosts:
        - moodle.domain.com

Persistence

The Bitnami Container Image for MoodleTM stores the MoodleTM 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 Parameters 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 MoodleTM is uninstalled, data is also removed.

Troubleshooting

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

Upgrading

To 11.0.0

This version standardizes the way of defining Ingress rules. When configuring a single hostname for the Ingress rule, set the ingress.hostname value. When defining more than one, set the ingress.extraHosts array. Apart from this case, no issues are expected to appear when 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

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, it should be done reusing the PVCs used to hold both the MariaDB and MoodleTM data on your previous release. To do so, follow the instructions below (the following example assumes that the release name is moodle):

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 names of the PVCs used to hold both the MariaDB and MoodleTM data on your current release:

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

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

$ helm upgrade moodle bitnami/moodle --set moodlePassword=$MOODLE_PASSWORD --set replicaCount=0 --set mariadb.enabled=false --version 8.1.6

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

$ helm upgrade moodle bitnami/moodle --set mariadb.primary.persistence.existingClaim=$MARIADB_PVC --set mariadb.auth.rootPassword=$MARIADB_ROOT_PASSWORD --set mariadb.auth.password=$MARIADB_PASSWORD --set moodlePassword=$MOODLE_PASSWORD

You should see the lines below in MariaDB container logs:

$ kubectl logs $(kubectl get pods -l app.kubernetes.io/instance=moodle,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 Container Image for MoodleTM was updated to support “non-root” user approach, however, it is not enabled by default. The container still runs as the root user and the Apache daemon is started as the daemon user, due to running Cron as a service, which requires running as root.

If you want to run with a non-root user, you need to set podSecurityContext.enabled=true and containerSecurity.context.enabled=true. In addition to that, you will also need to change the default Apache HTTP ports to run as a non-privileged user by setting containerPorts.http and containerPorts.https to a non-privileged port number (higher than 1024, i.e. 8080 and 8443, respectively). Note that, when running as a non-root user, Cron will not supported and therefore scheduled tasks will not be enabled for MoodleTM.

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

To 7.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/17301 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 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