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.
-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".
+Add the following @location@ sections to @/etc/nginx/conf.d/arvados-workbench.conf@ .
<notextile>
-<pre><code>location /composer {
- root /var/www/arvados-composer
- index index.html
-}
+<pre><code>server {
+ [...]
+
+ location /composer {
+ root /var/www/arvados-composer;
+ index index.html;
+ }
-location /composer.yml {
- return 200 '{ "API_HOST": "<span class="userinput">ClusterID.example.com</span>" }';
+ location /composer/composer.yml {
+ return 200 '{ "API_HOST": "<span class="userinput">ClusterID.example.com</span>" }';
+ }
}
</code></pre>
</notextile>
</code></pre>
</notextile>
+"Make sure to install the arvados/jobs image.":install-jobs-image.html
+
Submit a simple container request:
<notextile>
<notextile>
<pre><code>~$ <span class="userinput">uuid_prefix=$(arv --format=uuid user current | cut -d- -f1)</span>
-~$ <span class="userinput">project_uuid=$(arv --format=uuid group create --group '{"owner_uuid":"$uuid_prefix-tpzed-000000000000000", "group_class":"project", "name":"Arvados Standard Docker Images"}')</span>
+~$ <span class="userinput">project_uuid=$(arv --format=uuid group create --group '{"owner_uuid":"'$uuid_prefix'-tpzed-000000000000000", "group_class":"project", "name":"Arvados Standard Docker Images"}')</span>
~$ <span class="userinput">echo "Arvados project uuid is '$project_uuid'"</span>
~$ <span class="userinput">read -rd $'\000' newlink <<EOF; arv link create --link "$newlink"</span>
<span class="userinput">{
# "Install dependencies":#dependencies
# "Update config.yml":#update-config
# "Update Nginx configuration":#update-nginx
+# "Trusted client flag":#trusted_client
# "Install arvados-workbench":#install-packages
# "Restart the API server and controller":#restart-api
# "Confirm working installation":#confirm-working
-# "Trusted client setting":#trusted_client
h2(#dependencies). Install dependencies
</code></pre>
</notextile>
+h2(#trusted_client). Trusted client flag
+
+In the <strong>API server</strong> project root, start the Rails console. {% include 'install_rails_command' %}
+
+Create an ApiClient record for your Workbench installation with the @is_trusted@ flag set.
+
+<notextile><pre><code>irb(main):001:0> <span class="userinput">include CurrentApiClient</span>
+=> true
+irb(main):002:0> <span class="userinput">act_as_system_user do ApiClient.create!(url_prefix: "https://workbench.ClusterID.example.com/", is_trusted: true) end</span>
+=> #<ApiClient id: 2, uuid: "...", owner_uuid: "...", modified_by_client_uuid: nil, modified_by_user_uuid: "...", modified_at: "2019-12-16 14:19:10", name: nil, url_prefix: "https://workbench.ClusterID.example.com/", created_at: "2019-12-16 14:19:10", updated_at: "2019-12-16 14:19:10", is_trusted: true>
+</code></pre>
+</notextile>
+
{% assign arvados_component = 'arvados-workbench' %}
{% include 'install_packages' %}
h2(#confirm-working). Confirm working installation
Visit @https://workbench.ClusterID.example.com@ in a browser. You should be able to log in using the login method you configured in the previous step. If @Users.AutoAdminFirstUser@ is true, you will be an admin user.
-
-h2(#trusted_client). Trusted client flag
-
-Log in to Workbench once to ensure that the Arvados API server has a record of the Workbench client. (It's OK if Workbench says your account hasn't been activated yet. We'll deal with that next.)
-
-In the <strong>API server</strong> project root, start the Rails console. {% include 'install_rails_command' %}
-
-At the console, enter the following commands to locate the ApiClient record for your Workbench installation (typically, while you're setting this up, the @last@ one in the database is the one you want), then set the @is_trusted@ flag for the appropriate client record:
-
-<notextile><pre><code>irb(main):001:0> <span class="userinput">wb = ApiClient.all.last; [wb.url_prefix, wb.created_at]</span>
-=> ["https://workbench.example.com/", Sat, 19 Apr 2014 03:35:12 UTC +00:00]
-irb(main):002:0> <span class="userinput">include CurrentApiClient</span>
-=> true
-irb(main):003:0> <span class="userinput">act_as_system_user do wb.update_attributes!(is_trusted: true) end</span>
-=> true
-</code></pre>
-</notextile>
<notextile>
<pre><code> Services:
Workbench2:
- ExternalURL: <span class="userinput">"https://workbench2.ClustedID.example.com"</span>
+ ExternalURL: <span class="userinput">"https://workbench2.ClusterID.example.com"</span>
</code></pre>
</notextile>
-h2. Vocabulary configuration (optional)
-
-Workbench2 can load a vocabulary file which lists available metadata properties for groups and collections. To configure the property vocabulary definition, please visit the "Workbench2 Vocabulary Format":{{site.baseurl}}/admin/workbench2-vocabulary.html page in the Admin section.
-
h2(#update-nginx). Update Nginx configuration
Workbench2 does not require its own database. It is a set of html, javascript and css files that are served as static files from Nginx.
<notextile>
<pre><code>server {
- listen <span class="userinput">[your public IP address]</span>:443 ssl;
+ listen *:443 ssl;
server_name workbench2.<span class="userinput">ClusterID.example.com</span>;
ssl on;
- ssl_certificate <span class="userinput">/YOUR/PATH/TO/cert.pem</span>;
- ssl_certificate_key <span class="userinput">/YOUR/PATH/TO/cert.key</span>;
+ ssl_certificate <span class="userinput">/TODO/YOUR/PATH/TO/cert.pem</span>;
+ ssl_certificate_key <span class="userinput">/TODO/YOUR/PATH/TO/cert.key</span>;
index index.html;
- # Workbench2 uses a call to /config.json to bootstrap itself and talk to the desired API server
+ # TODO: Workbench2 uses a call to /config.json to bootstrap itself
+ # and find out where to contact the API server.
location /config.json {
return 200 '{ "API_HOST": "<span class="userinput">ClusterID.example.com</span>" }';
}
</code></pre>
</notextile>
+h2. Vocabulary configuration (optional)
+
+Workbench2 can load a vocabulary file which lists available metadata properties for groups and collections. To configure the property vocabulary definition, please visit the "Workbench2 Vocabulary Format":{{site.baseurl}}/admin/workbench2-vocabulary.html page in the Admin section.
+
{% assign arvados_component = 'arvados-workbench2' %}
{% include 'install_packages' %}
<pre><code> Services:
Websocket:
InternalURLs:
- <span class="userinput">"http://ws.ClusterID.example.com:8005"</span>: {}
+ "http://localhost:8005"</span>: {}
ExternalURL: <span class="userinput">wss://ws.ClusterID.example.com/websocket</span>
</span></code></pre>
</notextile>
}
server {
- listen <span class="userinput">[your public IP address]</span>:443 ssl;
- server_name ws.<span class="userinput">uuid_prefix.your.domain</span>;
+ listen *:443 ssl;
+ server_name ws.<span class="userinput">ClusterID.example.com</span>;
proxy_connect_timeout 90s;
proxy_read_timeout 300s;
ssl on;
- ssl_certificate <span class="userinput"/>YOUR/PATH/TO/cert.pem</span>;
- ssl_certificate_key <span class="userinput"/>YOUR/PATH/TO/cert.key</span>;
+ ssl_certificate <span class="userinput">/TODO/YOUR/PATH/TO/cert.pem</span>;
+ ssl_certificate_key <span class="userinput">/TODO/YOUR/PATH/TO/cert.key</span>;
location / {
proxy_pass http://arvados-ws;
Confirm the service is listening on its assigned port and responding to requests.
<notextile>
-<pre><code>~$ <span class="userinput">curl http://0.0.0.0:<b>8005</b>/status.json</span>
+<pre><code>~$ <span class="userinput">curl https://ws.ClusterID.example.com/status.json</span>
{"Clients":1}
</code></pre>
</notextile>
projects / arvados.git / commitdiff