Add documentation on how to upgrade from scratchfs to swap #34031
Conversation
alex-hunt-materialize
force-pushed
the
swap_docs
branch
2 times, most recently
from
5122dba to
38732e7
Compare
alex-hunt-materialize
force-pushed
the
swap_docs
branch
from
38732e7 to
55529fa
Compare
| @@ -0,0 +1,112 @@ | |||
| --- | |||
| title: "Upgrading to swap" | |||
There was a problem hiding this comment.
Q: [Catching up on the topic] How does this affect the deployment guideline pages:
- https://materialize.com/docs/installation/install-on-aws/appendix-deployment-guidelines/ ?
- https://materialize.com/docs/installation/install-on-azure/appendix-deployment-guidelines/
https://materialize.com/docs/installation/install-on-gcp/appendix-deployment-guidelines/ - https://materialize.com/docs/installation/operational-guidelines/
There was a problem hiding this comment.
Q2: This is specifically for upgrading to v26?
(double-checking to find out where best to have this for visibility for people who'll need to do this as well as not get in the way of people who won't need it going forward -- new deployment people + people who took the steps to upgrade)
There was a problem hiding this comment.
The old terraform is not updated for swap support. If they are using that, they don't need this yet. When they migrate to the new terraform monorepo, then they will need do do these operations.
We haven't developed the procedure for migrating from the old terraform to the new one.
There was a problem hiding this comment.
@alex-hunt-materialize, how would a terraform user upgrade to v26 and use swap?
There was a problem hiding this comment.
thank you for writing this doc - the guide is very helpful! But as a user, I feel like I have a gap between the upgrade guides like this and the upgrade guide with swap. Is there any way we can harmonize these?
There was a problem hiding this comment.
how would a terraform user upgrade to v26 and use swap?
I think we'll want a separate guide for that, with a link from this one. Bobby and I just added swap support to the old terraform yesterday, so I plan on writing that today.
I feel like I have a gap between the upgrade guides like this and the upgrade guide with swap. Is there any way we can harmonize these?
There is a link in that guide to https://preview.materialize.com/materialize/34031/installation/appendix-terraforms/#materialize-on-aws-terraform-module, and I plan on adding some swap details there. The additional steps for enabling swap in terraform will be to just set a variable and terraform apply. Everything in this guide is automated, except for any removal or repurpose of the old node group. We plan to add some code changes to repurpose the old node group, but we haven't ironed out the details yet.
Removed redundant information about swap and clarified that it is enabled by default in v26 and later.
|
@kay-kim this should be ready to review! |
|
Actually, going to merge this in now. As I refactor here and there, it'll be easier rebranching from the docs-upcoming ... branch. |
kay-kim
merged commit 0edd8fc
into
MaterializeInc:docs-upcoming-v26.0.0
3 participants
Add documentation on how to upgrade from scratchfs to swap
Motivation
Documentation.
Tips for reviewer
Docs preview https://preview.materialize.com/materialize/34031/installation/upgrade-to-swap/
Checklist
$T ⇔ Proto$Tmapping (possibly in a backwards-incompatible way), then it is tagged with aT-protolabel.