[ARVADOS] updated: 2.1.0-9-g6c8ca0862

Thu Oct 15 14:08:57 UTC 2020

Summary of changes:
 doc/api/keep-s3.html.textile.liquid     | 10 ++++++----
 doc/api/keep-webdav.html.textile.liquid | 10 ++++++++--
 2 files changed, 14 insertions(+), 6 deletions(-)

       via  6c8ca0862ed8a66dd42a85ec498fd6e32fad310f (commit)
      from  c01459a74632120eef952eec68780d02aa26c94c (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 6c8ca0862ed8a66dd42a85ec498fd6e32fad310f
Author: Peter Amstutz <peter.amstutz at curii.com>
Date:   Thu Oct 15 10:08:42 2020 -0400

    16558: Add supported operations to WebDAV
    
    Arvados-DCO-1.1-Signed-off-by: Peter Amstutz <peter.amstutz at curii.com>

diff --git a/doc/api/keep-s3.html.textile.liquid b/doc/api/keep-s3.html.textile.liquid
index d0346cb69..b56b232f3 100644
--- a/doc/api/keep-s3.html.textile.liquid
+++ b/doc/api/keep-s3.html.textile.liquid
@@ -11,7 +11,7 @@ Copyright (C) The Arvados Authors. All rights reserved.
 SPDX-License-Identifier: CC-BY-SA-3.0
 {% endcomment %}
 
-The Simple Storage Service (S3) is a de-facto standard for object storage originally developed by Amazon Web Services.  Arvados supports accessing files in Keep using the S3 API.
+The Simple Storage Service (S3) API is a de-facto standard for object storage originally developed by Amazon Web Services.  Arvados supports accessing files in Keep using the S3 API.
 
 S3 is supported by many "cloud native" applications, and client libraries exist in many languages for programmatic access.
 
@@ -19,9 +19,9 @@ h3. Endpoints and Buckets
 
 To access Arvados S3 using an S3 client library, you must tell it to use URL of the keep-web server (this is @Services.WebDAVDownload.ExternalURL@ in the public configuration) as the custom endpoint.
 
-The "bucket name" must be encoded as the first path segment of every request.  This is what Amazon calls "Path-Style Requests".
+The "bucket name" is an Arvados collection uuid, portable data hash, or project uuid.
 
-The bucket name must be an Arvados collection uuid, portable data hash, or project uuid.
+The bucket name must be encoded as the first path segment of every request.  This is what the S3 documentation calls "Path-Style Requests".
 
 h3. Supported Operations
 
@@ -75,4 +75,6 @@ Can be used one of two ways:
 * The "Credential" is the Arvados token uuid, and the "Signature" is derived from request headers and the Arvados token secret
 * The "Credential" is the Arvados token secret, and "Signature" is derived from the same Arvados token secret
 
-Also accepts older format @Authorization: AWS AccessKey:signature@ .  Provide the Arvados secret token for the "Access Key".  In this case, the signature is ignored.
+Consult the S3 documentation for information on how to produce AWS4-HMAC-SHA256 signatures.  If you are using a S3 client library, it should be handled for you already.
+
+Keep-web also accepts older format header @Authorization: AWS AccessKey:signature@ .  Provide the Arvados secret token for the "Access Key".  In this case, the signature can be anything as keep-web will ignore it.
diff --git a/doc/api/keep-webdav.html.textile.liquid b/doc/api/keep-webdav.html.textile.liquid
index 4b3f63d9b..1e9620cf0 100644
--- a/doc/api/keep-webdav.html.textile.liquid
+++ b/doc/api/keep-webdav.html.textile.liquid
@@ -11,12 +11,18 @@ Copyright (C) The Arvados Authors. All rights reserved.
 SPDX-License-Identifier: CC-BY-SA-3.0
 {% endcomment %}
 
-"Web Distributed Authoring and Versioning (WebDAV)":https://tools.ietf.org/html/rfc2518 is an IETF standard set of extensions to HTTP to manipulate and retrieve hierarchical web resources, similar to directories in a file system.  Arvados supports accessing files in Keep using WebDAV.
+"Web Distributed Authoring and Versioning (WebDAV)":https://tools.ietf.org/html/rfc4918 is an IETF standard set of extensions to HTTP to manipulate and retrieve hierarchical web resources, similar to directories in a file system.  Arvados supports accessing files in Keep using WebDAV.
 
 Most major operating systems include built-in support for mounting WebDAV resources as network file systems, see user guide sections for "Windows":{{site.baseurl}}/user/tutorials/tutorial-keep-mount-windows.html , "macOS":{{site.baseurl}}/user/tutorials/tutorial-keep-mount-os-x.html , "Linux (Gnome)":{{site.baseurl}}/user/tutorials/tutorial-keep-mount-gnu-linux.html#gnome .  WebDAV is also supported by various standalone storage browser applications such as "Cyberduck":https://cyberduck.io/ and client libraries exist in many languages for programmatic access.
 
 Keep-web provides read/write HTTP (WebDAV) access to files stored in Keep. It serves public data to anonymous and unauthenticated clients, and serves private data to clients that supply Arvados API tokens. It can be installed anywhere with access to Keep services, typically behind a web proxy that supports TLS.
 
+h3. Supported Operations
+
+Supports WebDAV HTTP methods @GET@, @PUT@, @DELETE@, @PROPFIND@, @COPY@, and @MOVE at .
+
+Does not support @LOCK@ or @UNLOCK at .  These methods will be accepted, but are no-ops.
+
 h3. Browsing
 
 Fetching the root path an Arvados WebDAV service will return a 401 Unauthorized response with a @WWW-Authenticate@ header indicating "support for RFC 7617 Basic Authentication":https://tools.ietf.org/html/rfc7617 .  Requests may provide an Arvados token using @Authorization: Basic@ as described in "Authorization mechanisms":#auth .
@@ -148,7 +154,7 @@ Keep-web supports partial resource reads using the HTTP @Range@ header as specif
 
 h3. Compatibility
 
-Client-provided authorization tokens are ignored if the client does not provide a Host header.
+Client-provided authorization tokens are ignored if the client does not provide a @Host@ header.
 
 In order to use the query string or a POST form authorization mechanisms, the client must follow 303 redirects; the client must accept cookies with a 303 response and send those cookies when performing the redirect; and either the client or an intervening proxy must resolve a relative URL ("//host/path") if given in a response Location header.
 

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


hooks/post-receive
-- 


