[MDEV-13620] Improve documentation and help text for MariaDB Backup's --plugin-dir option Created: 2017-08-22  Updated: 2020-08-25  Resolved: 2017-12-18

Status: Closed
Project: MariaDB Server
Component/s: Backup, Plugins
Affects Version/s: 10.1.26
Fix Version/s: 10.1.30, 10.2.12

Type: Bug Priority: Major
Reporter: Geoff Montee (Inactive) Assignee: Vladislav Vaintroub
Resolution: Fixed Votes: 0
Labels: backup, encryption, mariabackup

Sprint: 10.1.30

 Description   

In MDEV-13400, I mentioned that MariaDB backup ignores the --plugin-dir command-line option during the backup stage. Instead, the tool queries the server for its value, and it always uses that value. It sounds like we do not want to change this.

I believe that the --plugin-dir command-line option is read during the prepare stage.

We should probably update the --help text of the mariabackup tool to specify that the --plugin-dir option is only valid during the prepare stage. We should probably add a similar note to the documentation:

https://mariadb.com/kb/en/the-mariadb-library/mariabackup-options/

Should the utility also warn the user if they specify the --plugin-dir command-line option during the backup stage?

 Comments   
Comment by Vladislav Vaintroub [ 2017-08-22 ]

since MDEV-13608, plugin-dir is also used during backup stage to set the path for the client-side authentication plugins. Unfortunate consequence of mariabackup being half-server/half-client is that the same options can be (and now are) interpreted in different ways. So, no we cannot ignore or warn if it is used on command line.

Comment by Julien Fritsch [ 2017-09-12 ]

So it sounds like we won't be fixing this right ?

Comment by Vladislav Vaintroub [ 2017-09-12 ]

I can fix it, no big deal. I wrote an explanation in previous entry to set expectation of what to expect from this option. Usually, this does not really need any setting, and if it does need, people are doing something "special"

Generated at Thu Feb 08 08:07:01 UTC 2024 using Jira 8.20.16#820016-sha1:9d11dbea5f4be3d4cc21f03a88dd11d8c8687422.