Merge branch 'master' into 10112-workflow-show
[arvados.git] / doc / install / install-manual-prerequisites.html.textile.liquid
index de8f8cb9e096081610b6d95474bcc5c19c3a9fb3..e90ca976a9a189fa4b1557b5d3980cf070d05cb9 100644 (file)
@@ -13,7 +13,7 @@ table(table table-bordered table-condensed).
 |_Function_|_Number of nodes_|
 |Arvados API, Crunch dispatcher, Git, Websockets and Workbench|1|
 |Arvados Compute node|1|
-|Arvados Keepproxy server|1|
+|Arvados Keepproxy and Keep-web server|1|
 |Arvados Keepstore servers|2|
 |Arvados Shell server|1|
 |Arvados SSO server|1|
@@ -21,13 +21,25 @@ table(table table-bordered table-condensed).
 
 The number of Keepstore, shell and compute nodes listed above is a minimum. In a real production installation, you will likely run many more of each of those types of nodes. In such a scenario, you would probably also want to dedicate a node to the Workbench server and Crunch dispatcher, respectively. For performance reasons, you may want to run the database server on a separate node as well.
 
+h2. Supported GNU/Linux distributions
+
+table(table table-bordered table-condensed).
+|_Distribution_|_State_|_Last supported version_|
+|CentOS 7|Supported|Latest|
+|Debian 8 ("jessie")|Supported|Latest|
+|Ubuntu 12.04 ("precise")|Supported|Latest|
+|Ubuntu 14.04 ("trusty")|Supported|Latest|
+|Ubuntu 16.04 ("xenial")|Supported|Latest|
+|Debian 7 ("wheezy")|EOL|997479d1408139e96ecdb42a60b4f727f814f6c9 (2016-12-28)|
+|CentOS 6 |EOL|997479d1408139e96ecdb42a60b4f727f814f6c9 (2016-12-28)|
+
 h2(#repos). Arvados package repositories
 
 On any host where you install Arvados software, you'll need to set up an Arvados package repository.  They're available for several popular distributions.
 
 h3. CentOS
 
-Packages are available for CentOS 6.  First, register the Curoverse signing key in RPM's database:
+Packages are available for CentOS 7.  First, register the Curoverse signing key in RPM's database:
 
 {% include 'install_redhat_key' %}
 
@@ -40,37 +52,28 @@ baseurl=http://rpm.arvados.org/CentOS/$releasever/os/$basearch/
 </code></pre>
 </notextile>
 
-h3. Debian
+h3. Debian and Ubuntu
 
-Packages are available for Debian 7 ("wheezy").  First, register the Curoverse signing key in apt's database:
+Packages are available for Debian 8 ("jessie"), Ubuntu 12.04 ("precise"), Ubuntu 14.04 ("trusty") and Ubuntu 16.04 ("xenial").
+
+First, register the Curoverse signing key in apt's database:
 
 {% include 'install_debian_key' %}
 
-Then save the configuration line listed for your version of Debian in @/etc/apt/sources.list.d/arvados.list@:
+Configure apt to retrieve packages from the Arvados package repository. This command depends on your OS vendor and version:
 
 table(table table-bordered table-condensed).
-|*Debian version*|*@/etc/apt/sources.list.d/arvados.list@*|
-|7 ("wheezy")|@deb http://apt.arvados.org/ wheezy main@|
-
-Finally, add this new repository to apt's database:
-
-<notextile>
-<pre><code>~$ <span class="userinput">sudo /usr/bin/apt-get update</span>
-</code></pre>
-</notextile>
+|OS version|Command|
+|Debian 8 ("jessie")|<notextile><code><span class="userinput">echo "deb http://apt.arvados.org/ jessie main" &#x7c; sudo tee /etc/apt/sources.list.d/arvados.list</span></code></notextile>|
+|Ubuntu 12.04 ("precise")[1]|<notextile><code><span class="userinput">echo "deb http://apt.arvados.org/ precise main" &#x7c; sudo tee /etc/apt/sources.list.d/arvados.list</span></code></notextile>|
+|Ubuntu 14.04 ("trusty")[1]|<notextile><code><span class="userinput">echo "deb http://apt.arvados.org/ trusty main" &#x7c; sudo tee /etc/apt/sources.list.d/arvados.list</span></code></notextile>|
+|Ubuntu 16.04 ("xenial")[1]|<notextile><code><span class="userinput">echo "deb http://apt.arvados.org/ xenial main" &#x7c; sudo tee /etc/apt/sources.list.d/arvados.list</span></code></notextile>|
 
-h3. Ubuntu
+{% include 'notebox_begin' %}
 
-Packages are available for Ubuntu 12.04 ("precise").  First, register the Curoverse signing key in apt's database:
+fn1. Arvados packages for Ubuntu may depend on third-party packages in Ubuntu's "universe" repository.  If you're installing on Ubuntu, make sure you have the universe sources uncommented in @/etc/apt/sources.list@.
 
-{% include 'install_debian_key' %}
-
-Configure apt to retrieve packages from the Arvados package repository:
-
-<notextile>
-<pre><code>~$ <span class="userinput">echo "deb http://apt.arvados.org/ $(lsb_release -cs) main" | sudo tee /etc/apt/sources.list.d/arvados.list</span>
-</code></pre>
-</notextile>
+{% include 'notebox_end' %}
 
 Retrieve the package list:
 
@@ -93,7 +96,25 @@ You may also use a different method to pick the unique identifier. The unique id
 
 h2. SSL certificates
 
-There are six public-facing services that will require an SSL certificate. If you do not have official SSL certificates, you can use self-signed certificates. By convention, we use the following hostname pattern:
+There are six public-facing services that require an SSL certificate. If you do not have official SSL certificates, you can use self-signed certificates.
+
+{% include 'notebox_begin' %}
+
+Most Arvados clients and services will accept self-signed certificates when the @ARVADOS_API_HOST_INSECURE@ environment variable is set to @true@.  However, web browsers generally do not make it easy for users to accept self-signed certificates from Web sites.
+
+Users who log in through Workbench will visit at least three sites: the SSO server, the API server, and Workbench itself.  When a browser visits each of these sites, it will warn the user if the site uses a self-signed certificate, and the user must accept it before continuing.  This procedure usually only needs to be done once in a browser.
+
+After that's done, Workbench includes JavaScript clients for other Arvados services.  Users are usually not warned if these client connections are refused because the server uses a self-signed certificate, and it is especially difficult to accept those cerficiates:
+
+* JavaScript connects to the Websockets server to provide incremental page updates and view logs from running jobs.
+* JavaScript connects to the API and Keepproxy servers to upload local files to collections.
+* JavaScript connects to the Keep-web server to download log files.
+
+In sum, Workbench will be much less pleasant to use in a cluster that uses self-signed certificates.  You should avoid using self-signed certificates unless you plan to deploy a cluster without Workbench; you are deploying only to evaluate Arvados as an individual system administrator; or you can push configuration to users' browsers to trust your self-signed certificates.
+
+{% include 'notebox_end' %}
+
+By convention, we use the following hostname pattern:
 
 <div class="offset1">
 table(table table-bordered table-condensed).
@@ -101,6 +122,11 @@ table(table table-bordered table-condensed).
 |Arvados API|@uuid_prefix@.your.domain|
 |Arvados Git server|git.@uuid_prefix@.your.domain|
 |Arvados Keepproxy server|keep.@uuid_prefix@.your.domain|
+|Arvados Keep-web server|download.@uuid_prefix@.your.domain
+_and_
+*.collections.@uuid_prefix@.your.domain or
+*<notextile>--</notextile>collections.@uuid_prefix@.your.domain or
+collections.@uuid_prefix@.your.domain (see the "keep-web install docs":install-keep-web.html)|
 |Arvados SSO Server|auth.your.domain|
 |Arvados Websockets endpoint|ws.@uuid_prefix@.your.domain|
 |Arvados Workbench|workbench.@uuid_prefix@.your.domain|