13647: Add AccessViaHosts doc comment.

Arvados-DCO-1.1-Signed-off-by: Tom Clegg <tclegg@veritasgenetics.com>

diff --git a/doc/install/configure-fs-storage.html.textile.liquid b/doc/install/configure-fs-storage.html.textile.liquid
index aef6f13dc2abfe4c643816c75296140b6ceb9d5e..2e97813263bfbb45205e79c78e496a9c43578b5d 100644 (file)
--- a/doc/install/configure-fs-storage.html.textile.liquid
+++ b/doc/install/configure-fs-storage.html.textile.liquid
@@ -25,7 +25,7 @@ Note that each volume has an AccessViaHosts section indicating that (for example
     Volumes:
       <span class="userinput">uuid_prefix</span>-nyw5e-<span class="userinput">000000000000000</span>:
         AccessViaHosts:
-          "http://<span class="userinput">keep0.uuid_prefix.example.com</span>:25107/": {}
+          "http://<span class="userinput">keep0.uuid_prefix.example.com</span>:25107": {}
         Driver: Directory
         DriverParameters:
           # The directory that will be used as the backing store.
@@ -59,7 +59,7 @@ Note that each volume has an AccessViaHosts section indicating that (for example
 
       <span class="userinput">uuid_prefix</span>-nyw5e-<span class="userinput">000000000000001</span>:
         AccessViaHosts:
-          "http://keep1.<span class="userinput">uuid_prefix</span>.example.com:25107/": {}
+          "http://keep1.<span class="userinput">uuid_prefix</span>.example.com:25107": {}
         Driver: Directory
         DriverParameters:
           Root: /mnt/local-disk

diff --git a/lib/config/config.default.yml b/lib/config/config.default.yml
index 94cd1c602345dd9a7a222821aa5e0e17e2b04b18..b8c7fcccae5afefa878750e45dd7475356923b47 100644 (file)
--- a/lib/config/config.default.yml
+++ b/lib/config/config.default.yml
@@ -787,9 +787,24 @@ Clusters:
 
     Volumes:
       SAMPLE:
+        # AccessViaHosts specifies which keepstore processes can read
+        # and write data on the volume.
+        #
+        # For a local filesystem, AccessViaHosts has one entry,
+        # indicating which server the filesystem is located on.
+        #
+        # For a network-attached backend accessible by all keepstore
+        # servers, like a cloud storage bucket or an NFS mount,
+        # AccessViaHosts can be empty/omitted.
+        #
+        # Further info/examples:
+        # https://doc.arvados.org/install/configure-fs-storage.html
+        # https://doc.arvados.org/install/configure-s3-object-storage.html
+        # https://doc.arvados.org/install/configure-azure-blob-storage.html
         AccessViaHosts:
           SAMPLE:
             ReadOnly: false
+          "http://host1.example:25107": {}
         ReadOnly: false
         Replication: 1
         StorageClasses:

diff --git a/lib/config/generated_config.go b/lib/config/generated_config.go
index 00cefd70df741cbf15e80e2cc2462c3cf5bfda37..62c0a57917368cd262963204b4de7ee73ebf82a9 100644 (file)
--- a/lib/config/generated_config.go
+++ b/lib/config/generated_config.go
@@ -793,9 +793,24 @@ Clusters:
 
     Volumes:
       SAMPLE:
+        # AccessViaHosts specifies which keepstore processes can read
+        # and write data on the volume.
+        #
+        # For a local filesystem, AccessViaHosts has one entry,
+        # indicating which server the filesystem is located on.
+        #
+        # For a network-attached backend accessible by all keepstore
+        # servers, like a cloud storage bucket or an NFS mount,
+        # AccessViaHosts can be empty/omitted.
+        #
+        # Further info/examples:
+        # https://doc.arvados.org/install/configure-fs-storage.html
+        # https://doc.arvados.org/install/configure-s3-object-storage.html
+        # https://doc.arvados.org/install/configure-azure-blob-storage.html
         AccessViaHosts:
           SAMPLE:
             ReadOnly: false
+          "http://host1.example:25107": {}
         ReadOnly: false
         Replication: 1
         StorageClasses: