Skip to content
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

Merged
merged 3 commits into from Mar 11, 2021
Merged

Conversation

rocodes
Copy link
Contributor

@rocodes rocodes commented Mar 8, 2021

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)

  • Doc linting (make docs-lint) passed locally
  • Doc link linting (make docs-linkcheck) passed
  • You have previewed (make docs) docs at http://localhost:8000

@rocodes rocodes mentioned this pull request Mar 8, 2021
3 tasks
@rocodes rocodes changed the title indicate standard and alternate focal migration paths Add detailed Focal migration instructions to docs Mar 8, 2021
@eloquence eloquence added this to Under Review in SecureDrop Team Board Mar 9, 2021
@eloquence eloquence moved this from Under Review to In Development in SecureDrop Team Board Mar 9, 2021
@rocodes rocodes moved this from In Development to Ready for Review in SecureDrop Team Board Mar 9, 2021
@rocodes rocodes moved this from Ready for Review to In Development in SecureDrop Team Board Mar 9, 2021
@rocodes rocodes force-pushed the focal-migration branch 2 times, most recently from a3a276e to 096a54c Compare March 9, 2021 22:43
@rocodes rocodes moved this from In Development to Ready for Review in SecureDrop Team Board Mar 9, 2021
@rocodes rocodes requested a review from eloquence March 9, 2021 22:49
@eloquence eloquence moved this from Ready for Review to Under Review in SecureDrop Team Board Mar 9, 2021
@eloquence eloquence self-assigned this Mar 9, 2021
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.
Copy link
Member

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.

Copy link
Contributor Author

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.

Copy link
Member

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. :)

@eloquence
Copy link
Member

Looks great to me @rocodes, some minor comments inline. :)

@eloquence eloquence moved this from Under Review to In Development in SecureDrop Team Board Mar 10, 2021
Update v3_services.rst to include link to Alternate Migration Path and
modify warning callout
@rocodes rocodes moved this from In Development to Ready for Review in SecureDrop Team Board Mar 10, 2021
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.

Copy link
Contributor

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.

Copy link
Contributor

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.

rmol
rmol previously approved these changes Mar 11, 2021
Copy link
Contributor

@rmol rmol left a 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.
@rocodes
Copy link
Contributor Author

rocodes commented Mar 11, 2021

@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).

@rocodes rocodes requested a review from rmol March 11, 2021 18:45
Copy link
Contributor

@rmol rmol left a comment

Choose a reason for hiding this comment

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

:shipit:

@rmol rmol merged commit 25c9866 into main Mar 11, 2021
SecureDrop Team Board automation moved this from Ready for Review to Done Mar 11, 2021
@rmol rmol deleted the focal-migration branch March 11, 2021 19:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
No open projects
Development

Successfully merging this pull request may close these issues.

None yet

3 participants