hcq/MaxScale
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Tidy documents

Browse Source
This commit is contained in:
counterpoint
2015-01-28 14:33:58 +00:00
parent 2399b60eab
commit 55d643e12d
5 changed files with 57 additions and 50 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
About/COPYRIGHT.md
View File

@ -2,15 +2,17 @@ This source code is distributed as part of MariaDB Corporation MaxScale. It is f
software: you can redistribute it and/or modify it under the terms of the software: you can redistribute it and/or modify it under the terms of the
GNU General Public License as published by the Free Software Foundation, GNU General Public License as published by the Free Software Foundation,
version 2. version 2.
This program is distributed in the hope that it will be useful, but WITHOUT This program is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
FOR A PARTICULAR PURPOSE. See the GNU General Public License for more FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
details. details.
You should have received a copy of the GNU General Public License along with You should have received a copy of the GNU General Public License along with
this program; if not, write to the Free Software Foundation, Inc., 51 this program; if not, write to the Free Software Foundation, Inc.,
Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
Copyright MariaDB Corporation Ab 2013 Copyright MariaDB Corporation Ab 2013
MariaDB Corporation Corporation Ab
Tekniikantie 12 Tekniikantie 12
02150 Espoo 02150 Espoo
Finland Finland

8
About/MaxScale-1.0.4-Release-Notes.md
View File

@ -1,14 +1,14 @@
MaxScale Release Notes # MaxScale Release Notes
1.0.4 GA 1.0.4 GA
This document details the changes in version 1.0.4 since the release of the 1.0.2 Release Candidate of the MaxScale product. This document details the changes in version 1.0.4 since the release of the 1.0.2 Release Candidate of the MaxScale product.
# New Features ## New Features
No new features have been introduced since the released candidate was released. No new features have been introduced since the released candidate was released.
# Bug Fixes ## Bug Fixes
A number of bug fixes have been applied between the 0.6 alpha and this alpha release. The table below lists the bugs that have been resolved. The details for each of these may be found in bugs.mariadb.com. A number of bug fixes have been applied between the 0.6 alpha and this alpha release. The table below lists the bugs that have been resolved. The details for each of these may be found in bugs.mariadb.com.
@ -96,7 +96,7 @@ A number of bug fixes have been applied between the 0.6 alpha and this alpha rel
</table> </table>
# Known Issues ## Known Issues
There are a number bugs and known limitations within this version of MaxScale, the most serious of this are listed below. There are a number bugs and known limitations within this version of MaxScale, the most serious of this are listed below.

9
About/SETUP.md
View File

@ -1,24 +1,33 @@
Installation and startup Installation and startup
Untar the binary distribution in the desired location, Untar the binary distribution in the desired location,
e.g. /usr/local/skysql e.g. /usr/local/skysql
Alternatively build from the source code using the instructions Alternatively build from the source code using the instructions
in the README file and execute make install. in the README file and execute make install.
Simply set the environment variable MAXSCALE_HOME to point to the Simply set the environment variable MAXSCALE_HOME to point to the
MaxScale directory, found inside the path into which the files have been copied, MaxScale directory, found inside the path into which the files have been copied,
e.g. MAXSCALE_HOME=/usr/local/skysql/maxscale/MaxScale e.g. MAXSCALE_HOME=/usr/local/skysql/maxscale/MaxScale
Also you will need to optionaly set LD_LIBRARY_PATH to include the 'lib' folder, Also you will need to optionaly set LD_LIBRARY_PATH to include the 'lib' folder,
found inside the path into which the files have been copied, found inside the path into which the files have been copied,
e.g. LD_LIBRARY_PATH=/usr/local/skysql/maxscale/lib e.g. LD_LIBRARY_PATH=/usr/local/skysql/maxscale/lib
Because we need the libmysqld library for parsing we must create a Because we need the libmysqld library for parsing we must create a
valid my.cnf file to enable the library to be used. Copy the my.cnf valid my.cnf file to enable the library to be used. Copy the my.cnf
to $MAXSCALE_HOME/mysql/my.cnf. to $MAXSCALE_HOME/mysql/my.cnf.
To start MaxScale execute the command 'maxscale' from the bin folder, To start MaxScale execute the command 'maxscale' from the bin folder,
e.g. /usr/local/skysql/maxscale/bin/maxscale e.g. /usr/local/skysql/maxscale/bin/maxscale
Configuration Configuration
You need to edit the file MaxScale.cnf in $MAXSCALE_HOME/etc, you should You need to edit the file MaxScale.cnf in $MAXSCALE_HOME/etc, you should
define the set of server definitions you require, with the addresses define the set of server definitions you require, with the addresses
and ports of those servers. Also define the listening ports for your and ports of those servers. Also define the listening ports for your
various services. various services.
In order to view the internal activity of the gateway you can telnet to In order to view the internal activity of the gateway you can telnet to
the port defined for the telnet listener. Initially you may login with the port defined for the telnet listener. Initially you may login with
the user name of "admin" and the password "skysql". Once connected type the user name of "admin" and the password "skysql". Once connected type

26
Tutorials/Administration-Tutorial.md
View File

@ -1,10 +1,12 @@
Getting Started With MariaDB MaxScale # MaxScale Administration Tutorial
Common Administration Tasks [TOC]
## Common Administration Tasks
The purpose of this tutorial is to introduce the MaxScale Administrator to a few of the common administration tasks that need to be performed with MaxScale. It is not intended as a reference to all the tasks that may be performed, more this is aimed as an introduction for administrators who are new to MaxScale. The purpose of this tutorial is to introduce the MaxScale Administrator to a few of the common administration tasks that need to be performed with MaxScale. It is not intended as a reference to all the tasks that may be performed, more this is aimed as an introduction for administrators who are new to MaxScale.
# Starting MaxScale ### Starting MaxScale
There are several ways to start MaxScale, the most convenient mechanism is probably using the Linux service interface. When a MaxScale package is installed the package manager will also installed a script in /etc/init.d which may be used to start and stop MaxScale either directly or via the service interface. There are several ways to start MaxScale, the most convenient mechanism is probably using the Linux service interface. When a MaxScale package is installed the package manager will also installed a script in /etc/init.d which may be used to start and stop MaxScale either directly or via the service interface.
@ -14,7 +16,7 @@ or
$ /etc/init.d/maxscale start $ /etc/init.d/maxscale start
It is also possible to start MaxScale by executing the maxscale command itself, in this case you must ensure that the environment is correctly setup or command line options are passed. The major elements to consider are the correct setting of the MAXSCALE_HOME directory and to ensure that LD_LIBRARY_PATH. The LD_LIBRARY_PATH should include the lib directory that was installed as part of the MaxScale installation, the MAXSCALE_HOME should point to /usr/local/skysql/maxscale if a default installation has been created or to the directory this was relocated to. Running the executable $MAXSCALE_HOME/bin/maxscale will result in MaxScale running as a daemon process, unattached to the terminal in which it was started and using configuration files that it finds in the $MAXSCALE_HOME directory. It is also possible to start MaxScale by executing the maxscale command itself, in this case you must ensure that the environment is correctly setup or command line options are passed. The major elements to consider are the correct setting of the MAXSCALE\_HOME directory and to ensure that LD\_LIBRARY\_PATH. The LD\_LIBRARY\_PATH should include the lib directory that was installed as part of the MaxScale installation, the MAXSCALE_HOME should point to /usr/local/skysql/maxscale if a default installation has been created or to the directory this was relocated to. Running the executable \$MAXSCALE\_HOME/bin/maxscale will result in MaxScale running as a daemon process, unattached to the terminal in which it was started and using configuration files that it finds in the \$MAXSCALE_HOME directory.
Options may be passed to the MaxScale binary that alter this default behaviour, this options are documented in the table below. Options may be passed to the MaxScale binary that alter this default behaviour, this options are documented in the table below.
@ -57,7 +59,7 @@ Options may be passed to the MaxScale binary that alter this default behaviour,
</table> </table>
# Stopping MaxScale ### Stopping MaxScale
There are numerous ways in which MaxScale can be stopped; using the service interface, killing the process or by use of the maxadmin utility. There are numerous ways in which MaxScale can be stopped; using the service interface, killing the process or by use of the maxadmin utility.
@ -77,12 +79,11 @@ In order to shutdown MaxScale using the maxadmin command you may either connect
$ maxadmin -pskysql shutdown maxscale $ maxadmin -pskysql shutdown maxscale
# Checking The Status Of The MaxScale Services ### Checking The Status Of The MaxScale Services
It is possible to use the maxadmin command to obtain statistics regarding the services that are configured within your MaxScale configuration file. The maxadmin command "list services" will give very basic information regarding the services that are define. This command may be either run in interactive mode or passed on the maxadmin command line. It is possible to use the maxadmin command to obtain statistics regarding the services that are configured within your MaxScale configuration file. The maxadmin command "list services" will give very basic information regarding the services that are define. This command may be either run in interactive mode or passed on the maxadmin command line.
$ maxadmin -pskysql $ maxadmin -pskysql
MaxScale> list services MaxScale> list services
Services. Services.
@ -105,7 +106,7 @@ MaxScale>
It should be noted that network listeners count as a user of the service, therefore there will always be one user per network port in which the service listens. More detail can be obtained by use of the "show service" command which is passed a service name. It should be noted that network listeners count as a user of the service, therefore there will always be one user per network port in which the service listens. More detail can be obtained by use of the "show service" command which is passed a service name.
# What Clients Are Connected To MaxScale ### What Clients Are Connected To MaxScale
To determine what client are currently connected to MaxScale you can use the "list clients" command within maxadmin. This will give you IP address and the ID’s of the DCB and session for that connection. As with any maxadmin command this can be passed on the command line or typed interactively in maxadmin. To determine what client are currently connected to MaxScale you can use the "list clients" command within maxadmin. This will give you IP address and the ID’s of the DCB and session for that connection. As with any maxadmin command this can be passed on the command line or typed interactively in maxadmin.
@ -125,7 +126,7 @@ Client Connections
$ $
# Rotating Log Files ### Rotating Log Files
MaxScale write log data into four log files with varying degrees of detail. With the exception of the error log, which can not be disabled, these log files may be enabled and disabled via the maxadmin interface or in the configuration file. The default behaviour of MaxScale is to grow the log files indefinitely, the administrator must take action to prevent this. MaxScale write log data into four log files with varying degrees of detail. With the exception of the error log, which can not be disabled, these log files may be enabled and disabled via the maxadmin interface or in the configuration file. The default behaviour of MaxScale is to grow the log files indefinitely, the administrator must take action to prevent this.
@ -136,11 +137,8 @@ $ maxadmin -pskysql flush logs
Flushes all of the logs, whereas an individual log may be flushed with the "flush log" command. Flushes all of the logs, whereas an individual log may be flushed with the "flush log" command.
$ maxadmin -pskysql $ maxadmin -pskysql
MaxScale> flush log error MaxScale> flush log error
MaxScale> flush log trace MaxScale> flush log trace
MaxScale> MaxScale>
This may be integrated into the Linux logrotate mechanism by adding a configuration file to the /etc/logrotate.d directory. If we assume we want to rotate the log files once per month and wish to keep 5 log files worth of history, the configuration file would look like the following. This may be integrated into the Linux logrotate mechanism by adding a configuration file to the /etc/logrotate.d directory. If we assume we want to rotate the log files once per month and wish to keep 5 log files worth of history, the configuration file would look like the following.
@ -182,14 +180,13 @@ endscript
</table> </table>
# Taking A Database Server Out Of Use ### Taking A Database Server Out Of Use
MaxScale supports the concept of maintenance mode for servers within a cluster, this allows for planned, temporary removal of a database from the cluster within the need to change the MaxScale configuration. MaxScale supports the concept of maintenance mode for servers within a cluster, this allows for planned, temporary removal of a database from the cluster within the need to change the MaxScale configuration.
To achieve the removal of a database server you can use the set server command in the maxadmin utility to set the maintenance mode flag for the server. This may be done interactively within maxadmin or by passing the command on the command line. To achieve the removal of a database server you can use the set server command in the maxadmin utility to set the maintenance mode flag for the server. This may be done interactively within maxadmin or by passing the command on the command line.
MaxScale> set server dbserver3 maintenance MaxScale> set server dbserver3 maintenance
MaxScale> MaxScale>
This will cause MaxScale to stop routing any new requests to the server, however if there are currently requests executing on the server these will not be interrupted. This will cause MaxScale to stop routing any new requests to the server, however if there are currently requests executing on the server these will not be interrupted.
@ -197,7 +194,6 @@ This will cause MaxScale to stop routing any new requests to the server, however
To bring the server back into service use the "clear server" command to clear the maintenance mode bit for that server. To bring the server back into service use the "clear server" command to clear the maintenance mode bit for that server.
MaxScale> clear server dbserver3 maintenance MaxScale> clear server dbserver3 maintenance
MaxScale> MaxScale>
Note that maintenance mode is not persistent, if MaxScale restarts when a node is in maintenance mode a new instance of MaxScale will not honour this mode. If multiple MaxScale instances are configured to use the node them maintenance mode must be set within each MaxScale instance. However if multiple services within one MaxScale instance are using the server then you only need set the maintenance mode once on the server for all services to take note of the mode change. Note that maintenance mode is not persistent, if MaxScale restarts when a node is in maintenance mode a new instance of MaxScale will not honour this mode. If multiple MaxScale instances are configured to use the node them maintenance mode must be set within each MaxScale instance. However if multiple services within one MaxScale instance are using the server then you only need set the maintenance mode once on the server for all services to take note of the mode change.