Clustering in eZ Platform refers to setting up your install with several web servers for handling more load and/or for failover.
Server setup overview¶
This diagram illustrates how clustering of eZ Platform is typically set up, the parts illustrate the different roles needed for a successful cluster setup. The number of web servers, Memcached/Redis servers, Solr servers, Varnish servers, Database servers, NFS servers, as well as whether some servers play several of these roles (typically running Memcached/Redis across the web server) is up to you and your performance needs.
The minimal requirements are the following (with what is currently supported in italics):
- Shared HTTP cache (using Varnish)
- Shared Persistence cache and Sessions (using Memcached, or Redis)
- Shared Database (using MySQL/MariaDB)
- Shared Filesystem (using NFS, or S3)
For further details on requirements, see Requirements page.
While this is not a complete list, further recommendations include:
- Using Solr for better search and better search performance
- Using a CDN for improved performance and faster ping time worldwide
- Using Active/Passive Database for failover
- In general: Make sure to use later versions of PHP and MySQL/MariaDB within what is supported for your eZ Platform version to get more performance out of each server, however numbers might vary so make sure to test this when upgrading.
Binary files clustering¶
eZ Platform supports multi-server by means of custom IO handlers. They will make sure that files are correctly synchronized among the multiple clients that might use the data.
Memcached must not be bound to the local address if clusters are in use, or user logins will fail. To avoid this, in
/etc/memcached.conf take a look under
# Specify which IP address to listen on. The default is to listen on all IP addresses
For development environments, change the address below to
For production environments, follow this more secure instruction from the memcached man:
Listen on <addr>; default to INADDR_ANY. <addr> may be specified as host:port. If you don't specify a port number, the value you specified with -p or -U is used. You may specify multiple addresses separated by comma or by using -l multiple times. This is an important option to consider as there is no other way to secure the installation. Binding to an internal or firewalled network interface is suggested.
DFS IO Handler¶
What it is meant for¶
The DFS IO handler (
legacy_dfs_cluster) can be used to store binary files on an NFS server. It will use a database to manipulate metadata, making up for the potential inconsistency of network based filesystems.
You need to configure both metadata and binarydata handlers.
As the binarydata handler, create a new Flysystem local adapter configured to read/write to the NFS mount point on each local server. As metadata handler handler, create a dfs one, configured with a doctrine connection.
The default database install will now include the dfs table in the same database
For production, we strongly recommend creating the DFS table in its own database, using the
In our example, we will use one named
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38
# new doctrine connection for the dfs legacy_dfs_cluster metadata handler. doctrine: dbal: connections: dfs: driver: pdo_mysql host: 127.0.0.1 port: 3306 dbname: ezdfs user: root password: "rootpassword" charset: UTF8 # define the flysystem handler oneup_flysystem: adapters: nfs_adapter: local: directory: "/<path to nfs>/$var_dir$/$storage_dir$" # define the ez handlers ez_io: binarydata_handlers: nfs: flysystem: adapter: nfs_adapter metadata_handlers: dfs: legacy_dfs_cluster: connection: doctrine.dbal.dfs_connection # set the application handlers ezpublish: system: default: io: metadata_handler: dfs binarydata_handler: nfs
If you are looking to set up S3 or other Flysystem/third-party adapters like Google Cloud Storage, this needs to be configured as binary handler. The rest here will still stay the same, the dfs meta handler will take care of caching the lookups to avoid slow IO lookups.
Customizing the storage directory¶
eZ Publish 5.x required the NFS adapter directory to be set to
$var_dir$/$storage_dir$ part for the NFS path. This is no longer required with eZ Platform (unless you plan to use Legacy Bridge), but the default prefix used to serve binary files will still match this expectation.
If you decide to change this setting, make sure you also set
io.url_prefix to a matching value. If you set the NFS adapter's directory to "/path/to/nfs/storage", use this configuration so that the files can be served by Symfony:
1 2 3 4 5
ezpublish: system: default: io: url_prefix: "storage"
As an alternative, you may serve images from NFS using a dedicated web server. If in the example above, this server listens on http://static.example.com and uses
/path/to/nfs/storage as the document root, configure
io.url_prefix as follows:
1 2 3 4 5
ezpublish: system: default: io: url_prefix: "http://static.example.com/"
You can read more about that on Binary files URL handling.
Web server rewrite rules¶
The default eZ Platform rewrite rules will let image requests be served directly from disk. In a cluster setup, files matching
^/var/([^/]+/)?storage/images(-versioned)?/.* have to be passed through
In any case, this specific rewrite rule must be placed before the ones that "ignore" image files and just let the web server serve the files directly.
RewriteRule ^/var/([^/]+/)?storage/images(-versioned)?/.* /app.php [L]
Place this before the standard image rewrite rule in your vhost config (or uncomment if already there)
rewrite "^/var/([^/]+/)?storage/images(-versioned)?/(.*)" "/app.php" break;
Place this before the include of
ez_rewrite_params in your vhost config (or uncomment if already there).
If you are migrating an existing single-server site to a cluster, and not setting up a cluster from scratch, you need to migrate your files. Once you have configured your binarydata and metadata handlers, you can run the
ezplatform:io:migrate-files command. You can also use it when you are migrating from one data handler to another, e.g. from NFS to Amazon S3.
This command shows which handlers are configured (example output):
1 2 3
> php bin/console ezplatform:io:migrate-files --list-io-handlers Configured meta data handlers: default, dfs, aws_s3 Configured binary data handlers: default, nfs, aws_s3
You can do the actual migration like this (example parameters):
> php bin/console ezplatform:io:migrate-files --from=default,default --to=dfs,nfs --env=prod
--to values must be specified as
--from is omitted, the default IO configuration will be used.
--to is omitted, the first non-default IO configuration will be used.
The command must be executed with the same permissions as the web server.
During the command execution the files should not be modified. To avoid surprises you are advised to create a backup and/or execute a dry run before doing the actual update, using the
Since this command can run for a very long time, to avoid memory exhaustion run it in the production environment using the