added Xenial prep instructions in upgrade section #4046
Conversation
zenmonkeykstop
requested review from
emkll,
kushaldas and
redshiftzero
as code owners
There was a problem hiding this comment.
Looking good. Some comments inline (mostly formatting). There's a few cases of missing code block formatting that makes the code samples look like this:
Additionally, we may want to use both the Ubuntu version number and code name in every instance because it might not be obvious to someone unfamiliar (say, a Windows admin) that 16.04 == Xenial and 14.04 == Trusty.
I don't have hardware to test this on, so I can't verify that it does the thang tho.
zenmonkeykstop
force-pushed
the
docs-xenial-prep-guide
branch
2 times, most recently
from
e24a183 to
668f951
Compare
|
hey @kushaldas: on Monday can you spin through a test of these docs since you have fresh eyes on this PR? (This will be part of the announcement that goes out next week about Xenial) |
docs/upgrade/xenial_prep.rst
Outdated
|
|
||
| git checkout 0.11.0 | ||
|
|
||
| Important: If you see the warning ``refname ‘0.11.0’ is ambiguous`` in the output, we recommend that you contact us immediately at [email protected] (GPG encrypted). |
There was a problem hiding this comment.
This should probably be a .. warning:: block.
There was a problem hiding this comment.
Yup. 👍 to @heartsucker's comment. We need this as an important block.
|
|
||
| .. code:: sh | ||
|
|
||
| git checkout 0.11.0 |
There was a problem hiding this comment.
We should probably include the `refname '0.11.0' is ambiguous" warning here too.
docs/upgrade/xenial_prep.rst
Outdated
|
|
||
| Next, you’ll need to copy over the instance’s submission key and OSSEC public key. Their filenames may vary, but you can check them in the instance configuration file using the following command: | ||
|
|
||
| grep "_public_key" $DST/prod-specific.yml |
There was a problem hiding this comment.
I'm somewhat not a fan of the inline comments here and think it makes more sense to put all the text at the top and just leave this as shell commands only. I think this might be unclear for some admins. Maybe another reviewer has an opinion on this?
heartsucker
dismissed
their stale review
Dismissing my review to not block since the docs are worded well enough to make me happy for merge :D
docs/upgrade/xenial_prep.rst
Outdated
| Checking your Server Securedrop version | ||
| --------------------------------------- | ||
|
|
||
| The simplest way to check your SecureDrop version is to load the .onion address of your Source Interface in the Tor Browser. The version number will be in the footer of the Source Interface. You can also check the application version from the command line on the *Application Server* by running the command: |
There was a problem hiding this comment.
let us add a screenshot here?
docs/upgrade/xenial_prep.rst
Outdated
|
|
||
| git checkout 0.11.0 | ||
|
|
||
| Important: If you see the warning ``refname ‘0.11.0’ is ambiguous`` in the output, we recommend that you contact us immediately at [email protected] (GPG encrypted). |
There was a problem hiding this comment.
Yup. 👍 to @heartsucker's comment. We need this as an important block.
There was a problem hiding this comment.
I've focused testing on the instructions for the 0.3.x migration:
Using 0.11.0 prod vms, I've destroyed the the workstation (while preserving the secrets necessary for the migration). I've also recreated a prod-specific.yml file based on the configuration of the VMs. I've then checked out 0.3.12 and ran install.sh in tails_files. Then checked out 0.11.0 and walked through the instructions provided in this PR.
Everything works as expected: I've tried ./securedrop-admin {tailsconfig, backup, sdconfig, install, restore} . Note my comment on SRC path for copying sd-relevant files, can you confirm the path is correct? Other than that, other minor comments (inline).
Once SRC path is confirmed, based this my review and thorough review by others, this is good to merge.
zenmonkeykstop
force-pushed
the
docs-xenial-prep-guide
branch
from
668f951 to
36c8c88
Compare
zenmonkeykstop
force-pushed
the
docs-xenial-prep-guide
branch
from
36c8c88 to
74cc5c6
Compare
redshiftzero
dismissed
kushaldas’s stale review
hey kushal, dismissing your review as I think your comments were addressed here and we want to get these comms out EOD <3
Status
Ready for review
Description of Changes
Fixes #4044 .
Adds a new page to the Upgrade section covering steps required to upgrade workstations in preparation for Xenial migration.
Note that #4044 seems to be a bit more general, but this document is specifically to support the Xenial migration and associated messaging.
Testing
This is a docs-only PR but it also contains upgrade procedures:
Checklist
If you made changes to documentation:
make docs-lint) passed locally