Skip to content

Commit 882027d

Browse files
authored
Update README.md
Added production usage checklist
1 parent 7e50aec commit 882027d

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ With a focus on high performance, it utilizes batching heavily and uses C++ exte
3030
- [Advanced Features](#advanced-features)
3131
- [Migrations & Schema Changes](#migrations--schema-changes)
3232
- [Recovery Without Downtime](#recovery-without-downtime)
33+
- [Production usage](#production-usage)
3334
- [Development](#development)
3435
- [Running Tests](#running-tests)
3536
- [Contribution](#contribution)
@@ -304,6 +305,15 @@ tables: ['table_1', 'table_2*']
304305

305306
In case of a failure or during the initial replication, `mysql_ch_replicator` will preserve old data and continue syncing new data seamlessly. You could remove the state and restart replication from scratch.
306307

308+
## Production usage
309+
310+
Here is the checklist for production. Please read it carefully and confirm every point. If you have any questions - feel free to ask in discussion / issues. Following the checklist is critical to avoid any issues on prod.
311+
312+
#### Checklist
313+
314+
- [ ] No manual changes are made directly to ClickHouse databases or tables. All modifications (indexes, table settings, etc.) must be applied as overrides in the mysql_ch_replicator config.yaml.
315+
- [ ] All MySQL migrations undergo either CI/CD or manual testing before deployment. No migration is applied to production without being tested. The tests verify that replication continues to work correctly and that new records are successfully replicated from MySQL to ClickHouse after the migration.
316+
307317
## Development
308318

309319
To contribute to `mysql_ch_replicator`, clone the repository and install the required dependencies:

0 commit comments

Comments
 (0)