diff --git a/Documentation/About/Limitations.md b/Documentation/About/Limitations.md index b84615e50..5f8c1a335 100644 --- a/Documentation/About/Limitations.md +++ b/Documentation/About/Limitations.md @@ -74,9 +74,9 @@ transaction or change the autocommit mode using a prepared statement. ## 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 ` type statements. If a query by a query ID is to be killed, it needs to be done diff --git a/Documentation/Authenticators/PAM-Authenticator.md b/Documentation/Authenticators/PAM-Authenticator.md index 2096e8f72..0b2a2748e 100644 --- a/Documentation/Authenticators/PAM-Authenticator.md +++ b/Documentation/Authenticators/PAM-Authenticator.md @@ -18,14 +18,14 @@ is to change the listener and backend authenticator modules to `PAMAuth` and type=listener address=:: service=Read-Write-Service -protocol=MySQLClient +protocol=MariaDBClient authenticator=PAMAuth [Master-Server] type=server address=123.456.789.10 port=12345 -protocol=MySQLBackend +protocol=MariaDBBackend authenticator=PAMBackendAuth ``` diff --git a/Documentation/Design-Documents/Plugin-development-guide.md b/Documentation/Design-Documents/Plugin-development-guide.md index 1b4d74fe3..39bebdbe8 100644 --- a/Documentation/Design-Documents/Plugin-development-guide.md +++ b/Documentation/Design-Documents/Plugin-development-guide.md @@ -468,7 +468,7 @@ dummy_setting=two [RR Listener] type=listener service=RR Service -protocol=MySQLClient +protocol=MariaDBClient port=4009 ``` @@ -527,9 +527,9 @@ MaxScale> show service "RR Service" Root user access: Disabled Filter chain: MyLogFilter1 Backend databases: - 127.0.0.1:3001 Protocol: MySQLBackend Name: LocalMaster1 - 127.0.0.1:3002 Protocol: MySQLBackend Name: LocalSlave1 - 127.0.0.1:3003 Protocol: MySQLBackend Name: LocalSlave2 + 127.0.0.1:3001 Protocol: MariaDBBackend Name: LocalMaster1 + 127.0.0.1:3002 Protocol: MariaDBBackend Name: LocalSlave1 + 127.0.0.1:3003 Protocol: MariaDBBackend Name: LocalSlave2 Total connections: 2 Currently connected: 2 MaxScale> call command rrrouter test_command "one" 0 diff --git a/Documentation/Filters/Tee-Filter.md b/Documentation/Filters/Tee-Filter.md index b7a03c0aa..b4de2238d 100644 --- a/Documentation/Filters/Tee-Filter.md +++ b/Documentation/Filters/Tee-Filter.md @@ -163,12 +163,12 @@ options=/var/log/DataMart/InsertsLog [Orders Listener] type=listener service=Orders -protocol=MySQLClient +protocol=MariaDBClient port=4011 [DataMart Listener] type=listener service=DataMart -protocol=MySQLClient +protocol=MariaDBClient port=4012 ``` diff --git a/Documentation/Getting-Started/Configuration-Guide.md b/Documentation/Getting-Started/Configuration-Guide.md index 804d5390f..3609f404b 100644 --- a/Documentation/Getting-Started/Configuration-Guide.md +++ b/Documentation/Getting-Started/Configuration-Guide.md @@ -953,14 +953,14 @@ parameter used as the weighting parameter. type=server address=127.0.0.1 port=3000 -protocol=MySQLBackend +protocol=MariaDBBackend serv_weight=3 [server2] type=server address=127.0.0.1 port=3001 -protocol=MySQLBackend +protocol=MariaDBBackend serv_weight=1 [Read Service] @@ -1076,7 +1076,7 @@ address port and protocol parameters. type=server address=127.0.0.1 port=3000 -protocol=MySQLBackend +protocol=MariaDBBackend ``` #### `address` @@ -1093,7 +1093,7 @@ MaxScale will use this port to connect to the database server. #### `protocol` 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. #### `monitoruser` @@ -1206,7 +1206,7 @@ sudden connection spikes and rejected connections. For more information see [] type=listener service=] -protocol=[MySQLClient|HTTPD] +protocol=[MariaDBClient|HTTPD] address=[IP|hostname] port= socket= @@ -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 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 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 Server databases. This implementation is tailored for the MariaDB MaxScale to MySQL Database traffic and is not a general purpose implementation of the MySQL @@ -1376,7 +1376,7 @@ certificates, disable this feature. type=server address=10.131.24.62 port=3306 -protocol=MySQLBackend +protocol=MariaDBBackend ssl=required ssl_cert=/usr/local/mariadb/maxscale/ssl/crt.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] type=listener service=RW Split Router -protocol=MySQLClient +protocol=MariaDBClient port=3306 ssl=required ssl_cert=/usr/local/mariadb/maxscale/ssl/crt.maxscale.pem diff --git a/Documentation/REST-API/Resources-Server.md b/Documentation/REST-API/Resources-Server.md index 1409790f7..7e5231925 100644 --- a/Documentation/REST-API/Resources-Server.md +++ b/Documentation/REST-API/Resources-Server.md @@ -60,7 +60,7 @@ whitespace replaced with hyphens. The server names are case-insensitive. "parameters": { // Server parameters "address": "127.0.0.1", "port": 3000, - "protocol": "MySQLBackend", + "protocol": "MariaDBBackend", "authenticator": "MySQLBackendAuth", "ssl_key": "/etc/certs/client-key.pem", "ssl_cert": "/etc/certs/client-cert.pem", @@ -142,7 +142,7 @@ Response contains a resource collection with all servers. "parameters": { "address": "127.0.0.1", "port": 3000, - "protocol": "MySQLBackend", + "protocol": "MariaDBBackend", "authenticator": "MySQLBackendAuth", "ssl_key": "/etc/certs/client-key.pem", "ssl_cert": "/etc/certs/client-cert.pem", @@ -199,7 +199,7 @@ Response contains a resource collection with all servers. "parameters": { "address": "127.0.0.1", "port": 3001, - "protocol": "MySQLBackend", + "protocol": "MariaDBBackend", "ssl_key": "/etc/certs/client-key.pem", "ssl_cert": "/etc/certs/client-cert.pem", "ssl_ca_cert": "/etc/certs/ca.pem", @@ -247,7 +247,7 @@ object for defining a new server. "parameters": { "address": "127.0.0.1", "port": 3003, - "protocol": "MySQLBackend" + "protocol": "MariaDBBackend" } } } @@ -266,7 +266,7 @@ new servers to be created and immediately taken into use. "parameters": { "address": "127.0.0.1", "port": 3002, - "protocol": "MySQLBackend" + "protocol": "MariaDBBackend" } }, "relationships": { @@ -399,7 +399,7 @@ Response to `GET /v1/server/server1`: "parameters": { "address": "127.0.0.1", "port": 3000, - "protocol": "MySQLBackend" + "protocol": "MariaDBBackend" }, "state": "Master, Running", "version_string": "10.1.22-MariaDB", diff --git a/Documentation/REST-API/Resources-Service.md b/Documentation/REST-API/Resources-Service.md index bb59c05b1..152ada2ac 100644 --- a/Documentation/REST-API/Resources-Service.md +++ b/Documentation/REST-API/Resources-Service.md @@ -57,7 +57,7 @@ GET /v1/services/:name "attributes": { "parameters": { "port": 4008, - "protocol": "MySQLClient", + "protocol": "MariaDBClient", "authenticator": "MySQLAuth" } }, @@ -138,7 +138,7 @@ GET /v1/services "attributes": { "parameters": { "port": 4008, - "protocol": "MySQLClient", + "protocol": "MariaDBClient", "authenticator": "MySQLAuth" } }, @@ -247,7 +247,7 @@ GET /v1/services/:name/listeners "attributes": { "parameters": { "port": 4008, - "protocol": "MySQLClient", + "protocol": "MariaDBClient", "authenticator": "MySQLAuth" } }, @@ -281,7 +281,7 @@ GET /v1/services/:name/listeners "attributes": { "parameters": { "port": 4008, - "protocol": "MySQLClient", + "protocol": "MariaDBClient", "authenticator": "MySQLAuth" } }, @@ -315,7 +315,7 @@ GET /v1/services/:name/listeners/:listener "attributes": { "parameters": { "port": 4006, - "protocol": "MySQLClient", + "protocol": "MariaDBClient", "authenticator": "MySQLAuth" } }, diff --git a/Documentation/Reference/MaxAdmin.md b/Documentation/Reference/MaxAdmin.md index b317ee5fc..cf33389e3 100644 --- a/Documentation/Reference/MaxAdmin.md +++ b/Documentation/Reference/MaxAdmin.md @@ -293,10 +293,10 @@ execution of the MariaDB MaxScale command. Number of queries forwarded: 0 Started: Wed Jun 25 10:08:23 2014 Backend databases - 127.0.0.1:3309 Protocol: MySQLBackend - 127.0.0.1:3308 Protocol: MySQLBackend - 127.0.0.1:3307 Protocol: MySQLBackend - 127.0.0.1:3306 Protocol: MySQLBackend + 127.0.0.1:3309 Protocol: MariaDBBackend + 127.0.0.1:3308 Protocol: MariaDBBackend + 127.0.0.1:3307 Protocol: MariaDBBackend + 127.0.0.1:3306 Protocol: MariaDBBackend Users data: 0x724340 Total connections: 1 Currently connected: 1 @@ -602,10 +602,10 @@ Listeners. ----------------------+---------------------+--------------------+-----------------+-------+-------- Name | Service Name | Protocol Module | Address | Port | State ----------------------+---------------------+--------------------+-----------------+-------+-------- -RWSplit-Listener | RWSplit | MySQLClient | * | 4006 | Running -SchemaRouter-Listener | SchemaRouter | MySQLClient | * | 4010 | Running -RWSplit-Hint-Listener | RWSplit-Hint | MySQLClient | * | 4009 | Running -ReadConn-Listener | ReadConn | MySQLClient | * | 4008 | Running +RWSplit-Listener | RWSplit | MariaDBClient | * | 4006 | Running +SchemaRouter-Listener | SchemaRouter | MariaDBClient | * | 4010 | Running +RWSplit-Hint-Listener | RWSplit-Hint | MariaDBClient | * | 4009 | Running +ReadConn-Listener | ReadConn | MariaDBClient | * | 4008 | Running CLI-Listener | CLI | maxscaled | default | 0 | Running ----------------------+---------------------+--------------------+-----------------+-------+-------- MaxScale> @@ -643,10 +643,10 @@ MaxScale> show service RWSplit Started: Thu Apr 20 09:45:13 2017 Root user access: Disabled Backend databases: - [127.0.0.1]:3000 Protocol: MySQLBackend Name: server1 - [127.0.0.1]:3001 Protocol: MySQLBackend Name: server2 - [127.0.0.1]:3002 Protocol: MySQLBackend Name: server3 - [127.0.0.1]:3003 Protocol: MySQLBackend Name: server4 + [127.0.0.1]:3000 Protocol: MariaDBBackend Name: server1 + [127.0.0.1]:3001 Protocol: MariaDBBackend Name: server2 + [127.0.0.1]:3002 Protocol: MariaDBBackend Name: server3 + [127.0.0.1]:3003 Protocol: MariaDBBackend Name: server4 Total connections: 1 Currently connected: 1 MaxScale> @@ -740,7 +740,7 @@ MaxScale> show server server2 Server 0x6501d0 (server2) Server: 127.0.0.1 Status: Slave, Running - Protocol: MySQLBackend + Protocol: MariaDBBackend Port: 3001 Server Version: 10.1.22-MariaDB Node Id: 3001 @@ -935,7 +935,7 @@ DCB: 0x7fffdc014590 Service: RWSplit Server name/IP: 127.0.0.1 Port number: 3000 - Protocol: MySQLBackend + Protocol: MariaDBBackend Server status: Master, Running Role: Backend Request Handler Statistics: @@ -1225,11 +1225,11 @@ Module Name | Module Type | Version | API | Status ----------------+-----------------+---------+-------+------------------------- qc_sqlite | QueryClassifier | V1.0.0 | 1.1.0 | Beta 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 maxscaled | Protocol | V2.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 schemarouter | Router | V1.0.0 | 2.0.0 | Beta readwritesplit | Router | V1.1.0 | 2.0.0 | GA @@ -1379,7 +1379,7 @@ Parameters: NAME Server name HOST Server host address PORT Server port (default 3306) -PROTOCOL Server protocol (default MySQLBackend) +PROTOCOL Server protocol (default MariaDBBackend) AUTHENTICATOR Authenticator module name (default MySQLAuth) OPTIONS Comma separated list of options for the authenticator @@ -1513,7 +1513,7 @@ SERVICE Service where this listener is added NAME Listener name HOST Listener host address (default [::]) PORT Listener port (default 3306) -PROTOCOL Listener protocol (default MySQLClient) +PROTOCOL Listener protocol (default MariaDBClient) AUTHENTICATOR Authenticator module name (default MySQLAuth) OPTIONS Options for the authenticator module SSL_KEY Path to SSL private key diff --git a/Documentation/Tutorials/Avrorouter-Tutorial.md b/Documentation/Tutorials/Avrorouter-Tutorial.md index 0e348965e..876a4c4dc 100644 --- a/Documentation/Tutorials/Avrorouter-Tutorial.md +++ b/Documentation/Tutorials/Avrorouter-Tutorial.md @@ -62,7 +62,7 @@ source=replication-service [replication-listener] type=listener service=replication-service -protocol=MySQLClient +protocol=MariaDBClient port=3306 # The client listener for the avro-service diff --git a/Documentation/Tutorials/Filter-Tutorial.md b/Documentation/Tutorials/Filter-Tutorial.md index c1dc17395..8b7fe7030 100644 --- a/Documentation/Tutorials/Filter-Tutorial.md +++ b/Documentation/Tutorials/Filter-Tutorial.md @@ -138,7 +138,7 @@ Add this server into the MariaDB MaxScale configuration and create a service tha type=server address=192.168.4.28 port=3306 -protocol=MySQLBackend +protocol=MariaDBBackend [Cassandra] type=service diff --git a/Documentation/Tutorials/Galera-Cluster-Connection-Routing-Tutorial.md b/Documentation/Tutorials/Galera-Cluster-Connection-Routing-Tutorial.md index d8bf975af..67eb8a17f 100644 --- a/Documentation/Tutorials/Galera-Cluster-Connection-Routing-Tutorial.md +++ b/Documentation/Tutorials/Galera-Cluster-Connection-Routing-Tutorial.md @@ -120,7 +120,7 @@ service=Galera 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 +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. @@ -128,7 +128,7 @@ and/or a socket within the file system. [Galera Listener] type=listener service=Galera Service -protocol=MySQLClient +protocol=MariaDBClient port=4306 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 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. +all database connections in MariaDBBackend. ``` [dbserv1] type=server address=192.168.2.1 port=3306 -protocol=MySQLBackend +protocol=MariaDBBackend [dbserv2] type=server address=192.168.2.2 port=3306 -protocol=MySQLBackend +protocol=MariaDBBackend [dbserv3] type=server address=192.168.2.3 port=3306 -protocol=MySQLBackend +protocol=MariaDBBackend ``` 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 ---------------------+--------------------+-----------------+-------+-------- -Galera Service | MySQLClient | * | 4306 | Running +Galera Service | MariaDBClient | * | 4306 | Running CLI | maxscaled | localhost | 6603 | Running ---------------------+--------------------+-----------------+-------+-------- % diff --git a/Documentation/Tutorials/Galera-Cluster-Read-Write-Splitting-Tutorial.md b/Documentation/Tutorials/Galera-Cluster-Read-Write-Splitting-Tutorial.md index da3a8a74b..34f3006db 100644 --- a/Documentation/Tutorials/Galera-Cluster-Read-Write-Splitting-Tutorial.md +++ b/Documentation/Tutorials/Galera-Cluster-Read-Write-Splitting-Tutorial.md @@ -71,39 +71,39 @@ type=listener 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] type=listener service=Splitter Service -protocol=MySQLClient +protocol=MariaDBClient port=3306 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. -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] type=server address=192.168.2.1 port=3306 -protocol=MySQLBackend +protocol=MariaDBBackend [dbserv2] type=server address=192.168.2.2 port=3306 -protocol=MySQLBackend +protocol=MariaDBBackend [dbserv3] type=server address=192.168.2.3 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. @@ -194,7 +194,7 @@ Listeners. ---------------------+--------------------+-----------------+-------+-------- Service Name | Protocol Module | Address | Port | State ---------------------+--------------------+-----------------+-------+-------- -Splitter Service | MySQLClient | * | 3306 | Running +Splitter Service | MariaDBClient | * | 3306 | Running CLI | maxscaled | localhost | 6603 | Running ---------------------+--------------------+-----------------+-------+-------- ``` diff --git a/Documentation/Tutorials/MaxScale-Information-Schema.md b/Documentation/Tutorials/MaxScale-Information-Schema.md index a753e4220..ab4bf9791 100644 --- a/Documentation/Tutorials/MaxScale-Information-Schema.md +++ b/Documentation/Tutorials/MaxScale-Information-Schema.md @@ -25,7 +25,7 @@ The listener section defines the protocol, port and other information needed to [MaxInfo Listener] type=listener service=MaxInfo -protocol=MySQLClient +protocol=MariaDBClient port=9003 ``` @@ -48,7 +48,7 @@ As with any other listeners within MariaDB MaxScale the listeners can be bound t [MaxInfo Listener] type=listener service=MaxInfo -protocol=MySQLClient +protocol=MariaDBClient address=localhost port=9003 ``` @@ -205,14 +205,14 @@ mysql> show listeners; +----------------+-----------------+-----------+------+---------+ | Service Name | Protocol Module | Address | Port | State | +----------------+-----------------+-----------+------+---------+ -| Test Service | MySQLClient | * | 4006 | Running | -| Split Service | MySQLClient | * | 4007 | Running | -| Filter Service | MySQLClient | * | 4008 | Running | -| Named Service | MySQLClient | * | 4010 | Running | -| QLA Service | MySQLClient | * | 4009 | Running | +| Test Service | MariaDBClient | * | 4006 | Running | +| Split Service | MariaDBClient | * | 4007 | Running | +| Filter Service | MariaDBClient | * | 4008 | Running | +| Named Service | MariaDBClient | * | 4010 | Running | +| QLA Service | MariaDBClient | * | 4009 | Running | | Debug Service | telnetd | localhost | 4242 | Running | | CLI | maxscaled | localhost | 6603 | Running | -| MaxInfo | MySQLClient | * | 9003 | Running | +| MaxInfo | MariaDBClient | * | 9003 | Running | | MaxInfo | HTTPD | * | 8003 | Running | +----------------+-----------------+-----------+------+---------+ 9 rows in set (0.02 sec) @@ -296,7 +296,7 @@ mysql> show modules; | HTTPD | Protocol | V1.0.1 | 1.0.0 | In Development | | maxscaled | Protocol | V1.0.0 | 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 | | readwritesplit | Router | V1.0.2 | 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 -[ { "Service Name" : "Test Service", "Protocol Module" : "MySQLClient", "Address" : "*", "Port" : 4006, "State" : "Running"}, -{ "Service Name" : "Split Service", "Protocol Module" : "MySQLClient", "Address" : "*", "Port" : 4007, "State" : "Running"}, -{ "Service Name" : "Filter Service", "Protocol Module" : "MySQLClient", "Address" : "*", "Port" : 4008, "State" : "Running"}, -{ "Service Name" : "Named Service", "Protocol Module" : "MySQLClient", "Address" : "*", "Port" : 4010, "State" : "Running"}, -{ "Service Name" : "QLA Service", "Protocol Module" : "MySQLClient", "Address" : "*", "Port" : 4009, "State" : "Running"}, +[ { "Service Name" : "Test Service", "Protocol Module" : "MariaDBClient", "Address" : "*", "Port" : 4006, "State" : "Running"}, +{ "Service Name" : "Split Service", "Protocol Module" : "MariaDBClient", "Address" : "*", "Port" : 4007, "State" : "Running"}, +{ "Service Name" : "Filter Service", "Protocol Module" : "MariaDBClient", "Address" : "*", "Port" : 4008, "State" : "Running"}, +{ "Service Name" : "Named Service", "Protocol Module" : "MariaDBClient", "Address" : "*", "Port" : 4010, "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" : "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"}] $ ``` @@ -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" : "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" : "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" : "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"}, diff --git a/Documentation/Tutorials/MySQL-Cluster-Setup.md b/Documentation/Tutorials/MySQL-Cluster-Setup.md index aa26c05c7..207f89933 100644 --- a/Documentation/Tutorials/MySQL-Cluster-Setup.md +++ b/Documentation/Tutorials/MySQL-Cluster-Setup.md @@ -229,7 +229,7 @@ version_string=5.5.37-CLUSTER [Cluster Listener] type=listener service=Cluster Service -protocol=MySQLClient +protocol=MariaDBClient port=4906 [NDB Cluster Monitor] @@ -246,14 +246,14 @@ monitor_interval=8000 type=server address=127.0.0.1 port=3306 -protocol=MySQLBackend +protocol=MariaDBBackend [server2] #SQL node2 type=server address=162.243.90.81 port=3306 -protocol=MySQLBackend +protocol=MariaDBBackend ``` Assuming MariaDB MaxScale is installed in server1, start it. @@ -283,7 +283,7 @@ Server 0x3873b40 (server1) Server: 127.0.0.1 Status: NDB, Running -Protocol: MySQLBackend +Protocol: MariaDBBackend Port: 3306 Server Version: 5.5.38-ndb-7.2.17-cluster-gpl Node Id: 22 @@ -297,7 +297,7 @@ Server 0x3873a40 (server2) Server: 162.243.90.81 Status: NDB, Running -Protocol: MySQLBackend +Protocol: MariaDBBackend Port: 3306 Server Version: 5.5.38-ndb-7.2.17-cluster-gpl Node Id: 23 diff --git a/Documentation/Tutorials/MySQL-Replication-Connection-Routing-Tutorial.md b/Documentation/Tutorials/MySQL-Replication-Connection-Routing-Tutorial.md index 5ad3e53f6..376a0c33d 100644 --- a/Documentation/Tutorials/MySQL-Replication-Connection-Routing-Tutorial.md +++ b/Documentation/Tutorials/MySQL-Replication-Connection-Routing-Tutorial.md @@ -106,45 +106,45 @@ type=listener 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] type=listener service=Write-Service -protocol=MySQLClient +protocol=MariaDBClient port=4306 socket=/tmp/ClusterMaster [Read-Listener] type=listener service=Read-Service -protocol=MySQLClient +protocol=MariaDBClient 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. -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] type=server address=192.168.2.1 port=3306 -protocol=MySQLBackend +protocol=MariaDBBackend [dbserv2] type=server address=192.168.2.2 port=3306 -protocol=MySQLBackend +protocol=MariaDBBackend [dbserv3] type=server address=192.168.2.3 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. @@ -220,8 +220,8 @@ Listeners. ---------------------+--------------------+-----------------+-------+-------- Service Name | Protocol Module | Address | Port | State ---------------------+--------------------+-----------------+-------+-------- -Read Service | MySQLClient | * | 4307 | Running -Write Service | MySQLClient | * | 4306 | Running +Read Service | MariaDBClient | * | 4307 | Running +Write Service | MariaDBClient | * | 4306 | Running CLI | maxscaled | localhost | 6603 | Running ---------------------+--------------------+-----------------+-------+-------- ``` diff --git a/Documentation/Tutorials/MySQL-Replication-Read-Write-Splitting-Tutorial.md b/Documentation/Tutorials/MySQL-Replication-Read-Write-Splitting-Tutorial.md index 711a566e4..2a74b4022 100644 --- a/Documentation/Tutorials/MySQL-Replication-Read-Write-Splitting-Tutorial.md +++ b/Documentation/Tutorials/MySQL-Replication-Read-Write-Splitting-Tutorial.md @@ -106,7 +106,7 @@ 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 +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. @@ -114,7 +114,7 @@ and/or a socket within the file system. [Splitter Listener] type=listener service=Splitter Service -protocol=MySQLClient +protocol=MariaDBClient port=3306 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 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 -connections is `MySQLBackend`. +connections is `MariaDBBackend`. ``` [dbserv1] type=server address=192.168.2.1 port=3306 -protocol=MySQLBackend +protocol=MariaDBBackend [dbserv2] type=server address=192.168.2.2 port=3306 -protocol=MySQLBackend +protocol=MariaDBBackend [dbserv3] type=server address=192.168.2.3 port=3306 -protocol=MySQLBackend +protocol=MariaDBBackend ``` 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 Services. - --------------------------+----------------------+--------+--------------- - Service Name | Router Module | #Users | Total Sessions - --------------------------+----------------------+--------+--------------- - Splitter Service | readwritesplit | 1 | 1 - CLI | cli | 2 | 2 - --------------------------+----------------------+--------+--------------- % maxadmin list servers Servers. - -------------------+-----------------+-------+-------------+-------------------- - Server | Address | Port | Connections | Status - -------------------+-----------------+-------+-------------+-------------------- - dbserv1 | 192.168.2.1 | 3306 | 0 | Running, Slave - dbserv2 | 192.168.2.2 | 3306 | 0 | Running, Master - dbserv3 | 192.168.2.3 | 3306 | 0 | Running, Slave - -------------------+-----------------+-------+-------------+-------------------- % maxadmin list listeners Listeners. - ---------------------+--------------------+-----------------+-------+-------- - Service Name | Protocol Module | Address | Port | State - ---------------------+--------------------+-----------------+-------+-------- - -Splitter Service | MySQLClient | * | 3306 | Running - +Splitter Service | MariaDBClient | * | 3306 | Running CLI | maxscaled | localhost | 6603 | Running - ---------------------+--------------------+-----------------+-------+-------- ``` diff --git a/Documentation/Tutorials/RabbitMQ-And-Tee-Archiving.md b/Documentation/Tutorials/RabbitMQ-And-Tee-Archiving.md index 9c9fd3c33..0f11419f2 100644 --- a/Documentation/Tutorials/RabbitMQ-And-Tee-Archiving.md +++ b/Documentation/Tutorials/RabbitMQ-And-Tee-Archiving.md @@ -80,13 +80,13 @@ servers to the configuration file. type=server address=192.168.0.200 port=3306 -protocol=MySQLBackend +protocol=MariaDBBackend [archive-1] type=server address=192.168.0.201 port=3000 -protocol=MySQLBackend +protocol=MariaDBBackend ``` 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] type=listener service=Production -protocol=MySQLClient +protocol=MariaDBClient port=4000 [Archive Listener] type=listener service=Archive -protocol=MySQLClient +protocol=MariaDBClient port=4001 ``` @@ -224,13 +224,13 @@ Here is the complete configuration file. type=server address=192.168.0.200 port=3306 -protocol=MySQLBackend +protocol=MariaDBBackend [archive-1] type=server address=192.168.0.201 port=3000 -protocol=MySQLBackend +protocol=MariaDBBackend # MySQL server monitor [MySQL Monitor] @@ -263,13 +263,13 @@ filters=MQ Filter [Production Listener] type=listener service=Production -protocol=MySQLClient +protocol=MariaDBClient port=4000 [Archive Listener] type=listener service=Archive -protocol=MySQLClient +protocol=MariaDBClient port=4001 # Tee filter to duplicate insert, update and delete diff --git a/Documentation/Tutorials/Replication-Proxy-Binlog-Router-Tutorial.md b/Documentation/Tutorials/Replication-Proxy-Binlog-Router-Tutorial.md index 5aaef9552..f81c295c6 100644 --- a/Documentation/Tutorials/Replication-Proxy-Binlog-Router-Tutorial.md +++ b/Documentation/Tutorials/Replication-Proxy-Binlog-Router-Tutorial.md @@ -159,12 +159,12 @@ commands on the listener. [Replication Listener] type=listener service=Replication -protocol=MySQLClient +protocol=MariaDBClient port=3306 ``` 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. 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] type=listener service=Replication -protocol=MySQLClient +protocol=MariaDBClient port=3306 ssl=required ssl_key=/path/to/key.pem @@ -485,7 +485,7 @@ currently connected. Started: Thu Jan 29 16:06:11 2015 Root user access: Disabled Backend databases - 178.62.50.70:3306 Protocol: MySQLBackend + 178.62.50.70:3306 Protocol: MariaDBBackend Users data: 0x156c030 Total connections: 2 Currently connected: 2 diff --git a/Documentation/Tutorials/Simple-Sharding-Tutorial.md b/Documentation/Tutorials/Simple-Sharding-Tutorial.md index f4f604e8e..a9984a578 100644 --- a/Documentation/Tutorials/Simple-Sharding-Tutorial.md +++ b/Documentation/Tutorials/Simple-Sharding-Tutorial.md @@ -58,7 +58,7 @@ After this we configure a listener for the service. The listener is the actual p [Sharded Service Listener] type=listener service=Sharded Service -protocol=MySQLClient +protocol=MariaDBClient port=4000 ```