]> git.rkrishnan.org Git - tahoe-lafs/tahoe-lafs.git/blob - NEWS
tests: bump up the timeout on test_dirnode.Dirnode from 240s to 480s since it apparen...
[tahoe-lafs/tahoe-lafs.git] / NEWS
1 User visible changes in Tahoe-LAFS.  -*- outline; coding: utf-8 -*-
2
3 * Release 1.8.1 (coming)
4
5 ** Documentation
6
7  - All .txt documents (except historical docs) have been converted to
8    .rst format. (#1225)
9  - Added docs/backdoors.rst declaring that we won't add backdoors to
10    Tahoe-LAFS, or add anything to facilitate government access to data.
11    (#1216)
12
13 ** Bugfixes and Improvements
14
15  - Allow the repairer to improve the health of a file by uploading
16    some shares, even if it cannot achieve the configured happiness
17    threshold. This fixes a regression introduced between v1.7.1 and
18    v1.8.0. (#1212)
19  - Fix a memory leak in the ResponseCache which is used during mutable
20    file/directory operations. (#1045)
21  - Fix a regression and add a performance improvement in the downloader.
22    This issue caused repair to fail in some special cases. (#1223)
23  - Fix a bug that caused 'tahoe cp' to fail for a grid-to-grid copy
24    involving a non-ASCII filename. (#1224)
25  - Fix a rarely-encountered bug involving printing large strings to
26    the console on Windows. (#1232)
27  - Perform ~ expansion in the --exclude-from filename argument to
28    'tahoe backup'. (#1241)
29  - The CLI now ignores the HTTP_PROXY environment variable and
30    connects directly to the WAPI instead of going through an HTTP
31    proxy, thus avoiding giving caps to the HTTP proxy (and also
32    avoiding failures in the case that the HTTP proxy is failing or
33    requires authentication). (#1253)
34
35 ** Packaging
36
37  - Use a newer version of a dependency if needed, even if an older
38    version is installed. This would previously cause a VersionConflict
39    error. (#1190)
40
41 * Release 1.8.0 (2010-09-23)
42
43 ** New Features
44
45  - A completely new downloader which improves performance and
46    robustness of immutable-file downloads. It uses the fastest K
47    servers to download the data in K-way parallel. It automatically
48    fails over to alternate servers if servers fail in mid-download. It
49    allows seeking to arbitrary locations in the file (the previous
50    downloader which would only read the entire file sequentially from
51    beginning to end). It minimizes unnecessary round trips and
52    unnecessary bytes transferred to improve performance. It sends
53    requests to fewer servers to reduce the load on servers (the
54    previous one would send a small request to every server for every
55    download) (#287, #288, #448, #798, #800, #990, #1170, #1191)
56
57  - Non-ASCII command-line arguments and non-ASCII outputs now work on
58    Windows. In addition, the command-line tool now works on 64-bit
59    Windows. (#1074)
60
61 ** Bugfixes and Improvements
62
63  - Document and clean up the command-line options for specifying the
64    node's base directory. (#188, #706, #715, #772, #1108)
65  - The default node directory for Windows is ".tahoe" in the user's
66    home directory, the same as on other platforms. (#890)
67  - Fix a case in which full cap URIs could be logged. (#685, #1155)
68  - Fix bug in WUI in Python 2.5 when the system clock is set back to
69    1969. Now you can use Tahoe-LAFS with Python 2.5 and set your
70    system clock to 1969 and still use the WUI. (#1055)
71  - Many improvements in code organization, tests, logging,
72    documentation, and packaging. (#983, #1074, #1108, #1127, #1129,
73    #1131, #1166, #1175)
74
75 ** Dependency Updates
76
77  - on x86 and x86-64 platforms, pycryptopp >= 0.5.20
78  - pycrypto 2.2 is excluded due to a bug
79
80 * Release 1.7.1 (2010-07-18)
81
82 ** Bugfixes and Improvements
83
84  - Fix bug in which uploader could fail with AssertionFailure or
85    report that it had achieved servers-of-happiness when it
86    hadn't. (#1118)
87  - Fix bug in which servers could get into a state where they would
88    refuse to accept shares of a certain file (#1117)
89  - Add init scripts for managing the gateway server on Debian/Ubuntu
90    (#961)
91  - Fix bug where server version number was always 0 on the welcome
92    page (#1067)
93  - Add new command-line command "tahoe unlink" as a synonym for "tahoe
94    rm" (#776)
95  - The FTP frontend now encrypts its temporary files, protecting their
96    contents from an attacker who is able to read the disk. (#1083)
97  - Fix IP address detection on FreeBSD 7, 8, and 9 (#1098)
98  - Fix minor layout issue in the Web User Interface with Internet
99    Explorer (#1097)
100  - Fix rarely-encountered incompatibility between Twisted logging
101    utility and the new unicode support added in v1.7.0 (#1099)
102  - Forward-compatibility improvements for non-ASCII caps (#1051)
103
104 ** Code improvements
105
106  - Simplify and tidy-up directories, unicode support, test code (#923, #967,
107    #1072)
108
109 * Release 1.7.0 (2010-06-18)
110
111 ** New Features
112
113 *** SFTP support
114
115 Your Tahoe-LAFS gateway now acts like a full-fledged SFTP server.  It has been
116 tested with sshfs to provide a virtual filesystem in Linux.  Many users have
117 asked for this feature.  We hope that it serves them well! See the
118 docs/frontends/FTP-and-SFTP.txt document to get started.
119
120 *** support for non-ASCII character encodings
121
122 Tahoe-LAFS now correctly handles filenames containing non-ASCII characters on
123 all supported platforms:
124
125  - when reading files in from the local filesystem (such as when you run "tahoe
126    backup" to back up your local files to a Tahoe-LAFS grid);
127
128  - when writing files out to the local filesystem (such as when you run "tahoe
129    cp -r" to recursively copy files out of a Tahoe-LAFS grid);
130
131  - when displaying filenames to the terminal (such as when you run "tahoe ls"),
132    subject to limitations of the terminal and locale;
133
134  - when parsing command-line arguments, except on Windows.
135
136 *** Servers of Happiness
137
138 Tahoe-LAFS now measures during immutable file upload to see how well
139 distributed it is across multiple servers. It aborts the upload if the pieces
140 of the file are not sufficiently well-distributed.
141
142 This behavior is controlled by a configuration parameter called "servers of
143 happiness". With the default settings for its erasure coding, Tahoe-LAFS
144 generates 10 shares for each file, such that any 3 of those shares are
145 sufficient to recover the file. The default value of "servers of happiness" is
146 7, which means that Tahoe-LAFS will guarantee that there are at least 7 servers
147 holding some of the shares, such that any 3 of those servers can completely
148 recover your file.
149
150 The new upload code also distributes the shares better than the previous
151 version in some cases and takes better advantage of pre-existing shares (when a
152 file has already been previously uploaded). See the architecture.txt document
153 [3] for details.
154
155 ** Bugfixes and Improvements
156
157  - Premature abort of upload if some shares were already present and some
158    servers fail. (#608)
159  - python ./setup.py install -- can't create or remove files in install
160    directory. (#803)
161  - Network failure => internal TypeError. (#902)
162  - Install of Tahoe on CentOS 5.4. (#933)
163  - CLI option --node-url now supports https url. (#1028)
164  - HTML/CSS template files were not correctly installed under Windows. (#1033)
165  - MetadataSetter does not enforce restriction on setting "tahoe" subkeys.
166    (#1034)
167  - ImportError: No module named setuptools_darcs.setuptools_darcs. (#1054)
168  - Renamed Title in xhtml files. (#1062)
169  - Increase Python version dependency to 2.4.4, to avoid a critical CPython
170    security bug. (#1066)
171  - Typo correction for the munin plugin tahoe_storagespace. (#968)
172  - Fix warnings found by pylint. (#973)
173  - Changing format of some documentation files. (#1027)
174  - the misc/ directory was tied up. (#1068)
175  - The 'ctime' and 'mtime' metadata fields are no longer written except by
176    "tahoe backup". (#924)
177  - Unicode filenames in Tahoe-LAFS directories are normalized so that names
178    that differ only in how accents are encoded are treated as the same. (#1076)
179  - Various small improvements to documentation. (#937, #911, #1024, #1082)
180
181 ** Removals
182
183 The 'tahoe debug consolidate' subcommand (for converting old allmydata Windows
184 client backups to a newer format) has been removed.
185
186 ** Dependency Updates
187
188 the Python version dependency is raised to 2.4.4 in some cases (2.4.3 for
189   Redhat-based Linux distributions, 2.4.2 for UCS-2 builds) (#1066)
190 pycrypto >= 2.0.1
191 pyasn1 >= 0.0.8a
192 mock (only required by unit tests)
193
194 * Release 1.6.1 (2010-02-27)
195
196 ** Bugfixes
197
198 *** Correct handling of Small Immutable Directories
199
200 Immutable directories can now be deep-checked and listed in the web UI in
201 all cases. (In v1.6.0, some operations, such as deep-check, on a directory
202 graph that included very small immutable directories, would result in an
203 exception causing the whole operation to abort.) (#948)
204
205 ** Usability Improvements
206
207 Improved user interface messages and error reporting. (#681, #837, #939)
208
209 The timeouts for operation handles have been greatly increased, so that
210 you can view the results of an operation up to 4 days after it has
211 completed. After viewing them for the first time, the results are
212 retained for a further day. (#577)
213
214 * Release 1.6.0 (2010-02-01)
215
216 ** New Features
217
218 *** Immutable Directories
219
220 Tahoe-LAFS can now create and handle immutable directories. (#607, #833, #931)
221 These are read just like normal directories, but are "deep-immutable", meaning
222 that all their children (and everything reachable from those children) must be
223 immutable objects (i.e. immutable or literal files, and other immutable
224 directories).
225
226 These directories must be created in a single webapi call that provides all
227 of the children at once. (Since they cannot be changed after creation, the
228 usual create/add/add sequence cannot be used.) They have URIs that start with
229 "URI:DIR2-CHK:" or "URI:DIR2-LIT:", and are described on the human-facing web
230 interface (aka the "WUI") with a "DIR-IMM" abbreviation (as opposed to "DIR"
231 for the usual read-write directories and "DIR-RO" for read-only directories).
232
233 Tahoe-LAFS releases before 1.6.0 cannot read the contents of an immutable
234 directory. 1.5.0 will tolerate their presence in a directory listing (and
235 display it as "unknown"). 1.4.1 and earlier cannot tolerate them: a DIR-IMM
236 child in any directory will prevent the listing of that directory.
237
238 Immutable directories are repairable, just like normal immutable files.
239
240 The webapi "POST t=mkdir-immutable" call is used to create immutable
241 directories. See docs/frontends/webapi.txt for details.
242
243 *** "tahoe backup" now creates immutable directories, backupdb has dircache
244
245 The "tahoe backup" command has been enhanced to create immutable directories
246 (in previous releases, it created read-only mutable directories) (#828). This
247 is significantly faster, since it does not need to create an RSA keypair for
248 each new directory. Also "DIR-IMM" immutable directories are repairable, unlike
249 "DIR-RO" read-only mutable directories at present. (A future Tahoe-LAFS release
250 should also be able to repair DIR-RO.)
251
252 In addition, the backupdb (used by "tahoe backup" to remember what it has
253 already copied) has been enhanced to store information about existing immutable
254 directories. This allows it to re-use directories that have moved but still
255 contain identical contents, or that have been deleted and later replaced. (The
256 1.5.0 "tahoe backup" command could only re-use directories that were in the
257 same place as they were in the immediately previous backup.)  With this change,
258 the backup process no longer needs to read the previous snapshot out of the
259 Tahoe-LAFS grid, reducing the network load considerably. (#606)
260
261 A "null backup" (in which nothing has changed since the previous backup) will
262 require only two Tahoe-side operations: one to add an Archives/$TIMESTAMP
263 entry, and a second to update the Latest/ link. On the local disk side, it
264 will readdir() all your local directories and stat() all your local files.
265
266 If you've been using "tahoe backup" for a while, you will notice that your
267 first use of it after upgrading to 1.6.0 may take a long time: it must create
268 proper immutable versions of all the old read-only mutable directories. This
269 process won't take as long as the initial backup (where all the file contents
270 had to be uploaded too): it will require time proportional to the number and
271 size of your directories. After this initial pass, all subsequent passes
272 should take a tiny fraction of the time.
273
274 As noted above, Tahoe-LAFS versions earlier than 1.5.0 cannot list a directory
275 containing an immutable subdirectory. Tahoe-LAFS versions earlier than 1.6.0
276 cannot read the contents of an immutable directory.
277
278 The "tahoe backup" command has been improved to skip over unreadable objects
279 (like device files, named pipes, and files with permissions that prevent the
280 command from reading their contents), instead of throwing an exception and
281 terminating the backup process. It also skips over symlinks, because these
282 cannot be represented faithfully in the Tahoe-side filesystem. A warning
283 message will be emitted each time something is skipped. (#729, #850, #641)
284
285 *** "create-node" command added, "create-client" now implies --no-storage
286
287 The basic idea behind Tahoe-LAFS's client+server and client-only processes is
288 that you are creating a general-purpose Tahoe-LAFS "node" process, which has
289 several components that can be activated. Storage service is one of these
290 optional components, as is the Helper, FTP server, and SFTP server. Web gateway
291 functionality is nominally on this list, but it is always active; a future
292 release will make it optional. There are three special purpose servers that
293 can't currently be run as a component in a node: introducer, key-generator,
294 and stats-gatherer.
295
296 So now "tahoe create-node" will create a Tahoe-LAFS node process, and after
297 creation you can edit its tahoe.cfg to enable or disable the desired
298 services. It is a more general-purpose replacement for "tahoe create-client".
299 The default configuration has storage service enabled. For convenience, the
300 "--no-storage" argument makes a tahoe.cfg file that disables storage
301 service. (#760)
302
303 "tahoe create-client" has been changed to create a Tahoe-LAFS node without a
304 storage service. It is equivalent to "tahoe create-node --no-storage". This
305 helps to reduce the confusion surrounding the use of a command with "client" in
306 its name to create a storage *server*. Use "tahoe create-client" to create a
307 purely client-side node. If you want to offer storage to the grid, use
308 "tahoe create-node" instead.
309
310 In the future, other services will be added to the node, and they will be
311 controlled through options in tahoe.cfg . The most important of these
312 services may get additional --enable-XYZ or --disable-XYZ arguments to
313 "tahoe create-node".
314
315 ** Performance Improvements
316
317 Download of immutable files begins as soon as the downloader has located the K
318 necessary shares (#928, #287). In both the previous and current releases, a
319 downloader will first issue queries to all storage servers on the grid to
320 locate shares before it begins downloading the shares. In previous releases of
321 Tahoe-LAFS, download would not begin until all storage servers on the grid had
322 replied to the query, at which point K shares would be chosen for download from
323 among the shares that were located. In this release, download begins as soon as
324 any K shares are located. This means that downloads start sooner, which is
325 particularly important if there is a server on the grid that is extremely slow
326 or even hung in such a way that it will never respond. In previous releases
327 such a server would have a negative impact on all downloads from that grid. In
328 this release, such a server will have no impact on downloads, as long as K
329 shares can be found on other, quicker, servers.  This also means that
330 downloads now use the "best-alacrity" servers that they talk to, as measured by
331 how quickly the servers reply to the initial query. This might cause downloads
332 to go faster, especially on grids with heterogeneous servers or geographical
333 dispersion.
334
335 ** Minor Changes
336
337 The webapi acquired a new "t=mkdir-with-children" command, to create and
338 populate a directory in a single call. This is significantly faster than
339 using separate "t=mkdir" and "t=set-children" operations (it uses one
340 gateway-to-grid roundtrip, instead of three or four). (#533)
341
342 The t=set-children (note the hyphen) operation is now documented in
343 docs/frontends/webapi.txt, and is the new preferred spelling of the old
344 t=set_children (with an underscore). The underscore version remains for
345 backwards compatibility. (#381, #927)
346
347 The tracebacks produced by errors in CLI tools should now be in plain text,
348 instead of HTML (which is unreadable outside of a browser). (#646)
349
350 The [storage]reserved_space configuration knob (which causes the storage
351 server to refuse shares when available disk space drops below a threshold)
352 should work on Windows now, not just UNIX. (#637)
353
354 "tahoe cp" should now exit with status "1" if it cannot figure out a suitable
355 target filename, such as when you copy from a bare filecap. (#761)
356
357 "tahoe get" no longer creates a zero-length file upon error. (#121)
358
359 "tahoe ls" can now list single files. (#457)
360
361 "tahoe deep-check --repair" should tolerate repair failures now, instead of
362 halting traversal. (#874, #786)
363
364 "tahoe create-alias" no longer corrupts the aliases file if it had
365 previously been edited to have no trailing newline. (#741)
366
367 Many small packaging improvements were made to facilitate the "tahoe-lafs"
368 package being included in Ubuntu. Several mac/win32 binary libraries were
369 removed, some figleaf code-coverage files were removed, a bundled copy of
370 darcsver-1.2.1 was removed, and additional licensing text was added.
371
372 Several DeprecationWarnings for python2.6 were silenced. (#859)
373
374 The checker --add-lease option would sometimes fail for shares stored
375 on old (Tahoe v1.2.0) servers. (#875)
376
377 The documentation for installing on Windows (docs/install.html) has been
378 improved. (#773)
379
380 For other changes not mentioned here, see
381 <http://allmydata.org/trac/tahoe/query?milestone=1.6.0&keywords=!~news-done>.
382 To include the tickets mentioned above, go to
383 <http://allmydata.org/trac/tahoe/query?milestone=1.6.0>.
384
385
386 * Release 1.5.0 (2009-08-01)
387
388 ** Improvements
389
390 Uploads of immutable files now use pipelined writes, improving upload speed
391 slightly (10%) over high-latency connections. (#392)
392
393 Processing large directories has been sped up, by removing a O(N^2) algorithm
394 from the dirnode decoding path and retaining unmodified encrypted entries.
395 (#750, #752)
396
397 The human-facing web interface (aka the "WUI") received a significant CSS
398 makeover by Kevin Reid, making it much prettier and easier to read. The WUI
399 "check" and "deep-check" forms now include a "Renew Lease" checkbox,
400 mirroring the CLI --add-lease option, so leases can be added or renewed from
401 the web interface.
402
403 The CLI "tahoe mv" command now refuses to overwrite directories. (#705)
404
405 The CLI "tahoe webopen" command, when run without arguments, will now bring
406 up the "Welcome Page" (node status and mkdir/upload forms).
407
408 The 3.5MB limit on mutable files was removed, so it should be possible to
409 upload arbitrarily-sized mutable files. Note, however, that the data format
410 and algorithm remains the same, so using mutable files still requires
411 bandwidth, computation, and RAM in proportion to the size of the mutable file.
412 (#694)
413
414 This version of Tahoe-LAFS will tolerate directory entries that contain filecap
415 formats which it does not recognize: files and directories from the future.
416 This should improve the user experience (for 1.5.0 users) when we add new cap
417 formats in the future. Previous versions would fail badly, preventing the user
418 from seeing or editing anything else in those directories. These unrecognized
419 objects can be renamed and deleted, but obviously not read or written. Also
420 they cannot generally be copied. (#683)
421
422 ** Bugfixes
423
424 deep-check-and-repair now tolerates read-only directories, such as the ones
425 produced by the "tahoe backup" CLI command. Read-only directories and mutable
426 files are checked, but not repaired. Previous versions threw an exception
427 when attempting the repair and failed to process the remaining contents. We
428 cannot yet repair these read-only objects, but at least this version allows
429 the rest of the check+repair to proceed. (#625)
430
431 A bug in 1.4.1 which caused a server to be listed multiple times (and
432 frequently broke all connections to that server) was fixed. (#653)
433
434 The plaintext-hashing code was removed from the Helper interface, removing
435 the Helper's ability to mount a partial-information-guessing attack. (#722)
436
437 ** Platform/packaging changes
438
439 Tahoe-LAFS now runs on NetBSD, OpenBSD, ArchLinux, and NixOS, and on an
440 embedded system based on an ARM CPU running at 266 MHz.
441
442 Unit test timeouts have been raised to allow the tests to complete on
443 extremely slow platforms like embedded ARM-based NAS boxes, which may take
444 several hours to run the test suite. An ARM-specific data-corrupting bug in
445 an older version of Crypto++ (5.5.2) was identified: ARM-users are encouraged
446 to use recent Crypto++/pycryptopp which avoids this problem.
447
448 Tahoe-LAFS now requires a SQLite library, either the sqlite3 that comes
449 built-in with python2.5/2.6, or the add-on pysqlite2 if you're using
450 python2.4. In the previous release, this was only needed for the "tahoe backup"
451 command: now it is mandatory.
452
453 Several minor documentation updates were made.
454
455 To help get Tahoe-LAFS into Linux distributions like Fedora and Debian,
456 packaging improvements are being made in both Tahoe-LAFS and related libraries
457 like pycryptopp and zfec.
458
459 The Crypto++ library included in the pycryptopp package has been upgraded to
460 version 5.6.0 of Crypto++, which includes a more efficient implementation of
461 SHA-256 in assembly for x86 or amd64 architectures.
462
463 ** dependency updates
464
465  foolscap-0.4.1
466  no python-2.4.0 or 2.4.1 (2.4.2 is good)
467   (they contained a bug in base64.b32decode)
468  avoid python-2.6 on windows with mingw: compiler issues
469  python2.4 requires pysqlite2 (2.5,2.6 does not)
470  no python-3.x
471  pycryptopp-0.5.15
472
473
474 * Release 1.4.1 (2009-04-13)
475
476 ** Garbage Collection
477
478 The big feature for this release is the implementation of garbage collection,
479 allowing Tahoe storage servers to delete shares for old deleted files. When
480 enabled, this uses a "mark and sweep" process: clients are responsible for
481 updating the leases on their shares (generally by running "tahoe deep-check
482 --add-lease"), and servers are allowed to delete any share which does not
483 have an up-to-date lease. The process is described in detail in
484 docs/garbage-collection.txt .
485
486 The server must be configured to enable garbage-collection, by adding
487 directives to the [storage] section that define an age limit for shares. The
488 default configuration will not delete any shares.
489
490 Both servers and clients should be upgraded to this release to make the
491 garbage-collection as pleasant as possible. 1.2.0 servers have code to
492 perform the update-lease operation but it suffers from a fatal bug, while
493 1.3.0 servers have update-lease but will return an exception for unknown
494 storage indices, causing clients to emit an Incident for each exception,
495 slowing the add-lease process down to a crawl. 1.1.0 servers did not have the
496 add-lease operation at all.
497
498 ** Security/Usability Problems Fixed
499
500 A super-linear algorithm in the Merkle Tree code was fixed, which previously
501 caused e.g. download of a 10GB file to take several hours before the first
502 byte of plaintext could be produced. The new "alacrity" is about 2 minutes. A
503 future release should reduce this to a few seconds by fixing ticket #442.
504
505 The previous version permitted a small timing attack (due to our use of
506 strcmp) against the write-enabler and lease-renewal/cancel secrets. An
507 attacker who could measure response-time variations of approximatly 3ns
508 against a very noisy background time of about 15ms might be able to guess
509 these secrets. We do not believe this attack was actually feasible. This
510 release closes the attack by first hashing the two strings to be compared
511 with a random secret.
512
513 ** webapi changes
514
515 In most cases, HTML tracebacks will only be sent if an "Accept: text/html"
516 header was provided with the HTTP request. This will generally cause browsers
517 to get an HTMLized traceback but send regular text/plain tracebacks to
518 non-browsers (like the CLI clients). More errors have been mapped to useful
519 HTTP error codes.
520
521 The streaming webapi operations (deep-check and manifest) now have a way to
522 indicate errors (an output line that starts with "ERROR" instead of being
523 legal JSON). See docs/frontends/webapi.txt for details.
524
525 The storage server now has its own status page (at /storage), linked from the
526 Welcome page. This page shows progress and results of the two new
527 share-crawlers: one which merely counts shares (to give an estimate of how
528 many files/directories are being stored in the grid), the other examines
529 leases and reports how much space would be freed if GC were enabled. The page
530 also shows how much disk space is present, used, reserved, and available for
531 the Tahoe server, and whether the server is currently running in "read-write"
532 mode or "read-only" mode.
533
534 When a directory node cannot be read (perhaps because of insufficent shares),
535 a minimal webapi page is created so that the "more-info" links (including a
536 Check/Repair operation) will still be accessible.
537
538 A new "reliability" page was added, with the beginnings of work on a
539 statistical loss model. You can tell this page how many servers you are using
540 and their independent failure probabilities, and it will tell you the
541 likelihood that an arbitrary file will survive each repair period. The
542 "numpy" package must be installed to access this page. A partial paper,
543 written by Shawn Willden, has been added to docs/proposed/lossmodel.lyx .
544
545 ** CLI changes
546
547 "tahoe check" and "tahoe deep-check" now accept an "--add-lease" argument, to
548 update a lease on all shares. This is the "mark" side of garbage collection.
549
550 In many cases, CLI error messages have been improved: the ugly HTMLized
551 traceback has been replaced by a normal python traceback.
552
553 "tahoe deep-check" and "tahoe manifest" now have better error reporting.
554 "tahoe cp" is now non-verbose by default.
555
556 "tahoe backup" now accepts several "--exclude" arguments, to ignore certain
557 files (like editor temporary files and version-control metadata) during
558 backup.
559
560 On windows, the CLI now accepts local paths like "c:\dir\file.txt", which
561 previously was interpreted as a Tahoe path using a "c:" alias.
562
563 The "tahoe restart" command now uses "--force" by default (meaning it will
564 start a node even if it didn't look like there was one already running).
565
566 The "tahoe debug consolidate" command was added. This takes a series of
567 independent timestamped snapshot directories (such as those created by the
568 allmydata.com windows backup program, or a series of "tahoe cp -r" commands)
569 and creates new snapshots that used shared read-only directories whenever
570 possible (like the output of "tahoe backup"). In the most common case (when
571 the snapshots are fairly similar), the result will use significantly fewer
572 directories than the original, allowing "deep-check" and similar tools to run
573 much faster. In some cases, the speedup can be an order of magnitude or more.
574 This tool is still somewhat experimental, and only needs to be run on large
575 backups produced by something other than "tahoe backup", so it was placed
576 under the "debug" category.
577
578 "tahoe cp -r --caps-only tahoe:dir localdir" is a diagnostic tool which,
579 instead of copying the full contents of files into the local directory,
580 merely copies their filecaps. This can be used to verify the results of a
581 "consolidation" operation.
582
583 ** other fixes
584
585 The codebase no longer rauses RuntimeError as a kind of assert(). Specific
586 exception classes were created for each previous instance of RuntimeError.
587
588 Many unit tests were changed to use a non-network test harness, speeding them
589 up considerably.
590
591 Deep-traversal operations (manifest and deep-check) now walk individual
592 directories in alphabetical order. Occasional turn breaks are inserted to
593 prevent a stack overflow when traversing directories with hundreds of
594 entries.
595
596 The experimental SFTP server had its path-handling logic changed slightly, to
597 accomodate more SFTP clients, although there are still issues (#645).
598
599
600 * Release 1.3.0 (2009-02-13)
601
602 ** Checker/Verifier/Repairer
603
604 The primary focus of this release has been writing a checker / verifier /
605 repairer for files and directories.  "Checking" is the act of asking storage
606 servers whether they have a share for the given file or directory: if there
607 are not enough shares available, the file or directory will be
608 unrecoverable. "Verifying" is the act of downloading and cryptographically
609 asserting that the server's share is undamaged: it requires more work
610 (bandwidth and CPU) than checking, but can catch problems that simple
611 checking cannot. "Repair" is the act of replacing missing or damaged shares
612 with new ones.
613
614 This release includes a full checker, a partial verifier, and a partial
615 repairer. The repairer is able to handle missing shares: new shares are
616 generated and uploaded to make up for the missing ones. This is currently the
617 best application of the repairer: to replace shares that were lost because of
618 server departure or permanent drive failure.
619
620 The repairer in this release is somewhat able to handle corrupted shares. The
621 limitations are:
622
623  * Immutable verifier is incomplete: not all shares are used, and not all
624    fields of those shares are verified. Therefore the immutable verifier has
625    only a moderate chance of detecting corrupted shares.
626  * The mutable verifier is mostly complete: all shares are examined, and most
627    fields of the shares are validated.
628  * The storage server protocol offers no way for the repairer to replace or
629    delete immutable shares. If corruption is detected, the repairer will
630    upload replacement shares to other servers, but the corrupted shares will
631    be left in place.
632  * read-only directories and read-only mutable files must be repaired by
633    someone who holds the write-cap: the read-cap is insufficient. Moreover,
634    the deep-check-and-repair operation will halt with an error if it attempts
635    to repair one of these read-only objects.
636  * Some forms of corruption can cause both download and repair operations to
637    fail. A future release will fix this, since download should be tolerant of
638    any corruption as long as there are at least 'k' valid shares, and repair
639    should be able to fix any file that is downloadable.
640
641 If the downloader, verifier, or repairer detects share corruption, the
642 servers which provided the bad shares will be notified (via a file placed in
643 the BASEDIR/storage/corruption-advisories directory) so their operators can
644 manually delete the corrupted shares and investigate the problem. In
645 addition, the "incident gatherer" mechanism will automatically report share
646 corruption to an incident gatherer service, if one is configured. Note that
647 corrupted shares indicate hardware failures, serious software bugs, or malice
648 on the part of the storage server operator, so a corrupted share should be
649 considered highly unusual.
650
651 By periodically checking/repairing all files and directories, objects in the
652 Tahoe filesystem remain resistant to recoverability failures due to missing
653 and/or broken servers.
654
655 This release includes a wapi mechanism to initiate checks on individual
656 files and directories (with or without verification, and with or without
657 automatic repair). A related mechanism is used to initiate a "deep-check" on
658 a directory: recursively traversing the directory and its children, checking
659 (and/or verifying/repairing) everything underneath. Both mechanisms can be
660 run with an "output=JSON" argument, to obtain machine-readable check/repair
661 status results. These results include a copy of the filesystem statistics
662 from the "deep-stats" operation (including total number of files, size
663 histogram, etc). If repair is possible, a "Repair" button will appear on the
664 results page.
665
666 The client web interface now features some extra buttons to initiate check
667 and deep-check operations. When these operations finish, they display a
668 results page that summarizes any problems that were encountered. All
669 long-running deep-traversal operations, including deep-check, use a
670 start-and-poll mechanism, to avoid depending upon a single long-lived HTTP
671 connection. docs/frontends/webapi.txt has details.
672
673 ** Efficient Backup
674
675 The "tahoe backup" command is new in this release, which creates efficient
676 versioned backups of a local directory. Given a local pathname and a target
677 Tahoe directory, this will create a read-only snapshot of the local directory
678 in $target/Archives/$timestamp. It will also create $target/Latest, which is
679 a reference to the latest such snapshot. Each time you run "tahoe backup"
680 with the same source and target, a new $timestamp snapshot will be added.
681 These snapshots will share directories that have not changed since the last
682 backup, to speed up the process and minimize storage requirements. In
683 addition, a small database is used to keep track of which local files have
684 been uploaded already, to avoid uploading them a second time. This
685 drastically reduces the work needed to do a "null backup" (when nothing has
686 changed locally), making "tahoe backup' suitable to run from a daily cronjob.
687
688 Note that the "tahoe backup" CLI command must be used in conjunction with a
689 1.3.0-or-newer Tahoe client node; there was a bug in the 1.2.0 webapi
690 implementation that would prevent the last step (create $target/Latest) from
691 working.
692
693 ** Large Files
694
695 The 12GiB (approximate) immutable-file-size limitation is lifted. This
696 release knows how to handle so-called "v2 immutable shares", which permit
697 immutable files of up to about 18 EiB (about 3*10^14). These v2 shares are
698 created if the file to be uploaded is too large to fit into v1 shares. v1
699 shares are created if the file is small enough to fit into them, so that
700 files created with tahoe-1.3.0 can still be read by earlier versions if they
701 are not too large. Note that storage servers also had to be changed to
702 support larger files, and this release is the first release in which they are
703 able to do that. Clients will detect which servers are capable of supporting
704 large files on upload and will not attempt to upload shares of a large file
705 to a server which doesn't support it.
706
707 ** FTP/SFTP Server
708
709 Tahoe now includes experimental FTP and SFTP servers. When configured with a
710 suitable method to translate username+password into a root directory cap, it
711 provides simple access to the virtual filesystem. Remember that FTP is
712 completely unencrypted: passwords, filenames, and file contents are all sent
713 over the wire in cleartext, so FTP should only be used on a local (127.0.0.1)
714 connection. This feature is still in development: there are no unit tests
715 yet, and behavior with respect to Unicode filenames is uncertain. Please see
716 docs/frontends/FTP-and-SFTP.txt for configuration details. (#512, #531)
717
718 ** CLI Changes
719
720 This release adds the 'tahoe create-alias' command, which is a combination of
721 'tahoe mkdir' and 'tahoe add-alias'. This also allows you to start using a
722 new tahoe directory without exposing its URI in the argv list, which is
723 publicly visible (through the process table) on most unix systems.  Thanks to
724 Kevin Reid for bringing this issue to our attention.
725
726 The single-argument form of "tahoe put" was changed to create an unlinked
727 file. I.e. "tahoe put bar.txt" will take the contents of a local "bar.txt"
728 file, upload them to the grid, and print the resulting read-cap; the file
729 will not be attached to any directories. This seemed a bit more useful than
730 the previous behavior (copy stdin, upload to the grid, attach the resulting
731 file into your default tahoe: alias in a child named 'bar.txt').
732
733 "tahoe put" was also fixed to handle mutable files correctly: "tahoe put
734 bar.txt URI:SSK:..." will read the contents of the local bar.txt and use them
735 to replace the contents of the given mutable file.
736
737 The "tahoe webopen" command was modified to accept aliases. This means "tahoe
738 webopen tahoe:" will cause your web browser to open to a "wui" page that
739 gives access to the directory associated with the default "tahoe:" alias. It
740 should also accept leading slashes, like "tahoe webopen tahoe:/stuff".
741
742 Many esoteric debugging commands were moved down into a "debug" subcommand:
743
744  tahoe debug dump-cap
745  tahoe debug dump-share
746  tahoe debug find-shares
747  tahoe debug catalog-shares
748  tahoe debug corrupt-share
749
750 The last command ("tahoe debug corrupt-share") flips a random bit of the
751 given local sharefile. This is used to test the file verifying/repairing
752 code, and obviously should not be used on user data.
753
754 The cli might not correctly handle arguments which contain non-ascii
755 characters in Tahoe v1.3 (although depending on your platform it
756 might, especially if your platform can be configured to pass such
757 characters on the command-line in utf-8 encoding).  See
758 http://allmydata.org/trac/tahoe/ticket/565 for details.
759
760 ** Web changes
761
762 The "default webapi port", used when creating a new client node (and in the
763 getting-started documentation), was changed from 8123 to 3456, to reduce
764 confusion when Tahoe accessed through a Firefox browser on which the
765 "Torbutton" extension has been installed. Port 8123 is occasionally used as a
766 Tor control port, so Torbutton adds 8123 to Firefox's list of "banned ports"
767 to avoid CSRF attacks against Tor. Once 8123 is banned, it is difficult to
768 diagnose why you can no longer reach a Tahoe node, so the Tahoe default was
769 changed. Note that 3456 is reserved by IANA for the "vat" protocol, but there
770 are argueably more Torbutton+Tahoe users than vat users these days. Note that
771 this will only affect newly-created client nodes. Pre-existing client nodes,
772 created by earlier versions of tahoe, may still be listening on 8123.
773
774 All deep-traversal operations (start-manifest, start-deep-size,
775 start-deep-stats, start-deep-check) now use a start-and-poll approach,
776 instead of using a single (fragile) long-running synchronous HTTP connection.
777 All these "start-" operations use POST instead of GET. The old "GET
778 manifest", "GET deep-size", and "POST deep-check" operations have been
779 removed.
780
781 The new "POST start-manifest" operation, when it finally completes, results
782 in a table of (path,cap), instead of the list of verifycaps produced by the
783 old "GET manifest". The table is available in several formats: use
784 output=html, output=text, or output=json to choose one. The JSON output also
785 includes stats, and a list of verifycaps and storage-index strings.
786
787 The "return_to=" and "when_done=" arguments have been removed from the
788 t=check and deep-check operations.
789
790 The top-level status page (/status) now has a machine-readable form, via
791 "/status/?t=json". This includes information about the currently-active
792 uploads and downloads, which may be useful for frontends that wish to display
793 progress information. There is no easy way to correlate the activities
794 displayed here with recent wapi requests, however.
795
796 Any files in BASEDIR/public_html/ (configurable) will be served in response
797 to requests in the /static/ portion of the URL space. This will simplify the
798 deployment of javascript-based frontends that can still access wapi calls
799 by conforming to the (regrettable) "same-origin policy".
800
801 The welcome page now has a "Report Incident" button, which is tied into the
802 "Incident Gatherer" machinery. If the node is attached to an incident
803 gatherer (via log_gatherer.furl), then pushing this button will cause an
804 Incident to be signalled: this means recent log events are aggregated and
805 sent in a bundle to the gatherer. The user can push this button after
806 something strange takes place (and they can provide a short message to go
807 along with it), and the relevant data will be delivered to a centralized
808 incident-gatherer for later processing by operations staff.
809
810 The "HEAD" method should now work correctly, in addition to the usual "GET",
811 "PUT", and "POST" methods. "HEAD" is supposed to return exactly the same
812 headers as "GET" would, but without any of the actual response body data. For
813 mutable files, this now does a brief mapupdate (to figure out the size of the
814 file that would be returned), without actually retrieving the file's
815 contents.
816
817 The "GET" operation on files can now support the HTTP "Range:" header,
818 allowing requests for partial content. This allows certain media players to
819 correctly stream audio and movies out of a Tahoe grid. The current
820 implementation uses a disk-based cache in BASEDIR/private/cache/download ,
821 which holds the plaintext of the files being downloaded. Future
822 implementations might not use this cache. GET for immutable files now returns
823 an ETag header.
824
825 Each file and directory now has a "Show More Info" web page, which contains
826 much of the information that was crammed into the directory page before. This
827 includes readonly URIs, storage index strings, object type, buttons to
828 control checking/verifying/repairing, and deep-check/deep-stats buttons (for
829 directories). For mutable files, the "replace contents" upload form has been
830 moved here too. As a result, the directory page is now much simpler and
831 cleaner, and several potentially-misleading links (like t=uri) are now gone.
832
833 Slashes are discouraged in Tahoe file/directory names, since they cause
834 problems when accessing the filesystem through the wapi. However, there are
835 a couple of accidental ways to generate such names. This release tries to
836 make it easier to correct such mistakes by escaping slashes in several
837 places, allowing slashes in the t=info and t=delete commands, and in the
838 source (but not the target) of a t=rename command.
839
840 ** Packaging
841
842 Tahoe's dependencies have been extended to require the "[secure_connections]"
843 feature from Foolscap, which will cause pyOpenSSL to be required and/or
844 installed. If OpenSSL and its development headers are already installed on
845 your system, this can occur automatically. Tahoe now uses pollreactor
846 (instead of the default selectreactor) to work around a bug between pyOpenSSL
847 and the most recent release of Twisted (8.1.0). This bug only affects unit
848 tests (hang during shutdown), and should not impact regular use.
849
850 The Tahoe source code tarballs now come in two different forms: regular and
851 "sumo". The regular tarball contains just Tahoe, nothing else. When building
852 from the regular tarball, the build process will download any unmet
853 dependencies from the internet (starting with the index at PyPI) so it can
854 build and install them. The "sumo" tarball contains copies of all the
855 libraries that Tahoe requires (foolscap, twisted, zfec, etc), so using the
856 "sumo" tarball should not require any internet access during the build
857 process. This can be useful if you want to build Tahoe while on an airplane,
858 a desert island, or other bandwidth-limited environments.
859
860 Similarly, allmydata.org now hosts a "tahoe-deps" tarball which contains the
861 latest versions of all these dependencies. This tarball, located at
862 http://allmydata.org/source/tahoe/deps/tahoe-deps.tar.gz, can be unpacked in
863 the tahoe source tree (or in its parent directory), and the build process
864 should satisfy its downloading needs from it instead of reaching out to PyPI.
865 This can be useful if you want to build Tahoe from a darcs checkout while on
866 that airplane or desert island.
867
868 Because of the previous two changes ("sumo" tarballs and the "tahoe-deps"
869 bundle), most of the files have been removed from misc/dependencies/ . This
870 brings the regular Tahoe tarball down to 2MB (compressed), and the darcs
871 checkout (without history) to about 7.6MB. A full darcs checkout will still
872 be fairly large (because of the historical patches which included the
873 dependent libraries), but a 'lazy' one should now be small.
874
875 The default "make" target is now an alias for "setup.py build", which itself
876 is an alias for "setup.py develop --prefix support", with some extra work
877 before and after (see setup.cfg). Most of the complicated platform-dependent
878 code in the Makefile was rewritten in Python and moved into setup.py,
879 simplifying things considerably.
880
881 Likewise, the "make test" target now delegates most of its work to "setup.py
882 test", which takes care of getting PYTHONPATH configured to access the tahoe
883 code (and dependencies) that gets put in support/lib/ by the build_tahoe
884 step. This should allow unit tests to be run even when trial (which is part
885 of Twisted) wasn't already installed (in this case, trial gets installed to
886 support/bin because Twisted is a dependency of Tahoe).
887
888 Tahoe is now compatible with the recently-released Python 2.6 , although it
889 is recommended to use Tahoe on Python 2.5, on which it has received more
890 thorough testing and deployment.
891
892 Tahoe is now compatible with simplejson-2.0.x . The previous release assumed
893 that simplejson.loads always returned unicode strings, which is no longer the
894 case in 2.0.x .
895
896 ** Grid Management Tools
897
898 Several tools have been added or updated in the misc/ directory, mostly munin
899 plugins that can be used to monitor a storage grid.
900
901 The misc/spacetime/ directory contains a "disk watcher" daemon (startable
902 with 'tahoe start'), which can be configured with a set of HTTP URLs
903 (pointing at the wapi '/statistics' page of a bunch of storage servers),
904 and will periodically fetch disk-used/disk-available information from all the
905 servers. It keeps this information in an Axiom database (a sqlite-based
906 library available from divmod.org). The daemon computes time-averaged rates
907 of disk usage, as well as a prediction of how much time is left before the
908 grid is completely full.
909
910 The misc/munin/ directory contains a new set of munin plugins
911 (tahoe_diskleft, tahoe_diskusage, tahoe_doomsday) which talk to the
912 disk-watcher and provide graphs of its calculations.
913
914 To support the disk-watcher, the Tahoe statistics component (visible through
915 the wapi at the /statistics/ URL) now includes disk-used and disk-available
916 information. Both are derived through an equivalent of the unix 'df' command
917 (i.e. they ask the kernel for the number of free blocks on the partition that
918 encloses the BASEDIR/storage directory). In the future, the disk-available
919 number will be further influenced by the local storage policy: if that policy
920 says that the server should refuse new shares when less than 5GB is left on
921 the partition, then "disk-available" will report zero even though the kernel
922 sees 5GB remaining.
923
924 The 'tahoe_overhead' munin plugin interacts with an allmydata.com-specific
925 server which reports the total of the 'deep-size' reports for all active user
926 accounts, compares this with the disk-watcher data, to report on overhead
927 percentages. This provides information on how much space could be recovered
928 once Tahoe implements some form of garbage collection.
929
930 ** Configuration Changes: single INI-format tahoe.cfg file
931
932 The Tahoe node is now configured with a single INI-format file, named
933 "tahoe.cfg", in the node's base directory. Most of the previous
934 multiple-separate-files are still read for backwards compatibility (the
935 embedded SSH debug server and the advertised_ip_addresses files are the
936 exceptions), but new directives will only be added to tahoe.cfg . The "tahoe
937 create-client" command will create a tahoe.cfg for you, with sample values
938 commented out. (ticket #518)
939
940 tahoe.cfg now has controls for the foolscap "keepalive" and "disconnect"
941 timeouts (#521).
942
943 tahoe.cfg now has controls for the encoding parameters: "shares.needed" and
944 "shares.total" in the "[client]" section. The default parameters are still
945 3-of-10.
946
947 The inefficient storage 'sizelimit' control (which established an upper bound
948 on the amount of space that a storage server is allowed to consume) has been
949 replaced by a lightweight 'reserved_space' control (which establishes a lower
950 bound on the amount of remaining space). The storage server will reject all
951 writes that would cause the remaining disk space (as measured by a '/bin/df'
952 equivalent) to drop below this value. The "[storage]reserved_space="
953 tahoe.cfg parameter controls this setting. (note that this only affects
954 immutable shares: it is an outstanding bug that reserved_space does not
955 prevent the allocation of new mutable shares, nor does it prevent the growth
956 of existing mutable shares).
957
958 ** Other Changes
959
960 Clients now declare which versions of the protocols they support. This is
961 part of a new backwards-compatibility system:
962 http://allmydata.org/trac/tahoe/wiki/Versioning .
963
964 The version strings for human inspection (as displayed on the Welcome web
965 page, and included in logs) now includes a platform identifer (frequently
966 including a linux distribution name, processor architecture, etc).
967
968 Several bugs have been fixed, including one that would cause an exception (in
969 the logs) if a wapi download operation was cancelled (by closing the TCP
970 connection, or pushing the "stop" button in a web browser).
971
972 Tahoe now uses Foolscap "Incidents", writing an "incident report" file to
973 logs/incidents/ each time something weird occurs. These reports are available
974 to an "incident gatherer" through the flogtool command. For more details,
975 please see the Foolscap logging documentation. An incident-classifying plugin
976 function is provided in misc/incident-gatherer/classify_tahoe.py .
977
978 If clients detect corruption in shares, they now automatically report it to
979 the server holding that share, if it is new enough to accept the report.
980 These reports are written to files in BASEDIR/storage/corruption-advisories .
981
982 The 'nickname' setting is now defined to be a UTF-8 -encoded string, allowing
983 non-ascii nicknames.
984
985 The 'tahoe start' command will now accept a --syslog argument and pass it
986 through to twistd, making it easier to launch non-Tahoe nodes (like the
987 cpu-watcher) and have them log to syslogd instead of a local file. This is
988 useful when running a Tahoe node out of a USB flash drive.
989
990 The Mac GUI in src/allmydata/gui/ has been improved.
991
992
993 * Release 1.2.0 (2008-07-21)
994
995 ** Security
996
997 This release makes the immutable-file "ciphertext hash tree" mandatory.
998 Previous releases allowed the uploader to decide whether their file would
999 have an integrity check on the ciphertext or not. A malicious uploader could
1000 use this to create a readcap that would download as one file or a different
1001 one, depending upon which shares the client fetched first, with no errors
1002 raised. There are other integrity checks on the shares themselves, preventing
1003 a storage server or other party from violating the integrity properties of
1004 the read-cap: this failure was only exploitable by the uploader who gives you
1005 a carefully constructed read-cap. If you download the file with Tahoe 1.2.0
1006 or later, you will not be vulnerable to this problem. #491
1007
1008 This change does not introduce a compatibility issue, because all existing
1009 versions of Tahoe will emit the ciphertext hash tree in their shares.
1010
1011 ** Dependencies
1012
1013 Tahoe now requires Foolscap-0.2.9 . It also requires pycryptopp 0.5 or newer,
1014 since earlier versions had a bug that interacted with specific compiler
1015 versions that could sometimes result in incorrect encryption behavior. Both
1016 packages are included in the Tahoe source tarball in misc/dependencies/ , and
1017 should be built automatically when necessary.
1018
1019 ** Web API
1020
1021 Web API directory pages should now contain properly-slash-terminated links to
1022 other directories. They have also stopped using absolute links in forms and
1023 pages (which interfered with the use of a front-end load-balancing proxy).
1024
1025 The behavior of the "Check This File" button changed, in conjunction with
1026 larger internal changes to file checking/verification. The button triggers an
1027 immediate check as before, but the outcome is shown on its own page, and does
1028 not get stored anywhere. As a result, the web directory page no longer shows
1029 historical checker results.
1030
1031 A new "Deep-Check" button has been added, which allows a user to initiate a
1032 recursive check of the given directory and all files and directories
1033 reachable from it. This can cause quite a bit of work, and has no
1034 intermediate progress information or feedback about the process. In addition,
1035 the results of the deep-check are extremely limited. A later release will
1036 improve this behavior.
1037
1038 The web server's behavior with respect to non-ASCII (unicode) filenames in
1039 the "GET save=true" operation has been improved. To achieve maximum
1040 compatibility with variously buggy web browsers, the server does not try to
1041 figure out the character set of the inbound filename. It just echoes the same
1042 bytes back to the browser in the Content-Disposition header. This seems to
1043 make both IE7 and Firefox work correctly.
1044
1045 ** Checker/Verifier/Repairer
1046
1047 Tahoe is slowly acquiring convenient tools to check up on file health,
1048 examine existing shares for errors, and repair files that are not fully
1049 healthy. This release adds a mutable checker/verifier/repairer, although
1050 testing is very limited, and there are no web interfaces to trigger repair
1051 yet. The "Check" button next to each file or directory on the wapi page
1052 will perform a file check, and the "deep check" button on each directory will
1053 recursively check all files and directories reachable from there (which may
1054 take a very long time).
1055
1056 Future releases will improve access to this functionality.
1057
1058 ** Operations/Packaging
1059
1060 A "check-grid" script has been added, along with a Makefile target. This is
1061 intended (with the help of a pre-configured node directory) to check upon the
1062 health of a Tahoe grid, uploading and downloading a few files. This can be
1063 used as a monitoring tool for a deployed grid, to be run periodically and to
1064 signal an error if it ever fails. It also helps with compatibility testing,
1065 to verify that the latest Tahoe code is still able to handle files created by
1066 an older version.
1067
1068 The munin plugins from misc/munin/ are now copied into any generated debian
1069 packages, and are made executable (and uncompressed) so they can be symlinked
1070 directly from /etc/munin/plugins/ .
1071
1072 Ubuntu "Hardy" was added as a supported debian platform, with a Makefile
1073 target to produce hardy .deb packages. Some notes have been added to
1074 docs/debian.txt about building Tahoe on a debian/ubuntu system.
1075
1076 Storage servers now measure operation rates and latency-per-operation, and
1077 provides results through the /statistics web page as well as the stats
1078 gatherer. Munin plugins have been added to match.
1079
1080 ** Other
1081
1082 Tahoe nodes now use Foolscap "incident logging" to record unusual events to
1083 their NODEDIR/logs/incidents/ directory. These incident files can be examined
1084 by Foolscap logging tools, or delivered to an external log-gatherer for
1085 further analysis. Note that Tahoe now requires Foolscap-0.2.9, since 0.2.8
1086 had a bug that complained about "OSError: File exists" when trying to create
1087 the incidents/ directory for a second time.
1088
1089 If no servers are available when retrieving a mutable file (like a
1090 directory), the node now reports an error instead of hanging forever. Earlier
1091 releases would not only hang (causing the wapi directory listing to get
1092 stuck half-way through), but the internal dirnode serialization would cause
1093 all subsequent attempts to retrieve or modify the same directory to hang as
1094 well. #463
1095
1096 A minor internal exception (reported in logs/twistd.log, in the
1097 "stopProducing" method) was fixed, which complained about "self._paused_at
1098 not defined" whenever a file download was stopped from the web browser end.
1099
1100
1101 * Release 1.1.0 (2008-06-11)
1102
1103 ** CLI: new "alias" model
1104
1105 The new CLI code uses an scp/rsync -like interface, in which directories in
1106 the Tahoe storage grid are referenced by a colon-suffixed alias. The new
1107 commands look like:
1108  tahoe cp local.txt tahoe:virtual.txt
1109  tahoe ls work:subdir
1110
1111 More functionality is available through the CLI: creating unlinked files and
1112 directories, recursive copy in or out of the storage grid, hardlinks, and
1113 retrieving the raw read- or write- caps through the 'ls' command. Please read
1114 docs/CLI.txt for complete details.
1115
1116 ** wapi: new pages, new commands
1117
1118 Several new pages were added to the web API:
1119
1120  /helper_status : to describe what a Helper is doing
1121  /statistics : reports node uptime, CPU usage, other stats
1122  /file : for easy file-download URLs, see #221
1123  /cap == /uri : future compatibility
1124
1125 The localdir=/localfile= and t=download operations were removed. These
1126 required special configuration to enable anyways, but this feature was a
1127 security problem, and was mostly obviated by the new "cp -r" command.
1128
1129 Several new options to the GET command were added:
1130
1131  t=deep-size : add up the size of all immutable files reachable from the directory
1132  t=deep-stats : return a JSON-encoded description of number of files, size
1133                 distribution, total size, etc
1134
1135 POST is now preferred over PUT for most operations which cause side-effects.
1136
1137 Most wapi calls now accept overwrite=, and default to overwrite=true .
1138
1139 "POST /uri/DIRCAP/parent/child?t=mkdir" is now the preferred API to create
1140 multiple directories at once, rather than ...?t=mkdir-p .
1141
1142 PUT to a mutable file ("PUT /uri/MUTABLEFILECAP", "PUT /uri/DIRCAP/child")
1143 will modify the file in-place.
1144
1145 ** more munin graphs in misc/munin/
1146
1147   tahoe-introstats
1148   tahoe-rootdir-space
1149   tahoe_estimate_files
1150   mutable files published/retrieved
1151   tahoe_cpu_watcher
1152   tahoe_spacetime
1153
1154 ** New Dependencies
1155
1156   zfec 1.1.0
1157   foolscap 0.2.8
1158   pycryptopp 0.5
1159   setuptools (now required at runtime)
1160
1161 ** New Mutable-File Code
1162
1163 The mutable-file handling code (mostly used for directories) has been
1164 completely rewritten. The new scheme has a better API (with a modify()
1165 method) and is less likely to lose data when several uncoordinated writers
1166 change a file at the same time.
1167
1168 In addition, a single Tahoe process will coordinate its own writes. If you
1169 make two concurrent directory-modifying wapi calls to a single tahoe node,
1170 it will internally make one of them wait for the other to complete. This
1171 prevents auto-collision (#391).
1172
1173 The new mutable-file code also detects errors during publish better. Earlier
1174 releases might believe that a mutable file was published when in fact it
1175 failed.
1176
1177 ** other features
1178
1179 The node now monitors its own CPU usage, as a percentage, measured every 60
1180 seconds. 1/5/15 minute moving averages are available on the /statistics web
1181 page and via the stats-gathering interface.
1182
1183 Clients now accelerate reconnection to all servers after being offline
1184 (#374). When a client is offline for a long time, it scales back reconnection
1185 attempts to approximately once per hour, so it may take a while to make the
1186 first attempt, but once any attempt succeeds, the other server connections
1187 will be retried immediately.
1188
1189 A new "offloaded KeyGenerator" facility can be configured, to move RSA key
1190 generation out from, say, a wapi node, into a separate process. RSA keys
1191 can take several seconds to create, and so a wapi node which is being used
1192 for directory creation will be unavailable for anything else during this
1193 time. The Key Generator process will pre-compute a small pool of keys, to
1194 speed things up further. This also takes better advantage of multi-core CPUs,
1195 or SMP hosts.
1196
1197 The node will only use a potentially-slow "du -s" command at startup (to
1198 measure how much space has been used) if the "sizelimit" parameter has been
1199 configured (to limit how much space is used). Large storage servers should
1200 turn off sizelimit until a later release improves the space-management code,
1201 since "du -s" on a terabyte filesystem can take hours.
1202
1203 The Introducer now allows new announcements to replace old ones, to avoid
1204 buildups of obsolete announcements.
1205
1206 Immutable files are limited to about 12GiB (when using the default 3-of-10
1207 encoding), because larger files would be corrupted by the four-byte
1208 share-size field on the storage servers (#439). A later release will remove
1209 this limit. Earlier releases would allow >12GiB uploads, but the resulting
1210 file would be unretrievable.
1211
1212 The docs/ directory has been rearranged, with old docs put in
1213 docs/historical/ and not-yet-implemented ones in docs/proposed/ .
1214
1215 The Mac OS-X FUSE plugin has a significant bug fix: earlier versions would
1216 corrupt writes that used seek() instead of writing the file in linear order.
1217 The rsync tool is known to perform writes in this order. This has been fixed.