Bug #79173 Documentation incomplete for mysqlrpladmin scripts
Submitted: 8 Nov 2015 4:44 Modified: 8 Aug 2017 22:36
Reporter: monty solomon Email Updates:
Status: Closed Impact on me:
None 
Category:MySQL Utilities Severity:S3 (Non-critical)
Version:1.5, 1.6 OS:Any
Assigned to: Chuck Bell CPU Architecture:Any

[8 Nov 2015 4:44] monty solomon 
Description:
The documentation for the mysqlrpladmin scripts (before and after) does not describe the parameters passed to the scripts.

How to repeat:
View the documentation at
https://dev.mysql.com/doc/mysql-utilities/1.5/en/mysqlrpladmin.html
or
https://dev.mysql.com/doc/mysql-utilities/1.6/en/mysqlrpladmin.html

The utility permits the user to specify an external script to execute before and after the switchover and failover commands. The user can specify these with the --exec-before and --exec-after options. The return code of the script is used to determine success thus each script must report 0 (success) to be considered successful. If a script returns a value other than 0, the result code is presented in an error message.

 --exec-after=<script>

Name of script to execute after failover or switchover. Script name may include the path.

 --exec-before=<script>

Name of script to execute before failover or switchover. Script name may include the path.

Suggested fix:
Update the documentation to provide the details.
[16 Nov 2015 7:39] MySQL Verification Team 
Hello Monty,

Thank you for the report.

Thanks,
Umesh
[17 Dec 2015 3:30] Philip Olson 
Posted by developer:
 
This is fixed in the source, and the change will show up online shortly. Thank you for the bug report.
[28 Jan 2016 4:17] monty solomon 
When should I expect to see the updated documentation online?

Thanks.
[30 Aug 2016 13:44] MySQL Verification Team 
Hi Monty,

Have you confirmed the changes are reflecting in the manual? I see some information has been added and hence closing the bug for now. Please feel free to open the bug again if information provided is not sufficient.

Thanks,
Umesh
[6 Sep 2016 3:31] monty solomon 
I don't see any documentation about the parameters for the scripts.

https://dev.mysql.com/doc/mysql-utilities/1.5/en/mysqlrpladmin.html

https://dev.mysql.com/doc/mysql-utilities/1.6/en/mysqlrpladmin.html

 --exec-after=<script>

Name of external script to execute after failover or switchover. Script name may include the full path.

The return code of the script is used to determine success, thus each script must report 0 (success) to be considered successful. If a script returns a value other than 0, the result code is presented in an error message. The script specified using this option only runs if the switchover/failover executed with success.

 --exec-before=<script>

Name of external script to execute before failover or switchover. Script name may include the full path.

The return code of the script is used to determine success, thus each script must report 0 (success) to be considered successful. If a script returns a value other than 0, the result code is presented in an error message.
[28 Sep 2016 0:16] Philip Olson 
Posted by developer:
 
Thank you for the bug report, and update. This bug is now open (again) until the --exec-* parameter documentation is improved.

Also, reassigning this bug to Chuck.
[8 Aug 2017 22:36] Christine Cole 
[3 Aug 2017 7:52] Chuck Bell (CABELL)

Fixed in release-1.5 and 1.6 docs. Added text to notes section explaining the
parameters as requested.