doc/user/intro-keep.md

   1 ---
   2 layout: default
   3 navsection: userguide
   4 title: "Intro: Keep"
   5 navorder: 3
   6 ---
   7
   8 # Using Keep
   9
  10 Keep is a content-addressable storage system. Its semantics are
  11 inherently different from the POSIX-like file systems you're used to.
  12
  13 Using Keep looks like this:
  14
  15 1. Write data.
  16 2. Receive locator.
  17 3. Use locator to retrieve data.
  18 4. Tag the locator with a symbolic name.
  19
  20 By contrast, POSIX works like this:
  21
  22 1. Choose locator (*i.e.*, filename).
  23 2. Write data to locator.
  24 3. Use locator to retrieve data.
  25
  26 Content addressing provides various benefits which we discuss
  27 elsewhere.
  28
  29 ### Getting started
  30
  31 Write three bytes of data to Keep.
  32
  33     echo -n foo | whput -
  34
  35 Output:
  36
  37     acbd18db4cc2f85cedef654fccc4a4d8+3
  38
  39 Retrieve the data.
  40
  41     whget acbd18db4cc2f85cedef654fccc4a4d8+3
  42
  43 Output:
  44
  45     foo
  46
  47 ### Writing a collection
  48
  49 ### Reading a file from a collection
  50
  51 ### Adding a collection to Arvados
  52
  53 ### Tagging a collection
  54
  55 ### Mounting Keep as a read-only POSIX filesystem
  56
  57 ### Mounting a single collection as a POSIX filesystem
  58