[MXS-24] bugzillaId-604: Module load path documentation issues ... Created: 2014-01-01  Updated: 2024-02-02  Resolved: 2015-05-26

Status: Closed
Project: MariaDB MaxScale
Component/s: Core, Documentation
Affects Version/s: 1.0.1
Fix Version/s: 1.2.0

Type: Bug Priority: Minor
Reporter: Hartmut Holzgraefe Assignee: markus makela
Resolution: Fixed Votes: 0
Labels: None
Environment:

Linux


Issue Links:
Relates
relates to MXS-116 Do not run maxscale as root. Closed
Epic Link: MaxScale 1.2 Features

 Description   

This is imported from bugzilla item http://bugs.mariadb.com/show_bug.cgi?id=604

Description Hartmut Holzgraefe 2014-11-01 11:50:58 UTC

  • The module load path is only documented in the "Protocol Modules" subsection
    although it applies to all module types (this is the first module type
    described in the "Modules" section so it's unlikely to be overread, but still
    it's in the wrong place IMHO)
  • the path given in "Protocol Modules" is wrong, it says

These modules reside in the directory $MAXSCALE_HOME/module, [...]

while it is actually .../modules (ending with 's'), not .../module

  • the actual load path in server/core/load_utils.c is:

1) look for module .so file in the current directory
2) if that fails: look for it in $MAXSCALE_HOME/module

Suggested fixes:

  • remove loading from current working dir completey (cough security cough)
  • fix path in documentation
  • move load path description from "Protocol Modules" section to
    a more general one, e.g. a general "Introduction" part at the
    start of the "Modules" section


 Comments   
Comment by markus makela [ 2015-04-29 ]

Modules are now only loaded from the module directory. This fix is on the install_dir_change branch and will be merged once the install directory changes and removal of the MAXSCALE_HOME is done.

Comment by markus makela [ 2015-04-30 ]

This is related to MaxScale installation paths and will be resolved with the upgraded installation paths to more standardized locations.

Comment by markus makela [ 2015-05-26 ]

Documentation now correctly and clearly states the module load path and the way it can be configured.

The modules are no longer being searched for in multiple places. Only a single directory is used and this directory can be configured either through the command line or the configuration file.

Comment by Timofey Turenko [ 2015-05-29 ]

link to config option description https://github.com/mariadb-corporation/MaxScale/blob/develop/Documentation/Getting-Started/Configuration-Guide.md#libdir

Comment by Dipti Joshi (Inactive) [ 2015-06-16 ]

markus makela Please correct this typo in https://github.com/mariadb-corporation/MaxScale/blob/develop/Documentation/Getting-Started/Configuration-Guide.md#libdir - second sentence starts as "The library director is the only " - should be changed to "The library directory is the only"

Comment by markus makela [ 2015-06-16 ]

typo is fixed

Generated at Thu Feb 08 03:56:13 UTC 2024 using Jira 8.20.16#820016-sha1:9d11dbea5f4be3d4cc21f03a88dd11d8c8687422.