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

Change MySQL[Client|Backend] to MariaDB[Client|Backend]

Browse Source
This commit is contained in:
Johan Wikman
2018-01-04 21:41:21 +02:00
parent 7c3c9ca0a8
commit d64868f058
19 changed files with 115 additions and 134 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
Documentation/About/Limitations.md
View File

@ -74,9 +74,9 @@ transaction or change the autocommit mode using a prepared statement.
## Protocol limitations ## Protocol limitations
### Limitations with MySQL Protocol support (MySQLClient) ### Limitations with MySQL/MariaDB Protocol support (MariaDBClient)
* Compression is not included in the MySQL server handshake. * Compression is not included in the server handshake.
* MariaDB MaxScale does not support `KILL QUERY ID <query_id>` type * MariaDB MaxScale does not support `KILL QUERY ID <query_id>` type
statements. If a query by a query ID is to be killed, it needs to be done statements. If a query by a query ID is to be killed, it needs to be done

4
Documentation/Authenticators/PAM-Authenticator.md
View File

@ -18,14 +18,14 @@ is to change the listener and backend authenticator modules to `PAMAuth` and
type=listener type=listener
address=:: address=::
service=Read-Write-Service service=Read-Write-Service
protocol=MySQLClient protocol=MariaDBClient
authenticator=PAMAuth authenticator=PAMAuth
[Master-Server] [Master-Server]
type=server type=server
address=123.456.789.10 address=123.456.789.10
port=12345 port=12345
protocol=MySQLBackend protocol=MariaDBBackend
authenticator=PAMBackendAuth authenticator=PAMBackendAuth
``` ```

8
Documentation/Design-Documents/Plugin-development-guide.md
View File

@ -468,7 +468,7 @@ dummy_setting=two
[RR Listener] [RR Listener]
type=listener type=listener
service=RR Service service=RR Service
protocol=MySQLClient protocol=MariaDBClient
port=4009 port=4009
``` ```
@ -527,9 +527,9 @@ MaxScale> show service "RR Service"
Root user access: Disabled Root user access: Disabled
Filter chain: MyLogFilter1 Filter chain: MyLogFilter1
Backend databases: Backend databases:
127.0.0.1:3001 Protocol: MySQLBackend Name: LocalMaster1 127.0.0.1:3001 Protocol: MariaDBBackend Name: LocalMaster1
127.0.0.1:3002 Protocol: MySQLBackend Name: LocalSlave1 127.0.0.1:3002 Protocol: MariaDBBackend Name: LocalSlave1
127.0.0.1:3003 Protocol: MySQLBackend Name: LocalSlave2 127.0.0.1:3003 Protocol: MariaDBBackend Name: LocalSlave2
Total connections: 2 Total connections: 2
Currently connected: 2 Currently connected: 2
MaxScale> call command rrrouter test_command "one" 0 MaxScale> call command rrrouter test_command "one" 0

4
Documentation/Filters/Tee-Filter.md
View File

@ -163,12 +163,12 @@ options=/var/log/DataMart/InsertsLog
[Orders Listener] [Orders Listener]
type=listener type=listener
service=Orders service=Orders
protocol=MySQLClient protocol=MariaDBClient
port=4011 port=4011
[DataMart Listener] [DataMart Listener]
type=listener type=listener
service=DataMart service=DataMart
protocol=MySQLClient protocol=MariaDBClient
port=4012 port=4012
``` ```

20
Documentation/Getting-Started/Configuration-Guide.md
View File

@ -953,14 +953,14 @@ parameter used as the weighting parameter.
type=server type=server
address=127.0.0.1 address=127.0.0.1
port=3000 port=3000
protocol=MySQLBackend protocol=MariaDBBackend
serv_weight=3 serv_weight=3
[server2] [server2]
type=server type=server
address=127.0.0.1 address=127.0.0.1
port=3001 port=3001
protocol=MySQLBackend protocol=MariaDBBackend
serv_weight=1 serv_weight=1
[Read Service] [Read Service]
@ -1076,7 +1076,7 @@ address port and protocol parameters.
type=server type=server
address=127.0.0.1 address=127.0.0.1
port=3000 port=3000
protocol=MySQLBackend protocol=MariaDBBackend
``` ```
#### `address` #### `address`
@ -1093,7 +1093,7 @@ MaxScale will use this port to connect to the database server.
#### `protocol` #### `protocol`
The name for the protocol module to use to connect MariaDB MaxScale to the The name for the protocol module to use to connect MariaDB MaxScale to the
database. Currently only one backend protocol is supported, the MySQLBackend database. Currently only one backend protocol is supported, the MariaDBBackend
module. module.
#### `monitoruser` #### `monitoruser`
@ -1206,7 +1206,7 @@ sudden connection spikes and rejected connections. For more information see
[<Listener name>] [<Listener name>]
type=listener type=listener
service=<Service name>] service=<Service name>]
protocol=[MySQLClient|HTTPD] protocol=[MariaDBClient|HTTPD]
address=[IP|hostname] address=[IP|hostname]
port=<Listen port number> port=<Listen port number>
socket=<Socket path> socket=<Socket path>
@ -1265,14 +1265,14 @@ backend side. Each of the protocols can be either a client protocol or a backend
protocol. Client protocols are used for client-MariaDB MaxScale communication protocol. Client protocols are used for client-MariaDB MaxScale communication
and backend protocols are for MariaDB MaxScale-database communication. and backend protocols are for MariaDB MaxScale-database communication.
##### `MySQLClient` ##### `MariaDBClient`
This is the implementation of the MySQL protocol that is used by clients of This is the implementation of the MySQL protocol that is used by clients of
MariaDB MaxScale to connect to MariaDB MaxScale. MariaDB MaxScale to connect to MariaDB MaxScale.
##### `MySQLBackend` ##### `MariaDBBackend`
The MySQLBackend protocol module is the implementation of the protocol that The MariaDBBackend protocol module is the implementation of the protocol that
MariaDB MaxScale uses to connect to the backend MariaDB, MySQL and Percona MariaDB MaxScale uses to connect to the backend MariaDB, MySQL and Percona
Server databases. This implementation is tailored for the MariaDB MaxScale to Server databases. This implementation is tailored for the MariaDB MaxScale to
MySQL Database traffic and is not a general purpose implementation of the MySQL MySQL Database traffic and is not a general purpose implementation of the MySQL
@ -1376,7 +1376,7 @@ certificates, disable this feature.
type=server type=server
address=10.131.24.62 address=10.131.24.62
port=3306 port=3306
protocol=MySQLBackend protocol=MariaDBBackend
ssl=required ssl=required
ssl_cert=/usr/local/mariadb/maxscale/ssl/crt.max-client.pem ssl_cert=/usr/local/mariadb/maxscale/ssl/crt.max-client.pem
ssl_key=/usr/local/mariadb/maxscale/ssl/key.max-client.pem ssl_key=/usr/local/mariadb/maxscale/ssl/key.max-client.pem
@ -1394,7 +1394,7 @@ Authority file are also provided.
[RW Split Listener] [RW Split Listener]
type=listener type=listener
service=RW Split Router service=RW Split Router
protocol=MySQLClient protocol=MariaDBClient
port=3306 port=3306
ssl=required ssl=required
ssl_cert=/usr/local/mariadb/maxscale/ssl/crt.maxscale.pem ssl_cert=/usr/local/mariadb/maxscale/ssl/crt.maxscale.pem

12
Documentation/REST-API/Resources-Server.md
View File

@ -60,7 +60,7 @@ whitespace replaced with hyphens. The server names are case-insensitive.
"parameters": { // Server parameters "parameters": { // Server parameters
"address": "127.0.0.1", "address": "127.0.0.1",
"port": 3000, "port": 3000,
"protocol": "MySQLBackend", "protocol": "MariaDBBackend",
"authenticator": "MySQLBackendAuth", "authenticator": "MySQLBackendAuth",
"ssl_key": "/etc/certs/client-key.pem", "ssl_key": "/etc/certs/client-key.pem",
"ssl_cert": "/etc/certs/client-cert.pem", "ssl_cert": "/etc/certs/client-cert.pem",
@ -142,7 +142,7 @@ Response contains a resource collection with all servers.
"parameters": { "parameters": {
"address": "127.0.0.1", "address": "127.0.0.1",
"port": 3000, "port": 3000,
"protocol": "MySQLBackend", "protocol": "MariaDBBackend",
"authenticator": "MySQLBackendAuth", "authenticator": "MySQLBackendAuth",
"ssl_key": "/etc/certs/client-key.pem", "ssl_key": "/etc/certs/client-key.pem",
"ssl_cert": "/etc/certs/client-cert.pem", "ssl_cert": "/etc/certs/client-cert.pem",
@ -199,7 +199,7 @@ Response contains a resource collection with all servers.
"parameters": { "parameters": {
"address": "127.0.0.1", "address": "127.0.0.1",
"port": 3001, "port": 3001,
"protocol": "MySQLBackend", "protocol": "MariaDBBackend",
"ssl_key": "/etc/certs/client-key.pem", "ssl_key": "/etc/certs/client-key.pem",
"ssl_cert": "/etc/certs/client-cert.pem", "ssl_cert": "/etc/certs/client-cert.pem",
"ssl_ca_cert": "/etc/certs/ca.pem", "ssl_ca_cert": "/etc/certs/ca.pem",
@ -247,7 +247,7 @@ object for defining a new server.
"parameters": { "parameters": {
"address": "127.0.0.1", "address": "127.0.0.1",
"port": 3003, "port": 3003,
"protocol": "MySQLBackend" "protocol": "MariaDBBackend"
} }
} }
} }
@ -266,7 +266,7 @@ new servers to be created and immediately taken into use.
"parameters": { "parameters": {
"address": "127.0.0.1", "address": "127.0.0.1",
"port": 3002, "port": 3002,
"protocol": "MySQLBackend" "protocol": "MariaDBBackend"
} }
}, },
"relationships": { "relationships": {
@ -399,7 +399,7 @@ Response to `GET /v1/server/server1`:
"parameters": { "parameters": {
"address": "127.0.0.1", "address": "127.0.0.1",
"port": 3000, "port": 3000,
"protocol": "MySQLBackend" "protocol": "MariaDBBackend"
}, },
"state": "Master, Running", "state": "Master, Running",
"version_string": "10.1.22-MariaDB", "version_string": "10.1.22-MariaDB",

10
Documentation/REST-API/Resources-Service.md
View File

@ -57,7 +57,7 @@ GET /v1/services/:name
"attributes": { "attributes": {
"parameters": { "parameters": {
"port": 4008, "port": 4008,
"protocol": "MySQLClient", "protocol": "MariaDBClient",
"authenticator": "MySQLAuth" "authenticator": "MySQLAuth"
} }
}, },
@ -138,7 +138,7 @@ GET /v1/services
"attributes": { "attributes": {
"parameters": { "parameters": {
"port": 4008, "port": 4008,
"protocol": "MySQLClient", "protocol": "MariaDBClient",
"authenticator": "MySQLAuth" "authenticator": "MySQLAuth"
} }
}, },
@ -247,7 +247,7 @@ GET /v1/services/:name/listeners
"attributes": { "attributes": {
"parameters": { "parameters": {
"port": 4008, "port": 4008,
"protocol": "MySQLClient", "protocol": "MariaDBClient",
"authenticator": "MySQLAuth" "authenticator": "MySQLAuth"
} }
}, },
@ -281,7 +281,7 @@ GET /v1/services/:name/listeners
"attributes": { "attributes": {
"parameters": { "parameters": {
"port": 4008, "port": 4008,
"protocol": "MySQLClient", "protocol": "MariaDBClient",
"authenticator": "MySQLAuth" "authenticator": "MySQLAuth"
} }
}, },
@ -315,7 +315,7 @@ GET /v1/services/:name/listeners/:listener
"attributes": { "attributes": {
"parameters": { "parameters": {
"port": 4006, "port": 4006,
"protocol": "MySQLClient", "protocol": "MariaDBClient",
"authenticator": "MySQLAuth" "authenticator": "MySQLAuth"
} }
}, },

36
Documentation/Reference/MaxAdmin.md
View File

@ -293,10 +293,10 @@ execution of the MariaDB MaxScale command.
Number of queries forwarded: 0 Number of queries forwarded: 0
Started: Wed Jun 25 10:08:23 2014 Started: Wed Jun 25 10:08:23 2014
Backend databases Backend databases
127.0.0.1:3309 Protocol: MySQLBackend 127.0.0.1:3309 Protocol: MariaDBBackend
127.0.0.1:3308 Protocol: MySQLBackend 127.0.0.1:3308 Protocol: MariaDBBackend
127.0.0.1:3307 Protocol: MySQLBackend 127.0.0.1:3307 Protocol: MariaDBBackend
127.0.0.1:3306 Protocol: MySQLBackend 127.0.0.1:3306 Protocol: MariaDBBackend
Users data: 0x724340 Users data: 0x724340
Total connections: 1 Total connections: 1
Currently connected: 1 Currently connected: 1
@ -602,10 +602,10 @@ Listeners.
----------------------+---------------------+--------------------+-----------------+-------+-------- ----------------------+---------------------+--------------------+-----------------+-------+--------
Name | Service Name | Protocol Module | Address | Port | State Name | Service Name | Protocol Module | Address | Port | State
----------------------+---------------------+--------------------+-----------------+-------+-------- ----------------------+---------------------+--------------------+-----------------+-------+--------
RWSplit-Listener | RWSplit | MySQLClient | * | 4006 | Running RWSplit-Listener | RWSplit | MariaDBClient | * | 4006 | Running
SchemaRouter-Listener | SchemaRouter | MySQLClient | * | 4010 | Running SchemaRouter-Listener | SchemaRouter | MariaDBClient | * | 4010 | Running
RWSplit-Hint-Listener | RWSplit-Hint | MySQLClient | * | 4009 | Running RWSplit-Hint-Listener | RWSplit-Hint | MariaDBClient | * | 4009 | Running
ReadConn-Listener | ReadConn | MySQLClient | * | 4008 | Running ReadConn-Listener | ReadConn | MariaDBClient | * | 4008 | Running
CLI-Listener | CLI | maxscaled | default | 0 | Running CLI-Listener | CLI | maxscaled | default | 0 | Running
----------------------+---------------------+--------------------+-----------------+-------+-------- ----------------------+---------------------+--------------------+-----------------+-------+--------
MaxScale> MaxScale>
@ -643,10 +643,10 @@ MaxScale> show service RWSplit
Started: Thu Apr 20 09:45:13 2017 Started: Thu Apr 20 09:45:13 2017
Root user access: Disabled Root user access: Disabled
Backend databases: Backend databases:
[127.0.0.1]:3000 Protocol: MySQLBackend Name: server1 [127.0.0.1]:3000 Protocol: MariaDBBackend Name: server1
[127.0.0.1]:3001 Protocol: MySQLBackend Name: server2 [127.0.0.1]:3001 Protocol: MariaDBBackend Name: server2
[127.0.0.1]:3002 Protocol: MySQLBackend Name: server3 [127.0.0.1]:3002 Protocol: MariaDBBackend Name: server3
[127.0.0.1]:3003 Protocol: MySQLBackend Name: server4 [127.0.0.1]:3003 Protocol: MariaDBBackend Name: server4
Total connections: 1 Total connections: 1
Currently connected: 1 Currently connected: 1
MaxScale> MaxScale>
@ -740,7 +740,7 @@ MaxScale> show server server2
Server 0x6501d0 (server2) Server 0x6501d0 (server2)
Server: 127.0.0.1 Server: 127.0.0.1
Status: Slave, Running Status: Slave, Running
Protocol: MySQLBackend Protocol: MariaDBBackend
Port: 3001 Port: 3001
Server Version: 10.1.22-MariaDB Server Version: 10.1.22-MariaDB
Node Id: 3001 Node Id: 3001
@ -935,7 +935,7 @@ DCB: 0x7fffdc014590
Service: RWSplit Service: RWSplit
Server name/IP: 127.0.0.1 Server name/IP: 127.0.0.1
Port number: 3000 Port number: 3000
Protocol: MySQLBackend Protocol: MariaDBBackend
Server status: Master, Running Server status: Master, Running
Role: Backend Request Handler Role: Backend Request Handler
Statistics: Statistics:
@ -1225,11 +1225,11 @@ Module Name | Module Type | Version | API | Status
----------------+-----------------+---------+-------+------------------------- ----------------+-----------------+---------+-------+-------------------------
qc_sqlite | QueryClassifier | V1.0.0 | 1.1.0 | Beta qc_sqlite | QueryClassifier | V1.0.0 | 1.1.0 | Beta
MySQLAuth | Authenticator | V1.1.0 | 1.1.0 | GA MySQLAuth | Authenticator | V1.1.0 | 1.1.0 | GA
MySQLClient | Protocol | V1.1.0 | 1.1.0 | GA MariaDBClient | Protocol | V1.1.0 | 1.1.0 | GA
MaxAdminAuth | Authenticator | V2.1.0 | 1.1.0 | GA MaxAdminAuth | Authenticator | V2.1.0 | 1.1.0 | GA
maxscaled | Protocol | V2.0.0 | 1.1.0 | GA maxscaled | Protocol | V2.0.0 | 1.1.0 | GA
MySQLBackendAuth| Authenticator | V1.0.0 | 1.1.0 | GA MySQLBackendAuth| Authenticator | V1.0.0 | 1.1.0 | GA
MySQLBackend | Protocol | V2.0.0 | 1.1.0 | GA MariaDBBackend | Protocol | V2.0.0 | 1.1.0 | GA
mysqlmon | Monitor | V1.5.0 | 3.0.0 | GA mysqlmon | Monitor | V1.5.0 | 3.0.0 | GA
schemarouter | Router | V1.0.0 | 2.0.0 | Beta schemarouter | Router | V1.0.0 | 2.0.0 | Beta
readwritesplit | Router | V1.1.0 | 2.0.0 | GA readwritesplit | Router | V1.1.0 | 2.0.0 | GA
@ -1379,7 +1379,7 @@ Parameters:
NAME Server name NAME Server name
HOST Server host address HOST Server host address
PORT Server port (default 3306) PORT Server port (default 3306)
PROTOCOL Server protocol (default MySQLBackend) PROTOCOL Server protocol (default MariaDBBackend)
AUTHENTICATOR Authenticator module name (default MySQLAuth) AUTHENTICATOR Authenticator module name (default MySQLAuth)
OPTIONS Comma separated list of options for the authenticator OPTIONS Comma separated list of options for the authenticator
@ -1513,7 +1513,7 @@ SERVICE Service where this listener is added
NAME Listener name NAME Listener name
HOST Listener host address (default [::]) HOST Listener host address (default [::])
PORT Listener port (default 3306) PORT Listener port (default 3306)
PROTOCOL Listener protocol (default MySQLClient) PROTOCOL Listener protocol (default MariaDBClient)
AUTHENTICATOR Authenticator module name (default MySQLAuth) AUTHENTICATOR Authenticator module name (default MySQLAuth)
OPTIONS Options for the authenticator module OPTIONS Options for the authenticator module
SSL_KEY Path to SSL private key SSL_KEY Path to SSL private key

2
Documentation/Tutorials/Avrorouter-Tutorial.md
View File

@ -62,7 +62,7 @@ source=replication-service
[replication-listener] [replication-listener]
type=listener type=listener
service=replication-service service=replication-service
protocol=MySQLClient protocol=MariaDBClient
port=3306 port=3306
# The client listener for the avro-service # The client listener for the avro-service

2
Documentation/Tutorials/Filter-Tutorial.md
View File

@ -138,7 +138,7 @@ Add this server into the MariaDB MaxScale configuration and create a service tha
type=server type=server
address=192.168.4.28 address=192.168.4.28
port=3306 port=3306
protocol=MySQLBackend protocol=MariaDBBackend
[Cassandra] [Cassandra]
type=service type=service

14
Documentation/Tutorials/Galera-Cluster-Connection-Routing-Tutorial.md
View File

@ -120,7 +120,7 @@ service=Galera Service
``` ```
A listener must also define the protocol module it will use for the incoming A listener must also define the protocol module it will use for the incoming
network protocol, currently this should be the MySQLClient protocol for all network protocol, currently this should be the MariaDBClient protocol for all
database listeners. The listener may then supply a network port to listen on database listeners. The listener may then supply a network port to listen on
and/or a socket within the file system. and/or a socket within the file system.
@ -128,7 +128,7 @@ and/or a socket within the file system.
[Galera Listener] [Galera Listener]
type=listener type=listener
service=Galera Service service=Galera Service
protocol=MySQLClient protocol=MariaDBClient
port=4306 port=4306
socket=/tmp/DB.Cluster socket=/tmp/DB.Cluster
``` ```
@ -141,26 +141,26 @@ The next stage is the configuration is to define the server information.
This defines how to connect to each of the servers within the cluster, again a section This defines how to connect to each of the servers within the cluster, again a section
is created for each server, with the type set to server, the network address and port to is created for each server, with the type set to server, the network address and port to
connect to and the protocol to use to connect to the server. Currently the protocol for connect to and the protocol to use to connect to the server. Currently the protocol for
all database connections in MySQLBackend. all database connections in MariaDBBackend.
``` ```
[dbserv1] [dbserv1]
type=server type=server
address=192.168.2.1 address=192.168.2.1
port=3306 port=3306
protocol=MySQLBackend protocol=MariaDBBackend
[dbserv2] [dbserv2]
type=server type=server
address=192.168.2.2 address=192.168.2.2
port=3306 port=3306
protocol=MySQLBackend protocol=MariaDBBackend
[dbserv3] [dbserv3]
type=server type=server
address=192.168.2.3 address=192.168.2.3
port=3306 port=3306
protocol=MySQLBackend protocol=MariaDBBackend
``` ```
In order for MariaDB MaxScale to monitor the servers using the correct monitoring In order for MariaDB MaxScale to monitor the servers using the correct monitoring
@ -255,7 +255,7 @@ Listeners.
---------------------+--------------------+-----------------+-------+-------- ---------------------+--------------------+-----------------+-------+--------
Service Name | Protocol Module | Address | Port | State Service Name | Protocol Module | Address | Port | State
---------------------+--------------------+-----------------+-------+-------- ---------------------+--------------------+-----------------+-------+--------
Galera Service | MySQLClient | * | 4306 | Running Galera Service | MariaDBClient | * | 4306 | Running
CLI | maxscaled | localhost | 6603 | Running CLI | maxscaled | localhost | 6603 | Running
---------------------+--------------------+-----------------+-------+-------- ---------------------+--------------------+-----------------+-------+--------
% %

14
Documentation/Tutorials/Galera-Cluster-Read-Write-Splitting-Tutorial.md
View File

@ -71,39 +71,39 @@ type=listener
service=Splitter Service service=Splitter Service
``` ```
A listener must also define the protocol module it will use for the incoming network protocol, currently this should be the `MySQLClient` protocol for all database listeners. The listener may then supply a network port to listen on and/or a socket within the file system. A listener must also define the protocol module it will use for the incoming network protocol, currently this should be the `MariaDBClient` protocol for all database listeners. The listener may then supply a network port to listen on and/or a socket within the file system.
``` ```
[Splitter Listener] [Splitter Listener]
type=listener type=listener
service=Splitter Service service=Splitter Service
protocol=MySQLClient protocol=MariaDBClient
port=3306 port=3306
socket=/tmp/ClusterMaster socket=/tmp/ClusterMaster
``` ```
An address parameter may be given if the listener is required to bind to a particular network address when using hosts with multiple network addresses. The default behavior is to listen on all network interfaces. An address parameter may be given if the listener is required to bind to a particular network address when using hosts with multiple network addresses. The default behavior is to listen on all network interfaces.
The next stage is the configuration is to define the server information. This defines how to connect to each of the servers within the cluster, again a section is created for each server, with the type set to server, the network address and port to connect to and the protocol to use to connect to the server. Currently the protocol module for all database connections in `MySQLBackend`. The next stage is the configuration is to define the server information. This defines how to connect to each of the servers within the cluster, again a section is created for each server, with the type set to server, the network address and port to connect to and the protocol to use to connect to the server. Currently the protocol module for all database connections in `MariaDBBackend`.
``` ```
[dbserv1] [dbserv1]
type=server type=server
address=192.168.2.1 address=192.168.2.1
port=3306 port=3306
protocol=MySQLBackend protocol=MariaDBBackend
[dbserv2] [dbserv2]
type=server type=server
address=192.168.2.2 address=192.168.2.2
port=3306 port=3306
protocol=MySQLBackend protocol=MariaDBBackend
[dbserv3] [dbserv3]
type=server type=server
address=192.168.2.3 address=192.168.2.3
port=3306 port=3306
protocol=MySQLBackend protocol=MariaDBBackend
``` ```
In order for MariaDB MaxScale to monitor the servers using the correct monitoring mechanisms a section should be provided that defines the monitor to use and the servers to monitor. Once again a section is created with a symbolic name for the monitor, with the type set to monitor. Parameters are added for the module to use, the list of servers to monitor and the username and password to use when connecting to the the servers with the monitor. In order for MariaDB MaxScale to monitor the servers using the correct monitoring mechanisms a section should be provided that defines the monitor to use and the servers to monitor. Once again a section is created with a symbolic name for the monitor, with the type set to monitor. Parameters are added for the module to use, the list of servers to monitor and the username and password to use when connecting to the the servers with the monitor.
@ -194,7 +194,7 @@ Listeners.
---------------------+--------------------+-----------------+-------+-------- ---------------------+--------------------+-----------------+-------+--------
Service Name | Protocol Module | Address | Port | State Service Name | Protocol Module | Address | Port | State
---------------------+--------------------+-----------------+-------+-------- ---------------------+--------------------+-----------------+-------+--------
Splitter Service | MySQLClient | * | 3306 | Running Splitter Service | MariaDBClient | * | 3306 | Running
CLI | maxscaled | localhost | 6603 | Running CLI | maxscaled | localhost | 6603 | Running
---------------------+--------------------+-----------------+-------+-------- ---------------------+--------------------+-----------------+-------+--------
``` ```

32
Documentation/Tutorials/MaxScale-Information-Schema.md
View File

@ -25,7 +25,7 @@ The listener section defines the protocol, port and other information needed to
[MaxInfo Listener] [MaxInfo Listener]
type=listener type=listener
service=MaxInfo service=MaxInfo
protocol=MySQLClient protocol=MariaDBClient
port=9003 port=9003
``` ```
@ -48,7 +48,7 @@ As with any other listeners within MariaDB MaxScale the listeners can be bound t
[MaxInfo Listener] [MaxInfo Listener]
type=listener type=listener
service=MaxInfo service=MaxInfo
protocol=MySQLClient protocol=MariaDBClient
address=localhost address=localhost
port=9003 port=9003
``` ```
@ -205,14 +205,14 @@ mysql> show listeners;
+----------------+-----------------+-----------+------+---------+ +----------------+-----------------+-----------+------+---------+
| Service Name | Protocol Module | Address | Port | State | | Service Name | Protocol Module | Address | Port | State |
+----------------+-----------------+-----------+------+---------+ +----------------+-----------------+-----------+------+---------+
| Test Service | MySQLClient | * | 4006 | Running | | Test Service | MariaDBClient | * | 4006 | Running |
| Split Service | MySQLClient | * | 4007 | Running | | Split Service | MariaDBClient | * | 4007 | Running |
| Filter Service | MySQLClient | * | 4008 | Running | | Filter Service | MariaDBClient | * | 4008 | Running |
| Named Service | MySQLClient | * | 4010 | Running | | Named Service | MariaDBClient | * | 4010 | Running |
| QLA Service | MySQLClient | * | 4009 | Running | | QLA Service | MariaDBClient | * | 4009 | Running |
| Debug Service | telnetd | localhost | 4242 | Running | | Debug Service | telnetd | localhost | 4242 | Running |
| CLI | maxscaled | localhost | 6603 | Running | | CLI | maxscaled | localhost | 6603 | Running |
| MaxInfo | MySQLClient | * | 9003 | Running | | MaxInfo | MariaDBClient | * | 9003 | Running |
| MaxInfo | HTTPD | * | 8003 | Running | | MaxInfo | HTTPD | * | 8003 | Running |
+----------------+-----------------+-----------+------+---------+ +----------------+-----------------+-----------+------+---------+
9 rows in set (0.02 sec) 9 rows in set (0.02 sec)
@ -296,7 +296,7 @@ mysql> show modules;
| HTTPD | Protocol | V1.0.1 | 1.0.0 | In Development | | HTTPD | Protocol | V1.0.1 | 1.0.0 | In Development |
| maxscaled | Protocol | V1.0.0 | 1.0.0 | GA | | maxscaled | Protocol | V1.0.0 | 1.0.0 | GA |
| telnetd | Protocol | V1.0.1 | 1.0.0 | GA | | telnetd | Protocol | V1.0.1 | 1.0.0 | GA |
| MySQLClient | Protocol | V1.0.0 | 1.0.0 | GA | | MariaDBClient | Protocol | V1.0.0 | 1.0.0 | GA |
| mysqlmon | Monitor | V1.4.0 | 1.0.0 | GA | | mysqlmon | Monitor | V1.4.0 | 1.0.0 | GA |
| readwritesplit | Router | V1.0.2 | 1.0.0 | GA | | readwritesplit | Router | V1.0.2 | 1.0.0 | GA |
| readconnroute | Router | V1.1.0 | 1.0.0 | GA | | readconnroute | Router | V1.1.0 | 1.0.0 | GA |
@ -448,14 +448,14 @@ The /listeners URI will return a JSON array with one entry per listener, each en
``` ```
$ curl http://maxscale.mariadb.com:8003/listeners $ curl http://maxscale.mariadb.com:8003/listeners
[ { "Service Name" : "Test Service", "Protocol Module" : "MySQLClient", "Address" : "*", "Port" : 4006, "State" : "Running"}, [ { "Service Name" : "Test Service", "Protocol Module" : "MariaDBClient", "Address" : "*", "Port" : 4006, "State" : "Running"},
{ "Service Name" : "Split Service", "Protocol Module" : "MySQLClient", "Address" : "*", "Port" : 4007, "State" : "Running"}, { "Service Name" : "Split Service", "Protocol Module" : "MariaDBClient", "Address" : "*", "Port" : 4007, "State" : "Running"},
{ "Service Name" : "Filter Service", "Protocol Module" : "MySQLClient", "Address" : "*", "Port" : 4008, "State" : "Running"}, { "Service Name" : "Filter Service", "Protocol Module" : "MariaDBClient", "Address" : "*", "Port" : 4008, "State" : "Running"},
{ "Service Name" : "Named Service", "Protocol Module" : "MySQLClient", "Address" : "*", "Port" : 4010, "State" : "Running"}, { "Service Name" : "Named Service", "Protocol Module" : "MariaDBClient", "Address" : "*", "Port" : 4010, "State" : "Running"},
{ "Service Name" : "QLA Service", "Protocol Module" : "MySQLClient", "Address" : "*", "Port" : 4009, "State" : "Running"}, { "Service Name" : "QLA Service", "Protocol Module" : "MariaDBClient", "Address" : "*", "Port" : 4009, "State" : "Running"},
{ "Service Name" : "Debug Service", "Protocol Module" : "telnetd", "Address" : "localhost", "Port" : 4242, "State" : "Running"}, { "Service Name" : "Debug Service", "Protocol Module" : "telnetd", "Address" : "localhost", "Port" : 4242, "State" : "Running"},
{ "Service Name" : "CLI", "Protocol Module" : "maxscaled", "Address" : "localhost", "Port" : 6603, "State" : "Running"}, { "Service Name" : "CLI", "Protocol Module" : "maxscaled", "Address" : "localhost", "Port" : 6603, "State" : "Running"},
{ "Service Name" : "MaxInfo", "Protocol Module" : "MySQLClient", "Address" : "*", "Port" : 9003, "State" : "Running"}, { "Service Name" : "MaxInfo", "Protocol Module" : "MariaDBClient", "Address" : "*", "Port" : 9003, "State" : "Running"},
{ "Service Name" : "MaxInfo", "Protocol Module" : "HTTPD", "Address" : "*", "Port" : 8003, "State" : "Running"}] { "Service Name" : "MaxInfo", "Protocol Module" : "HTTPD", "Address" : "*", "Port" : 8003, "State" : "Running"}]
$ $
``` ```
@ -469,7 +469,7 @@ $ curl http://maxscale.mariadb.com:8003/modules
[ { "Module Name" : "HTTPD", "Module Type" : "Protocol", "Version" : "V1.0.1", "API Version" : "1.0.0", "Status" : "In Development"}, [ { "Module Name" : "HTTPD", "Module Type" : "Protocol", "Version" : "V1.0.1", "API Version" : "1.0.0", "Status" : "In Development"},
{ "Module Name" : "maxscaled", "Module Type" : "Protocol", "Version" : "V1.0.0", "API Version" : "1.0.0", "Status" : "GA"}, { "Module Name" : "maxscaled", "Module Type" : "Protocol", "Version" : "V1.0.0", "API Version" : "1.0.0", "Status" : "GA"},
{ "Module Name" : "telnetd", "Module Type" : "Protocol", "Version" : "V1.0.1", "API Version" : "1.0.0", "Status" : "GA"}, { "Module Name" : "telnetd", "Module Type" : "Protocol", "Version" : "V1.0.1", "API Version" : "1.0.0", "Status" : "GA"},
{ "Module Name" : "MySQLClient", "Module Type" : "Protocol", "Version" : "V1.0.0", "API Version" : "1.0.0", "Status" : "GA"}, { "Module Name" : "MariaDBClient", "Module Type" : "Protocol", "Version" : "V1.0.0", "API Version" : "1.0.0", "Status" : "GA"},
{ "Module Name" : "mysqlmon", "Module Type" : "Monitor", "Version" : "V1.4.0", "API Version" : "1.0.0", "Status" : "GA"}, { "Module Name" : "mysqlmon", "Module Type" : "Monitor", "Version" : "V1.4.0", "API Version" : "1.0.0", "Status" : "GA"},
{ "Module Name" : "readwritesplit", "Module Type" : "Router", "Version" : "V1.0.2", "API Version" : "1.0.0", "Status" : "GA"}, { "Module Name" : "readwritesplit", "Module Type" : "Router", "Version" : "V1.0.2", "API Version" : "1.0.0", "Status" : "GA"},
{ "Module Name" : "readconnroute", "Module Type" : "Router", "Version" : "V1.1.0", "API Version" : "1.0.0", "Status" : "GA"}, { "Module Name" : "readconnroute", "Module Type" : "Router", "Version" : "V1.1.0", "API Version" : "1.0.0", "Status" : "GA"},

10
Documentation/Tutorials/MySQL-Cluster-Setup.md
View File

@ -229,7 +229,7 @@ version_string=5.5.37-CLUSTER
[Cluster Listener] [Cluster Listener]
type=listener type=listener
service=Cluster Service service=Cluster Service
protocol=MySQLClient protocol=MariaDBClient
port=4906 port=4906
[NDB Cluster Monitor] [NDB Cluster Monitor]
@ -246,14 +246,14 @@ monitor_interval=8000
type=server type=server
address=127.0.0.1 address=127.0.0.1
port=3306 port=3306
protocol=MySQLBackend protocol=MariaDBBackend
[server2] [server2]
#SQL node2 #SQL node2
type=server type=server
address=162.243.90.81 address=162.243.90.81
port=3306 port=3306
protocol=MySQLBackend protocol=MariaDBBackend
``` ```
Assuming MariaDB MaxScale is installed in server1, start it. Assuming MariaDB MaxScale is installed in server1, start it.
@ -283,7 +283,7 @@ Server 0x3873b40 (server1)
Server: 127.0.0.1 Server: 127.0.0.1
Status: NDB, Running Status: NDB, Running
Protocol: MySQLBackend Protocol: MariaDBBackend
Port: 3306 Port: 3306
Server Version: 5.5.38-ndb-7.2.17-cluster-gpl Server Version: 5.5.38-ndb-7.2.17-cluster-gpl
Node Id: 22 Node Id: 22
@ -297,7 +297,7 @@ Server 0x3873a40 (server2)
Server: 162.243.90.81 Server: 162.243.90.81
Status: NDB, Running Status: NDB, Running
Protocol: MySQLBackend Protocol: MariaDBBackend
Port: 3306 Port: 3306
Server Version: 5.5.38-ndb-7.2.17-cluster-gpl Server Version: 5.5.38-ndb-7.2.17-cluster-gpl
Node Id: 23 Node Id: 23

18
Documentation/Tutorials/MySQL-Replication-Connection-Routing-Tutorial.md
View File

@ -106,45 +106,45 @@ type=listener
service=Read-Service service=Read-Service
``` ```
A listener must also define the protocol module it will use for the incoming network protocol, currently this should be the MySQLClient protocol for all database listeners. The listener may then supply a network port to listen on and/or a socket within the file system. A listener must also define the protocol module it will use for the incoming network protocol, currently this should be the MariaDBClient protocol for all database listeners. The listener may then supply a network port to listen on and/or a socket within the file system.
``` ```
[Write-Listener] [Write-Listener]
type=listener type=listener
service=Write-Service service=Write-Service
protocol=MySQLClient protocol=MariaDBClient
port=4306 port=4306
socket=/tmp/ClusterMaster socket=/tmp/ClusterMaster
[Read-Listener] [Read-Listener]
type=listener type=listener
service=Read-Service service=Read-Service
protocol=MySQLClient protocol=MariaDBClient
port=4307 port=4307
``` ```
An address parameter may be given if the listener is required to bind to a particular network address when using hosts with multiple network addresses. The default behavior is to listen on all network interfaces. An address parameter may be given if the listener is required to bind to a particular network address when using hosts with multiple network addresses. The default behavior is to listen on all network interfaces.
The next stage is the configuration is to define the server information. This defines how to connect to each of the servers within the cluster, again a section is created for each server, with the type set to server, the network address and port to connect to and the protocol to use to connect to the server. Currently the protocol for all database connections in MySQLBackend. The next stage is the configuration is to define the server information. This defines how to connect to each of the servers within the cluster, again a section is created for each server, with the type set to server, the network address and port to connect to and the protocol to use to connect to the server. Currently the protocol for all database connections in MariaDBBackend.
``` ```
[dbserv1] [dbserv1]
type=server type=server
address=192.168.2.1 address=192.168.2.1
port=3306 port=3306
protocol=MySQLBackend protocol=MariaDBBackend
[dbserv2] [dbserv2]
type=server type=server
address=192.168.2.2 address=192.168.2.2
port=3306 port=3306
protocol=MySQLBackend protocol=MariaDBBackend
[dbserv3] [dbserv3]
type=server type=server
address=192.168.2.3 address=192.168.2.3
port=3306 port=3306
protocol=MySQLBackend protocol=MariaDBBackend
``` ```
In order for MariaDB MaxScale to monitor the servers using the correct monitoring mechanisms a section should be provided that defines the monitor to use and the servers to monitor. Once again a section is created with a symbolic name for the monitor, with the type set to monitor. Parameters are added for the module to use, the list of servers to monitor and the username and password to use when connecting to the the servers with the monitor. In order for MariaDB MaxScale to monitor the servers using the correct monitoring mechanisms a section should be provided that defines the monitor to use and the servers to monitor. Once again a section is created with a symbolic name for the monitor, with the type set to monitor. Parameters are added for the module to use, the list of servers to monitor and the username and password to use when connecting to the the servers with the monitor.
@ -220,8 +220,8 @@ Listeners.
---------------------+--------------------+-----------------+-------+-------- ---------------------+--------------------+-----------------+-------+--------
Service Name | Protocol Module | Address | Port | State Service Name | Protocol Module | Address | Port | State
---------------------+--------------------+-----------------+-------+-------- ---------------------+--------------------+-----------------+-------+--------
Read Service | MySQLClient | * | 4307 | Running Read Service | MariaDBClient | * | 4307 | Running
Write Service | MySQLClient | * | 4306 | Running Write Service | MariaDBClient | * | 4306 | Running
CLI | maxscaled | localhost | 6603 | Running CLI | maxscaled | localhost | 6603 | Running
---------------------+--------------------+-----------------+-------+-------- ---------------------+--------------------+-----------------+-------+--------
``` ```

33
Documentation/Tutorials/MySQL-Replication-Read-Write-Splitting-Tutorial.md
View File

@ -106,7 +106,7 @@ service=Splitter Service
``` ```
A listener must also define the protocol module it will use for the incoming A listener must also define the protocol module it will use for the incoming
network protocol, currently this should be the `MySQLClient` protocol for all network protocol, currently this should be the `MariaDBClient` protocol for all
database listeners. The listener may then supply a network port to listen on database listeners. The listener may then supply a network port to listen on
and/or a socket within the file system. and/or a socket within the file system.
@ -114,7 +114,7 @@ and/or a socket within the file system.
[Splitter Listener] [Splitter Listener]
type=listener type=listener
service=Splitter Service service=Splitter Service
protocol=MySQLClient protocol=MariaDBClient
port=3306 port=3306
socket=/tmp/ClusterMaster socket=/tmp/ClusterMaster
``` ```
@ -127,26 +127,26 @@ The next stage in the configuration is to define the backend servers. The
definitions include how to connect to the servers. A section is created for each definitions include how to connect to the servers. A section is created for each
server and it contains: `type` set to `server`, the network address and port, server and it contains: `type` set to `server`, the network address and port,
and the protocol to use. Currently, the protocol module for all database and the protocol to use. Currently, the protocol module for all database
connections is `MySQLBackend`. connections is `MariaDBBackend`.
``` ```
[dbserv1] [dbserv1]
type=server type=server
address=192.168.2.1 address=192.168.2.1
port=3306 port=3306
protocol=MySQLBackend protocol=MariaDBBackend
[dbserv2] [dbserv2]
type=server type=server
address=192.168.2.2 address=192.168.2.2
port=3306 port=3306
protocol=MySQLBackend protocol=MariaDBBackend
[dbserv3] [dbserv3]
type=server type=server
address=192.168.2.3 address=192.168.2.3
port=3306 port=3306
protocol=MySQLBackend protocol=MariaDBBackend
``` ```
For MariaDB MaxScale to monitor the servers using the correct monitoring For MariaDB MaxScale to monitor the servers using the correct monitoring
@ -209,51 +209,32 @@ the services, listeners etc have been correctly configured.
% maxadmin list services % maxadmin list services
Services. Services.
--------------------------+----------------------+--------+--------------- --------------------------+----------------------+--------+---------------
Service Name | Router Module | #Users | Total Sessions Service Name | Router Module | #Users | Total Sessions
--------------------------+----------------------+--------+--------------- --------------------------+----------------------+--------+---------------
Splitter Service | readwritesplit | 1 | 1 Splitter Service | readwritesplit | 1 | 1
CLI | cli | 2 | 2 CLI | cli | 2 | 2
--------------------------+----------------------+--------+--------------- --------------------------+----------------------+--------+---------------
% maxadmin list servers % maxadmin list servers
Servers. Servers.
-------------------+-----------------+-------+-------------+-------------------- -------------------+-----------------+-------+-------------+--------------------
Server | Address | Port | Connections | Status Server | Address | Port | Connections | Status
-------------------+-----------------+-------+-------------+-------------------- -------------------+-----------------+-------+-------------+--------------------
dbserv1 | 192.168.2.1 | 3306 | 0 | Running, Slave dbserv1 | 192.168.2.1 | 3306 | 0 | Running, Slave
dbserv2 | 192.168.2.2 | 3306 | 0 | Running, Master dbserv2 | 192.168.2.2 | 3306 | 0 | Running, Master
dbserv3 | 192.168.2.3 | 3306 | 0 | Running, Slave dbserv3 | 192.168.2.3 | 3306 | 0 | Running, Slave
-------------------+-----------------+-------+-------------+-------------------- -------------------+-----------------+-------+-------------+--------------------
% maxadmin list listeners % maxadmin list listeners
Listeners. Listeners.
---------------------+--------------------+-----------------+-------+-------- ---------------------+--------------------+-----------------+-------+--------
Service Name | Protocol Module | Address | Port | State Service Name | Protocol Module | Address | Port | State
---------------------+--------------------+-----------------+-------+-------- ---------------------+--------------------+-----------------+-------+--------
Splitter Service | MariaDBClient | * | 3306 | Running
Splitter Service | MySQLClient | * | 3306 | Running
CLI | maxscaled | localhost | 6603 | Running CLI | maxscaled | localhost | 6603 | Running
---------------------+--------------------+-----------------+-------+-------- ---------------------+--------------------+-----------------+-------+--------
``` ```

16
Documentation/Tutorials/RabbitMQ-And-Tee-Archiving.md
View File

@ -80,13 +80,13 @@ servers to the configuration file.
type=server type=server
address=192.168.0.200 address=192.168.0.200
port=3306 port=3306
protocol=MySQLBackend protocol=MariaDBBackend
[archive-1] [archive-1]
type=server type=server
address=192.168.0.201 address=192.168.0.201
port=3000 port=3000
protocol=MySQLBackend protocol=MariaDBBackend
``` ```
After we have defined the `production-1` and `archive-1` servers, we need a monitor After we have defined the `production-1` and `archive-1` servers, we need a monitor
@ -145,13 +145,13 @@ Next we will configure the listeners for these two services.
[Production Listener] [Production Listener]
type=listener type=listener
service=Production service=Production
protocol=MySQLClient protocol=MariaDBClient
port=4000 port=4000
[Archive Listener] [Archive Listener]
type=listener type=listener
service=Archive service=Archive
protocol=MySQLClient protocol=MariaDBClient
port=4001 port=4001
``` ```
@ -224,13 +224,13 @@ Here is the complete configuration file.
type=server type=server
address=192.168.0.200 address=192.168.0.200
port=3306 port=3306
protocol=MySQLBackend protocol=MariaDBBackend
[archive-1] [archive-1]
type=server type=server
address=192.168.0.201 address=192.168.0.201
port=3000 port=3000
protocol=MySQLBackend protocol=MariaDBBackend
# MySQL server monitor # MySQL server monitor
[MySQL Monitor] [MySQL Monitor]
@ -263,13 +263,13 @@ filters=MQ Filter
[Production Listener] [Production Listener]
type=listener type=listener
service=Production service=Production
protocol=MySQLClient protocol=MariaDBClient
port=4000 port=4000
[Archive Listener] [Archive Listener]
type=listener type=listener
service=Archive service=Archive
protocol=MySQLClient protocol=MariaDBClient
port=4001 port=4001
# Tee filter to duplicate insert, update and delete # Tee filter to duplicate insert, update and delete

8
Documentation/Tutorials/Replication-Proxy-Binlog-Router-Tutorial.md
View File

@ -159,12 +159,12 @@ commands on the listener.
[Replication Listener] [Replication Listener]
type=listener type=listener
service=Replication service=Replication
protocol=MySQLClient protocol=MariaDBClient
port=3306 port=3306
``` ```
The protocol used by slaves for connection to MariaDB MaxScale is the same The protocol used by slaves for connection to MariaDB MaxScale is the same
*MySQLClient* protocol that is used for client applications to connect to *MariaDBClient* protocol that is used for client applications to connect to
databases, therefore the same MariaDB MaxScale protocol module can be used. databases, therefore the same MariaDB MaxScale protocol module can be used.
It's also possible to enable client side SSL by adding the required SSL options It's also possible to enable client side SSL by adding the required SSL options
@ -174,7 +174,7 @@ in the listener:
[Replication SSL Listener] [Replication SSL Listener]
type=listener type=listener
service=Replication service=Replication
protocol=MySQLClient protocol=MariaDBClient
port=3306 port=3306
ssl=required ssl=required
ssl_key=/path/to/key.pem ssl_key=/path/to/key.pem
@ -485,7 +485,7 @@ currently connected.
Started: Thu Jan 29 16:06:11 2015 Started: Thu Jan 29 16:06:11 2015
Root user access: Disabled Root user access: Disabled
Backend databases Backend databases
178.62.50.70:3306 Protocol: MySQLBackend 178.62.50.70:3306 Protocol: MariaDBBackend
Users data: 0x156c030 Users data: 0x156c030
Total connections: 2 Total connections: 2
Currently connected: 2 Currently connected: 2

2
Documentation/Tutorials/Simple-Sharding-Tutorial.md
View File

@ -58,7 +58,7 @@ After this we configure a listener for the service. The listener is the actual p
[Sharded Service Listener] [Sharded Service Listener]
type=listener type=listener
service=Sharded Service service=Sharded Service
protocol=MySQLClient protocol=MariaDBClient
port=4000 port=4000
``` ```