Tidy documents
This commit is contained in:
counterpoint
parent
5088f898a2
commit
5f6a7ac4ae
@ -2,16 +2,18 @@ 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
|
||||
GNU General Public License as published by the Free Software Foundation,
|
||||
version 2.
|
||||
|
||||
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
|
||||
FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
|
||||
details.
|
||||
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
|
||||
Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
|
||||
Copyright MariaDB Corporation Ab 2013
|
||||
MariaDB Corporation Corporation Ab
|
||||
Tekniikantie 12
|
||||
02150 Espoo
|
||||
Finland
|
||||
|
||||
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 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
|
||||
|
||||
Copyright MariaDB Corporation Ab 2013
|
||||
Tekniikantie 12
|
||||
02150 Espoo
|
||||
Finland
|
||||
|
||||
|
||||
@ -24,7 +24,7 @@ Master selection is based only on MIN(wsrep_local_index), no other server parame
|
||||
|
||||
## Limitations in the connection router
|
||||
|
||||
If Master changes (ie. new Master promotion) during current connection the router cannot check the change
|
||||
If Master changes (ie. new Master promotion) during current connection the router cannot check the change
|
||||
|
||||
## Limitations in the Read/Write Splitter
|
||||
|
||||
@ -86,7 +86,7 @@ There is a possibility for misbehavior; if "USE mytable" was executed in one of
|
||||
|
||||
The above-mentioned behavior can be partially controller with RWSplit configuration parameter called
|
||||
|
||||
use_sql_variables_in=[master|all] (master)
|
||||
use_sql_variables_in=[master|all] (master)
|
||||
|
||||
Server-side session variables are called as SQL variables. If "master" or no value is set, SQL variables are read and written in master only. Autocommit values and prepared statements are routed to all nodes always.
|
||||
|
||||
|
||||
@ -1,14 +1,14 @@
|
||||
MaxScale Release Notes
|
||||
# MaxScale Release Notes
|
||||
|
||||
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.
|
||||
|
||||
# New Features
|
||||
## New Features
|
||||
|
||||
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.
|
||||
|
||||
@ -96,7 +96,7 @@ A number of bug fixes have been applied between the 0.6 alpha and this alpha rel
|
||||
</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.
|
||||
|
||||
|
||||
@ -1,24 +1,33 @@
|
||||
Installation and startup
|
||||
|
||||
Untar the binary distribution in the desired location,
|
||||
e.g. /usr/local/skysql
|
||||
|
||||
Alternatively build from the source code using the instructions
|
||||
in the README file and execute make install.
|
||||
|
||||
Simply set the environment variable MAXSCALE_HOME to point to the
|
||||
MaxScale directory, found inside the path into which the files have been copied,
|
||||
e.g. MAXSCALE_HOME=/usr/local/skysql/maxscale/MaxScale
|
||||
|
||||
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,
|
||||
e.g. LD_LIBRARY_PATH=/usr/local/skysql/maxscale/lib
|
||||
|
||||
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
|
||||
to $MAXSCALE_HOME/mysql/my.cnf.
|
||||
|
||||
To start MaxScale execute the command 'maxscale' from the bin folder,
|
||||
e.g. /usr/local/skysql/maxscale/bin/maxscale
|
||||
|
||||
Configuration
|
||||
|
||||
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
|
||||
and ports of those servers. Also define the listening ports for your
|
||||
various services.
|
||||
|
||||
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 user name of "admin" and the password "skysql". Once connected type
|
||||
|
||||
@ -1,20 +1,22 @@
|
||||
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.
|
||||
|
||||
# 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.
|
||||
|
||||
$ service maxscale start
|
||||
$ service maxscale start
|
||||
|
||||
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.
|
||||
|
||||
@ -57,33 +59,32 @@ Options may be passed to the MaxScale binary that alter this default behaviour,
|
||||
</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.
|
||||
|
||||
Stopping MaxScale with the service interface is simply a case of using the service stop command or calling the init.d script with the stop argument.
|
||||
|
||||
$ service maxscale stop
|
||||
$ service maxscale stop
|
||||
|
||||
or
|
||||
|
||||
$ /etc/init.d/maxscale stop
|
||||
$ /etc/init.d/maxscale stop
|
||||
|
||||
MaxScale will also stop gracefully if it received a hangup signal, to find the process id of the MaxScale server use the ps command or read the contents of the maxscale.pid file located in the same directory as the logs.
|
||||
|
||||
$ kill -HUP `cat $MAXSCALE_HOME/log/maxscale.pid`
|
||||
$ kill -HUP `cat $MAXSCALE_HOME/log/maxscale.pid`
|
||||
|
||||
In order to shutdown MaxScale using the maxadmin command you may either connect with maxadmin in interactive mode or pass the "shutdown maxscale" command you wish to execute as an argument to maxadmin.
|
||||
In order to shutdown MaxScale using the maxadmin command you may either connect with maxadmin in interactive mode or pass the "shutdown maxscale" command you wish to execute as an argument to maxadmin.
|
||||
|
||||
$ 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.
|
||||
|
||||
$ maxadmin -pskysql
|
||||
|
||||
MaxScale> list services
|
||||
$ maxadmin -pskysql
|
||||
MaxScale> list services
|
||||
|
||||
Services.
|
||||
|
||||
@ -101,15 +102,15 @@ CLI | cli | 2 | 2
|
||||
|
||||
--------------------------+----------------------+--------+---------------
|
||||
|
||||
MaxScale>
|
||||
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.
|
||||
|
||||
# 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.
|
||||
|
||||
$ maxadmin -pskysql list clients
|
||||
$ maxadmin -pskysql list clients
|
||||
|
||||
Client Connections
|
||||
|
||||
@ -123,25 +124,22 @@ 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.
|
||||
|
||||
It is possible to rotate either a single log file or all the log files with a single command. When the logfile is rotated, the current log file is closed and a new log file, with an increased sequence number in its name, is created. Log file rotation is achieved by use of the "flush log" or “flush logs” command in maxadmin.
|
||||
|
||||
$ maxadmin -pskysql flush logs
|
||||
$ maxadmin -pskysql flush logs
|
||||
|
||||
Flushes all of the logs, whereas an individual log may be flushed with the "flush log" command.
|
||||
|
||||
$ maxadmin -pskysql
|
||||
|
||||
MaxScale> flush log error
|
||||
|
||||
MaxScale> flush log trace
|
||||
|
||||
MaxScale>
|
||||
$ maxadmin -pskysql
|
||||
MaxScale> flush log error
|
||||
MaxScale> flush log trace
|
||||
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.
|
||||
|
||||
@ -182,23 +180,21 @@ endscript
|
||||
</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.
|
||||
|
||||
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>
|
||||
MaxScale> set server dbserver3 maintenance
|
||||
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.
|
||||
|
||||
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>
|
||||
MaxScale> clear server dbserver3 maintenance
|
||||
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.
|
||||
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user