docs/helper.txt

   1
   2 = The Tahoe Upload Helper =
   3
   4 As described in the "SWARMING DOWNLOAD, TRICKLING UPLOAD" section of
   5 architecture.txt, Tahoe uploads require more bandwidth than downloads: you
   6 must push the redundant shares during upload, but you do not need to retrieve
   7 them during download. With the default 3-of-10 encoding parameters, this
   8 means that an upload will require about 3.3x the traffic as a download of the
   9 same file.
  10
  11 Unfortunately, this "expansion penalty" occurs in the same upstream direction
  12 that most consumer DSL lines are slow anyways. Typical ADSL lines get 8 times
  13 as much download capacity as upload capacity. When the ADSL upstream penalty
  14 is combined with the expansion penalty, the result is uploads that can take
  15 up to 32 times longer than downloads.
  16
  17 The "Helper" is a service that can mitigate the expansion penalty by
  18 arranging for the client node to send data to a central Helper node instead
  19 of sending it directly to the storage servers. It sends ciphertext to the
  20 Helper, so the security properties remain the same as with non-Helper
  21 uploads. The Helper is responsible for applying the erasure encoding
  22 algorithm and placing the resulting shares on the storage servers.
  23
  24 Of course, the helper cannot mitigate the ADSL upstream penalty.
  25
  26 The second benefit of using an upload helper is that clients who lose their
  27 network connections while uploading a file (because of a network flap, or
  28 because they shut down their laptop while an upload was in progress) can
  29 resume their upload rather than needing to start again from scratch. The
  30 helper holds the partially-uploaded ciphertext on disk, and when the client
  31 tries to upload the same file a second time, it discovers that the partial
  32 ciphertext is already present. The client then only needs to upload the
  33 remaining ciphertext. This reduces the "interrupted upload penalty" to a
  34 minimum.
  35
  36 This also serves to reduce the number of active connections between the
  37 client and the outside world: most of their traffic flows over a single TCP
  38 connection to the helper. This can improve TCP fairness, and should allow
  39 other applications that are sharing the same uplink to compete more evenly
  40 for the limited bandwidth.
  41
  42
  43
  44 == Setting Up A Helper ==
  45
  46 Who should consider running a helper?
  47
  48  * Benevolent entities which wish to provide better upload speed for clients
  49    that have slow uplinks
  50  * Folks which have machines with upload bandwidth to spare.
  51  * Server grid operators who want clients to connect to a small number of
  52    helpers rather than a large number of storage servers (a "multi-tier"
  53    architecture)
  54
  55 What sorts of machines are good candidates for running a helper?
  56
  57  * The Helper needs to have good bandwidth to the storage servers. In
  58    particular, it needs to have at least 3.3x better upload bandwidth than
  59    the client does, or the client might as well upload directly to the
  60    storage servers. In a commercial grid, the helper should be in the same
  61    colo (and preferably in the same rack) as the storage servers.
  62  * The Helper will take on most of the CPU load involved in uploading a file.
  63    So having a dedicated machine will give better results.
  64  * The Helper buffers ciphertext on disk, so the host will need at least as
  65    much free disk space as there will be simultaneous uploads. When an upload
  66    is interrupted, that space will be used for a longer period of time.
  67
  68 To turn a Tahoe client node into a helper (i.e. to run a helper service in
  69 addition to whatever else that node is doing), just create a file in your
  70 node's base directory named "run_helper", and put any non-empty string in it.
  71 Then restart the node:
  72
  73  echo "yes" >$BASEDIR/run_helper
  74  tahoe restart $BASEDIR
  75
  76 Then restart the node. This will signal the node to create a Helper service
  77 and listen for incoming requests. Once the node has started, there will be a
  78 file named private/helper.furl which contains the contact information for the
  79 helper: you will need to give this FURL to any clients that wish to use your
  80 helper.
  81
  82  cat $BASEDIR/private/helper.furl |mail -s "helper furl" friend@example.com
  83
  84 You can tell if your node is running a helper by looking at its web status
  85 page. Assuming that you've set up the 'webport' to use port 3456, point your
  86 browser at http://localhost:3456/ . The welcome page will say "Helper: 0
  87 active uploads" or "Not running helper" as appropriate. The
  88 http://localhost:3456/helper_status page will also provide details on what
  89 the helper is currently doing.
  90
  91 The helper will store the ciphertext that is is fetching from clients in
  92 $BASEDIR/helper/CHK_incoming/ . Once all the ciphertext has been fetched, it
  93 will be moved to $BASEDIR/helper/CHK_encoding/ and erasure-coding will
  94 commence. Once the file is fully encoded and the shares are pushed to the
  95 storage servers, the ciphertext file will be deleted.
  96
  97 If a client disconnects while the ciphertext is being fetched, the partial
  98 ciphertext will remain in CHK_incoming/ until they reconnect and finish
  99 sending it. If a client disconnects while the ciphertext is being encoded,
 100 the data will remain in CHK_encoding/ until they reconnect and encoding is
 101 finished. For long-running and busy helpers, it may be a good idea to delete
 102 files in these directories that have not been modified for a week or two.
 103 Future versions of tahoe will try to self-manage these files a bit better.
 104
 105 == Using a Helper ==
 106
 107 Who should consider using a Helper?
 108
 109  * clients with limited upstream bandwidth, such as a consumer ADSL line
 110  * clients who believe that the helper will give them faster uploads than
 111    they could achieve with a direct upload
 112  * clients who experience problems with TCP connection fairness: if other
 113    programs or machines in the same home are getting less than their fair
 114    share of upload bandwidth. If the connection is being shared fairly, then
 115    a Tahoe upload that is happening at the same time as a single FTP upload
 116    should get half the bandwidth.
 117  * clients who have been given the helper.furl by someone who is running a
 118    Helper and is willing to let them use it
 119
 120 To take advantage of somebody else's Helper, take the helper.furl file that
 121 they give you, and copy it into your node's base directory, then restart the
 122 node:
 123
 124  cat email >$BASEDIR/helper.furl
 125  tahoe restart $BASEDIR
 126
 127 This will signal the client to try and connect to the helper. Subsequent
 128 uploads will use the helper rather than using direct connections to the
 129 storage server.
 130
 131 If the node has been configured to use a helper, that node's HTTP welcome
 132 page (http://localhost:3456/) will say "Helper: $HELPERFURL" instead of
 133 "Helper: None". If the helper is actually running and reachable, the next
 134 line will say "Connected to helper?: yes" instead of "no".
 135
 136 The helper is optional. If a helper is connected when an upload begins, the
 137 upload will use the helper. If there is no helper connection present when an
 138 upload begins, that upload will connect directly to the storage servers. The
 139 client will automatically attempt to reconnect to the helper if the
 140 connection is lost, using the same exponential-backoff algorithm as all other
 141 tahoe/foolscap connections.
 142
 143 The upload/download status page (http://localhost:3456/status) will announce
 144 the using-helper-or-not state of each upload, in the "Helper?" column.
 145
 146 == Other Helper Modes ==
 147
 148 The Tahoe Helper only currently helps with one kind of operation: uploading
 149 immutable files. There are three other things it might be able to help with
 150 in the future:
 151
 152  * downloading immutable files
 153  * uploading mutable files (such as directories)
 154  * downloading mutable files (like directories)
 155
 156 Since mutable files are currently limited in size, the ADSL upstream penalty
 157 is not so severe for them. There is no ADSL penalty to downloads, but there
 158 may still be benefit to extending the helper interface to assist with them:
 159 fewer connections to the storage servers, and better TCP fairness.
 160
 161 A future version of the Tahoe helper might provide assistance with these
 162 other modes. If it were to help with all four modes, then the clients would
 163 not need direct connections to the storage servers at all: clients would
 164 connect to helpers, and helpers would connect to servers. For a large grid
 165 with tens of thousands of clients, this might make the grid more scalable.