Magento
Magento is a feature-rich flexible e-commerce solution. It includes transaction options, multi-store functionality, loyalty programs, product categorization and shopper filtering, promotion rules, and more.
TL;DR;
$ helm install stable/magento
Introduction
This chart bootstraps a Magento 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 Magento 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/magento
The command deploys Magento 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 Magento 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) |
image.registry |
Magento image registry | docker.io |
image.repository |
Magento Image name | bitnami/magento |
image.tag |
Magento Image tag | {VERSION} |
image.debug |
Specify if debug values should be set | false |
image.pullPolicy |
Image pull policy | Always if imageTag is latest, else IfNotPresent |
image.pullSecrets |
Specify docker-registry secret names as an array | [] (does not add image pull secrets to deployed pods) |
magentoHost |
Magento host to create application URLs | nil |
magentoLoadBalancerIP |
loadBalancerIP for the magento Service |
nil |
magentoUsername |
User of the application | user |
magentoPassword |
Application password | random 10 character long alphanumeric string |
magentoEmail |
Admin email | user@example.com |
magentoFirstName |
Magento Admin First Name | FirstName |
magentoLastName |
Magento Admin Last Name | LastName |
magentoMode |
Magento mode | developer |
magentoAdminUri |
Magento prefix to access Magento Admin | admin |
allowEmptyPassword |
Allow DB blank passwords | yes |
ingress.enabled |
Enable ingress controller resource | false |
ingress.annotations |
Ingress annotations | [] |
ingress.certManager |
Add annotations for cert-manager | false |
ingress.hosts[0].name |
Hostname to your Magento installation | magento.local |
ingress.hosts[0].path |
Path within the url structure | / |
ingress.hosts[0].tls |
Utilize TLS backend in ingress | false |
ingress.hosts[0].tlsHosts |
Array of TLS hosts for ingress record (defaults to ingress.hosts[0].name if nil) |
nil |
ingress.hosts[0].tlsSecret |
TLS Secret (certificates) | magento.local-tls-secret |
ingress.secrets[0].name |
TLS Secret Name | nil |
ingress.secrets[0].certificate |
TLS Secret Certificate | nil |
ingress.secrets[0].key |
TLS Secret Key | nil |
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_magento |
externalDatabase.password |
Password for the above username | nil |
externalDatabase.database |
Name of the existing database | bitnami_magento |
mariadb.enabled |
Whether to use the MariaDB chart | true |
mariadb.rootUser.password |
MariaDB admin password | nil |
mariadb.db.name |
Database name to create | bitnami_magento |
mariadb.db.user |
Database user to create | bn_magento |
mariadb.db.password |
Password for the database | random 10 character long alphanumeric string |
service.type |
Kubernetes Service type | LoadBalancer |
service.port |
Service HTTP port | 80 |
service.httpsPort |
Service HTTPS port | 443 |
nodePorts.https |
Kubernetes https node port | "" |
service.externalTrafficPolicy |
Enable client source IP preservation | Cluster |
service.nodePorts.http |
Kubernetes http node port | "" |
service.nodePorts.https |
Kubernetes https node port | "" |
service.loadBalancerIP |
loadBalancerIP for the Magento Service |
nil |
livenessProbe.enabled |
Turn on and off liveness probe | true |
livenessProbe.initialDelaySeconds |
Delay before liveness probe is initiated | 1000 |
livenessProbe.periodSeconds |
How often to perform the probe | 10 |
livenessProbe.timeoutSeconds |
When the probe times out | 5 |
livenessProbe.successThreshold |
Minimum consecutive successes for the probe | 1 |
livenessProbe.failureThreshold |
Minimum consecutive failures for the probe | 6 |
readinessProbe.enabled |
Turn on and off readiness probe | true |
readinessProbe.initialDelaySeconds |
Delay before readiness probe is initiated | 30 |
readinessProbe.periodSeconds |
How often to perform the probe | 5 |
readinessProbe.timeoutSeconds |
When the probe times out | 3 |
readinessProbe.successThreshold |
Minimum consecutive successes for the probe | 1 |
readinessProbe.failureThreshold |
Minimum consecutive failures for the probe | 3 |
persistence.enabled |
Enable persistence using PVC | true |
persistence.apache.storageClass |
PVC Storage Class for Apache volume | nil (uses alpha storage annotation) |
persistence.apache.accessMode |
PVC Access Mode for Apache volume | ReadWriteOnce |
persistence.apache.size |
PVC Storage Request for Apache volume | 1Gi |
persistence.magento.storageClass |
PVC Storage Class for Magento volume | nil (uses alpha storage annotation) |
persistence.magento.accessMode |
PVC Access Mode for Magento volume | ReadWriteOnce |
persistence.magento.size |
PVC Storage Request for Magento volume | 8Gi |
resources |
CPU/Memory resource requests/limits | Memory: 512Mi, CPU: 300m |
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 | lusotycoon/apache-exporter |
metrics.image.tag |
Apache exporter image tag | v0.5.0 |
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/magento. For more information please refer to the bitnami/magento image documentation.
Note
:
For Magento to function correctly, you should specify the
magentoHostparameter to specify the FQDN (recommended) or the public IP address of the Magento service.Optionally, you can specify the
magentoLoadBalancerIPparameter to assign a reserved IP address to the Magento service of the chart. However please note that this feature is only available on a few cloud providers (f.e. GKE).To reserve a public IP address on GKE:
$ gcloud compute addresses create magento-public-ipThe reserved IP address can be associated to the Magento service by specifying it as the value of the
magentoLoadBalancerIPparameter while installing the chart.
Specify each parameter using the --set key=value[,key=value] argument to helm install. For example,
$ helm install --name my-release \
--set magentoUsername=admin,magentoPassword=password,mariadb.mariadbRootPassword=secretpassword \
stable/magento
The above command sets the Magento 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/magento
Tip
: You can use the default values.yaml
Persistence
The Bitnami Magento image stores the Magento data and configurations at the /bitnami/magento and /bitnami/apache paths of the container.
Persistent Volume Claims are used to keep the data across deployments. There is a known issue in Kubernetes Clusters with EBS in different availability zones. Ensure your cluster is configured properly to create Volumes in the same availability zone where the nodes are running. Kuberentes 1.12 solved this issue with the Volume Binding Mode.
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 magento:
$ kubectl patch deployment magento-magento --type=json -p='[{"op": "remove", "path": "/spec/selector/matchLabels/chart"}]'
$ kubectl delete statefulset magento-mariadb --cascade=false