15694: Catch exception from get_current_container in runtime_status_update

[arvados.git] / doc / install / install-workbench-app.html.textile.liquid

diff --git a/doc/install/install-workbench-app.html.textile.liquid b/doc/install/install-workbench-app.html.textile.liquid
index 9f8d3212b21b8f97a9c6ba759fe1db7be8d8ce13..72a80fd834e2c272544de6bae238113f6355032a 100644 (file)
--- a/doc/install/install-workbench-app.html.textile.liquid
+++ b/doc/install/install-workbench-app.html.textile.liquid
@@ -3,6 +3,11 @@ layout: default
 navsection: installguide
 title: Install Workbench
 ...
 navsection: installguide
 title: Install Workbench
 ...

+{% comment %}
+Copyright (C) The Arvados Authors. All rights reserved.
+
+SPDX-License-Identifier: CC-BY-SA-3.0
+{% endcomment %}

 
 h2. Install prerequisites
 
 
 h2. Install prerequisites
 


@@ -16,7 +21,7 @@ h2(#install_workbench). Install Workbench and dependencies
 
 Workbench doesn't need its own database, so it does not need to have PostgreSQL installed.
 
 
 Workbench doesn't need its own database, so it does not need to have PostgreSQL installed.
 

-{% assign rh_version = "6" %}
+{% assign rh_version = "7" %}

 {% include 'note_python_sc' %}
 
 On a Debian-based system, install the following packages:
 {% include 'note_python_sc' %}
 
 On a Debian-based system, install the following packages:


@@ -35,11 +40,9 @@ On a Red Hat-based system, install the following packages:
 
 h2(#configure). Configure Workbench
 
 
 h2(#configure). Configure Workbench
 

-Edit @/etc/arvados/workbench/application.yml@ following the instructions below.  Workbench reads both @application.yml@ and its own @config/application.defaults.yml@ file.  Values in @application.yml@ take precedence over the defaults that are defined in @config/application.defaults.yml@.  The @config/application.yml.example@ file is not read by Workbench and is provided for installation convenience only.
-
-Consult @config/application.default.yml@ for a full list of configuration options.  Always put your local configuration in @/etc/arvados/workbench/application.yml@—never edit @config/application.default.yml@.
+Edit @/etc/arvados/config.yml@ to set the keys below.  Only the most important configuration options are listed here.  The full set of configuration options are in the "Workbench section of config.yml":{{site.baseurl}}/admin/config.html

 
 

-h3. secret_token
+h3. Workbench.SecretKeyBase

 
 This application needs a secret token. Generate a new secret:
 
 
 This application needs a secret token. Generate a new secret:
 


@@ -49,33 +52,57 @@ aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
 </code></pre>
 </notextile>
 
 </code></pre>
 </notextile>
 

-Then put that value in the @secret_token@ field.
+Then put that value in the @Workbench.SecretKeyBase@ field.

 
 

-h3. arvados_login_base and arvados_v1_base
+<notextile>
+<pre><code>Cluster:
+  zzzzz:
+    Workbench:
+      SecretKeyBase: <span class="userinput">aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa</span>
+</code></pre>
+</notextile>
+
+h3. Services.Controller.ExternalURL

 
 

-Point @arvados_login_base@ and @arvados_v1_base@ at your "API server":install-api-server.html. For example like this:
+Ensure that @Services.Controller.ExternalURL@ is configured for "Arvados Controller":install-controller.html . For example like this:

 
 <notextile>
 
 <notextile>

-<pre><code>arvados_login_base: https://prefix_uuid.your.domain/login
-arvados_v1_base: https://prefix_uuid.your.domain/arvados/v1
+<pre><code>Cluster:
+  zzzzz:
+    Services:
+      Controller:
+        ExternalURL: <span class="userinput">https://prefix_uuid.your.domain</span>

 </code></pre>
 </notextile>
 
 </code></pre>
 </notextile>
 

-h3. site_name
+h3. Workbench.SiteName

 
 

-@site_name@ can be set to any arbitrary string. It is used to identify this Workbench to people visiting it.
+@Workbench.SiteName@ can be set to any arbitrary string. It is used to identify this Workbench to people visiting it.

 
 

-h3. arvados_insecure_https

 
 

-If the SSL certificate you use for your API server isn't an official certificate signed by a CA, make sure @arvados_insecure_https@ is @true@.
+<notextile>
+<pre><code>Cluster:
+  zzzzz:
+    Workbench:
+      SiteName: <span class="userinput">My Arvados</span>
+</code></pre>
+</notextile>
+
+h3. TLS.Insecure

 
 

-h3. Other options
+For testing only.  Allows use of self-signed certificates.  If true, workbench will not verify the TLS certificate of Arvados Controller.

 
 

-Consult @application.default.yml@ for a full list of configuration options. Always put your local configuration in @application.yml@ instead of editing @application.default.yml@.
+<notextile>
+<pre><code>Cluster:
+  zzzzz:
+    TLS:
+      Insecure: <span class="userinput">false</span>
+</code></pre>
+</notextile>

 
 

-h2. Configure Piwik
+h2. Configure Piwik (optional)

 
 

-In @/var/www/arvados-workbench/current/config@, copy @piwik.yml.example@ to @piwik.yml@ and edit to suit.
+Piwik can be used to gather usage analytics.  In @/var/www/arvados-workbench/current/config@, copy @piwik.yml.example@ to @piwik.yml@ and edit to suit.

 
 h2. Set up Web server
 
 
 h2. Set up Web server
 


@@ -99,7 +126,7 @@ For best performance, we recommend you use Nginx as your Web server front-end, w
   #passenger_ruby /usr/local/rvm/wrappers/default/ruby;
 
   # `client_max_body_size` should match the corresponding setting in
   #passenger_ruby /usr/local/rvm/wrappers/default/ruby;
 
   # `client_max_body_size` should match the corresponding setting in

-  # the API server's Nginx configuration.
+  # the API.MaxRequestSize and Controller's server's Nginx configuration.

   client_max_body_size 128m;
 }
 
   client_max_body_size 128m;
 }
 


@@ -119,7 +146,7 @@ server {
 
   index  index.html index.htm index.php;
   # `client_max_body_size` should match the corresponding setting in
 
   index  index.html index.htm index.php;
   # `client_max_body_size` should match the corresponding setting in

-  # the API server's Nginx configuration.
+  # the API.MaxRequestSize and Controller's server's Nginx configuration.

   client_max_body_size 128m;
 
   location / {
   client_max_body_size 128m;
 
   location / {