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