-
Notifications
You must be signed in to change notification settings - Fork 26
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add detailed Focal migration instructions to docs #169
Conversation
a3a276e
to
096a54c
Compare
docs/upgrade/focal_migration.rst
Outdated
and you will be guided through reinstalling SecureDrop. | ||
|
||
Once you have reinstalled SecureDrop, you will be instructed on how to | ||
apply your backup file, restoring data and Tor credentials. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would simplify this step, e.g.:
Follow the instructions for migrating an instance with v3 onion services. As part of this process, you will reinstall your servers, restore your backup, and configure access via your Admin Workstation.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sure, tweaked in b9367dc. I wanted to provide a bit of detail just to give people confidence that yes, wiping and reinstalling from scratch is what we want them to do. I think this accomplishes that goal.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It does! I would like to avoid the mouthful v2+v3 or v3 onion services
wherever possible, but that's a minor nit and history will solve this problem for us soon. :)
Looks great to me @rocodes, some minor comments inline. :) |
Update v3_services.rst to include link to Alternate Migration Path and modify warning callout
d86780e
to
b9367dc
Compare
please coordinate your maintenance window with us, so we can ensure that our team | ||
can provide support in a timely manner. In any event, please do not hesitate to | ||
:ref:`contact us <contact_us>` for assistance. | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could link to Decommission SecureDrop here, to remind them to take the proper care with the old hardware.
will become unreachable. | ||
#. :doc:`Take a backup of the current instance <../backup_and_restore>`. Once | ||
you have taken a backup of the servers, power them off. | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Mentioning the Decommission SecureDrop notes on deleting submissions and wiping the server storage would be good at this point, with the caveat that either deletion of a large volume of submissions, or an interstitial installation of Ubuntu with full disk encryption, would make the migration take quite a bit longer.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
These instructions took a Xenial v2+v3 instance to Focal v3 with no mishaps.
I think just to be thorough we should point out that reinstalling on the same hardware without wiping the storage could theoretically leave old data recoverable, but I expect most deployments will be restoring the same data anyway.
…e warning about data recovery and link to decomm docs in focal migration guide.
@rmol I have added in a warning about data recovery and a link to decommissioning docs in this guide, and also included a "Decommission old servers" step in the general backup-restore-migrate guide (which will outlive focal stuff). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Status
Ready for Review
(Replaces #160)
Description of Changes
Testing
Visual review
Release
Wait for #168 to land, will require references to that PR
Wait for #154, will refer to Ubuntu 20.04 instructions as well
Checklist (Optional)
make docs-lint
) passed locallymake docs-linkcheck
) passedmake docs
) docs at http://localhost:8000