OpenCart packaged by Bitnami¶

OpenCart is free open source ecommerce platform for online merchants. OpenCart provides a professional and reliable foundation from which to build a successful online store.

Overview of OpenCart

Trademarks: This software listing is packaged by Bitnami. The respective trademarks mentioned in the offering are owned by the respective companies, and use of them does not imply any affiliation or endorsement.

TL;DR¶

使用加速地址添加仓库:

helm repo add bitnami "https://helm-charts.itboon.top/bitnami" --force-update
helm update bitnami

helm install my-release bitnami/opencart

Introduction¶

This chart bootstraps an OpenCart 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 OpenCart application.

Bitnami charts can be used with Kubeapps for deployment and management of Helm Charts in clusters.

Looking to use OpenCart in production? Try VMware Application Catalog, the enterprise edition of Bitnami Application Catalog.

Prerequisites¶

• Kubernetes 1.19+
• Helm 3.2.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 bitnami/opencart

The command deploys OpenCart 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¶

Global parameters¶

Common parameters¶

OpenCart parameters¶

Traffic Exposure Parameters¶

Database parameters¶

Volume Permissions parameters¶

Metrics parameters¶

Certificate injection parameters¶

NetworkPolicy parameters¶

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

Note:

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

Optionally, you can specify the opencartLoadBalancerIP parameter to assign a reserved IP address to the OpenCart 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 opencart-public-ip

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

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

helm install my-release \
  --set opencartUsername=admin,opencartPassword=password,mariadb.auth.rootPassword=secretpassword \
    bitnami/opencart

The above command sets the OpenCart 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 bitnami/opencart

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.

Image¶

The image parameter allows specifying which image will be pulled for the chart.

Private registry¶

If you configure the image value to one in a private registry, you will need to specify an image pull secret.

1. Manually create image pull secret(s) in the namespace. See this YAML example reference. Consult your image registry's documentation about getting the appropriate secret.

2. Note that the imagePullSecrets configuration value cannot currently be passed to helm using the --set parameter, so you must supply these using a values.yaml file, such as:

   imagePullSecrets:
     - name: SECRET_NAME
   

3. Install the chart

Setting Pod's affinity¶

This chart allows you to set your custom affinity using the affinity parameter. Find more information about Pod's affinity in the kubernetes documentation.

As an alternative, you can use of the preset configurations for pod affinity, pod anti-affinity, and node affinity available at the bitnami/common chart. To do so, set the podAffinityPreset, podAntiAffinityPreset, or nodeAffinityPreset parameters.

Persistence¶

The Bitnami OpenCart image stores the OpenCart data and configurations at the /bitnami/opencart 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.

Existing PersistentVolumeClaim¶

1. Create the PersistentVolume
2. Create the PersistentVolumeClaim
3. Install the chart

helm install my-release --set persistence.existingClaim=PVC_NAME bitnami/opencart

Host path¶

System compatibility¶

• The local filesystem accessibility to a container in a pod with hostPath has been tested on OSX/MacOS with xhyve, and Linux with VirtualBox.
• Windows has not been tested with the supported VM drivers. Minikube does however officially support Mounting Host Folders per pod. Or you may manually sync your container whenever host files are changed with tools like docker-sync or docker-bg-sync.

Mounting steps¶

1. The specified hostPath directory must already exist (create one if it does not).

2. Install the chart

   helm install my-release --set persistence.hostPath=/PATH/TO/HOST/MOUNT bitnami/opencart
   

   This will mount the prestashop-data volume into the hostPath directory. The site data will be persisted if the mount path contains valid data, else the site data will be initialized at first launch. 3. Because the container cannot control the host machine's directory permissions, you must set the PrestaShop file directory permissions yourself and disable or clear PrestaShop cache.

Troubleshooting¶

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

Upgrading¶

To 14.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¶

OpenCart version was bumped to its latest major, 4.x.x. The most remarkable change is that the /admin folder has been renamed to /administration for security requirements. Though no incompatibilities are expected while upgrading from previous versions, OpenCart recommends backing up your application first before upgrading.

To 12.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 11.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 10.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 9.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¶

• https://docs.bitnami.com/tutorials/resolve-helm2-helm3-post-migration-issues/
• https://helm.sh/docs/topics/v2_v3_migration/
• https://helm.sh/blog/migrate-from-helm-v2-to-helm-v3/

To 8.0.0¶

Important: Under no circumstance should you run helm upgrade to 8.0.0 or you may suffer unrecoverable data loss of your site's data.

This release includes several breaking changes which are listed below. To upgrade to 8.0.0, we recommend to install a new OpenCart chart, and migrate your OpenCart site using the application's Backup & Restore tool.

NOTE: It is highly recommended to create a backup of your database before migrating your site. 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 name of the PVC used to hold the MariaDB data on your current release:

export OPENCART_PASSWORD=$(kubectl get secret --namespace default opencart -o jsonpath="{.data.opencart-password}" | base64 -d)
export MARIADB_ROOT_PASSWORD=$(kubectl get secret --namespace default opencart-mariadb -o jsonpath="{.data.mariadb-root-password}" | base64 -d)
export MARIADB_PASSWORD=$(kubectl get secret --namespace default opencart-mariadb -o jsonpath="{.data.mariadb-password}" | base64 -d)
export MARIADB_PVC=$(kubectl get pvc -l app.kubernetes.io/instance=opencart,app.kubernetes.io/name=mariadb,app.kubernetes.io/component=primary -o jsonpath="{.items[0].metadata.name}")

New volume mount locations¶

Locations for volume mounts have been changed. Now, OpenCart's persisted volume will contain the following directories:

• opencart: Persisted OpenCart files
• opencart_storage: OpenCart storage files

These folders will be mounted to the respective sub-paths in /bitnami. Before, the entire volume was mounted to /bitnami/opencart.

Support for non-root user approach¶

The Bitnami OpenCart image was updated to support and enable the "non-root" user approach

If you want to continue to run the container image as the root user, you need to set podSecurityContext.enabled=false and containerSecurity.context.enabled=false.

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

MariaDB dependency update¶

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 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/17302 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 opencart:

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

License¶

Copyright © 2023 VMware, Inc.

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.