Skip to content

Commit 49a5bc6

Browse files
Fix grammar and clarity in failover documentation
A few minor clarifications. Turned future tense into present tense.
1 parent 07c51b0 commit 49a5bc6

File tree

1 file changed

+19
-19
lines changed

1 file changed

+19
-19
lines changed

maxscale/mariadb-maxscale-tutorials/automatic-failover-with-mariadb-monitor.md

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,15 @@
44
the state of a MariaDB replication cluster. The monitor can perform cluster manipulation operations
55
such as *failover*, *switchover* and *rejoin*. By default, these operations are launched manually,
66
but they can be configured to also trigger automatically. All replication modifying operations
7-
assume GTID-based replication, and will refuse to launch or may work incorrectly when using
7+
assume GTID-based replication, and refuses to launch or may work incorrectly when using
88
file-and-position-based replication. Also, the operations are mainly designed to work with simple
9-
topologies, i.e. 1 primary and one to multiple replicas. More complicated setups (multilayered
9+
topologies, for instance 1 primary and one to multiple replicas. More complicated setups (multilayered
1010
replication, multimaster rings etc.) may work, but should be tested separately to ensure the results
1111
are predictable.
1212

1313
The following examples have four servers: *server1* is the initial primary and *server2* to
1414
*server4* are replicas. The servers are monitored by *TheMonitor*. The MaxScale configuration file
15-
would look as follows:
15+
looks as follows:
1616

1717
```ini
1818
[server1]
@@ -92,11 +92,11 @@ alternate form works for module commands in general.
9292
During failover, *TheMonitor* selects the best replica, promotes it to primary and modifies the
9393
other replicas to replicate from the new primary. The main criteria for *best replica* is being most
9494
up-to-date. If the best replica has unprocessed events in its relay log, meaning it has received
95-
binary log events from the old primary but not processed them, then failover will stall until the
96-
processing is complete. If multiple replicas are equally good, then the monitor prefers to promote
95+
binary log events from the old primary but not processed them, failover stalls until the
96+
processing is complete. If multiple replicas are equally good, the monitor prefers to promote
9797
servers in the order stated in the *servers*-setting.
9898

99-
After failover completes, the cluster should look like:
99+
After failover completes, the cluster looks like this:
100100

101101
```bash
102102
$ maxctrl list servers
@@ -113,7 +113,7 @@ $ maxctrl list servers
113113
└─────────┴─────────────────┴──────┴─────────────┴─────────────────┘
114114
```
115115

116-
If *server1* comes back online, it will not be rejoined to the cluster:
116+
If *server1* comes back online, it is not rejoined to the cluster:
117117

118118
```bash
119119
$ maxctrl list servers
@@ -135,8 +135,8 @@ does, see [MariaDB Monitor documentation](../reference/maxscale-monitors/mariadb
135135

136136
## Automatic Failover
137137

138-
To enable automatic failover, simply add `auto_failover=true` to the monitor section in the
139-
configuration file.
138+
To enable automatic failover, add `auto_failover=true` to the monitor section in the
139+
configuration file:
140140

141141
```ini
142142
[TheMonitor]
@@ -182,9 +182,9 @@ $ maxctrl list servers
182182
└─────────┴─────────────────┴──────┴─────────────┴────────────────────────┘
183183
```
184184

185-
If you are continuously monitoring the server states, you may notice for a brief period that the
185+
If you are continuously monitoring the server states, you may notice that, for a brief period, the
186186
state of *server1* is _Down_ and the state of *server2* is still _Slave, Running_. This is because
187-
the monitor does not begin failover immediately as the server goes down, as the problem could be
187+
the monitor does not begin failover immediately when the server goes down, as the problem could be
188188
temporary. The monitor waits for *server1* to come back for
189189
[failcount](../reference/maxscale-monitors/mariadb-monitor.md#failcount) monitor intervals. The
190190
recommended value for *failcount* depends on *monitor_interval* and the stability of the network.
@@ -203,7 +203,7 @@ failcount=5
203203
## Rejoin
204204

205205
To enable automatic rejoin, simply add `auto_rejoin=true` to the monitor section in the
206-
configuration file.
206+
configuration file:
207207

208208
```ini
209209
[TheMonitor]
@@ -215,8 +215,8 @@ auto_rejoin=true
215215
...
216216
```
217217

218-
When automatic rejoin is enabled, MariaDB Monitor will attempt to rejoin a failed primary as a
219-
replica should it come back online.
218+
When automatic rejoin is enabled, MariaDB Monitor attempts to rejoin a failed primary as a
219+
replica if it comes back online.
220220

221221
In the next example, failover (either automatic or manual) has promoted *server2* to replace failed
222222
primary *server1*:
@@ -236,12 +236,12 @@ $ maxctrl list servers
236236
└─────────┴─────────────────┴──────┴─────────────┴─────────────────┘
237237
```
238238

239-
If *server1* now reappears, the monitor will detect that and attempt to rejoin the old primary as a
240-
replica. Rejoin is not always possible: If the old primary processed a write (just before crashing)
241-
and that write was never replicated to the new primary, then automatic rejoin will not be possible
242-
as the old and new primaries have diverged.
239+
If *server1* reappears, the monitor detects that, and attempts to rejoin the old primary as a
240+
replica. Rejoin is not always possible: If the old primary processed a write (just before crashing),
241+
and that write was never replicated to the new primary, then automatic rejoin is not possible
242+
because the old and new primaries have diverged.
243243

244-
If rejoin succeeds, then the cluster state will end up looking like:
244+
If rejoin succeeds, the cluster state ends up looking like:
245245

246246
```bash
247247
$ maxctrl list servers

0 commit comments

Comments
 (0)