[MXS-4805] Docker usage instructions do not cover the implications of the configuration file locations Created: 2023-10-09  Updated: 2023-10-09

Status: Open
Project: MariaDB MaxScale
Component/s: Docker, Documentation
Affects Version/s: None
Fix Version/s: None

Type: Bug Priority: Minor
Reporter: markus makela Assignee: Unassigned
Resolution: Unresolved Votes: 0
Labels: None


 Description   

The documentation on DockerHub states this:

Configure via configuration file

Custom configuration can be given in an additional configuration file (e.g. my-maxscale.cnf). The file needs to be mounted into /etc/maxscale.cnf.d/

docker run -d --name mxs -v $PWD/my-maxscale.cnf:/etc/maxscale.cnf.d/my-maxscale.cnf mariadb/maxscale:latest

This has two problems:

  • The [maxscale] section can only be located in the root configuration file /etc/maxscale.cnf. The current documentation does not take this into account and if global options are specified, the startup will fail with an error.
  • Mounting the configuration file on top of the root configuration file will overwrite the threads value which can result in a OOM situation if the container has resource restrictions which is why the threads=1 is set by default in the default configuration file.

Generated at Thu Feb 08 04:31:17 UTC 2024 using Jira 8.20.16#820016-sha1:9d11dbea5f4be3d4cc21f03a88dd11d8c8687422.