From: Tom Clegg Date: Tue, 10 Mar 2015 18:23:44 +0000 (-0400) Subject: 5073: Document docker limitations. Bring "overview" up to the top of the install... X-Git-Tag: 1.1.0~1763^2~1 X-Git-Url: https://git.arvados.org/arvados.git/commitdiff_plain/56907cb993bce1287242c379bdfd48e329aa307d 5073: Document docker limitations. Bring "overview" up to the top of the install section. --- diff --git a/doc/_config.yml b/doc/_config.yml index 0a6c4ede5c..3dd2e2e298 100644 --- a/doc/_config.yml +++ b/doc/_config.yml @@ -143,9 +143,9 @@ navbar: - Overview: - install/index.html.textile.liquid - Docker: + - install/pre-built-docker.html.textile.liquid - install/install-docker.html.textile.liquid - Manual installation: - - install/install-manual-overview.html.textile.liquid - install/install-manual-prerequisites.html.textile.liquid - install/install-api-server.html.textile.liquid - install/install-workbench-app.html.textile.liquid diff --git a/doc/install/index.html.textile.liquid b/doc/install/index.html.textile.liquid index 500f6f6bd0..2ae58b987c 100644 --- a/doc/install/index.html.textile.liquid +++ b/doc/install/index.html.textile.liquid @@ -4,24 +4,11 @@ navsection: installguide title: Installation overview ... -Arvados can be installed in multiple ways. Arvados does not depend on any particular cloud operating stack. Arvados runs on one or more GNU/Linux system(s). Arvados is being developed on Debian and Ubuntu GNU/Linux. +Arvados components run on GNU/Linux systems, and do not depend on any particular cloud operating stack. It is developed primarily on Debian and Ubuntu GNU/Linux. -h2. Quick installation +Arvados components can be installed and configured in a number of different ways. Step-by-step instructions are available for a few specific setups: +# "Install pre-built docker images":pre-built-docker.html *(quickest)* +# "Build your own docker images":install-docker.html from source +# "Manual installation":install-manual-prerequisites.html (most flexible) -Make sure curl and docker are installed on your system. Then, as a user in the docker group, execute - - -
~$ \curl -sSL http://get.arvados.org | bash
-
 - -This command will download the latest copy of the Arvados docker images. It also gets the arvdock command and saves it in the current working directory. It then uses arvdock to spin up Arvados. Depending on the speed of your internet connection, it can take a while to download the Arvados docker images. - -This installation method assumes your web browser and the Arvados docker containers run on the same host. - -If you prefer, you can also download the installation script and inspect it before running it. The @http://get.arvados.org@ url redirects to https://raw.githubusercontent.com/curoverse/arvados-dev/master/install/easy-docker-install.sh, which is the installation script. - -h2. Installation from source - -It is also possible to build the Arvados docker images from source. The instructions are available "here":install-docker.html. - -For production use or evaluation at scale a "Manual Installation":install-manual-overview.html is more appropriate. This installation method assumes you have a number of (virtual) machines at your disposal to install the different Arvados components onto. +For production use or evaluation at scale, the "manual installation":install-manual-prerequisites.html is more appropriate. This method assumes you have a number of (virtual) machines at your disposal for running the various Arvados components. diff --git a/doc/install/install-api-server.html.textile.liquid b/doc/install/install-api-server.html.textile.liquid index 6ce4de6b0b..c3d5200b16 100644 --- a/doc/install/install-api-server.html.textile.liquid +++ b/doc/install/install-api-server.html.textile.liquid @@ -138,13 +138,11 @@ Alternatively, if the database user you intend to use for the API server is not ~/arvados/services/api$ RAILS_ENV=production bundle exec rake db:seed -
- -

Note!

+{% include 'notebox_begin' %} You can safely ignore the following error message you may see when loading the database structure: 
ERROR:  must be owner of extension plpgsql
 -
+{% include 'notebox_end' %} h2(#omniauth). Set up omniauth diff --git a/doc/install/install-docker.html.textile.liquid b/doc/install/install-docker.html.textile.liquid index 00f84eb6e2..e84b59203e 100644 --- a/doc/install/install-docker.html.textile.liquid +++ b/doc/install/install-docker.html.textile.liquid @@ -1,17 +1,16 @@ --- layout: default navsection: installguide -title: Installing with Docker +title: Build and install docker images ... -h2. Purpose - This installation method is appropriate for local testing, evaluation, and development. For production use, this method is not recommended. h2. Prerequisites # A GNU/Linux (virtual) machine # A working Docker installation (see "Installing Docker":https://docs.docker.com/installation/) +# A working Go installation (see "Install the Go tools":https://golang.org/doc/install) h2. Download the source tree diff --git a/doc/install/install-manual-overview.html.textile.liquid b/doc/install/install-manual-overview.html.textile.liquid index 1ba9451529..fca5916a55 100644 --- a/doc/install/install-manual-overview.html.textile.liquid +++ b/doc/install/install-manual-overview.html.textile.liquid @@ -4,13 +4,12 @@ navsection: installguide title: Overview ... -{% include 'alert_stub' %} +{% comment %} +Obsolete page, no longer in nav. +{% endcomment %} -The manual installation guide will walk you through setting up a basic Arvados cluster on a number of (virtual) GNU/Linux systems. This installation method is intended for evaluation or production use at scale. - -
- -

Note

-

If you are looking to evaluate Arvados on one machine, we recommend the "Docker installation method":install-docker.html instead.

-
+ +Please proceed to "Prerequisites":install-manual-prerequisites.html. diff --git a/doc/install/pre-built-docker.html.textile.liquid b/doc/install/pre-built-docker.html.textile.liquid new file mode 100644 index 0000000000..fb87195e3e --- /dev/null +++ b/doc/install/pre-built-docker.html.textile.liquid @@ -0,0 +1,32 @@ +--- +layout: default +navsection: installguide +title: Install pre-built docker images +... + +{% include 'notebox_begin' %} +This method is easy, but is not yet suitable for production use. It is still in development: some features do not work yet. +* Websockets service is not enabled. This means Workbench auto-refresh and web upload (and some other features) do not work. +* The node manager is not enabled. Two worker containers are brought up at startup. +* The automatic network configuration allows you to log in to Workbench from a browser _running on the same host as docker_. Connecting from other hosts will require additional configuration (not covered here). +{% include 'notebox_end' %} + +First, make sure that @curl@ and @docker@ are installed on your system, and that you are in the docker group (see "Installing Docker":https://docs.docker.com/installation/). + +
~$ which curl
+/usr/bin/curl
+~$ docker.io --version
+Docker version 1.2.0-dev, build dc243c8
+~$ groups
+yourusername sudo fuse docker
+
 + +Download and install Arvados. + + +
~$ \curl -sSL get.arvados.org | bash
+
 + +This command will download the latest copy of the Arvados docker images. It also gets the arvdock command and saves it in the current working directory. It then uses arvdock to spin up Arvados. Depending on the speed of your internet connection, it can take a while to download the Arvados docker images. + +If you prefer, you can also download the installation script and inspect it before running it. @get.arvados.org@ redirects to "https://raw.githubusercontent.com/curoverse/arvados-dev/master/install/easy-docker-install.sh":https://raw.githubusercontent.com/curoverse/arvados-dev/master/install/easy-docker-install.sh, which is the installation script.