Support #4186

[Documentation] Install documentation improvements

Added by Peter Amstutz about 6 years ago. Updated over 5 years ago.

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

100%

Estimated time:
(Total: 4.00 h)
Story points:
0.5

Subtasks

Task #4341: Make the manual installation documentation more complete.ResolvedWard Vandewege

Associated revisions

Revision 93ffb7c3 (diff)
Added by Ward Vandewege about 6 years ago

First set of improvements:

  • Suggest skipping SSO server installation for now, until we upgrade that codebase
  • Be more explicit about the desired values for arvados_login_base and
    arvados_v1_base in the workbench installation instructions.

refs #4186

Revision 0311a59f (diff)
Added by Ward Vandewege about 6 years ago

Explain the Keepstore's -permission-key-file argument and API server's
blob_signing_key configuration value.

refs #4186

Revision 95b0d814 (diff)
Added by Ward Vandewege about 6 years ago

Add install dependencies for the SSO server.

refs #4186

Revision 016ecd4c
Added by Ward Vandewege about 6 years ago

Merge branch '4186-install-doc-improvements'

refs #4186

Revision 9d5b7d2e (diff)
Added by Ward Vandewege about 6 years ago

Batch of improvements for the manual installation documentation:

  • add prerequisites section
  • add shell server section
  • add keepproxy section
  • many other updates throughout

refs #4186

Revision b09dddc9 (diff)
Added by Ward Vandewege about 6 years ago

Keepproxy just needs an anonymous token.

refs #4186

Revision 930198d1 (diff)
Added by Ward Vandewege about 6 years ago

Fix typo.

refs #4186

Revision ed4105d0 (diff)
Added by Ward Vandewege about 6 years ago

Batch of improvements for the manual installation documentation:

  • add prerequisites section
  • add shell server section
  • add keepproxy section
  • many other updates throughout

refs #4186

Revision d14c0c81 (diff)
Added by Ward Vandewege about 6 years ago

Keepproxy just needs an anonymous token.

refs #4186

Revision 7c3f2671 (diff)
Added by Ward Vandewege about 6 years ago

Fix typo.

refs #4186

Revision afc70738 (diff)
Added by Ward Vandewege about 6 years ago

Add keepstore installation page.

refs #4186

Revision 4978c1e7 (diff)
Added by Ward Vandewege about 6 years ago

Clean up the installation overview pages a bit more.

refs #4186

Revision 27b534dd
Added by Ward Vandewege about 6 years ago

Merge branch '4186-install-doc-improvements-2'

refs #4186

Revision 102582e4 (diff)
Added by Ward Vandewege about 6 years ago

Fix broken link in docs. Duh.

refs #4186

Revision 48ccafc4
Added by Tom Clegg about 6 years ago

Merge branch '3824-docker-fixes' refs #3824 refs #4186

Revision 399a90e3 (diff)
Added by Ward Vandewege about 6 years ago

Improve the installation instructions for keepproxy and keepstore - take sudo into account.

refs #4186

Revision aa106904
Added by Ward Vandewege about 6 years ago

Merge branch '4186-install-doc-improvements'

refs #4186

History

#1 Updated by Peter Amstutz about 6 years ago

<emyr> what should the permission key file used by keepstore contain ? there doesn't seem to be any mention of this on the keepstore install doc page : http://doc.arvados.org/install/install-keep.html
<brett> emyr: It should contain a single line with a long random alphanumeric string. It should be the same as the blob_signing_key that you set in the API server's config/application.yml.
<brett> There are comments in config/application.default.yml that explain in a little more detail.
<emyr> I've got past that bit. I'd suggest you make a mention of it on the keep install page as people installing it from scratch will just immediately go to the install instructions and expect to have the information there.
<emyr> Now I'm on to the bit about installing the SSO server. The command 'bundle install' doesn't work for me. is there a list of pre-requisites somewhere ? Again it would be handy if there was a link to the pre-reqs from the install documentation.
<brett> emyr: Yeah, I agree, it's sort of a known weak point in our documentation. Can you paste the error you get when you try to run `bundle install`?
<tetron> brett: emyr maybe we could file some tickets on specific things missing from the documentation?
<tomclegg> (hm, is sso-server still in openid-limbo?)
<brett> tomclegg: That's the last update I heard about it.
<tetron> cure is getting coffee then he can answer that
<emyr> initially i just got command not found. I did 'gem install bundler' which enabled the command - this should be mentioned in the docs.
<emyr> anyway, the error I get now is...
<emyr> Gem::Installer::ExtensionBuildError: ERROR: Failed to build gem native extension. /usr/bin/ruby1.9.1 extconf.rb /usr/lib/ruby/1.9.1/rubygems/custom_require.rb:36:in `require': cannot load such file -- mkmf (LoadError) from /usr/lib/ruby/1.9.1/rubygems/custom_require.rb:36:in `require' from extconf.rb:13:in `<main>' Gem files will remain installed in /var/lib/gems/1.9.1/gems/bcrypt-ruby-3.1.2 for inspection. Results logged to /var
<emyr> happy to go through theis as a guinea pig so you can improve the docs by the way :-D
<tetron> emyr: ah. I think that falls in the category of things that's totally obvious if you're a ruby developer and totally not obvious if you're not
<emyr> yup...not done any ruby
<tomclegg> (might be better off using https://auth.curoverse.com with the ID/secret in arvados/docker/config.yml.example)
<emyr> python, C++, java, perl, tcl, php yep....no ruby :-D
<tetron> emyr: ah, you need to install Ruby 2.1
<emyr> ok. I'll do that. Should I just install the latest ruby from source into /usr/local ?
<emyr> this machine is running ubuntu 12-04 LTS
<tomclegg> emyr: I'd recommend skipping the "install SSO" step and going to "install the API server" at least until @cure comes back with coffee
<tomclegg> emyr: it leads you through installing ruby 2.1, for one thing
<tetron> emyr: http://doc.arvados.org/install/install-api-server.html
<tetron> we should probably have a "prerequisites" page
<tomclegg> that install-api-server page is supposed to have all the prerequisites
<emyr> yep. but coming up with a list can be harder than it seems. At least if you have one it gives you something to keep up-to-date as you get feedback on failed builds

#2 Updated by Emyr James about 6 years ago

Issues I have come across so-far :

  • The documentation referred to the package and executable 'keep' but this had been changed to 'keepstore' Docs are now updated.
  • for the SSO install, the command 'bundle install' doesn't work out of the box on a vanilla ubuntu install. Need to install the bundler ruby gem - obvious for a ruby dev but not those without ruby experience. A pre-requisites page along with advice on how to get them installed on typical machines (e.g. out of the box ubuntu LTS) would be handy. We have ubuntu 12-04 at our institution so the ruby is a bit out of date. I will install a later version of ruby from source and carry on with the 'install-api-server' section for now.

#3 Updated by Emyr James about 6 years ago

Another issue...
When getting the api server up and running, I'm running into the following when doing the database initialization step...

root@host:~/arvados/services/api# RAILS_ENV=development bundle exec rake db:setup
arvados_development already exists
arvados_test already exists
rake aborted!
Refusing to start in development mode with missing configuration.

The following configuration settings must be specified in
config/application.yml:
  • blob_signing_key

I can't see any metnion of blob_signing_key in the docs.

#4 Updated by Emyr James about 6 years ago

now running in to this issue...

http://stackoverflow.com/questions/4368789/error-must-be-owner-of-language-plpgsql

I will remove plpgsql from template1 and see if that allows progress

#5 Updated by Emyr James about 6 years ago

ran in to various issues with the db setup, possibly due to a partial setup previously that ran into an issue. I dropped databases arvados_development and arvados_test and then redid the rake command which completed without error.

#6 Updated by Brett Smith about 6 years ago

  • Category set to Documentation
  • Target version set to Bug Triage

#7 Updated by Ward Vandewege about 6 years ago

  • Target version changed from Bug Triage to 2014-10-29 sprint

#8 Updated by Ward Vandewege about 6 years ago

  • Subject changed from [Documentation] Install documentation improvements to [Documentation] Install documentation improvements
  • Story points set to 0.5

#9 Updated by Radhika Chippada about 6 years ago

  • Assigned To set to Ward Vandewege

#10 Updated by Ward Vandewege about 6 years ago

  • Status changed from New to In Progress

#11 Updated by Ward Vandewege about 6 years ago

  • Target version changed from 2014-10-29 sprint to 2014-11-19 sprint

#12 Updated by Ward Vandewege about 6 years ago

  • Target version changed from 2014-11-19 sprint to 2014-12-10 sprint

#13 Updated by Ward Vandewege almost 6 years ago

  • Target version changed from 2014-12-10 sprint to 2015-01-07 sprint

#14 Updated by Tom Clegg almost 6 years ago

  • Target version changed from 2015-01-07 sprint to Arvados Future Sprints

#15 Updated by Tom Clegg almost 6 years ago

  • Target version changed from Arvados Future Sprints to 2015-01-28 Sprint

#16 Updated by Tom Clegg almost 6 years ago

  • Target version changed from 2015-01-28 Sprint to 2015-02-18 sprint

#17 Updated by Ward Vandewege almost 6 years ago

  • Target version changed from 2015-02-18 sprint to 2015-03-11 sprint

#18 Updated by Ward Vandewege over 5 years ago

  • Status changed from In Progress to Resolved

Also available in: Atom PDF