MXS-1156: Documentation update

MXS-1156: Documentation update.
Some content removed: probably added by a previous merge.
This commit is contained in:
MassimilianoPinto 2017-08-31 10:41:00 +02:00
parent e1efb91ea5
commit a0cf053102
2 changed files with 64 additions and 54 deletions

View File

@ -269,40 +269,6 @@ Example:
3;bbbbbbbbbaaaaaaabbbbbccccceeeddddd3333333ddddaaaaffffffeeeeecccd
```
A complete example of a service entry for a binlog router service would be as
follows.
```
[Replication]
type=service
router=binlogrouter
servers=masterdb
version_string=5.6.17-log
user=maxscale
passwd=Mhu87p2D
router_options=uuid=f12fcb7f-b97b-11e3-bc5e-0401152c4c22,
server_id=3,
user=repl,
password=slavepass,
master_id=32,
heartbeat=30,
binlogdir=/var/binlogs,
transaction_safety=1,
master_version=5.6.19-common,
master_hostname=common_server,
master_uuid=xxx-fff-cccc-common,
mariadb10-compatibility=1,
send_slave_heartbeat=1,
ssl_cert_verification_depth=9,
semisync=1,
encrypt_binlog=1,
encryption_algorithm=aes_ctr,
encryption_key_file=/var/binlogs/enc_key.txt,
slave_hostname=maxscale-blr-1
```
The minimum set of router options that must be given in the configuration are
`server_id` and `master_id` (unless the real master id should be used); default
values may be used for all other options.
### `mariadb10_slave_gtid`
If enabled this option allows MariaDB 10.x slave servers to connect to binlog
@ -384,6 +350,57 @@ without caring about binlog filename and sequence:
just change _host_ and _port_, the replication will
resume from last GTID MaxScale has seen.
### `master_retry_count`
This option sets the maximum number of connection retries when the master server is disconnected or not reachable.
Default value is 1000.
### `connect_retry`
The option sets the time interval for a new connection retry to master server, default value is 60 seconds.
**A complete example** of a service entry for a binlog router service would be as
follows.
```
[Replication]
type=service
router=binlogrouter
servers=masterdb
version_string=5.6.17-log
user=maxscale
passwd=Mhu87p2D
router_options=uuid=f12fcb7f-b97b-11e3-bc5e-0401152c4c22,
server_id=3,
user=repl,
password=slavepass,
master_id=32,
heartbeat=30,
binlogdir=/var/binlogs,
transaction_safety=1,
master_version=5.6.19-common,
master_hostname=common_server,
master_uuid=xxx-fff-cccc-common,
mariadb10-compatibility=1,
send_slave_heartbeat=1,
ssl_cert_verification_depth=9,
semisync=1,
encrypt_binlog=1,
encryption_algorithm=aes_ctr,
encryption_key_file=/var/binlogs/enc_key.txt,
mariadb10_slave_gtid=On,
mariadb10_master_gtid=Off,
binlog_structure=flat,
slave_hostname=maxscale-blr-1,
master_retry_count=1000,
connect_retry=60
```
The minimum set of router options that must be given in the configuration are
`server_id` and `master_id` (unless the real master id should be used); default
values may be used for all other options.
## Examples
The [Replication Proxy](../Tutorials/Replication-Proxy-Binlog-Router-Tutorial.md) tutorial will

View File

@ -38,22 +38,6 @@ The minimum set of router options that must be given in the configuration are ar
Additional information about the encryption of the Binlog files can be found here:
[Binlogrouter - The replication protocol proxy module for MariaDB MaxScale](../Routers/Binlogrouter.md).
### `mariadb10_slave_gtid`
If enabled this option allows MariaDB 10.x slave servers to connect to binlog
server using GTID value instead of binlog_file name and position. Default option value is _off_.
### `mariadb10_master_gtid`
This option allows MaxScale binlog router to register with MariaDB 10.X
master using GTID instead of binlog_file name and position in CHANGE MASTER TO admin command.
Default option value is _off_.
### `binlog_structure`
This option controls the way binlog files are saved in the binlogdir: there are two
possible values, _flat_ or _tree_. The _tree_ structure easily allows the changing of
the master server without caring about binlog filename and sequence.
Default option value is _flat_.
A **complete example** of a service entry for a binlog router service would be as follows.
@ -84,7 +68,10 @@ A **complete example** of a service entry for a binlog router service would be a
encryption_key_file=/var/binlogs/enc_key.txt,
mariadb10_slave_gtid=On,
mariadb10_master_gtid=Off,
binlog_structure=flat
binlog_structure=flat,
slave_hostname=maxscale-blr-1,
master_retry_count=1000,
connect_retry=60
```
The minimum set of router options that must be given in the configuration
@ -333,6 +320,8 @@ Please note that is such condition the only user for MySQL protocol connection t
master_ssl_cert=/home/mpinto/packages/certificates/client/client-cert.pem
master_ssl_ca=/home/mpinto/packages/certificates/client/ca.pem
#master_tls_version=TLSv12
#master_heartbeat_period=300
#master_connect_retry=60
Enabling replication from a master server requires:
@ -341,7 +330,7 @@ Enabling replication from a master server requires:
MASTER_USER='repl',
MASTER_PASSWORD=‘somepasswd’,
MASTER_LOG_FILE=‘repl-bin.000159',
MASTER_LOG_POS=4
MASTER_LOG_POS=4;
It's possible to specify the desired *MASTER_LOG_FILE* but position must be 4
@ -350,7 +339,7 @@ required, as the needed values are automatically set by parsing *MASTER_LOG_FILE
##### MariaDB 10 GTID
Since MaxScale 2.2, if option _mariadb10_master_gtid_ is On, it's possible to use GTID
Since MaxScale 2.2, if option _mariadb10_master_gtid_ is On, it's possible to use GTID (MASTER_USE_GTID=Slave_pos),
instead of _file_ and _pos_.
This also implies that MariaDB 10 slave servers can only connect with GTID mode to MaxScale.
@ -360,7 +349,8 @@ MariaDB> CHANGE MASTER TO
MASTER_HOST=‘$master_server’,
MASTER_PORT=$master_port,
MASTER_USER='repl',
MASTER_PASSWORD=‘somepasswd’;
MASTER_PASSWORD=‘somepasswd’,
MASTER_USE_GTID=Slave_pos;
```
**Note**: the _log file name_ to write binlog events into is the one specified in
the _Fake Rotate_ event received at registration time.
@ -401,6 +391,9 @@ The supported options are:
MASTER_PASSWORD
MASTER_LOG_FILE
MASTER_LOG_POS
MASTER_CONNECT_RETRY
MASTER_HEARTBEAT_PERIOD
MASTER_USE_GTID
and SSL options as well: