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

MXS-2214: Fix object names in documentation

Browse Source 
The object names now always use a valid and supported form.
This commit is contained in:
Markus Mäkelä
2018-12-27 12:46:57 +02:00
parent ee98900685
commit 88f234fdcd
31 changed files with 79 additions and 80 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@ -73,7 +73,7 @@ port=4001
type=service
router=cli
[CLI Listener]
[CLI-Listener]
type=listener
service=CLI
protocol=maxscaled

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

@ -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

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

@ -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

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

@ -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

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

@ -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
```

2
Documentation/Tutorials/RabbitMQ-Setup-And-MaxScale-Integration.md
View File

@ -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

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

@ -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

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

@ -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