Story #9705

[Crunch2] [Doc] Document Crunch 2 setup in Install Guide

Added by Brett Smith over 4 years ago. Updated over 4 years ago.

Status:
Resolved
Priority:
Normal
Assigned To:
Category:
Documentation
Target version:
Start date:
08/03/2016
Due date:
% Done:

100%

Estimated time:
(Total: 0.00 h)
Story points:
0.0

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.


Subtasks

Task #9723: Review 9705-crunch2-install-guide-wipResolvedPeter Amstutz

Associated revisions

Revision cbba74fc
Added by Tom Clegg over 4 years ago

Merge branch '9705-crunch2-install-guide-wip'

closes #9705
closes #9706

History

#1 Updated by Brett Smith over 4 years ago

  • Description updated (diff)

#2 Updated by Radhika Chippada over 4 years ago

  • Assigned To set to Brett Smith
  • Target version set to 2016-08-17 sprint
  • Story points set to 1.0

#3 Updated by Brett Smith over 4 years ago

  • 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.

#4 Updated by Brett Smith over 4 years ago

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.

#5 Updated by Brett Smith over 4 years ago

The instructions about updating GRUB configuration on CentOS come from this Red Hat page

#6 Updated by Peter Amstutz over 4 years ago

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.

#7 Updated by Brett Smith over 4 years ago

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.

#8 Updated by Peter Amstutz over 4 years ago

This is great, thanks. LGTM @ f662db7

#9 Updated by Brett Smith over 4 years ago

Rebased on current master and now at 728fadd. This should be good to merge once the dependent functionality is added to crunch-dispatch-slurm.

#10 Updated by Tom Clegg over 4 years ago

  • Target version changed from 2016-08-17 sprint to 2016-08-31 sprint

#11 Updated by Tom Clegg over 4 years ago

  • Story points changed from 1.0 to 0.0

#12 Updated by Tom Clegg over 4 years ago

  • Assigned To changed from Brett Smith to Tom Clegg

#13 Updated by Tom Clegg over 4 years ago

  • Status changed from In Progress to Resolved

Applied in changeset arvados|commit:cbba74fcd57b7b81337d44c2e663ba317e6538de.

Also available in: Atom PDF