Back to Charts

PrestaShop

stable/prestashop/README.md

latest24.6 KB
Original Source

PrestaShop

PrestaShop is a popular open source e-commerce solution. Professional tools are easily accessible to increase online sales including instant guest checkout, abandoned cart reminders and automated Email marketing.

This Helm chart is deprecated

Given the stable deprecation timeline, the Bitnami maintained PrestaShop Helm chart is now located at bitnami/charts.

The Bitnami repository is already included in the Hubs and we will continue providing the same cadence of updates, support, etc that we've been keeping here these years. Installation instructions are very similar, just adding the bitnami repo and using it during the installation (bitnami/<chart> instead of stable/<chart>)

bash
$ helm repo add bitnami https://charts.bitnami.com/bitnami
$ helm install my-release bitnami/<chart>           # Helm 3
$ helm install --name my-release bitnami/<chart>    # Helm 2

To update an exisiting stable deployment with a chart hosted in the bitnami repository you can execute

bash
$ helm repo add bitnami https://charts.bitnami.com/bitnami
$ helm upgrade my-release bitnami/<chart>

Issues and PRs related to the chart itself will be redirected to bitnami/charts GitHub repository. In the same way, we'll be happy to answer questions related to this migration process in this issue created as a common place for discussion.

TL;DR;

console
$ helm install my-release stable/prestashop

Introduction

This chart bootstraps a PrestaShop 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 PrestaShop 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 2.11+ or 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:

console
$ helm install my-release stable/prestashop

The command deploys PrestaShop 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:

console
$ 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 PrestaShop chart and their default values.

ParameterDescriptionDefault
global.imageRegistryGlobal Docker image registrynil
global.imagePullSecretsGlobal Docker registry secret names as an array[] (does not add image pull secrets to deployed pods)
global.storageClassGlobal storage class for dynamic provisioningnil
image.registryPrestaShop image registrydocker.io
image.repositoryPrestaShop image namebitnami/prestashop
image.tagPrestaShop image tag{TAG_NAME}
image.pullPolicyImage pull policyIfNotPresent
image.pullSecretsSpecify docker-registry secret names as an array[] (does not add image pull secrets to deployed pods)
nameOverrideString to partially override prestashop.fullname template with a string (will prepend the release name)nil
fullnameOverrideString to fully override prestashop.fullname template with a stringnil
service.typeKubernetes Service typeLoadBalancer
service.portService HTTP port80
service.httpsPortService HTTPS port443
service.nodePorts.httpKubernetes http node port""
service.nodePorts.httpsKubernetes https node port""
service.externalTrafficPolicyEnable client source IP preservationCluster
service.loadBalancerIP LoadBalancer service IP address""
ingress.enabledEnable ingress controller resourcefalse
ingress.certManagerAdd annotations for cert-managerfalse
ingress.annotationsIngress annotations[]
ingress.hosts[0].nameHostname to your PrestaShop installationprestashop.local
ingress.hosts[0].pathPath within the url structure/
ingress.hosts[0].tlsUtilize TLS backend in ingressfalse
ingress.hosts[0].tlsSecretTLS Secret (certificates)prestashop.local-tls
ingress.secrets[0].nameTLS Secret Namenil
ingress.secrets[0].certificateTLS Secret Certificatenil
ingress.secrets[0].keyTLS Secret Keynil
prestashopHostPrestaShop host to create application URLs (when ingress, it will be ignored)nil
prestashopUsernameUser of the application[email protected]
prestashopPasswordApplication passwordrandom 10 character long alphanumeric string
prestashopEmailAdmin email[email protected]
prestashopFirstNameFirst NameBitnami
prestashopLastNameLast NameName
prestashopCookieCheckIPWhether to check the cookie's IP address or notno
prestashopCountryDefault country of the storeus
prestashopLanguageDefault language of the store (iso code)en
smtpHostSMTP hostnil
smtpPortSMTP portnil
smtpUserSMTP usernil
smtpPasswordSMTP passwordnil
smtpProtocolSMTP protocol [ssl, tls]nil
allowEmptyPasswordAllow DB blank passwordsyes
externalDatabase.hostHost of the external databasenil
externalDatabase.portSMTP protocol [ssl, none]3306
externalDatabase.userExisting username in the external dbbn_prestashop
externalDatabase.passwordPassword for the above usernamenil
externalDatabase.databaseName of the existing databasebitnami_prestashop
mariadb.enabledWhether to use the MariaDB charttrue
mariadb.image.registryMariaDB image registrydocker.io
mariadb.image.repositoryMariaDB image namebitnami/mariadb
mariadb.image.tagMariaDB image tag{TAG_NAME}
mariadb.db.nameDatabase name to createbitnami_prestashop
mariadb.db.userDatabase user to createbn_prestashop
mariadb.db.passwordPassword for the databasenil
mariadb.rootUser.passwordMariaDB admin passwordnil
sessionAffinityConfigures the session affinityNone
persistence.enabledEnable persistence using PVCtrue
persistence.storageClassPVC Storage Class for PrestaShop volumenil (uses alpha storage class annotation)
persistence.existingClaimAn Existing PVC name for PrestaShop volumenil (uses alpha storage class annotation)
persistence.accessModePVC Access Mode for PrestaShop volumeReadWriteOnce
persistence.sizePVC Storage Request for PrestaShop volume8Gi
resourcesCPU/Memory resource requests/limitsMemory: 512Mi, CPU: 300m
livenessProbe.enabledWould you like a livenessProbe to be enabledtrue
livenessProbe.initialDelaySecondsDelay before liveness probe is initiated600
livenessProbe.periodSecondsHow often to perform the probe3
livenessProbe.timeoutSecondsWhen the probe times out5
livenessProbe.failureThresholdMinimum consecutive failures for the probe to be considered failed after having succeeded.6
livenessProbe.successThresholdMinimum consecutive successes for the probe to be considered successful after having failed.1
readinessProbe.enabledWould you like a readinessProbe to be enabledtrue
readinessProbe.initialDelaySecondsDelay before readiness probe is initiated30
readinessProbe.periodSecondsHow often to perform the probe3
readinessProbe.timeoutSecondsWhen the probe times out5
readinessProbe.failureThresholdMinimum consecutive failures for the probe to be considered failed after having succeeded.6
readinessProbe.successThresholdMinimum consecutive successes for the probe to be considered successful after having failed.1
podAnnotationsPod annotations{}
affinityMap of node/pod affinities{}
metrics.enabledStart a side-car prometheus exporterfalse
metrics.image.registryApache exporter image registrydocker.io
metrics.image.repositoryApache exporter image namebitnami/apache-exporter
metrics.image.tagApache exporter image tag{TAG_NAME}
metrics.image.pullPolicyImage pull policyIfNotPresent
metrics.image.pullSecretsSpecify docker-registry secret names as an array[] (does not add image pull secrets to deployed pods)
metrics.podAnnotationsAdditional annotations for Metrics exporter pod{prometheus.io/scrape: "true", prometheus.io/port: "9117"}
metrics.resourcesExporter resource requests/limit{}

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

Note:

For PrestaShop to function correctly, you should specify the prestashopHost parameter to specify the FQDN (recommended) or the public IP address of the PrestaShop service.

Optionally, you can specify the prestashopLoadBalancerIP parameter to assign a reserved IP address to the PrestaShop 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:

bash
$ gcloud compute addresses create prestashop-public-ip

The reserved IP address can be associated to the PrestaShop service by specifying it as the value of the prestashopLoadBalancerIP parameter while installing the chart.

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

console
$ helm install my-release \
  --set prestashopUsername=admin,prestashopPassword=password,mariadb.mariadbRootPassword=secretpassword \
    stable/prestashop

The above command sets the PrestaShop 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,

console
$ helm install my-release -f values.yaml stable/prestashop

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.

Persistence

The Bitnami PrestaShop image stores the PrestaShop data and configurations at the /bitnami/prestashop path of the container.

Persistent Volume Claims are used to keep the data across deployments. This is known to work in GCE, AWS, and minikube. See the Parameters section to configure the PVC or to disable persistence.

Upgrading

To 9.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/17308 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 prestashop:

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