Story #16471

Install docs mention using Salt

Added by Peter Amstutz 5 months ago. Updated 1 day ago.

Status:
Resolved
Priority:
Normal
Assigned To:
Category:
Documentation
Target version:
Start date:
10/09/2020
Due date:
% Done:

100%

Estimated time:
(Total: 0.00 h)
Story points:
-
Release relationship:
Auto

Subtasks

Task #16545: Review 16471-install-using-saltResolvedJavier Bértoli

Associated revisions

Revision 2501c7aa (diff)
Added by Javier Bértoli 15 days ago

feat(salt): start salt install documentation

refs #16471
Arvados-DCO-1.1-Signed-off-by: Javier Bértoli <>

Revision cc6a3969 (diff)
Added by Javier Bértoli 15 days ago

feat(salt): start salt install documentation

refs #16471
Arvados-DCO-1.1-Signed-off-by: Javier Bértoli <>

Revision ff4fad2e (diff)
Added by Javier Bértoli 13 days ago

fix(salt): temporal fix for database setup issue

plus some linting

refs #16471 and #16992
Arvados-DCO-1.1-Signed-off-by: Javier Bértoli <>

Revision 1021d0b3 (diff)
Added by Javier Bértoli 13 days ago

fix(salt): temporal fix for database setup issue

plus some linting

refs #16471 and #16992
Arvados-DCO-1.1-Signed-off-by: Javier Bértoli <>

Revision 94bece81 (diff)
Added by Javier Bértoli 9 days ago

fix(salt): choose repo

refs #16471 and #16992
Arvados-DCO-1.1-Signed-off-by: Javier Bértoli <>

Revision 244e797a (diff)
Added by Javier Bértoli 9 days ago

feat(docs): salt install documentation
refs #16471 and #16992
Arvados-DCO-1.1-Signed-off-by: Javier Bértoli <>

Revision f43a1f88 (diff)
Added by Javier Bértoli 6 days ago

feat(provision): example configurations in salt

refs #16471 and #16992
Arvados-DCO-1.1-Signed-off-by: Javier Bértoli <>

Revision 646aabae (diff)
Added by Javier Bértoli 6 days ago

feat(provision): better testing config and documentation

refs #16471 and #16992
Arvados-DCO-1.1-Signed-off-by: Javier Bértoli <>

Revision 9181425e (diff)
Added by Javier Bértoli 6 days ago

docs(provision): document initial URL

refs #16471 and #16992
Arvados-DCO-1.1-Signed-off-by: Javier Bértoli <>

Revision 579c147c (diff)
Added by Javier Bértoli 6 days ago

docs(provision): document initial URL

refs #16471 and #16992
Arvados-DCO-1.1-Signed-off-by: Javier Bértoli <>

Revision 4bcdecf2 (diff)
Added by Javier Bértoli 6 days ago

docs(provision): document initial URL

refs #16471 and #16992
Arvados-DCO-1.1-Signed-off-by: Javier Bértoli <>

Revision 52558368 (diff)
Added by Javier Bértoli 3 days ago

docs(salt): some minor fixes in the Salt-based installation documentation.

refs #16471:
Arvados-DCO-1.1-Signed-off-by: Javier Bértoli <>

Revision e04c307f
Added by Javier Bértoli 1 day ago

Merge branch '16471-install-using-salt' into master

closes #16471
Arvados-DCO-1.1-Signed-off-by: Javier Bértoli <>

Revision 76ec9e2a
Added by Ward Vandewege 1 day ago

Merge branch '16471-install-using-salt' into 2.1-dev

refs #16471

Arvados-DCO-1.1-Signed-off-by: Ward Vandewege <>

History

#1 Updated by Peter Amstutz 5 months ago

  • Assigned To set to Javier Bértoli

#2 Updated by Peter Amstutz 4 months ago

  • Target version changed from 2020-06-17 Sprint to 2020-07-01 Sprint

#3 Updated by Javier Bértoli 4 months ago

  • Target version changed from 2020-07-01 Sprint to 2020-07-15

#4 Updated by Peter Amstutz 3 months ago

  • Target version changed from 2020-07-15 to 2020-08-12 Sprint

#5 Updated by Peter Amstutz 3 months ago

  • Release set to 25

#6 Updated by Peter Amstutz 2 months ago

  • Target version changed from 2020-08-12 Sprint to 2020-08-26 Sprint

#7 Updated by Peter Amstutz about 2 months ago

  • Target version changed from 2020-08-26 Sprint to 2020-09-09 Sprint

#8 Updated by Javier Bértoli about 1 month ago

  • Target version changed from 2020-09-09 Sprint to 2020-09-23 Sprint

#9 Updated by Peter Amstutz 29 days ago

  • Target version changed from 2020-09-23 Sprint to 2020-10-07 Sprint

#10 Updated by Peter Amstutz 16 days ago

  • Target version changed from 2020-10-07 Sprint to 2020-10-21 Sprint

#11 Updated by Lucas Di Pentima 13 days ago

Some comments

  • Added 77bf8cb84 to include the new salt documentation to the install guide. (wasn’t able to reach it from anywhere)
  • When doing a rake generate && rake run locally to see the rendered doc site, I’m seeing several formatting issues with the new documentation.
  • Also, some links land on incorrect locations.
  • The “install dependencies” section feels a bit empty. Can we have an example of how to install them using salt? If it does need extra salt formulas, maybe just an example of one component is enough.
  • In the provision.sh file:
    • There’s a BRANCH envvar set to some value. Is this valid? The comment says that it will switch to the provided branch name before running, I think it shouldn’t be set by default.
    • Running the script as a regular user fails when trying to create /srv/<something> dirs for lack of permission reasons

#12 Updated by Javier Bértoli 9 days ago

  • Status changed from New to In Progress

Lucas, I uploaded new documentation commit 244e797ae@arvados

#13 Updated by Javier Bértoli 8 days ago

The changes to the arvados-formula got merged upstream.

#14 Updated by Lucas Di Pentima 8 days ago

Some comments:

  • I think the “SaltStack quick start” should be listed as an installation option on the “Overview” (Install doc section).
  • On the rendered doc site, section “For the impatient”, the first sentence gets splitted in 2 after the 4th word (tested on Safari & Chrome browsers). The same happens on the “Introduction” section. Other lines also get cut on different lenghts, what I’m thinking it’s happening is that the line breaks on the documentation source file gets translated literally on the rendered site. Every sentence should be written on just 1 (sometimes long) line of text so that the browser decides when to break it depending on the window's width.
  • The code boxes have an initial empty line that could be avoided for better aesthetics.
  • The documentation states that the provision.sh script should be run as root. OTOH, there’re “sudo” executions inside it, but if run as a normal user, it will fail creating some directories inside /srv/ so I think it would be clearer to not use “sudo” and check for the current user so that it fails when it’s not root.
  • There’s some issue with link rendering on the “Install dependencies” section.
  • Both times I tried running the provision.sh script as root on a fresh Debian Buster VM, the process got stuck at:
[INFO    ] Executing command ['dpkg', '--get-selections', '*'] in directory '/root'
[INFO    ] Executing command ['systemd-run', '--scope', '--description', '"salt.loaded.int.module.aptpkg"', 'apt-get', '-q', '-y', '-o', 'DPkg::Options::=--force-confold', '-o', 'DPkg::Options::=--force-confdef', 'install', 'arvados-api-server'] in directory '/root'

(…not sure if the above was because I had not enough patience.)
  • When trying vagrant up, it took some time but finished correctly. It took around 800 seconds, not sure if this is normal but it would be nice to mention it on the documentation
  • After running vagrant up, I don’t know how to contact Arvados, should vagrant provide an exported workbench URL when finishing? If there’s a default IP/port that vagrant uses, it would be useful to say so on the doc page.

#15 Updated by Javier Bértoli 6 days ago

  • Made some more changes to the docs and scripts, following Lucas' suggestions. (commit 4bcdecf24@arvados, branch 16471-install-using-salt)
  • Refactored some things in the Salt formula
  • Made the provision.sh script able to reload the configuration and re-rerun salt so, if you run it in a VM, can just reload it and will update all the configuration.

#16 Updated by Lucas Di Pentima 6 days ago

I've pushed a little fix, with that it LGTM.

#17 Updated by Ward Vandewege 3 days ago

I've pushed some more fixes on this branch, including some refactoring to split out the different types of Salt-based installations. See a02f66383e58001b40c4cf732155397eb99d3207

#18 Updated by Javier Bértoli 3 days ago

Added a few lines regarding DNS and changing 'source-based' -> 'package-based' (commit 525583680@arvados, branch 16471-install-using-salt)

#19 Updated by Ward Vandewege 2 days ago

Javier Bértoli wrote:

Added a few lines regarding DNS and changing 'source-based' -> 'package-based' (commit 525583680@arvados, branch 16471-install-using-salt)

Okay I see how that was confusing. I pushed a fix for the `source-based` wording at 7544023f69773730d69a0c614f1220e7936aea5d on branch 16471-install-using-salt. With that, I think this is good to be merged from my perspective (but I have only reviewed the documentation, I have not tried the actual Salt formula!).

#20 Updated by Javier Bértoli 1 day ago

  • Status changed from In Progress to Feedback

Lucas and Ward reviewed it.
Merged

#21 Updated by Peter Amstutz 1 day ago

  • Status changed from Feedback to Resolved

Also available in: Atom PDF