Refactor the multi-host salt install page.
[arvados.git] / doc / install / salt-single-host.html.textile.liquid
1 ---
2 layout: default
3 navsection: installguide
4 title: Single host Arvados
5 ...
6 {% comment %}
7 Copyright (C) The Arvados Authors. All rights reserved.
8
9 SPDX-License-Identifier: CC-BY-SA-3.0
10 {% endcomment %}
11
12 # "Limitations of the single host install":#limitations
13 # "Prerequisites":#prerequisites
14 # "Download the installer":#download
15 # "Copy the configuration files":#copy_config
16 # "Choose the SSL configuration":#certificates
17 ## "Using a self-signed certificate":#self-signed
18 ## "Using a Let's Encrypt certificate":#lets-encrypt
19 ## "Bring your own certificate":#bring-your-own
20 # "Further customization of the installation (modifying the salt pillars and states)":#further_customization
21 # "Run the provision.sh script":#run_provision_script
22 # "Install the CA root certificate":#ca_root_certificate
23 # "Initial user and login":#initial_user
24 # "Test the installed cluster running a simple workflow":#test_install
25 # "After the installation":#post_install
26
27 h2(#limitations). Limitations of the single host install
28
29 <b>NOTE: The single host installation is a good choice for evaluating Arvados, but it is not recommended for production use.</b>
30
31 Using the default configuration, this installation method has a number of limitations:
32
33 * all services run on the same machine, and they will compete for resources. This includes any compute jobs.
34 * it uses the local machine disk for Keep storage (under the @/tmp@ directory). There may not be a lot of space available.
35 * it installs the @crunch-dispatch-local@ dispatcher, which can run just eight concurrent CWL jobs. These jobs will be executed on the same machine that runs all the Arvados services and may well starve them of resources.
36
37 It is possible to start with the single host installation method and modify the Arvados configuration file later to address these limitations. E.g. switch to a "different storage volume setup":{{site.baseurl}}/install/configure-s3-object-storage.html for Keep, and switch to "the cloud dispatcher":{{site.baseurl}}/install/crunch2-cloud/install-dispatch-cloud.html to provision compute resources dynamically.
38
39 h2(#prerequisites). Prerequisites
40
41 * git
42 * a dedicated (virtual) machine for your Arvados server with at least 2 cores and 8 GiB of RAM, running a "supported Arvados distribution":{{site.baseurl}}/install/install-manual-prerequisites.html#supportedlinux
43 * a DNS hostname that resolves to the IP address of your Arvados server
44 * ports 443, 8800-8805 need to be reachable from your client (configurable in @local.params@, see below)
45 * port 80 needs to be reachable from everywhere on the internet (only when using "Let's Encrypt":#lets-encrypt)
46 * an SSL certificate matching the hostname in use (only when using "bring your own certificate":#bring-your-own)
47
48 h2(#download). Download the installer
49
50 {% include 'download_installer' %}
51
52 h2(#copy_config). Copy the configuration files
53
54 <notextile>
55 <pre><code>cp local.params.example.single_host_single_hostname local.params
56 cp -r config_examples/single_host/single_hostname local_config_dir
57 </code></pre>
58 </notextile>
59
60 Edit the variables in the <i>local.params</i> file. Pay attention to the <notextile><b>*_PORT, *_TOKEN</b> and <b>*_KEY</b></notextile> variables. The *SSL_MODE* variable is discussed in the next section.
61
62 {% include 'ssl_config' %}
63
64 h2(#further_customization). Further customization of the installation (modifying the salt pillars and states)
65
66 If you want or need further customization, you can edit the Saltstack pillars and states files. Pay particular attention to the <i>pillars/arvados.sls</i> one. Any extra <i>state</i> file you add under <i>local_config_dir/states</i> will be added to the salt run and applied to the host.
67
68 h2(#run_provision_script). Run the provision.sh script
69
70 When you finished customizing the configuration, you are ready to copy the files to the host (if needed) and run the @provision.sh@ script:
71
72 <notextile>
73 <pre><code>scp -r provision.sh local* tests user@host:
74 ssh user@host sudo ./provision.sh
75 </code></pre>
76 </notextile>
77
78 and wait for it to finish. The script will need 5 to 10 minutes to install and configure everything.
79
80 If everything goes OK, you'll get final output that looks similar to this:
81
82 <notextile>
83 <pre><code>arvados: Succeeded: 151 (changed=36)
84 arvados: Failed:      0
85 </code></pre>
86 </notextile>
87
88 {% include 'install_ca_cert' %}
89
90 h2(#initial_user). Initial user and login
91
92 At this point you should be able to log on to your new Arvados cluster. The workbench URL will be
93
94 * https://@HOSTNAME_EXT@
95
96 By default, the provision script creates an initial user for testing purposes. This user is configured as administrator of the newly created cluster. The username, password and e-mail address for the initial user are configured in the @local.params@ file. Log in with the e-mail address and password.
97
98 h2(#test_install). Test the installed cluster running a simple workflow
99
100 The @provision.sh@ script saves a simple example test workflow in the @/tmp/cluster_tests@ directory in the node. If you want to run it, just ssh to the node, change to that directory and run:
101
102 <notextile>
103 <pre><code>cd /tmp/cluster_tests
104 sudo ./run-test.sh
105 </code></pre>
106 </notextile>
107
108 It will create a test user (by default, the same one as the admin user), upload a small workflow and run it. If everything goes OK, the output should similar to this (some output was shortened for clarity):
109
110 <notextile>
111 <pre><code>Creating Arvados Standard Docker Images project
112 Arvados project uuid is 'arva2-j7d0g-0prd8cjlk6kfl7y'
113 {
114  ...
115  "uuid":"arva2-o0j2j-n4zu4cak5iifq2a",
116  "owner_uuid":"arva2-tpzed-000000000000000",
117  ...
118 }
119 Creating initial user ('admin')
120 Setting up user ('admin')
121 {
122  "items":[
123   {
124    ...
125    "owner_uuid":"arva2-tpzed-000000000000000",
126    ...
127    "uuid":"arva2-o0j2j-1ownrdne0ok9iox"
128   },
129   {
130    ...
131    "owner_uuid":"arva2-tpzed-000000000000000",
132    ...
133    "uuid":"arva2-o0j2j-1zbeyhcwxc1tvb7"
134   },
135   {
136    ...
137    "email":"admin@arva2.arv.local",
138    ...
139    "owner_uuid":"arva2-tpzed-000000000000000",
140    ...
141    "username":"admin",
142    "uuid":"arva2-tpzed-3wrm93zmzpshrq2",
143    ...
144   }
145  ],
146  "kind":"arvados#HashList"
147 }
148 Activating user 'admin'
149 {
150  ...
151  "email":"admin@arva2.arv.local",
152  ...
153  "username":"admin",
154  "uuid":"arva2-tpzed-3wrm93zmzpshrq2",
155  ...
156 }
157 Running test CWL workflow
158 INFO /usr/bin/cwl-runner 2.1.1, arvados-python-client 2.1.1, cwltool 3.0.20200807132242
159 INFO Resolved 'hasher-workflow.cwl' to 'file:///tmp/cluster_tests/hasher-workflow.cwl'
160 ...
161 INFO Using cluster arva2 (https://arva2.arv.local:8443/)
162 INFO Upload local files: "test.txt"
163 INFO Uploaded to ea34d971b71d5536b4f6b7d6c69dc7f6+50 (arva2-4zz18-c8uvwqdry4r8jao)
164 INFO Using collection cache size 256 MiB
165 INFO [container hasher-workflow.cwl] submitted container_request arva2-xvhdp-v1bkywd58gyocwm
166 INFO [container hasher-workflow.cwl] arva2-xvhdp-v1bkywd58gyocwm is Final
167 INFO Overall process status is success
168 INFO Final output collection d6c69a88147dde9d52a418d50ef788df+123
169 {
170     "hasher_out": {
171         "basename": "hasher3.md5sum.txt",
172         "class": "File",
173         "location": "keep:d6c69a88147dde9d52a418d50ef788df+123/hasher3.md5sum.txt",
174         "size": 95
175     }
176 }
177 INFO Final process status is success
178 </code></pre>
179 </notextile>
180
181 h2(#post_install). After the installation
182
183 Once the installation is complete, it is recommended to keep a copy of your local configuration files. Committing them to version control is a good idea.
184
185 Re-running the Salt-based installer is not recommended for maintaining and upgrading Arvados, please see "Maintenance and upgrading":{{site.baseurl}}/admin/maintenance-and-upgrading.html for more information.