[MXS-1617] Improve documentation of "cluster management" feature Created: 2018-01-18  Updated: 2020-04-16  Resolved: 2020-04-16

Status: Closed
Project: MariaDB MaxScale
Component/s: Documentation
Affects Version/s: 2.2.0
Fix Version/s: N/A

Type: Task Priority: Major
Reporter: Geoff Montee (Inactive) Assignee: markus makela
Resolution: Incomplete Votes: 0
Labels: None

Issue Links:
Relates
relates to MXS-1607 Blog post: Managing MaxScale HA Clust... Closed
relates to MXS-1331 Add cluster management commands to Ma... Closed
Sprint: MXS-SPRINT-103, MXS-SPRINT-104

 Description   

MXS-1331 added new "cluster management" features to MaxScale 2.2. I see a bit of information in the documentation about this:

https://mariadb.com/kb/en/mariadb-enterprise/mariadb-maxscale-22-maxctrl/#cluster

However, there isn't really much information at all. It even mentions a --hosts option, but doesn't really elaborate on how to provide this option or what format this option should be provided in.

We should probably add more details to the documentation about these new cluster management features in general.

Should we also add a tutorial on how to set up a "cluster" of MaxScale instances?:

https://mariadb.com/kb/en/mariadb-enterprise/maxscale-22-tutorials/

Should this "How to make MariaDB MaxScale High Available" tutorial be modified (or at least renamed) now that MaxScale has built-in "clustering" features?:

https://mariadb.com/kb/en/mariadb-enterprise/mariadb-maxscale-22-how-to-make-mariadb-maxscale-high-available/



 Comments   
Comment by Johan Wikman [ 2018-01-18 ]

Good suggestions and we will address this in 2.2.2.

This is also relevant https://jira.mariadb.org/browse/MXS-1607

Comment by markus makela [ 2020-04-16 ]

The old documentation has been removed. The --help cluster output should describe what each command does and those have been extended for 2.5.

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