Bitnami LMS powered by Moodle(TM) LMS

Moodle(TM) LMS is an open source online Learning Management System widely used at universities, schools, and corporations. It is modular and highly adaptable to any type of online learning.

Overview of Bitnami LMS powered by Moodle™ LMS

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

TL;DR

helm install my-release oci://REGISTRY_NAME/REPOSITORY_NAME/moodle

Note: You need to substitute the placeholders REGISTRY_NAME and REPOSITORY_NAME with a reference to your Helm chart registry and repository.

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.

Prerequisites

  • Kubernetes 1.23+
  • Helm 3.8.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 oci://REGISTRY_NAME/REPOSITORY_NAME/moodle

Note: You need to substitute the placeholders REGISTRY_NAME and REPOSITORY_NAME with a reference to your Helm chart registry and repository. For example, in the case of Bitnami, you need to use REGISTRY_NAME=registry-1.docker.io and REPOSITORY_NAME=bitnamicharts.

The command deploys Moodle™ 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

Configuration and installation details

Resource requests and limits

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 resourcePreset is discouraged as it may not fully adapt to your specific needs. Find more information on container resource management in the official Kubernetes documentation.

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(TM) 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 Moodle™ 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 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 Moodle™ is uninstalled, data is also removed.

Parameters

Global parameters

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.storageClass DEPRECATED: use global.defaultStorageClass instead ""
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

Common parameters

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

Moodle™ parameters

Name Description Value
image.registry Moodle image registry REGISTRY_NAME
image.repository Moodle image repository REPOSITORY_NAME/moodle
image.digest Moodle image digest in the way sha256:aa…. Please note this parameter, if set, will override the tag ""
image.pullPolicy Moodle 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 Moodle replicas (requires ReadWriteMany PVC support) 1
autoscaling.enabled Enable Horizontal POD autoscaling for Moodle™ false
autoscaling.minReplicas Minimum number of Moodle™ replicas 1
autoscaling.maxReplicas Maximum number of Moodle™ replicas 10
autoscaling.targetCPU Target CPU utilization percentage 80
autoscaling.targetMemory Target Memory utilization percentage 80
moodleSkipInstall Skip Moodle™ installation wizard. Useful for migrations and restoring from SQL dump false
moodleSiteName Site name ""
moodleLang Site language ""
moodleUsername User of the application user
moodlePassword Application password ""
moodleEmail Admin email [email protected]
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
extraEnvVars An array to add extra env vars []
extraEnvVarsCM ConfigMap with extra environment variables ""
extraEnvVarsSecret Secret with extra environment variables (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 Extra init containers to add to the deployment []
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 Extra sidecar containers to add to the deployment []
automountServiceAccountToken Mount Service Account token in pod false
hostAliases Moodle™ pods host aliases []
tolerations Tolerations for pod assignment []
priorityClassName Moodle™ pods’ priorityClassName ""
schedulerName Name of the k8s scheduler (other than default) ""
topologySpreadConstraints Topology Spread Constraints 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 {}
extraContainerPorts Optionally specify extra list of additional ports for Moodle&trade container(s) []
sessionAffinity Control where client requests go, to the same pod or round-robin None
persistence.enabled Enable persistence using PVC true
persistence.customStorageClass Create a custom storage class {}
persistence.storageClass PVC Storage Class for Moodle ""
persistence.accessModes PVC Access Mode for Moodle ["ReadWriteOnce"]
persistence.size PVC Storage Request for Moodle 8Gi
persistence.existingClaim An Existing PVC name ""
persistence.hostPath Host mount path for Moodle ""
persistence.annotations Persistent Volume Claim annotations {}
podAffinityPreset Pod affinity preset ""
podAntiAffinityPreset Pod anti-affinity preset soft
nodeAffinityPreset.type Node affinity type ""
nodeAffinityPreset.key Node label key to match ""
nodeAffinityPreset.values Node label values to match []
affinity Map of node/pod affinities {}
nodeSelector Node labels for pod assignment {}
resourcesPreset Set container resources according to one common preset (allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge). This is ignored if resources is set (resources is recommended for production). micro
resources Set container requests and limits for different resources like CPU or memory (essential for production workloads) {}
podSecurityContext.enabled Enable Moodle™ pods’ Security Context true
podSecurityContext.fsGroupChangePolicy Set filesystem group change policy Always
podSecurityContext.sysctls Set kernel settings using the sysctl interface []
podSecurityContext.supplementalGroups Set filesystem extra groups []
podSecurityContext.fsGroup Moodle™ pods’ group ID 1001
containerSecurityContext.enabled Enabled containers’ Security Context true
containerSecurityContext.seLinuxOptions Set SELinux options in container {}
containerSecurityContext.runAsUser Set containers’ Security Context runAsUser 1001
containerSecurityContext.runAsGroup Set containers’ Security Context runAsGroup 0
containerSecurityContext.runAsNonRoot Set container’s Security Context runAsNonRoot true
containerSecurityContext.privileged Set container’s Security Context privileged false
containerSecurityContext.readOnlyRootFilesystem Set container’s Security Context readOnlyRootFilesystem false
containerSecurityContext.allowPrivilegeEscalation Set container’s Security Context allowPrivilegeEscalation false
containerSecurityContext.capabilities.drop List of capabilities to be dropped ["ALL"]
containerSecurityContext.seccompProfile.type Set container’s Security Context seccomp profile RuntimeDefault
startupProbe.enabled Enable startupProbe false
startupProbe.path Request path for startupProbe /login/index.php
startupProbe.initialDelaySeconds Initial delay seconds for startupProbe 30
startupProbe.periodSeconds Period seconds for startupProbe 10
startupProbe.timeoutSeconds Timeout seconds for startupProbe 5
startupProbe.failureThreshold Failure threshold for startupProbe 60
startupProbe.successThreshold Success threshold for startupProbe 1
livenessProbe.enabled Enable livenessProbe true
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 6
livenessProbe.successThreshold Success threshold for livenessProbe 1
readinessProbe.enabled Enable readinessProbe true
readinessProbe.path Request path for readinessProbe /login/index.php
readinessProbe.initialDelaySeconds Initial delay seconds for readinessProbe 30
readinessProbe.periodSeconds Period seconds for readinessProbe 5
readinessProbe.timeoutSeconds Timeout seconds for readinessProbe 3
readinessProbe.failureThreshold Failure threshold for readinessProbe 6
readinessProbe.successThreshold Success threshold for readinessProbe 1
customStartupProbe Override default startup probe {}
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) {}
serviceAccount.create Enable creation of ServiceAccount for Moodle pod true
serviceAccount.name The name of the ServiceAccount to use. ""
serviceAccount.automountServiceAccountToken Allows auto mount of ServiceAccountToken on the serviceAccount created false
serviceAccount.annotations Additional custom annotations for the ServiceAccount {}

Traffic Exposure Parameters

Name Description Value
service.type Service type LoadBalancer
service.ports.http Service HTTP port 80
service.ports.https Service HTTPS port 443
service.nodePorts.http Kubernetes HTTP node port ""
service.nodePorts.https Kubernetes HTTPS node port ""
service.clusterIP Service Cluster IP ""
service.loadBalancerSourceRanges Service load balancer source ranges []
service.loadBalancerIP loadBalancerIP for the Moodle™ Service (optional, cloud specific) ""
service.externalTrafficPolicy Enable client source IP preservation Cluster
service.extraPorts Extra ports to expose (normally used with the sidecar value) []
service.annotations Additional custom annotations for Moodle™ service {}
service.sessionAffinity Session Affinity for Kubernetes service, can be “None” or “ClientIP” None
service.sessionAffinityConfig Additional settings for the sessionAffinity {}
ingress.enabled Set to true to enable ingress record generation false
ingress.pathType Ingress Path type ImplementationSpecific
ingress.apiVersion Override API Version (automatically detected if not set) ""
ingress.hostname When the ingress is enabled, a host pointing to this will be created moodle.local
ingress.path The Path to Moodle™. You may need to set this to ‘/*’ in order to use this with ALB ingress controllers. /
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 []
ingress.ingressClassName IngressClass that will be be used to implement the Ingress (Kubernetes 1.18+) ""
ingress.extraRules Additional rules to be covered with this ingress record []

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_moodle
mariadb.auth.username Database user to create bn_moodle
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 PVC Access Modes for Moodle™ volume ["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 ""
mariadb.primary.resourcesPreset Set container resources according to one common preset (allowed values: none, nano, small, medium, large, xlarge, 2xlarge). This is ignored if primary.resources is set (primary.resources is recommended for production). micro
mariadb.primary.resources Set container requests and limits for different resources like CPU or memory (essential for production workloads) {}
externalDatabase.type Type of the existing database ""
externalDatabase.host Host of the existing database ""
externalDatabase.port Port of the existing database 3306
externalDatabase.user Existing username in the external db bn_moodle
externalDatabase.password Password for the above username ""
externalDatabase.database Name of the existing database bitnami_moodle
externalDatabase.existingSecret Name of an existing secret resource containing the DB password ""

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 REGISTRY_NAME
volumePermissions.image.repository Init container volume-permissions image repository REPOSITORY_NAME/os-shell
volumePermissions.image.digest Init container volume-permissions image digest in the way sha256:aa…. Please note this parameter, if set, will override the tag ""
volumePermissions.image.pullPolicy Init container volume-permissions image pull policy IfNotPresent
volumePermissions.image.pullSecrets Specify docker-registry secret names as an array []
volumePermissions.resourcesPreset Set container resources according to one common preset (allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge). This is ignored if volumePermissions.resources is set (volumePermissions.resources is recommended for production). nano
volumePermissions.resources Set container requests and limits for different resources like CPU or memory (essential for production workloads) {}

Metrics parameters

Name Description Value
metrics.enabled Start a side-car prometheus exporter false
metrics.image.registry Apache exporter image registry REGISTRY_NAME
metrics.image.repository Apache exporter image repository REPOSITORY_NAME/apache-exporter
metrics.image.digest Apache exporter image digest in the way sha256:aa…. Please note this parameter, if set, will override the tag ""
metrics.image.pullPolicy Apache exporter image pull policy IfNotPresent
metrics.image.pullSecrets Specify docker-registry secret names as an array []
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, otherwise leave blank ""
metrics.service.loadBalancerSourceRanges Prometheus metrics service service Load Balancer sources []
metrics.service.clusterIP Prometheus metrics service Cluster IP ""
metrics.service.externalTrafficPolicy Prometheus metrics service service external traffic policy Cluster
metrics.service.annotations Annotations for Prometheus Exporter pods. Evaluated as a template. {}
metrics.service.sessionAffinity Session Affinity for Kubernetes service, can be “None” or “ClientIP” None
metrics.service.sessionAffinityConfig Additional settings for the sessionAffinity {}
metrics.resourcesPreset Set container resources according to one common preset (allowed values: none, nano, micro, small, medium, large, xlarge, 2xlarge). This is ignored if metrics.resources is set (metrics.resources is recommended for production). nano
metrics.resources Set container requests and limits for different resources like CPU or memory (essential for production workloads) {}
metrics.podAnnotations Metrics exporter pod Annotation and Labels {}

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 ""
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/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 with extra environment variables ""
certificates.extraEnvVarsSecret Secret with extra environment variables ""
certificates.image.registry Container sidecar registry REGISTRY_NAME
certificates.image.repository Container sidecar image repository REPOSITORY_NAME/os-shell
certificates.image.digest Container sidecar image digest in the way sha256:aa…. Please note this parameter, if set, will override the tag ""
certificates.image.pullPolicy Container sidecar image pull policy IfNotPresent
certificates.image.pullSecrets Container sidecar image pull secrets []

NetworkPolicy parameters

Name Description Value
networkPolicy.enabled Specifies whether a NetworkPolicy should be created true
networkPolicy.allowExternal Don’t require server label for connections true
networkPolicy.allowExternalEgress Allow the pod to access any range of port and all destinations. true
networkPolicy.extraIngress Add extra ingress rules to the NetworkPolicy []
networkPolicy.extraEgress Add extra ingress rules to the NetworkPolicy []
networkPolicy.ingressNSMatchLabels Labels to match to allow traffic from other namespaces {}
networkPolicy.ingressNSPodMatchLabels Pod labels to match to allow traffic from other namespaces {}

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 \
    oci://REGISTRY_NAME/REPOSITORY_NAME/moodle

Note: You need to substitute the placeholders REGISTRY_NAME and REPOSITORY_NAME with a reference to your Helm chart registry and repository. For example, in the case of Bitnami, you need to use REGISTRY_NAME=registry-1.docker.io and REPOSITORY_NAME=bitnamicharts.

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.

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 oci://REGISTRY_NAME/REPOSITORY_NAME/moodle

Note: You need to substitute the placeholders REGISTRY_NAME and REPOSITORY_NAME with a reference to your Helm chart registry and repository. For example, in the case of Bitnami, you need to use REGISTRY_NAME=registry-1.docker.io and REPOSITORY_NAME=bitnamicharts. Tip: You can use the default values.yaml

Troubleshooting

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

Upgrading

To 23.0.0

This major release bumps the MariaDB version to 11.4. Follow the upstream instructions for upgrading from MariaDB 11.3 to 11.4. No major issues are expected during the upgrade.

To 21.0.0

This major bump changes the following security defaults:

  • resourcesPreset is changed from none to the minimum size working in our test suites (NOTE: resourcesPreset is not meant for production usage, but resources adapted to your use case).
  • global.compatibility.openshift.adaptSecurityContext is changed from disabled to auto.
  • The networkPolicy section has been normalized amongst all Bitnami charts. Compared to the previous approach, the values section has been simplified (check the Parameters section) and now it set to enabled=true by default. Egress traffic is allowed by default and ingress traffic is allowed by all pods but only to the ports set in containerPorts and extraContainerPorts.

This could potentially break any customization or init scripts used in your deployment. If this is the case, change the default values to the previous ones.

Also, this major release bumps the MariaDB chart version to 18.x.x; no major issues are expected during the upgrade.

To 20.0.0

This major release bumps the MariaDB version to 11.2. No major issues are expected during the upgrade.

To 18.0.0

This major release bumps the MariaDB version to 11.1. No major issues are expected during the upgrade.

To 17.0.0

This major release bumps the MariaDB version to 11.0. Follow the upstream instructions for upgrading from MariaDB 10.11 to 11.0. No major issues are expected during the upgrade.

To 15.0.0

This major release bumps the MariaDB version to 10.11. Follow the upstream instructions for upgrading from MariaDB 10.6 to 10.11. No major issues are expected during the upgrade.

To 13.0.0

This major release bumps the MariaDB version to 10.6. Follow the upstream instructions for upgrading from MariaDB 10.5 to 10.6. No major issues are expected during the upgrade.

To 12.0.0

This major release renames several values in this chart and adds missing features, in order to be inline with the rest of assets in the Bitnami charts repository.

Affected values:

  • service.port was deprecated. We recommend using service.ports.http instead.
  • service.httpsPort was deprecated. We recommend using service.ports.https instead.

Additionally updates the MariaDB subchart to it newest major, 10.0.0, which contains similar changes. Check MariaDB Upgrading Notes for more information.

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 Moodle™ 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 Moodle™ data on your current release:

export MOODLE_PASSWORD=$(kubectl get secret --namespace default moodle -o jsonpath="{.data.moodle-password}" | base64 -d)
export MARIADB_ROOT_PASSWORD=$(kubectl get secret --namespace default moodle-mariadb -o jsonpath="{.data.mariadb-root-password}" | base64 -d)
export MARIADB_PASSWORD=$(kubectl get secret --namespace default moodle-mariadb -o jsonpath="{.data.mariadb-password}" | base64 -d)
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 Moodle™ replicas to 0:

helm upgrade moodle oci://REGISTRY_NAME/REPOSITORY_NAME/moodle --set moodlePassword=$MOODLE_PASSWORD --set replicaCount=0 --set mariadb.enabled=false --version 8.1.6

Note: You need to substitute the placeholders REGISTRY_NAME and REPOSITORY_NAME with a reference to your Helm chart registry and repository. For example, in the case of Bitnami, you need to use REGISTRY_NAME=registry-1.docker.io and REPOSITORY_NAME=bitnamicharts.

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

helm upgrade moodle oci://REGISTRY_NAME/REPOSITORY_NAME/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

Note: You need to substitute the placeholders REGISTRY_NAME and REPOSITORY_NAME with a reference to your Helm chart registry and repository. For example, in the case of Bitnami, you need to use REGISTRY_NAME=registry-1.docker.io and REPOSITORY_NAME=bitnamicharts.

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 Moodle™ 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 Moodle™.

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

License

Copyright © 2024 Broadcom. The term “Broadcom” refers to Broadcom Inc. and/or its subsidiaries.

Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

check-circle-line exclamation-circle-line close-line
Scroll to top icon