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

Removes references to v2 services #208

Merged
merged 3 commits into from May 3, 2021
Merged

Removes references to v2 services #208

merged 3 commits into from May 3, 2021

Conversation

zenmonkeykstop
Copy link
Contributor

Status

Ready for review

Description of Changes

Removes references to v2 services in installation, migration, onboarding, and development docs. For posterity, v2 references in older upgrade documents have been left intact, but the v3 services docs referring to v2+v3 transitions have been updated to recommend a Focal migration instead.

Testing

  • CI good
  • Docs changes are clear and correct
  • No non-historical refs to v2 services

Release

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

@eloquence eloquence self-assigned this Apr 29, 2021
@eloquence eloquence added this to Under Review in SecureDrop Team Board Apr 29, 2021
#. Commit both the ``securedrop/requirements/python3/*.in`` and
``securedrop/requirements/python3/*.txt`` files

Note that application dependency changes are suject to closer review, using
Copy link
Member

Choose a reason for hiding this comment

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

typo: suject

Copy link
Member

@eloquence eloquence Apr 30, 2021

Choose a reason for hiding this comment

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

Pushed up 99bd0fa to resolve.

If v3 onion services are not enabled, the dynamic inventory file will
automatically read the Onion URLs from the ``app-ssh-aths`` and ``mon-ssh-aths``
files and use them to connect to the servers over SSH during subsequent playbook
runs.

V3 onion services
^^^^^^^^^^^^^^^^^
Copy link
Member

Choose a reason for hiding this comment

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

Heading could be removed, but nbd either way.

@@ -3,19 +3,20 @@ SecureDrop V3 Onion Services

.. important::

SecureDrop instances must migrate to v3 onion services and Ubuntu 20.04
SecureDrop instances must migrate to v3 onion services and Ubuntu 20.04 (Focal)
before April 30, 2021.
Copy link
Member

Choose a reason for hiding this comment

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

This will only be released to the stable version of the docs after April 30, so I think we could be even more explicit here and just say that the Source Interface of any SecureDrop still running Xenial/v2 was disabled after April 30.

Copy link
Member

Choose a reason for hiding this comment

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

Alternatively, perhaps we can phase this section of the docs out entirely with 2.0.0, and consolidate anything we still need from it into the backup/migration procedures.

@eloquence
Copy link
Member

LGTM! Comfortable merging as-is but left one potential suggestion for improvement, now or in future. Note there's still one outstanding reference in the glossary that we should update:

Support for v2 onion services will start to be removed from SecureDrop in February 2021, and we strongly recommend :doc:upgrading SecureDrop instances to v3 onion services <v3_services> as soon as possible.

eloquence
eloquence previously approved these changes Apr 30, 2021
@eloquence
Copy link
Member

Note there's still one outstanding reference in the glossary that we should update:

I'll push a small commit to fix that & then merge, then we can handle any further refactoring in follow-up.

@eloquence eloquence merged commit 6573c22 into main May 3, 2021
SecureDrop Team Board automation moved this from Under Review to Done May 3, 2021
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.

Remove v2 onion services from documentation
2 participants