[ARVADOS] updated: 1.2.0-113-g8ba722358
Git user
git at public.curoverse.com
Fri Sep 28 16:02:32 EDT 2018
Summary of changes:
doc/api/methods.html.textile.liquid | 29 ++++++++++++++++++++--
doc/api/methods/collections.html.textile.liquid | 4 ++-
.../methods/container_requests.html.textile.liquid | 2 ++
doc/api/methods/containers.html.textile.liquid | 2 ++
doc/api/methods/workflows.html.textile.liquid | 2 ++
5 files changed, 36 insertions(+), 3 deletions(-)
via 8ba7223586eabdbc2bcc2cf8cc143ce624286e50 (commit)
from f451703c7c38cb006f468525ea02196b659f3e27 (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 8ba7223586eabdbc2bcc2cf8cc143ce624286e50
Author: Peter Amstutz <pamstutz at veritasgenetics.com>
Date: Fri Sep 28 16:02:19 2018 -0400
13619: Document availability of federation features
Arvados-DCO-1.1-Signed-off-by: Peter Amstutz <pamstutz at veritasgenetics.com>
diff --git a/doc/api/methods.html.textile.liquid b/doc/api/methods.html.textile.liquid
index 937ae706d..6f3426523 100644
--- a/doc/api/methods.html.textile.liquid
+++ b/doc/api/methods.html.textile.liquid
@@ -15,7 +15,9 @@ The following methods are available for most resources. Some resources may limi
The methods are relative to the base URI, e.g., @/arvados/v1/resource_type at . For arguments specifying a *Location* of @path@, the value of the argument is incorporated into the path portion of the URI. For example, a @uuid@ of @aaaaa-bbbbb-ccccccccccccccc@ in a path position yields a URI of @/arvados/v1/resource_type/aaaaa-bbbbb-ccccccccccccccc at .
-Arguments specifying a *Location* of @query@ are incorporated into the query portion of the URI or request body. For example, @/arvados/v1/resource_type?resource_type={}@.
+Arguments specifying a *Location* of "query" are incorporated into the query portion of the URI or request body. For example, @/arvados/v1/resource_type?count=none at .
+
+Certain method calls on certain object types support "federation":{{site.baseurl}}/architecture/federation.html , that is, the ability to operate on objects owned by different clusters. API pages for specific object types list which federated operations are supported for that type (if any) in the "Methods" section.
h2. create
@@ -27,16 +29,21 @@ The @create@ method creates a new object of the specified type. Note that:
This method corresponds to the HTTP request @POST /arvados/v1/resource_type at . A successful create call returns a copy of the new object.
+To create an object on a remote cluster (federated create), provide the @cluster_id@ of the target cluster.
+
Arguments:
table(table table-bordered table-condensed).
|_. Argument |_. Type |_. Description |_. Location |
-|{resource_type}|object|Name is the singular form of the resource type, e.g., for the "collections" resource, this argument is "collection"|query||
+|{resource_type}|object|Name is the singular form of the resource type, e.g., for the "collections" resource, this argument is "collection"|body||
+|{cluster_id}|string|Optional, the cluster on which to create the object if not the current cluster.|query||
h2. delete
The @delete@ method deletes an object of the specified type. It corresponds to the HTTP request @DELETE /arvados/v1/resource_type/uuid at . A successful delete call returns a copy of the deleted object.
+The cluster id portion of the @uuid@ is used to determine which cluster owns the object, a federated delete request will be routed to that cluster.
+
Arguments:
table(table table-bordered table-condensed).
@@ -47,6 +54,8 @@ h2. get
The @get@ method gets a single object with the specified @uuid at . It corresponds to the HTTP request @GET /arvados/v1/resource_type/uuid at .
+The cluster id portion of the @uuid@ is used to determine which cluster owns the object, a federated get request will be routed to that cluster.
+
Arguments:
table(table table-bordered table-condensed).
@@ -112,6 +121,20 @@ table(table table-bordered table-condensed).
Note that exclusion filters @!=@ and @not in@ will return records for which the property is not defined at all. To restrict filtering to records on which the subproperty is defined, combine with an @exists@ filter.
+h4. Federated listing
+
+Federated listing forwards a request to multiple clusters and combines the results. Currently only a very restricted form of the "list" method is supported.
+
+To query multiple clusters, the list method must:
+
+* Have filters only matching @[["uuid", "in", [...]]@ or @["uuid", "=", "..."]@
+* Must specify @count=none@
+* If @select@ is specified, it must include @uuid@
+* Must not specify @limit@, @offset@ or @order@
+* Must not request more items than the maximum response size
+
+This form may be used to request a specific list of objects by uuid which are owned by multiple clusters.
+
h3. Results of list method
A successful call to list will return the following object.
@@ -128,6 +151,8 @@ h2. update
The @update@ method updates fields on the object with the specified @uuid at . It corresponds to the HTTP request @PUT /arvados/v1/resource_type/uuid at . Note that only the listed attributes (and "standard metadata":resources.html) are updated, unset attributes will retain their previous values, and the attributes of a given resource type are fixed (you cannot introduce new toplevel attributes). Also note that updates replace the value of the attribute, so if an attribute has an object value, the entire object is replaced. A successful update call returns the updated copy of the object.
+The cluster id portion of the @uuid@ is used to determine which cluster owns the object, a federated update request will be routed to that cluster.
+
table(table table-bordered table-condensed).
|_. Argument |_. Type |_. Description |_. Location |
{background:#ccffcc}.|uuid|string|The UUID of the resource in question.|path||
diff --git a/doc/api/methods/collections.html.textile.liquid b/doc/api/methods/collections.html.textile.liquid
index f761c665e..bcd57415d 100644
--- a/doc/api/methods/collections.html.textile.liquid
+++ b/doc/api/methods/collections.html.textile.liquid
@@ -53,6 +53,8 @@ See "Common resource methods":{{site.baseurl}}/api/methods.html for more informa
Required arguments are displayed in %{background:#ccffcc}green%.
+Supports federated @get@ only, which may be called with either a uuid or a portable data hash. When requesting a portable data hash which is not available on the home cluster, the query is forwarded to all the clusters listed in @RemoteClusters@ and returns the first successful result.
+
h3. create
Create a new Collection.
@@ -75,7 +77,7 @@ table(table table-bordered table-condensed).
h3. get
-Gets a Collection's metadata by UUID.
+Gets a Collection's metadata by UUID or portable data hash. When making a request by portable data hash, the returned record will only have the @portable_data_hash@ and @manifest_text at .
Arguments:
diff --git a/doc/api/methods/container_requests.html.textile.liquid b/doc/api/methods/container_requests.html.textile.liquid
index 0e2e8ce7c..e1e006a86 100644
--- a/doc/api/methods/container_requests.html.textile.liquid
+++ b/doc/api/methods/container_requests.html.textile.liquid
@@ -100,6 +100,8 @@ See "Common resource methods":{{site.baseurl}}/api/methods.html for more informa
Required arguments are displayed in %{background:#ccffcc}green%.
+Supports federated @create@, @delete@, @get@, @list@, and @update at .
+
h2(#create). create
Create a new container request.
diff --git a/doc/api/methods/containers.html.textile.liquid b/doc/api/methods/containers.html.textile.liquid
index 9ebd91d2b..cf92fef42 100644
--- a/doc/api/methods/containers.html.textile.liquid
+++ b/doc/api/methods/containers.html.textile.liquid
@@ -92,6 +92,8 @@ See "Common resource methods":{{site.baseurl}}/api/methods.html for more informa
Required arguments are displayed in %{background:#ccffcc}green%.
+Supports federated @create@, @delete@, @get@, @list@, and @update at .
+
h2(#create). create
Create a new Container.
diff --git a/doc/api/methods/workflows.html.textile.liquid b/doc/api/methods/workflows.html.textile.liquid
index 5d1020485..77ed6f359 100644
--- a/doc/api/methods/workflows.html.textile.liquid
+++ b/doc/api/methods/workflows.html.textile.liquid
@@ -34,6 +34,8 @@ See "Common resource methods":{{site.baseurl}}/api/methods.html for more informa
Required arguments are displayed in %{background:#ccffcc}green%.
+Supports federated @create@, @delete@, @get@, @list@, and @update at .
+
h3. create
Create a new Workflow.
-----------------------------------------------------------------------
hooks/post-receive
--
More information about the arvados-commits
mailing list