Idea #9705
closed
[Crunch2] [Doc] Document Crunch 2 setup in Install Guide
Added by Brett Smith over 8 years ago.
Updated about 8 years ago.
Description
Port the Crunch2 Installation wiki page to the Install Guide, adding background and details as necessary and making it conform to Install Guide typographic conventions. Lay out pages in the TOC following the suggestion in #9359-4.
If #9706 gets done alongside this story, you can skip documenting runit scripts, and instead give people instructions for deploying on systemd, and how to adapt that to other init systems if needed.
- Description updated (diff)
- Assigned To set to Brett Smith
- Target version set to 2016-08-17 sprint
- Story points set to 1.0
- Status changed from New to In Progress
Updated the wiki with systemd instructions and filled in examples as appropriate. Starting to port that to the Install Guide now.
9705-crunch2-install-guide-wip is up for review. There's a little bit of "go where the puck is going" here: the text assumes both #9706 and #9745 are done and merged. We should probably hold off merging these docs until that is actually the case. But I think it can still be reviewed in the meantime.
Much of the text is based off Crunch2 installation, if you want to refer to that.
The instructions about updating GRUB configuration on CentOS come from this Red Hat page
Reviewing 368fce7
It's awkward that it suggests using runit
for arvados-docker-cleaner
but systemd
for crunch-dispatch-slurm
(but I guess that's because don't have a tested systemd unit for arvados-docker-cleaner
). Filed #9756.
Different versions of Docker have different behavior involving the interaction of -cgroup-parent
and systemd
. For Docker 1.9, users may need to disable Docker's systemd integration with this docker daemon
option:
--exec-opt native.cgroupdriver=cgroupfs
Under "Test the dispatcher" it should probably note that ARVADOS_API_HOST and ARVADOS_API_TOKEN need to be set.
Peter Amstutz wrote:
It's awkward that it suggests using runit
for arvados-docker-cleaner
but systemd
for crunch-dispatch-slurm
(but I guess that's because don't have a tested systemd unit for arvados-docker-cleaner
). Filed #9756.
It occurred to me that #9756 is arguably blocked by #9759. So... fine, I tried out a systemd unit definition on my laptop, and plunked it directly in the Install Guide. It hasn't been as tested in as many environments, but it does flow better, and if there are any integration issues with it at least they should be as transparent to deal with as the runit instructions were.
Different versions of Docker have different behavior involving the interaction of -cgroup-parent
and systemd
. For Docker 1.9, users may need to disable Docker's systemd integration with this docker daemon
option:
--exec-opt native.cgroupdriver=cgroupfs
Thanks, added this note.
Under "Test the dispatcher" it should probably note that ARVADOS_API_HOST and ARVADOS_API_TOKEN need to be set.
The text mentions the commands are meant to run on a shell node. I bolded this text and reorganized it a bit for emphasis. This follows the same pattern that we use elsewhere in the install guide when API objects have to be created, like the install instructions for keepstore and keepproxy. If there are additional readability improvements that need to be made here, I'd suggest filing a separate story about that, because it needs to be applied consistently across the entire Install Guide, and I think touching up other pages is out of scope for this story.
This is great, thanks. LGTM @ f662db7
Rebased on current master and now at 728fadd. This should be good to merge once the dependent functionality is added to crunch-dispatch-slurm.
- Target version changed from 2016-08-17 sprint to 2016-08-31 sprint
- Story points changed from 1.0 to 0.0
- Assigned To changed from Brett Smith to Tom Clegg
- Status changed from In Progress to Resolved
Applied in changeset arvados|commit:cbba74fcd57b7b81337d44c2e663ba317e6538de.
Also available in: Atom
PDF