MXS-2214: Fix object names in documentation
The object names now always use a valid and supported form.
This commit is contained in:
Markus Mäkelä
@ -126,7 +126,7 @@ soft_ttl=20
|
||||
rules=...
|
||||
...
|
||||
|
||||
[Cached Routing Service]
|
||||
[Cached-Routing-Service]
|
||||
type=service
|
||||
...
|
||||
filters=Cache
|
||||
|
||||
@ -64,7 +64,7 @@ type=filter
|
||||
module=dbfwfilter
|
||||
rules=/home/user/rules.txt
|
||||
|
||||
[Firewalled Routing Service]
|
||||
[Firewalled-Routing-Service]
|
||||
type=service
|
||||
router=readconnrouter
|
||||
servers=server1
|
||||
|
||||
@ -19,7 +19,7 @@ The Maxrows filter is easy to configure and to add to any existing service.
|
||||
type=filter
|
||||
module=maxrows
|
||||
|
||||
[MaxRows Routing Service]
|
||||
[MaxRows-Routing-Service]
|
||||
type=service
|
||||
...
|
||||
filters=MaxRows
|
||||
|
||||
@ -184,7 +184,7 @@ match=SELECT.*from.*PRODUCTS .*
|
||||
exclude=WHERE.*PRODUCT_ID.*
|
||||
filebase=/var/logs/qla/SelectProducts
|
||||
|
||||
[Product Service]
|
||||
[Product-Service]
|
||||
type=service
|
||||
router=readconnrouter
|
||||
servers=server1
|
||||
|
||||
@ -39,7 +39,7 @@ logging_object=my1
|
||||
logging_schema=test
|
||||
logging_source_user=maxtest
|
||||
|
||||
[RabbitMQ Service]
|
||||
[RabbitMQ-Service]
|
||||
type=service
|
||||
router=readconnrouter
|
||||
servers=server1
|
||||
|
||||
@ -22,7 +22,7 @@ type=filter
|
||||
module=tee
|
||||
service=DataMart
|
||||
|
||||
[Data Service]
|
||||
[Data-Service]
|
||||
type=service
|
||||
router=readconnrouter
|
||||
servers=server1
|
||||
@ -153,20 +153,20 @@ router=readconnroute
|
||||
servers=datamartserver
|
||||
user=massi
|
||||
password=6628C50E07CCE1F0392EDEEB9D1203F3
|
||||
filters=QLA_DataMart
|
||||
filters=QLA-DataMart
|
||||
|
||||
[QLA_DataMart]
|
||||
[QLA-DataMart]
|
||||
type=filter
|
||||
module=qlafilter
|
||||
options=/var/log/DataMart/InsertsLog
|
||||
|
||||
[Orders Listener]
|
||||
[Orders-Listener]
|
||||
type=listener
|
||||
service=Orders
|
||||
protocol=MariaDBClient
|
||||
port=4011
|
||||
|
||||
[DataMart Listener]
|
||||
[DataMart-Listener]
|
||||
type=listener
|
||||
service=DataMart
|
||||
protocol=MariaDBClient
|
||||
|
||||
@ -27,7 +27,7 @@ max_qps = 500
|
||||
throttling_duration = 60000
|
||||
...
|
||||
|
||||
[Routing Service]
|
||||
[Routing-Service]
|
||||
type = service
|
||||
filters = Throttle
|
||||
```
|
||||
|
||||
@ -194,7 +194,7 @@ filebase=/var/logs/top/ControlAppServer
|
||||
In the service definition add both filters
|
||||
|
||||
```
|
||||
[App Service]
|
||||
[App-Service]
|
||||
type=service
|
||||
router=readconnrouter
|
||||
servers=server1
|
||||
|
||||
@ -128,7 +128,7 @@ query_delimiter=@@@
|
||||
filename=/var/logs/tpm/perf.log
|
||||
named_pipe=/tmp/tpmfilter
|
||||
|
||||
[Product Service]
|
||||
[Product-Service]
|
||||
type=service
|
||||
router=readconnrouter
|
||||
servers=server1
|
||||
|
||||
@ -975,7 +975,7 @@ A service is identified by a service name, which is the name of the
|
||||
configuration file section and a type parameter of service.
|
||||
|
||||
```
|
||||
[Test Service]
|
||||
[Test-Service]
|
||||
type=service
|
||||
```
|
||||
|
||||
@ -1214,7 +1214,7 @@ port=3001
|
||||
protocol=MariaDBBackend
|
||||
serv_weight=1
|
||||
|
||||
[Read Service]
|
||||
[Read-Service]
|
||||
type=service
|
||||
router=readconnroute
|
||||
servers=server1,server2
|
||||
@ -1284,7 +1284,7 @@ as if the parameter is not defined.
|
||||
Example:
|
||||
|
||||
```
|
||||
[Test Service]
|
||||
[Test-Service]
|
||||
connection_timeout=300
|
||||
```
|
||||
|
||||
@ -1298,7 +1298,7 @@ connections" error being returned.
|
||||
Example:
|
||||
|
||||
```
|
||||
[Test Service]
|
||||
[Test-Service]
|
||||
max_connections=100
|
||||
```
|
||||
|
||||
@ -1325,10 +1325,10 @@ as no parsing is needed on MaxScale.
|
||||
This is only supported by MariaDB versions 10.3 or newer. Default is false.
|
||||
The following Server side config is needed too.
|
||||
|
||||
```
|
||||
session_track_state_change = ON
|
||||
session_track_transaction_info = CHARACTERISTICS
|
||||
```
|
||||
```
|
||||
session_track_state_change = ON
|
||||
session_track_transaction_info = CHARACTERISTICS
|
||||
```
|
||||
|
||||
#### `retain_last_statements`
|
||||
|
||||
@ -1342,6 +1342,7 @@ turn it off for a specific service, or just enable it for specific services.
|
||||
|
||||
The value of this parameter can be changed at runtime using `maxctrl` and the
|
||||
new value will take effect for sessions created thereafter.
|
||||
|
||||
```
|
||||
maxctrl alter service MyService retain_last_statements 5
|
||||
```
|
||||
@ -1864,7 +1865,7 @@ MariaDB MaxScale will determine this as an encrypted password and automatically
|
||||
it before sending it the database server.
|
||||
|
||||
```
|
||||
[Split Service]
|
||||
[Split-Service]
|
||||
type=service
|
||||
router=readwritesplit
|
||||
servers=server1,server2,server3,server4
|
||||
@ -2078,7 +2079,7 @@ configuration update is required as well.
|
||||
Example:
|
||||
|
||||
```
|
||||
[Galera Listener]
|
||||
[Galera-Listener]
|
||||
type=listener
|
||||
address=192.168.3.33
|
||||
port=4408
|
||||
|
||||
@ -19,7 +19,7 @@ and a username and a password to connect to these servers. The user requires the
|
||||
REPLICATION CLIENT privilege to successfully monitor the state of the servers.
|
||||
|
||||
```
|
||||
[Galera Monitor]
|
||||
[Galera-Monitor]
|
||||
type=monitor
|
||||
module=galeramon
|
||||
servers=server1,server2,server3
|
||||
|
||||
@ -15,7 +15,7 @@ and a password to connect to these servers. The user requires the REPLICATION CL
|
||||
to successfully monitor the state of the servers.
|
||||
|
||||
```
|
||||
[Multi-Master Monitor]
|
||||
[Multi-Master-Monitor]
|
||||
type=monitor
|
||||
module=mmmon
|
||||
servers=server1,server2,server3
|
||||
|
||||
@ -819,7 +819,7 @@ Here is a monitor configuration that only triggers the script when a master
|
||||
or a slave server goes down.
|
||||
|
||||
```
|
||||
[Database Monitor]
|
||||
[Database-Monitor]
|
||||
type=monitor
|
||||
module=mariadbmon
|
||||
servers=server1,server2
|
||||
|
||||
@ -11,13 +11,12 @@ The MySQL Cluster Monitor is a monitoring module for MaxScale that monitors a My
|
||||
A minimal configuration for a monitor requires a set of servers for monitoring and a username and a password to connect to these servers. The user requires the REPLICATION CLIENT privilege to successfully monitor the state of the servers.
|
||||
|
||||
```
|
||||
[MySQL Cluster Monitor]
|
||||
[MySQL-Cluster-Monitor]
|
||||
type=monitor
|
||||
module=ndbclustermon
|
||||
servers=server1,server2,server3
|
||||
user=myuser
|
||||
password=mypwd
|
||||
|
||||
```
|
||||
|
||||
### Common Monitor Parameters
|
||||
|
||||
@ -8,7 +8,7 @@ needs to be configured and the filter needs to be applied to the service.
|
||||
Here is an example service which has the hint filter configured and applied.
|
||||
|
||||
```
|
||||
[Read Service]
|
||||
[Read-Service]
|
||||
type=service
|
||||
router=readconnroute
|
||||
router_options=master
|
||||
|
||||
@ -58,13 +58,13 @@ An example configuration looks as follows:
|
||||
type=service
|
||||
router=cli
|
||||
|
||||
[MaxAdmin Unix Listener]
|
||||
[MaxAdmin-Unix-Listener]
|
||||
type=listener
|
||||
service=MaxAdmin
|
||||
protocol=maxscaled
|
||||
socket=default
|
||||
|
||||
[MaxAdmin Inet Listener]
|
||||
[MaxAdmin-Inet-Listener]
|
||||
type=listener
|
||||
service=MaxAdmin
|
||||
protocol=maxscaled
|
||||
|
||||
@ -17,14 +17,14 @@ type=service
|
||||
router=cli
|
||||
|
||||
# Unix Domain Socket
|
||||
[CLI Unix Listener]
|
||||
[CLI-Unix-Listener]
|
||||
type=listener
|
||||
service=CLI
|
||||
protocol=maxscaled
|
||||
socket=default
|
||||
|
||||
# Internet Socket
|
||||
[CLI Inet Listener]
|
||||
[CLI-Inet-Listener]
|
||||
type=listener
|
||||
service=CLI
|
||||
protocol=maxscaled
|
||||
|
||||
@ -7,11 +7,11 @@ The **debugcli** router is a special kind of statement based router. Rather than
|
||||
The definition of the debug cli service is illustrated below
|
||||
|
||||
```
|
||||
[Debug Service]
|
||||
[Debug-Service]
|
||||
type=service
|
||||
router=debugcli
|
||||
|
||||
[Debug Listener]
|
||||
[Debug-Listener]
|
||||
type=listener
|
||||
service=Debug Service
|
||||
protocol=telnetd
|
||||
|
||||
@ -70,7 +70,7 @@ servers after session creation.
|
||||
A minimal configuration doesn't require any parameters as all settings have
|
||||
reasonable defaults.
|
||||
```
|
||||
[Routing Service]
|
||||
[Routing-Service]
|
||||
type=service
|
||||
router=hintrouter
|
||||
servers=slave1,slave2,slave3
|
||||
@ -79,7 +79,7 @@ servers=slave1,slave2,slave3
|
||||
If packets should be routed to the master server by default and only a few
|
||||
connections are required, the configuration might be as follows.
|
||||
```
|
||||
[Routing Service]
|
||||
[Routing-Service]
|
||||
type=service
|
||||
router=hintrouter
|
||||
servers=MyMaster, slave1,slave2,slave3,slave4,slave5,slave6,slave7
|
||||
|
||||
@ -62,7 +62,7 @@ To configure a read-only service that tolerates master failures, we first
|
||||
need to add a new section in to the configuration file.
|
||||
|
||||
```
|
||||
[Read Service]
|
||||
[Read-Service]
|
||||
type=service
|
||||
router=readconnroute
|
||||
servers=slave1,slave2,slave3
|
||||
|
||||
@ -136,7 +136,7 @@ In above-mentioned case the user-defined variable would only be updated in the
|
||||
master where the query would be routed to due to the `INSERT` statement.
|
||||
|
||||
```
|
||||
[Splitter Service]
|
||||
[Splitter-Service]
|
||||
type=service
|
||||
router=readwritesplit
|
||||
servers=dbserv1, dbserv2, dbserv3
|
||||
|
||||
@ -55,7 +55,7 @@ configuration in the next chapter.
|
||||
Here is an example configuration of the schemarouter:
|
||||
|
||||
```
|
||||
[Shard Router]
|
||||
[Shard-Router]
|
||||
type=service
|
||||
router=schemarouter
|
||||
servers=server1,server2
|
||||
@ -125,7 +125,7 @@ defined as parameters. The values defined in _router_options_ will have priority
|
||||
over the parameters.
|
||||
|
||||
```
|
||||
[Shard Router]
|
||||
[Shard-Router]
|
||||
type=service
|
||||
router=schemarouter
|
||||
servers=server1,server2
|
||||
|
||||
@ -73,7 +73,7 @@ port=4001
|
||||
type=service
|
||||
router=cli
|
||||
|
||||
[CLI Listener]
|
||||
[CLI-Listener]
|
||||
type=listener
|
||||
service=CLI
|
||||
protocol=maxscaled
|
||||
|
||||
@ -46,7 +46,7 @@ The type is used by the configuration manager within MariaDB MaxScale to determi
|
||||
|
||||
When a filter is used within a service in MariaDB MaxScale the entry filters= is added to the service definition in the ini file section for the service. Multiple filters can be defined using a syntax akin to the Linux shell pipe syntax.
|
||||
```
|
||||
[Split Service]
|
||||
[Split-Service]
|
||||
type=service
|
||||
router=readwritesplit
|
||||
servers=dbserver1,dbserver2,dbserver3,dbserver4
|
||||
|
||||
@ -44,7 +44,7 @@ security the password can be encrypted as explained
|
||||
[here](../Getting-Started/Configuration-Guide.md#encrypting-passwords).
|
||||
|
||||
```
|
||||
[MaxInfo Listener]
|
||||
[MaxInfo-Listener]
|
||||
type=listener
|
||||
service=MaxInfo
|
||||
protocol=MariaDBClient
|
||||
@ -55,7 +55,7 @@ To listen with the HTTP protocol and hence return JSON documents a section
|
||||
as shown below is required.
|
||||
|
||||
```
|
||||
[MaxInfo JSON Listener]
|
||||
[MaxInfo-JSON-Listener]
|
||||
type=listener
|
||||
service=MaxInfo
|
||||
protocol=HTTPD
|
||||
@ -72,7 +72,7 @@ allows the access to the maxinfo data to be limited to the localhost by
|
||||
adding an address=localhost parameter in the configuration file.
|
||||
|
||||
```
|
||||
[MaxInfo Listener]
|
||||
[MaxInfo-Listener]
|
||||
type=listener
|
||||
service=MaxInfo
|
||||
protocol=MariaDBClient
|
||||
|
||||
@ -217,7 +217,7 @@ mysql> select count(1) from test.t1;
|
||||
Add these sections into the maxscale.cnf config file:
|
||||
|
||||
```
|
||||
[Cluster Service]
|
||||
[Cluster-Service]
|
||||
type=service
|
||||
router=readconnroute
|
||||
router_options=ndb
|
||||
@ -226,13 +226,13 @@ user=test
|
||||
password=test
|
||||
version_string=5.5.37-CLUSTER
|
||||
|
||||
[Cluster Listener]
|
||||
[Cluster-Listener]
|
||||
type=listener
|
||||
service=Cluster Service
|
||||
service=Cluster-Service
|
||||
protocol=MariaDBClient
|
||||
port=4906
|
||||
|
||||
[NDB Cluster Monitor]
|
||||
[NDB-Cluster-Monitor]
|
||||
type=monitor
|
||||
module=ndbclustermon
|
||||
servers=server1,server2
|
||||
@ -241,7 +241,6 @@ password=monitor
|
||||
monitor_interval=8000
|
||||
|
||||
[server1]
|
||||
|
||||
#SQL node1
|
||||
type=server
|
||||
address=127.0.0.1
|
||||
|
||||
@ -94,7 +94,7 @@ module for those servers. This module will detect if connectivity to the servers
|
||||
is lost and notify MariaDB MaxScale of the changed server states.
|
||||
|
||||
```
|
||||
[MySQL Monitor]
|
||||
[MySQL-Monitor]
|
||||
type=monitor
|
||||
module=mariadbmon
|
||||
servers=production-1, archive-1
|
||||
@ -129,7 +129,7 @@ router=readconnroute
|
||||
servers=archive-1
|
||||
user=maxuser
|
||||
password=maxpwd
|
||||
filters=MQ Filter
|
||||
filters=MQ-Filter
|
||||
```
|
||||
|
||||
The `filters` parameters for the services refer to the filters we will be creating next.
|
||||
@ -142,13 +142,13 @@ use the `archive-1` server. Both services user the `maxuser` user with the `maxp
|
||||
Next we will configure the listeners for these two services.
|
||||
|
||||
```
|
||||
[Production Listener]
|
||||
[Production-Listener]
|
||||
type=listener
|
||||
service=Production
|
||||
protocol=MariaDBClient
|
||||
port=4000
|
||||
|
||||
[Archive Listener]
|
||||
[Archive-Listener]
|
||||
type=listener
|
||||
service=Archive
|
||||
protocol=MariaDBClient
|
||||
@ -180,7 +180,7 @@ After the Tee filter is configured, we will configure the Mqfilter to communicat
|
||||
the RabbitMQ server we've set up.
|
||||
|
||||
```
|
||||
[MQ Filter]
|
||||
[MQ-Filter]
|
||||
type=filter
|
||||
module=mqfilter
|
||||
hostname=192.168.0.201
|
||||
@ -201,13 +201,13 @@ in the `mxs-queue-1` queue.
|
||||
The last thing to add is the administration interface.
|
||||
|
||||
```
|
||||
[MaxAdmin Service]
|
||||
[MaxAdmin-Service]
|
||||
type=service
|
||||
router=cli
|
||||
|
||||
[MaxAdmin Listener]
|
||||
[MaxAdmin-Listener]
|
||||
type=listener
|
||||
service=MaxAdmin Service
|
||||
service=MaxAdmin-Service
|
||||
protocol=maxscaled
|
||||
socket=default
|
||||
```
|
||||
@ -233,7 +233,7 @@ port=3000
|
||||
protocol=MariaDBBackend
|
||||
|
||||
# MySQL server monitor
|
||||
[MySQL Monitor]
|
||||
[MySQL-Monitor]
|
||||
type=monitor
|
||||
module=mariadbmon
|
||||
servers=production-1, archive-1
|
||||
@ -257,16 +257,16 @@ router=readconnroute
|
||||
servers=archive-1
|
||||
user=maxuser
|
||||
password=maxpwd
|
||||
filters=MQ Filter
|
||||
filters=MQ-Filter
|
||||
|
||||
# Listeners for the services
|
||||
[Production Listener]
|
||||
[Production-Listener]
|
||||
type=listener
|
||||
service=Production
|
||||
protocol=MariaDBClient
|
||||
port=4000
|
||||
|
||||
[Archive Listener]
|
||||
[Archive-Listener]
|
||||
type=listener
|
||||
service=Archive
|
||||
protocol=MariaDBClient
|
||||
@ -282,7 +282,7 @@ match=\(insert\)\|\(update\)\|\(delete\)
|
||||
|
||||
# Mqfilter to log the canonical versions of the archive
|
||||
# server queries to a RabbitMQ broker
|
||||
[MQ Filter]
|
||||
[MQ-Filter]
|
||||
type=filter
|
||||
module=mqfilter
|
||||
hostname=192.168.0.201
|
||||
@ -294,13 +294,13 @@ queue=msg-queue-1
|
||||
key=MaxScale
|
||||
|
||||
# Administration interface setup
|
||||
[MaxAdmin Service]
|
||||
[MaxAdmin-Service]
|
||||
type=service
|
||||
router=cli
|
||||
|
||||
[MaxAdmin Listener]
|
||||
[MaxAdmin-Listener]
|
||||
type=listener
|
||||
service=MaxAdmin Service
|
||||
service=MaxAdmin-Service
|
||||
protocol=maxscaled
|
||||
socket=default
|
||||
```
|
||||
|
||||
@ -177,7 +177,7 @@ Content-type: text/plain
|
||||
The new filter needs to be configured in maxscale.cnf.
|
||||
|
||||
```
|
||||
[Test Service]
|
||||
[Test-Service]
|
||||
type=service
|
||||
router=readconnroute
|
||||
router_options=slave
|
||||
|
||||
@ -156,7 +156,7 @@ or from a MySQL client. The binlogrouter is administered and configured via SQL
|
||||
commands on the listener.
|
||||
|
||||
```
|
||||
[Replication Listener]
|
||||
[Replication-Listener]
|
||||
type=listener
|
||||
service=Replication
|
||||
protocol=MariaDBClient
|
||||
@ -171,7 +171,7 @@ It's also possible to enable client side SSL by adding the required SSL options
|
||||
in the listener:
|
||||
|
||||
```
|
||||
[Replication SSL Listener]
|
||||
[Replication-SSL-Listener]
|
||||
type=listener
|
||||
service=Replication
|
||||
protocol=MariaDBClient
|
||||
|
||||
@ -44,7 +44,7 @@ port=3306
|
||||
The next step is to configure the service which the users connect to. This section defines which router to use, which servers to connect to and the credentials to use. The router we use in this tutorial is the `schemarouter`.
|
||||
|
||||
```
|
||||
[Sharded Service]
|
||||
[Sharded-Service]
|
||||
type=service
|
||||
router=schemarouter
|
||||
servers=accounts_west,accounts_east
|
||||
@ -55,9 +55,9 @@ password=YqztlYGDvZ8tVMe3GUm9XCwQi
|
||||
After this we configure a listener for the service. The listener is the actual port the user connects to. We will use the port 4000.
|
||||
|
||||
```
|
||||
[Sharded Service Listener]
|
||||
[Sharded-Service-Listener]
|
||||
type=listener
|
||||
service=Sharded Service
|
||||
service=Sharded-Service
|
||||
protocol=MariaDBClient
|
||||
port=4000
|
||||
```
|
||||
@ -65,7 +65,7 @@ port=4000
|
||||
The final step is to configure a monitor which will monitor the state of the servers. The monitor will notify MariaDB MaxScale if the servers are down. We add the two servers to the monitor, define the credentials to use and we set the monitoring cycle interval.
|
||||
|
||||
```
|
||||
[MySQL Monitor]
|
||||
[MySQL-Monitor]
|
||||
type=monitor
|
||||
module=mariadbmon
|
||||
servers=accounts_west,accounts_east
|
||||
|
||||
@ -39,7 +39,7 @@ the listener which is associated with that service.
|
||||
Here is an example of an old style configuration.
|
||||
|
||||
```
|
||||
[RW Split Router]
|
||||
[RW-Split-Router]
|
||||
type=service
|
||||
router=readwritesplit
|
||||
servers=server1,server2,server3,server4
|
||||
@ -51,9 +51,9 @@ ssl_key=/home/user/certs/server-key.pem
|
||||
ssl_ca_cert=/home/user/certs/ca.pem
|
||||
ssl_version=TLSv12
|
||||
|
||||
[RW Split Listener]
|
||||
[RW-Split-Listener]
|
||||
type=listener
|
||||
service=RW Split Router
|
||||
service=RW-Split-Router
|
||||
protocol=MySQLClient
|
||||
port=3306
|
||||
```
|
||||
@ -61,16 +61,16 @@ port=3306
|
||||
And here is the new, 1.4 compatible configuration style.
|
||||
|
||||
```
|
||||
[RW Split Router]
|
||||
[RW-Split-Router]
|
||||
type=service
|
||||
router=readwritesplit
|
||||
servers=server1,server2,server3,server4
|
||||
user=jdoe
|
||||
passwd=BD26E4139A15280CA882264AA1551C70
|
||||
|
||||
[RW Split Listener]
|
||||
[RW-Split-Listener]
|
||||
type=listener
|
||||
service=RW Split Router
|
||||
service=RW-Split-Router
|
||||
protocol=MySQLClient
|
||||
port=3306
|
||||
ssl=required
|
||||
|
||||
Reference in New Issue
Block a user