Skip to content

WIP: Add AWS RDS docs#385

Merged
shlomi-noach merged 18 commits intogithub:masterfrom
jacobbednarz:add-rds-docs
Apr 10, 2017
Merged

WIP: Add AWS RDS docs#385
shlomi-noach merged 18 commits intogithub:masterfrom
jacobbednarz:add-rds-docs

Conversation

@jacobbednarz
Copy link
Copy Markdown
Contributor

This adds a new file under the doc directory that covers the caveats
and work arounds for using Amazon RDS.

The idea here is that we have a RDS document and each engine (mysql,
aurora, etc) gets a sub section for specific stuff and everything else
ends up as general as possible.

Due to the way aurora is architected, replication means something
slightly different to the traditional sense. This includes a work
around to use test/migrate on replica instead of only master migrations.
@jacobbednarz
Copy link
Copy Markdown
Contributor Author

@pbitty @shlomi-noach do you mind running your eyes over this and making sure I've covered everything?

Copy link
Copy Markdown
Contributor

@shlomi-noach shlomi-noach left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for working on this ❤️ !

Since I'm not running RDS nor Aurora, I have no technical review to offer.

However, can we have a playbook checklist available for Aurora? A list of actions/configurations that must be checked/set for running the migration?

Comment thread doc/rds.md
@@ -0,0 +1,31 @@
# Amazon RDS
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's just add a quick sentence before this line, carifying that gh-ost actually runs on RDS and Aurora.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed in 15d30ce

Comment thread doc/rds.md
## Limitations

- No `SUPER` privileges.
- `gh-ost` runs should be setup use [`--assume-rbr`][assume_rbr_docs] and use `binlog_format=ROW`.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[assume_rbr_docs] link

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I gather you mean, "whoa, where's the actual link? have you gone crazy?" 😛

These are reference links which allow you to reuse a single link multiple times without repeating it over and over. The links themselves are put at the bottom.

Or would you rather not use reference links?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

oh, you're right 😛 , thank you for pointing this out!

Comment thread doc/rds.md

In Aurora replication, you have separate reader and writer endpoints however because the cluster shares the underlying storage layer, `gh-ost` will detect it is running on the master. This becomes an issue when you wish to use [migrate/test on replica][migrate_test_on_replica_docs] because you won't be able to use a single cluster in the same way you would with MySQL RDS.

To work around this, you can follow along the [AWS replication between clusters documentation][aws_replication_docs] for Aurora with one small caveat. For the "Create a Snapshot of Your Replication Master" step, the binlog position is not available in the AWS console. You will need to issue the SQL query `SHOW SLAVE STATUS` or `aws rds describe-events` API call to get the correct position.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[aws_replication_docs] link

@jacobbednarz
Copy link
Copy Markdown
Contributor Author

However, can we have a playbook checklist available for Aurora? A list of actions/configurations that must be checked/set for running the migration?

Sure! Let me ponder on how to best present this without confusing people who actually want to use non-RDS documentation when they come searching for it.

@shlomi-noach shlomi-noach changed the title Add AWS RDS docs WIP: Add AWS RDS docs Mar 28, 2017
@shlomi-noach
Copy link
Copy Markdown
Contributor

@jacobbednarz I changed the title to "WIP: ..." (Work In Progress). Please ping me when you wish me to merge this PR. Thank you very much!

@jacobbednarz
Copy link
Copy Markdown
Contributor Author

Thanks @shlomi-noach. I'm standing up fresh clusters at the moment to put together a checklist and should be able to report back in the next day or so with some updates.

@jacobbednarz
Copy link
Copy Markdown
Contributor Author

@pbitty do you mind casting your 👀 over 55d8b3a and letting me know if you think anything is missing? Much of the stuff I have in my list is internal to us and I'm unsure how much knowledge assumption we should be making here.

@pbitty
Copy link
Copy Markdown
Contributor

pbitty commented Apr 3, 2017

Sorry for the late reply. I will take a look at it today.

@jacobbednarz
Copy link
Copy Markdown
Contributor Author

@shlomi-noach I'm happy to merge as is and if there is any feedback from @pbitty (or others on RDS) we can open new PRs for it.

Copy link
Copy Markdown
Contributor

@shlomi-noach shlomi-noach left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great! Please make sure there's a link to this document from wherever makes sense to you.

@jacobbednarz
Copy link
Copy Markdown
Contributor Author

Oh, derpp! 🤦‍♂️ Let me add that too.

@jacobbednarz
Copy link
Copy Markdown
Contributor Author

Are you 👌 with c3eda3f?

@shlomi-noach shlomi-noach merged commit 3313cb3 into github:master Apr 10, 2017
@shlomi-noach
Copy link
Copy Markdown
Contributor

Thank you!

@jacobbednarz jacobbednarz deleted the add-rds-docs branch April 10, 2017 04:02
@jacobbednarz
Copy link
Copy Markdown
Contributor Author

🎉 🎉 🎉

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants