Documentation updates.
[cumulus.git] / NEWS
1 0.8 [???]
2     - SNAPSHOT FORMAT CHANGE: The snapshot format has been extended to
3       allow the local database to be partially rebuilt from the contents
4       of the metadata log.  This may be useful for disaster recovery and
5       other scenarios.  The changes are small, but old tools will not
6       read the new backups.
7
8 0.7 [2008-06-23]
9     - LOCAL DATABASE CHANGE: The addition of subfile incrementals has
10       requires an extension to the local database.  The upgrade script
11       contrib/upgrade0.7-localdb.sql should be run prior to running
12       backups with this version.
13     - Name change: the system is now known as Cumulus (replacing the old
14       name of "LBS").  Some traces of the old name still remain.
15     - Initial support for direct backups to remote storage.  A sample
16       script is provided for backing up to Amazon S3.  Other scripts
17       should be simple to write.  The interface should not yet be
18       considered stable, and may change in a future release.
19     - Support for efficient subfile incremental backups.  Changes to a
20       small portion of a file do not require re-uploading substantially
21       all of the file, even in cases where there is an insertion or
22       deletion that shifts most of the file contents.
23     - Allow selected files/directories to be restored, not simply an
24       entire snapshot.  Additionally, restore files in an order that
25       should optimize performance (restore files based on how they are
26       grouped into segments, instead of lexicographic order).
27       Currently, the implementation of these changes requires that all
28       metadata be loaded into memory when the restore tool runs, so it
29       is more memory-intensive than the old version.  This may be fixed
30       in a future version; in the meantime, if the current restore tool
31       requires too much memory, try the old restore tool or the
32       restore.pl script.
33     - Add a verbose ("-v") flag.  By default, files will not be listed
34       as they are backed up.  The old behavior can be turned back on
35       with -v.
36
37 0.6 [2008-02-19]
38     - SNAPSHOT FORMAT CHANGE: A few minor tweaks have been made to the
39       snapshot format.  There is nothing substantial--this is primarily
40       a cleaning up of the format before use becomes more widespread.
41       An efficient and explicit means for representing sparse files has
42       been added to the format.  Updated tools will be needed to
43       properly understand the new snapshots.  Tools will continue to be
44       able to read the old snapshot format.
45     - LOCAL DATABASE CHANGE: The local database has been changed so that
46       segment utilization data for past snapshots is stored more
47       efficiently.  The script in contrib/upgrade0.6-localdb.sql must be
48       run on a database to upgrade it prior to running backups with the
49       new tool.
50     - The statcache implementation has been reworked, and the format
51       changed.  The first backup will run more slowly since the old
52       statcache data will be ignored.  New statcache data will be
53       written to statcache2.  The old statcache file can be deleted.
54     - Metadata is shared between snapshots where possible.  The
55       --full-metadata option can be used to disable this (completely
56       writing out all metadata with the new snapshot).
57     - Add an "intent" field to snapshots, which specifies informally how
58       long a snapshot is intended to be kept.  For example, 1 can be
59       used for daily snapshots, and 7 for weekly snapshots.  Segment
60       cleaning is now partly guided by intent values, but tuning of the
61       cleaning algorithms is not yet finished.
62
63 0.5.1 [2007-11-13]
64     - Have the lbs-util tool check the version number when reading a
65       snapshot, and signal an error if the format is not recognized.
66     - Include a sample script, contrib/parity-gen, for creating
67       RAID-like parity sets to recover from some segment corruption.
68       The par2 command (http://parchive.sourceforge.net/) is used to
69       actually generate the parity sets; the parity-gen script simply
70       automates maintaining the parity sets.
71
72 0.5 [2007-10-16]
73     - Much improved Python interface for accessing and manipulating LBS
74       archives and local database information.  The interface should not
75       yet be considered completely stable.
76     - Python implementation of lbs-util now includes most of the
77       features of the Perl implementation, plus some other new features.
78       The Perl library and utility are deprecated and have been removed
79       from this release.
80     - Preliminary snapshot restore support in lbs-util.  This is still
81       not yet extensively tested.
82
83 0.4 [2007-08-24]
84     - Documentation improvements: a getting started README, and a
85       description of some of the implementation details.
86     - Include an example filter script, lbs-filter-gpg, for encrypting
87       segment data as it is written.
88     - Add support for signed snapshot descriptor files (via the
89       --signature-filter option).  Due to the checksums contained in the
90       snapshot descriptor, the signature covers the entire contents of
91       the snapshot.
92     - Preview release of lbs-util.py, a Python-based program for
93       managing LBS snapshots.  It currently implements a very simple
94       form of automatic segment cleaning, though this isn't much tested.
95     - Improved segment repacking support; after cleaning segments,
96       objects can be written out in different groups based on age.  This
97       may help with long-term segment cleaning efficiency, but probably
98       needs more tuning.
99
100 0.3 [2007-08-10]
101     - LOCAL DATABASE CHANGE: A checksums file is now written out along
102       with the snapshot descriptor that contains checksums of segments
103       used in a snapshot.  This will allow quick integrity checks of a
104       snapshot, without needing to decompress or decrypt the segment
105       files.  The local database schema was modified to store the
106       checksums for segments.
107     - Build dependence on libtar has been dropped.  All necessary
108       support for writing TAR files is now directly included with the
109       source.
110     - The snapshot format is now documented, at least in part.  See
111       format.txt.
112     - Snapshots now include link count and inode number for files with
113       multiple hard links, so that a restore program could determine
114       which files should be hard linked on restore.  The reference
115       restore.pl script does not use this.
116     - Bugfix: Print a help message instead of crashing if no files are
117       specified.
118     - Bugfix: File descriptors of files being backed up were closed
119       twice.  In some cases this might have led to an unrelated file
120       being closed (if the file descriptor was quickly re-used).
121     - Preview of a new lbs-util command for maintaining snapshots.
122       Functionality is currently limited.
123
124 0.2.2 [2007-07-27]
125     - Update reference restore.pl script to handle octal/hexadecimal
126       (format change introduced in 0.2).
127     - Better support for mixing multiple backup schemes: the statcache
128       file is now per-scheme, so performance should be better in cases
129       where multiple different backups (of different source directories)
130       are made, all sharing the same local database directory.
131
132 0.2.1 [2007-07-20]
133     - Bugfix: Do not print an error when only one directory is specified
134       to back up.
135
136 0.2 [2007-07-20]
137     - SNAPSHOT FORMAT CHANGE: Metadata logs in backups can now contain
138       octal and hexadecimal values.  Old restore programs may not be
139       able to read these new backups.  The reference restore.pl script
140       has not yet been updated.
141     - LOCAL DATABASE CHANGE: Backups may be assigned a name with the
142       --scheme= command-line option, to allow different backup sets to
143       be mixed in the same directory.  The database schema for the local
144       database is changed.
145     - Improved selection (inclusion/exclusion) of files to be included
146       in a backup.
147     - Device major/minor numbers are dumped for block and character
148       devices.
149
150 0.1 [2007-07-14]
151     - Initial release.