Keep clients

Keep clients are applications such as arv-get, arv-put and arv-mount which store and retrieve data from Keep. In doing so, these programs interact with both the API server (which stores file metadata in the form of collection objects) and individual keepstore servers (which store the actual data blocks).

Storing a file

  1. The client discovers keep servers (or proxies) using the accessible method on keep_services
  2. Data is split into 64 MiB blocks and the MD5 hash is computed for each block.
  3. The client uploads each block to one or more Keep servers, based on the number of desired replicas. The priority order is determined using rendezvous hashing, described below.
  4. The Keep server returns a block locator (the MD5 sum of the block) and a “signed token” which the client can use as proof of knowledge for the block.
  5. The client constructs a manifest which lists the blocks by MD5 hash and how to reassemble them into the original files.
  6. The client creates a collection and provides the manifest_text
  7. The API server accepts the collection after validating the signed tokens (proof of knowledge) for each block.

Fetching a file

  1. The client requests a collection object including manifest_text from the APIs server
  2. The server adds “token signatures” to the manifest_text and returns it to the client.
  3. The client discovers keep servers (or proxies) using the accessible method on keep_services
  4. For each data block, the client chooses the highest priority server using rendezvous hashing, described below.
  5. The client sends the data block request to the keep server, along with the token signature from the API which proves to Keep servers that the client is permitted to read a given block.
  6. The server provides the block data after validating the token signature for the block (if the server does not have the block, it returns a 404 and the client tries the next highest priority server)

Rendezvous hashing

Each keep_service resource has an assigned uuid. To determine priority assignments of blocks to servers, for each keep service compute the MD5 sum of the string concatenation of the block locator (hex-coded hash part only) and service uuid, then sort this list in descending order. Blocks are preferentially placed on servers with the highest weight.


Previous: Introduction to Keep Next: Data lifecycle

The content of this documentation is licensed under the Creative Commons Attribution-Share Alike 3.0 United States licence.
Code samples in this documentation are licensed under the Apache License, Version 2.0.