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

Focal migration (take 2) #160

Closed
wants to merge 4 commits into from
Closed

Conversation

rocodes
Copy link
Contributor

@rocodes rocodes commented Feb 26, 2021

Status

Work in progress - feedback welcome

Description of Changes

Testing

Visual review

Release

Wait for #133 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

sssoleileraaa and others added 4 commits February 4, 2021 18:20
path; rename docs from "focal_prep" to "focal_migration", and
remove backup step from prep (this should occur during migration and not
beforehand).
@rocodes
Copy link
Contributor Author

rocodes commented Feb 26, 2021

Curses, this is a clean branch so I'm not sure why I'm seeing those extra merge commits. Okay, well
3234e41 is what I was trying to put up here, just for some preliminary feedback on whether we like the general structure/approach before I spend too much time on it. Ignore the git cruft and let me know how you feel about the structure.
The migration guide relies heavily on the 2 PRs I referenced, and honestly they make up the bulk of the migration instructions.


Instances that already have :doc:`v3 onion services <../v3_services>` enabled
and follow our migration guide will be able to
preserve their existing *Source* and *Journalist Interface* onion URLs.
Copy link
Member

Choose a reason for hiding this comment

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

As a reader, that left me with the question "what if I'm not running v3?". I know this is clarified later in the doc, but maybe add another sentence here, e.g.:

If you are still running v2 onion services, you must switch to v3 as part of the migration at the latest, and your onion addresses will change.

SecureDrop servers are updated automatically with the latest release version.
If your servers are running an old version, this indicates a major configuration
problem, and you may need to reinstall SecureDrop. In that case, please
:ref:`contact us <contact_us>` for assistance.
Copy link
Member

Choose a reason for hiding this comment

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

I realize this is language from the existing prep guide, but on re-reading it here, it seems to me we should probably drop the "you may need to reinstall SecureDrop" here. They'll need to reinstall SecureDrop regardless of their current version in order to migrate; if their current server is so badly misconfigured that it's not even on 1.7.1, that may just imply that a careful review is required to determine if the data can be safely moved over to the new install. So I would suggest just dropping that clause, and keeping the "please contact us".

----------------------------
(For SecureDrop instances already using v3 onion services)

#. :doc:`Take a backup of the current instance <../backup_and_restore>`.
Copy link
Member

Choose a reason for hiding this comment

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

If there are steps that are identical for both migration scenarios (e.g., make a backup, download/verify Ubuntu 20.04 media), it may make sense to split those into their own section for preparatory steps. I do recognize that means that earlier links won't be able to go directly to the path-specific section.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

For downloading/verifying Ubuntu 20.04, yes, I can add that to the preparatory steps. The reason I think that making a backup belongs during the actual migration window is it's time-sensitive; ideally the instance would be backed up and then taken offline immediately, so that no submissions fall through the cracks.

Copy link
Member

Choose a reason for hiding this comment

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

Yes, that makes sense; I meant that the backup paragraph is duplicated in the two sections for the different paths, and if we can consolidate migration steps that are the same regardless of v2/v3 status, that might make it easier to maintain. But understand if you prefer to err on the side of just having each migration procedure be fully self-contained.

@eloquence
Copy link
Member

Thanks @rocodes, what's there so far is looking very good to me on visual review. Note that this PR currently includes some merge commits and an unrelated commit; just ping me if you'd like help resolving that.

@rocodes
Copy link
Contributor Author

rocodes commented Mar 8, 2021

Replaced by #169

@rocodes rocodes closed this Mar 8, 2021
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.

None yet

3 participants