doc/architecture/federation.html.textile.liquid

   1 ---
   2 layout: default
   3 navsection: architecture
   4 title: "Federation"
   5 ...
   6
   7 {% comment %}
   8 Copyright (C) The Arvados Authors. All rights reserved.
   9
  10 SPDX-License-Identifier: CC-BY-SA-3.0
  11 {% endcomment %}
  12
  13 Arvados federation enables clients to transparently read, create and manipulate objects and collections across clusters in different regions or organizations.  Federation supports workfows that integrate and analyze data across multiple clusters by sending computation to where the data is, reducing the technical and legal barriers to analyzing large, sensitive data sets.
  14
  15 _This feature is under development.  Support for federation is limited to certain types of requests.  The behaviors described here should not be interpreted as a stable API._
  16
  17 Detailed configuration information is available on the "federation admin section":{{site.baseurl}}/admin/federation.html.
  18
  19 h2(#cluster_id). Cluster identifiers
  20
  21 Clusters are identified by a five-digit alphanumeric id (numbers and lowercase letters).  There are 36 ^5^ = 60466176 possible cluster identifiers.
  22
  23 * For automated test purposes, use "z****"
  24 * For experimental/local-only/private clusters that won't ever be visible on the public Internet, use "x****"
  25 * For long-lived clusters, we recommend reserving a cluster id.  Contact "info@curii.com":mailto:info@curii.com for more information.
  26
  27 Cluster identifiers are mapped API server hosts one of two ways:
  28
  29 * Through DNS resolution, under the @arvadosapi.com@ domain.  For example, the API server for the cluster @pirca@ can be found at @pirca.arvadosapi.com@.  To register a cluster id for free under @arvadosapi.com@, contact "info@curii.com":mailto:info@curii.com
  30 * Through explicit configuration:
  31
  32 The @RemoteClusters@ section of @/etc/arvados/config.yml@ (for arvados-controller)
  33
  34 <pre>
  35 Clusters:
  36   clsr1:
  37     RemoteClusters:
  38       clsr2:
  39         Host: api.cluster2.example
  40         Proxy: true
  41       clsr3:
  42         Host: api.cluster3.example
  43         Proxy: true
  44 </pre>
  45
  46 In this example, the cluster @clsr1@ is configured to contact @api.cluster2.example@ for requests involving @clsr2@ and @api.cluster3.example@ for requests involving @clsr3@.
  47
  48 h2(#identity). Identity
  49
  50 The goal is for a federated user to have a single identity across the cluster federation.  This identity is a user account on a specific "home cluster".  When arvados-controller contacts a remote cluster, the remote cluster verifies the user's identity (see below) and then creates a mirror of the user account with the same uuid of the user's home cluster.  On the remote cluster, permissions can then be granted to the federated user, and the federated user can create and own objects.
  51
  52 h3. Peer federation: Authenticating remote users with salted tokens
  53
  54 When making a request to the home cluster, authorization is established by looking up the API token in the @api_client_authorizations@ table to determine the user identity.  When making a request to a remote cluster, we need to provide an API token which can be used to establish the user's identity.  The remote cluster will connect back to the home cluster to determine if the token valid and the user it corresponds to.  However, we do not want to send along the same API token used for the original request.  If the remote cluster is malicious or compromised, sending along user's regular token would compromise the user account on the home cluster.  Instead, the controller sends a "salted token".  The salted token is restricted to only to fetching the user account and group membership.  The salted token consists of the uuid of the token in @api_client_authorizations@ and the SHA1 HMAC of the original token and the cluster id of remote cluster.  To verify the token, the remote cluster contacts the home cluster and provides the token uuid, the hash, and its cluster id.  The home cluster uses the uuid to look up the token re-computes the SHA1 HMAC of the original token and cluster id.  If that hash matches, then the token is valid.  To avoid having to re-validate the token on every request, it is cached for a short period.
  55
  56 The security properties of this scheme are:
  57
  58 * The salted token does not grant access on the home cluster beyond what is needed to verify user identity
  59 * Revoking a token on the home cluster also revokes it for remote clusters (after the cache period)
  60 * A salted token given to a malicious/compromised cluster cannot be used to gain access to the user account on another remote cluster
  61
  62 h3. LoginCluster federation: Centralized user database
  63
  64 In a LoginCluster federation, there is a central "home" called the LoginCluster, and one or more "satellite" clusters.  The satellite clusters delegate their user management to the LoginCluster.  Unlike the peer federation, satellite clusters implicitly trust the home cluster, so the "salted token" scheme is not used.  Users arriving at a satellite cluster are redirected to the home cluster for login, the user token is issued by the LoginCluster, and then the user is sent back to the satellite cluster.   Tokens issued by the LoginCluster are accepted by all clusters in the federation.  All requests for user records on a satellite cluster is forwarded to the LoginCluster.
  65
  66 h2(#retrieval). Federated records
  67
  68 !(full-width){{site.baseurl}}/images/arvados_federation.svg!
  69
  70 h3. Retrieving and updating records
  71
  72 In the REST API, GET and PUT/PATCH requests are used to fetch and update records.
  73
  74 # the client begins by making a request to the home arvados-controller to retrieve or update a specific record owned by a remote cluster
  75 # arvados-controller determines the 5-digit cluster id from the first part of the uuid string
  76 # arvados-controller determines the API server host corresponding to the cluster id
  77 # arvados-controller creates a "salted" token by combining the API token used for the request and the target cluster id
  78 # arvados-controller contacts the remote cluster to request the desired record, providing the salted token
  79 # the remote cluster verifies the salted token
  80 # the remote cluster processes the request and returns a response
  81 # arvados-controller forwards the response to the client
  82
  83 h3. Creating records
  84
  85 In the REST API, POST requests create new records, so there is no uuid to use for the cluster id.  In this case, to create an object on a remote cluster, the request includes the @cluster_id@ parameter.  The flow is otherwise the same as described above.
  86
  87 h3. Collections and Keep block retrieval
  88
  89 Each collection record has @manifest_text@, which describes how to reassemble keep blocks into files as described in the "Manifest format":{{site.baseurl}}/architecture/manifest-format.html.  Each block identifier in the manifest has an added signature which is used to confirm permission to read the block.  To read a block from a keepstore server, the client must provide the block identifier, the signature, and the same API token used to retrieve the collection record.
  90
  91 See "Federation signatures":{{site.baseurl}}/architecture/manifest-format.html#federationsignatures for details on how federation affects block signatures.