Feature #18624

[documentation] describe the requirements for compute images

Added by Ward Vandewege 6 days ago. Updated about 24 hours ago.

Status:
Resolved
Priority:
Normal
Assigned To:
Category:
-
Target version:
Start date:
01/13/2022
Due date:
% Done:

100%

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

Subtasks

Task #18625: review 18624-document-compute-image-requirementsResolvedWard Vandewege

History

#1 Updated by Ward Vandewege 6 days ago

  • Status changed from New to In Progress

#2 Updated by Ward Vandewege 6 days ago

ready for review at 12d5c5197da939a41bc59cd1a4bf6db9dc0e7df0 on branch 18624-document-compute-image-requirements

This also removes the installation of crunch-run from the cloud compute images, since arvados-dispatch-cloud takes care of that now.

#3 Updated by Tom Clegg 5 days ago

Typo "compoute"

Capitalize SSH for consistency ("ssh public key", "ssh user")

Elsewhere we describe config entries like CloudVMs.DriverParameters.AdminUsername rather than CloudVMs/DriverParameters/AdminUsername -- we should stick with one convention.

"Docker or Singularity needs to be installed and running" -- "running" isn't really a thing for singularity, perhaps just say "installed", but add links to https://doc.arvados.org/main/install/crunch2/install-compute-node-docker.html and https://doc.arvados.org/main/install/crunch2/install-compute-node-singularity.html which have more detailed requirements/recipes? Do we need to update those two pages to say they apply to slurm, lsf, or building a custom compute node image?

#4 Updated by Ward Vandewege 4 days ago

Tom Clegg wrote:

Typo "compoute"

Capitalize SSH for consistency ("ssh public key", "ssh user")

Elsewhere we describe config entries like CloudVMs.DriverParameters.AdminUsername rather than CloudVMs/DriverParameters/AdminUsername -- we should stick with one convention.

Thanks, all fixed as you suggested.

"Docker or Singularity needs to be installed and running" -- "running" isn't really a thing for singularity, perhaps just say "installed", but add links to https://doc.arvados.org/main/install/crunch2/install-compute-node-docker.html and https://doc.arvados.org/main/install/crunch2/install-compute-node-singularity.html which have more detailed requirements/recipes? Do we need to update those two pages to say they apply to slurm, lsf, or building a custom compute node image?

I removed 'and running'. We could link to those to pages, but for LSF/Slurm we still need crunch-run to be installed too, so those pages are subtly different. I think it's OK to not link anything from this section - if one is going to build their own compute image it is reasonable to expect they know what they are doing, and if not, they can always ask.

Ready for another look at 1125f71d2adf4f797b6869e870ef3cf56ea98569 on branch 18624-document-compute-image-requirements

#5 Updated by Tom Clegg 4 days ago

LGTM, thanks!

#6 Updated by Ward Vandewege 4 days ago

  • % Done changed from 0 to 100
  • Status changed from In Progress to Resolved

Applied in changeset arvados-private:commit:arvados|736e7cb4e93b2e8fbb7d8ed0948bb11ddd5f065b.

Also available in: Atom PDF