shopware-operator

Shopware Operator

Overview

This repository contains the Shopware Operator for Kubernetes. The Operator is a Kubernetes controller that manages Shopware installations in a Kubernetes cluster.

Installation

Below you find a descriptions how to deploy the Operator using helm or kubectl.

Helm

For a helm installation check out our charts repository

kubectl

1. Install the custom resource definitions (cdr) for your cluster:

   kubectl apply -f https://github.com/shopware/shopware-operator/releases/latest/download/crd.yaml --server-side
   

2. Deploy the operator itself from manager.yaml:

   kubectl apply -f https://github.com/shopware/shopware-operator/releases/latest/download/manager.yaml
   

[!IMPORTANT] This will install the Operator in the default namespace, if you want to change this use kubectl -n <namespace> apply -f ...

Local Development

To set up a local development environment, you must have the following components in place:

• A valid Store custom resource
• A MySQL-compatible database
• An S3-compatible object storage

These are required for a basic Shopware deployment within a Kubernetes cluster.

We recommend using the Shopware Helm Chart, which includes a Percona-based MySQL database and an S3-compatible interface provided by MinIO.To run the operator within your cluster, execute the following command:

NAMESPACE=default make run

[!IMPORTANT] Ensure that you are using the correct Kubernetes context before running the command.

Limitations and Issues

Sidecars

When using sidecars, please ensure they are properly terminated. Unfortunately, Kubernetes does not provide a reliable mechanism for managing the shutdown of jobs (such as setup and migration jobs). As a result, we cannot guarantee that containers within the pod will be stopped correctly. To address this, the job will be deleted once the operator container has completed its task.

Contributing

Shopware welcomes community contributions to help improving the Shopware Operator. If you found a bug or want to change something create an issue before fixing/changing it.

Another good place to discuss the Shopware Operator with developers and other community members is the Slack channel: https://shopwarecommunity.slack.com/channels/shopware6-kubernetes