Merge branch 'master' into 15572-new-install-docs
[arvados.git] / doc / install / install-composer.html.textile.liquid
1 ---
2 layout: default
3 navsection: installguide
4 title: Install Composer
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 Arvados Composer is a web-based javascript application for building Common Workflow Languge (CWL) Workflows.
13
14 # "Install dependencies":#dependencies
15 # "Update config.yml":#update-config
16 # "Update Nginx configuration":#update-nginx
17 # "Install arvados-composer":#install-packages
18 # "Restart the API server and controller":#restart-api
19 # "Confirm working installation":#confirm-working
20
21 h2(#dependencies). Install dependencies
22
23 In addition to Arvados core services, Composer requires "Arvados hosted git repositories":install-arv-git-httpd.html which are used for storing workflow files.
24
25 h2(#configure). Update config.yml
26
27 Edit @config.yml@ and set @Services.Composer.ExternalURL@ to the location from which it is served:
28
29 <notextile>
30 <pre><code>    Services:
31       Composer:
32         ExternalURL: <span class="userinput">https://workbench.CusterID.example.com/composer</span></code></pre>
33 </notextile>
34
35 h2(#update-nginx). Update nginx configuration
36
37 Composer may be served from the same host as Workbench.  Composer communicates directly with the Arvados API server.  It does not require its own backend and should be served as a static file.
38
39 Use a text editor to create a new file @/etc/nginx/conf.d/arvados-composer.conf@ with the following configuration.  Options that need attention are marked with "TODO".
40
41 <notextile>
42 <pre><code>location /composer {
43   root   /var/www/arvados-composer
44   index  index.html
45 }
46
47 location /composer.yml {
48   return 200 '{ "API_HOST": "<span class="userinput">ClusterID.example.com</span>" }';
49 }
50 </code></pre>
51 </notextile>
52
53 h2(#install-packages). Install arvados-composer
54
55 h3. Centos 7
56
57 <notextile>
58 <pre><code># <span class="userinput">yum install arvados-composer</span>
59 </code></pre>
60 </notextile>
61
62 h3. Debian and Ubuntu
63
64 <notextile>
65 <pre><code># <span class="userinput">apt-get --no-install-recommends install arvados-composer</span>
66 </code></pre>
67 </notextile>
68
69 h2(#restart-api). Restart the API server and controller
70
71 After adding Workbench to the Services section, make sure the cluster config file is up to date on the API server host, and restart the API server and controller processes to ensure the changes are applied.
72
73 <notextile>
74 <pre><code># <span class="userinput">systemctl restart nginx arvados-controller</span>
75 </code></pre>
76 </notextile>
77
78 h2(#confirm-working). Confirm working installation
79
80 Visit @https://workbench.ClusterID.example.com/composer@ in a browser.  You should be able to log in using the login method you configured previously.