Arvados Composer is a web-based javascript application for building Common Workflow Languge (CWL) Workflows.
-h2. Prerequisites
+# "Install dependencies":#dependencies
+# "Update config.yml":#update-config
+# "Update Nginx configuration":#update-nginx
+# "Install arvados-composer":#install-packages
+# "Restart the API server and controller":#restart-api
+# "Confirm working installation":#confirm-working
-In addition to Arvados core services, Composer requires "Arvados hosted git repositories":install-arv-git-httpd.html which are used for storing workflow files.
-
-h2. Install
+h2(#dependencies). Install dependencies
-Composer may be installed on the same host as Workbench, or on a different host. Composer communicates directly with the Arvados API server. It does not require its own backend and should be served as a static file.
-
-On a Debian-based system, install the following package:
+In addition to Arvados core services, Composer requires "Arvados hosted git repositories":install-arv-git-httpd.html which are used for storing workflow files.
-<notextile>
-<pre><code>~$ <span class="userinput">sudo apt-get install arvados-composer</span>
-</code></pre>
-</notextile>
+h2(#configure). Update config.yml
-On a Red Hat-based system, install the following package:
+Edit @config.yml@ and set @Services.Composer.ExternalURL@ to the location from which it is served:
<notextile>
-<pre><code>~$ <span class="userinput">sudo yum install arvados-composer</span>
-</code></pre>
+<pre><code> Services:
+ Composer:
+ ExternalURL: <span class="userinput">https://workbench.CusterID.example.com/composer</span></code></pre>
</notextile>
-h2. Configure
+h2(#update-nginx). Update nginx configuration
-h3. Nginx
+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.
-Add Composer to your Nginx configuration. This example will host Composer at @/composer@.
+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".
-<pre>
-location /composer {
+<notextile>
+<pre><code>location /composer {
root /var/www/arvados-composer
index index.html
}
-</pre>
-h3. composer.yml
+location /composer.yml {
+ return 200 '{ "API_HOST": "<span class="userinput">ClusterID.example.com</span>" }';
+}
+</code></pre>
+</notextile>
+
+h2(#install-packages). Install arvados-composer
-Create @/var/www/arvados-composer/composer.yml@ and set @API_HOST@ to your API server:
+h3. Centos 7
-<pre>
-API_HOST: zzzzz.arvadosapi.com
-</pre>
+<notextile>
+<pre><code># <span class="userinput">yum install arvados-composer</span>
+</code></pre>
+</notextile>
-h3. Workbench link to composer
+h3. Debian and Ubuntu
-Edit @config.yml@ and set @Services.Composer.ExternalURL@ to the location from which it is served:
+<notextile>
+<pre><code># <span class="userinput">apt-get --no-install-recommends install arvados-composer</span>
+</code></pre>
+</notextile>
+
+h2(#restart-api). Restart the API server and controller
+
+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.
<notextile>
-<pre><code>Clusters:
- zzzzz:
- Services:
- Composer:
- ExternalURL: <span class="userinput">https://workbench.zzzzz.arvadosapi.com/composer</span></code></pre>
+<pre><code># <span class="userinput">systemctl restart nginx arvados-controller</span>
+</code></pre>
</notextile>
+
+h2(#confirm-working). Confirm working installation
+
+Visit @https://workbench.ClusterID.example.com/composer@ in a browser. You should be able to log in using the login method you configured previously.
projects / arvados.git / blobdiff