Skip to content

Commit 55d8b3a

Browse files
committed
Add preflight checklist for aurora docs
1 parent 1aaf47e commit 55d8b3a

1 file changed

Lines changed: 9 additions & 1 deletion

File tree

doc/rds.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@
77
- No `SUPER` privileges.
88
- `gh-ost` runs should be setup use [`--assume-rbr`][assume_rbr_docs] and use `binlog_format=ROW`.
99
- Aurora does not allow editing of the `read_only` parameter. While it is defined as `{TrueIfReplica}`, the parameter is non-modifiable field.
10-
- In order to have binlogs enabled, the backup window must be set to greater than 1 day.
1110

1211
## Aurora
1312

@@ -27,6 +26,15 @@ If you use `pt-table-checksum` as a part of your data integrity checks, you migh
2726
This tool requires binlog_format=STATEMENT, but the current binlog_format is set to ROW and an error occurred while attempting to change it. If running MySQL 5.1.29 or newer, setting binlog_format requires the SUPER privilege. You will need to manually set binlog_format to 'STATEMENT' before running this tool.
2827
```
2928

29+
#### Preflight checklist
30+
31+
Before trying to run any `gh-ost` migrations you will want to confirm the following:
32+
33+
- [ ] You have a secondary cluster available that will act as a replica. Rule of thumb here has been a 1 instance per cluster to mimic MySQL-style replication as opposed to Aurora style.
34+
- [ ] The database instance parameters and database cluster parameters are consistent between your master and replicas
35+
- [ ] Executing `SHOW SLAVE STATUS\G` on your replica cluster displays the correct master host, binlog position, etc.
36+
- [ ] Database backup retention is greater than 1 day to enable binlogs
37+
3038
[new_issue]: https://github.com/github/gh-ost/issues/new
3139
[assume_rbr_docs]: https://github.com/github/gh-ost/blob/master/doc/command-line-flags.md#assume-rbr
3240
[migrate_test_on_replica_docs]: https://github.com/github/gh-ost/blob/master/doc/cheatsheet.md#c-migratetest-on-replica

0 commit comments

Comments
 (0)