[ARVADOS] updated: 1.3.0-1543-g281564ef3

Thu Aug 15 18:25:38 UTC 2019

Summary of changes:
 doc/admin/config-migration.html.textile.liquid    | 10 +++---
 doc/install/install-keepproxy.html.textile.liquid | 39 ++++++++++++++++-------
 2 files changed, 32 insertions(+), 17 deletions(-)

       via  281564ef3672e8655f95d2c7df031b552e090ccc (commit)
      from  5ae0a422e60788a4039d17d2d8dfb60f250329c7 (commit)

Those revisions listed above that are new to this repository have
not appeared on any other notification email; so we list those
revisions in full, below.


commit 281564ef3672e8655f95d2c7df031b552e090ccc
Author: Eric Biagiotti <ebiagiotti at veritasgenetics.com>
Date:   Thu Aug 15 14:25:29 2019 -0400

    14715: Fixes install and config migration docs
    
    Arvados-DCO-1.1-Signed-off-by: Eric Biagiotti <ebiagiotti at veritasgenetics.com>

diff --git a/doc/admin/config-migration.html.textile.liquid b/doc/admin/config-migration.html.textile.liquid
index 8bb108371..97039b394 100644
--- a/doc/admin/config-migration.html.textile.liquid
+++ b/doc/admin/config-migration.html.textile.liquid
@@ -64,19 +64,19 @@ Currently only reads @RemoteClusters@ from centralized configuration.  Still req
 
 h2(#keepproxy). keepproxy
 
-The legacy keepproxy config is stored at @/etc/arvados/keepproxy/keepproxy.yml@ and can still be used with the @-config=path/to/legacy/config@ keepproxy command line argument. If migrated to the centralized config at @/etc/arvados/config.yml@, @keepproxy.yml@ should be moved out of the way and/or deleted.
+The legacy keepproxy config is stored at @/etc/arvados/keepproxy/keepproxy.yml@ and will continue to take precedence over the cluster config, unless removed. Also, a legacy keepproxy config in a different path can be used with the @-config=path/to/legacy/config@ keepproxy command line argument. If a @-config@ command line argument is provided, this will take precedence over @/etc/arvados/keepproxy/keepproxy.yml@ and the cluster config. If migrated to the centralized config at @/etc/arvados/config.yml@, @keepproxy.yml@ should be moved out of the way and/or deleted and the @config@ command line argument should not be used.
 
 Configuration via individual command line arguments is no longer available. The following table maps former keepproxy command line arguments and legacy config values to their equivalent representation in the centralized config, which may need to be set manually.
 
 table(table table-bordered table-condensed).
 |*Command Line*|*Legacy keepproxy.yml*|*Centralized config.yml*|
-|-listen|Listen|Services:Keepproxy:InternalURLs|
+|-listen|Listen|Services.Keepproxy.InternalURLs|
 |-no-get|DisableGet|N/A|
 |-no-put|DisablePut|N/A|
-|-default-replicas|DefaultReplicas|Collections:DefaultReplication|
+|-default-replicas|DefaultReplicas|Collections.DefaultReplication|
 |-pid|PIDFile|N/A|
-|N/A|Debug|SystemLogs:LogLevel|
-|-timeout|Timeout|API:KeepServiceRequestTimeout|
+|N/A|Debug|SystemLogs.LogLevel|
+|-timeout|Timeout|API.KeepServiceRequestTimeout|
 |-management-token|ManagementToken|ManagementToken|
 
 Note that some options are no longer supported. If you are still using the legacy config at @/etc/arvados/keepproxy/keepproxy.yml@ and @DisableGet@ or @DisablePut@ are set to true or @PIDFile@ has a value, keepproxy will produce an error and fail to start.
diff --git a/doc/install/install-keepproxy.html.textile.liquid b/doc/install/install-keepproxy.html.textile.liquid
index 738cd523e..da1146d88 100644
--- a/doc/install/install-keepproxy.html.textile.liquid
+++ b/doc/install/install-keepproxy.html.textile.liquid
@@ -56,7 +56,7 @@ Edit the cluster config at @/etc/arvados/config.yml@ and set @Services.Keepproxy
 
 <notextile>
 <pre><code>Clusters:
-  zzzzz:
+  <span class="userinput">uuid_prefix</span>:
     Services:
       <span class="userinput">Keepproxy:
         ExternalURL: https://keep.uuid_prefix.your.domain
@@ -65,17 +65,6 @@ Edit the cluster config at @/etc/arvados/config.yml@ and set @Services.Keepproxy
 </span></code></pre>
 </notextile>
 
-h3. Set up the Keepproxy service
-
-Install runit to supervise the keepproxy daemon.  {% include 'install_runit' %}
-
-The keepproxy command to run is:
-
-<notextile>
-<pre><code>~$ <span class="userinput">exec keepproxy
-</code></pre>
-</notextile>
-
 h3. Set up a reverse proxy with SSL support
 
 Because the Keepproxy is intended for access from anywhere on the internet, it is recommended to use SSL for transport encryption.
@@ -140,6 +129,32 @@ export ARVADOS_API_TOKEN=zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz
 EOF</span>
 </code></pre></notextile>
 
+h2. Run Keepproxy
+
+h3. Start the service (option 1: systemd)
+
+If your system does not use systemd, skip this section and follow the "runit instructions":#runit instead.
+
+If your system uses systemd, the keepproxy service should already be set up. Start it and check its status:
+
+<notextile>
+<pre><code>~$ <span class="userinput">sudo systemctl restart keepproxy</span>
+~$ <span class="userinput">sudo systemctl status keepproxy</span>
+&#x25cf; keepproxy.service - Arvados Keep Proxy
+   Loaded: loaded (/lib/systemd/system/keepproxy.service; enabled)
+   Active: active (running) since Tue 2019-07-23 09:33:47 EDT; 3 weeks 1 days ago
+     Docs: https://doc.arvados.org/
+ Main PID: 1150 (Keepproxy)
+   CGroup: /system.slice/keepproxy.service
+           └─1150 /usr/bin/keepproxy
+[...]
+</code></pre>
+</notextile>
+
+h3(#runit). Start the service (option 2: runit)
+
+Install runit to supervise the Keep-web daemon.  {% include 'install_runit' %}
+
 h3. Testing keepproxy
 
 Log into a host that is on an external network from your private Arvados network.  The host should be able to contact your keepproxy server (eg keep.$uuid_prefix.arvadosapi.com), but not your keepstore servers (eg keep[0-9].$uuid_prefix.arvadosapi.com).

-----------------------------------------------------------------------


hooks/post-receive
-- 


