5194: minor fixes
[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 REST API, Websockets, Workbench and Crunch dispatcher|1|
15 |Arvados SSO server|1|
16 |Arvados Keepproxy server|1|
17 |Arvados Keepstore servers|2|
18 |Arvados shell server|1|
19 |Arvados compute node|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. A unique identifier
25
26 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:
27
28 <pre>
29 Digest::MD5.hexdigest(`hostname`).to_i(16).to_s(36)[0..4]
30 </pre>
31
32 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@. 
33
34
35 h2. SSL certificates
36
37 There are four 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:
38
39 <div class="offset1">
40 table(table table-bordered table-condensed).
41 |_Function_|_Hostname_|
42 |Arvados REST API|@uuid_prefix@.your.domain|
43 |Arvados Websockets endpoint|ws.@uuid_prefix@.your.domain|
44 |Arvados Keepproxy server|keep.@uuid_prefix@.your.domain|
45 |Arvados Workbench|workbench.@uuid_prefix@.your.domain|
46 </div>