16306: Merge branch 'master'
[arvados.git] / doc / install / automatic.html.textile.liquid
1 ---
2 layout: default
3 navsection: installguide
4 title: Automatic single-node install
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 This method sets up a new Arvados cluster using a single host/VM. It is the easiest way to get a new production cluster up and running.
13
14 A single-node installation supports all Arvados functionality at small scale. Substantial workloads will require additional nodes and configuration steps.
15
16 h2. Prerequisites
17
18 You will need:
19 * a server host running Debian 10 (buster).
20 * a unique 5-character ID like @x9999@ for your cluster (first character should be @[a-w]@ for a long-lived / production cluster; all characters are @[a-z0-9]@).
21 * a DNS name like @x9999.example.com@ that resolves to your server host (or a load balancer / proxy that passes HTTP and HTTPS requests through to your server host).
22 * a Google account (use it in place of <code>example@gmail.com.example</code> in the instructions below).
23
24 h2. Initialize the cluster
25
26 <pre>
27 # apt-get install arvados-server
28 # arvados-server init -type production -cluster-id x9999 -controller-address x9999.example.com -admin-email example@gmail.com.example
29 </pre>
30
31 When the "init" command is finished, navigate to the link shown in the terminal (e.g., @https://x9999.example.com/?api_token=zzzzzzzzzzzzzzzzzzzzzz@). This will log you in to your admin account.
32
33 h2. Enable login
34
35 Follow the instructions to "set up Google login":{{site.baseurl}}/install/setup-login.html or another authentication option.
36
37 After updating your configuration file (@/etc/arvados/config.yml@), restart the server to make your changes take effect:
38
39 <pre>
40 # systemctl restart arvados-server
41 </pre>