Merge branch 'master' into 6384-libpam-arvados
[arvados.git] / doc / install / install-manual-prerequisites.html.textile.liquid
1 ---
2 layout: default
3 navsection: installguide
4 title: Prerequisites
5 ...
6
7 h2. Hardware (or virtual machines)
8
9 This guide assumes you have seven systems available in the same network subnet:
10
11 <div class="offset1">
12 table(table table-bordered table-condensed).
13 |_Function_|_Number of nodes_|
14 |Arvados API, Crunch dispatcher, Git, Websockets and Workbench|1|
15 |Arvados Compute node|1|
16 |Arvados Keepproxy server|1|
17 |Arvados Keepstore servers|2|
18 |Arvados Shell server|1|
19 |Arvados SSO server|1|
20 </div>
21
22 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.
23
24 h2(#repos). Arvados package repositories
25
26 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.
27
28 h3. CentOS
29
30 Packages are available for CentOS 6.  First, register the Curoverse signing key in RPM's database:
31
32 {% include 'install_redhat_key' %}
33
34 Then save this configuration block in @/etc/yum.repos.d/arvados.repo@:
35
36 <notextile>
37 <pre><code>[arvados]
38 name=Arvados
39 baseurl=http://rpm.arvados.org/CentOS/$releasever/os/$basearch/
40 </code></pre>
41 </notextile>
42
43 h3. Debian
44
45 Packages are available for Debian 7 ("wheezy").  First, register the Curoverse signing key in apt's database:
46
47 {% include 'install_debian_key' %}
48
49 Then save the configuration line listed for your version of Debian in @/etc/apt/sources.list.d/arvados.list@:
50
51 table(table table-bordered table-condensed).
52 |*Debian version*|*@/etc/apt/sources.list.d/arvados.list@*|
53 |7 ("wheezy")|@deb http://apt.arvados.org/ wheezy main@|
54
55 Finally, add this new repository to apt's database:
56
57 <notextile>
58 <pre><code>~$ <span class="userinput">sudo /usr/bin/apt-get update</span>
59 </code></pre>
60 </notextile>
61
62 h3. Ubuntu
63
64 Packages are available for Ubuntu 12.04 ("precise").  First, register the Curoverse signing key in apt's database:
65
66 {% include 'install_debian_key' %}
67
68 Then save the configuration line listed for your version of Ubuntu in @/etc/apt/sources.list.d/arvados.list@:
69
70 table(table table-bordered table-condensed).
71 |*Ubuntu version*|*@/etc/apt/sources.list.d/arvados.list@*|
72 |12.04 ("precise")|@deb http://apt.arvados.org/ precise main@|
73
74 h2. A unique identifier
75
76 Each Arvados installation should have a globally unique identifier, which is a unique 5-character alphanumeric string. Here is a snippet of ruby that generates such a string based on the hostname of your computer:
77
78 <pre>
79 Digest::MD5.hexdigest(`hostname`).to_i(16).to_s(36)[0..4]
80 </pre>
81
82 You may also use a different method to pick the unique identifier. The unique identifier will be part of the hostname of the services in your Arvados cluster. The rest of this documentation will refer to it as your @uuid_prefix@.
83
84
85 h2. SSL certificates
86
87 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:
88
89 <div class="offset1">
90 table(table table-bordered table-condensed).
91 |_Function_|_Hostname_|
92 |Arvados API|@uuid_prefix@.your.domain|
93 |Arvados Git server|git.@uuid_prefix@.your.domain|
94 |Arvados Keepproxy server|keep.@uuid_prefix@.your.domain|
95 |Arvados SSO Server|auth.your.domain|
96 |Arvados Websockets endpoint|ws.@uuid_prefix@.your.domain|
97 |Arvados Workbench|workbench.@uuid_prefix@.your.domain|
98 </div>