Ticket #778: mutabledocs.dpatch

File mutabledocs.dpatch, 18.1 KB (added by kevan, at 2010-05-24T00:42:26Z)

make a distinction between immutable file uploads and mutable file uploads wrt servers of happiness

Line 
1Sun May 23 17:16:25 PDT 2010  Kevan Carstensen <kevan@isnotajoke.com>
2  * Note that servers of happiness only applies to immutable files for the moment
3
4New patches:
5
6[Note that servers of happiness only applies to immutable files for the moment
7Kevan Carstensen <kevan@isnotajoke.com>**20100524001625
8 Ignore-this: 28039c5fce61846fe7ea459fca81cba5
9] {
10hunk ./docs/architecture.txt 186
11 files which have been uploaded once before, while making sure we still wind up
12 with as many shares as we desire.
13 
14-If we are unable to place every share that we want, but we still managed to
15-place enough shares on enough servers to achieve a condition called "servers of
16-happiness" then we'll do the upload anyways. If we cannot achieve "servers of
17-happiness", the upload is declared a failure.
18+If we are uploading an immutable file and are unable to place every share that
19+we want, but we still managed to place enough shares on enough servers to
20+achieve a condition called "servers of happiness" then we'll do the upload
21+anyways. If we cannot achieve "servers of happiness", the immutable file upload
22+is declared a failure. If we are uploading a mutable file or a directory and
23+are unable to place all of the shares that we want to place, the upload will
24+fail regardless of where the shares were placed.
25 
26 The current defaults use k=3, servers_of_happiness=7, and N=10. N=10 means that
27 we'll try to place 10 shares. k=3 means that we need any three shares to
28hunk ./docs/architecture.txt 196
29-recover the file. servers_of_happiness=7 means that we'll consider the upload
30-to be successful if we can place shares on enough servers that there are 7
31-different servers, the correct functioning of any k of which guarantee the
32-availability of the file.
33+recover the file. servers_of_happiness=7 means that we'll consider an immutable
34+file upload to be successful if we can place shares on enough servers that
35+there are 7 different servers, the correct functioning of any k of which
36+guarantee the availability of the immutable file.
37 
38 N=10 and k=3 means there is a 3.3x expansion factor. On a small grid, you
39 should set N about equal to the number of storage servers in your grid; on a
40hunk ./docs/configuration.txt 275
41  larger than 256, because of the 8-bit erasure-coding algorithm that Tahoe
42  uses.
43 
44- shares.happy allows you control over the distribution of your file. An upload
45- is only considered successful if shares are placed on at least 'shares.happy'
46- distinct servers, the correct functioning of at least k of which is sufficient
47- to guarantee the availability of the uploaded file. This value should not be
48- larger than the number of servers on your grid.
49+ shares.happy allows you control over the distribution of your immutable file.
50+ An upload is only considered successful if shares are placed on at least
51+ 'shares.happy' distinct servers, the correct functioning of at least k of
52+ which is sufficient to guarantee the availability of the uploaded file. This
53+ value should not be larger than the number of servers on your grid.
54+
55+ (mutable files use a different share placement algorithm that does not
56+  consider this parameter)
57 
58 
59 == Storage Server Configuration ==
60}
61
62Context:
63
64[setup: remove bundled setuptools_darcs-1.2.8.tar
65zooko@zooko.com**20100522015333
66 Ignore-this: 378b1964b513ae7fe22bae2d3478285d
67 This version of setuptools_darcs had a bug when used on Windows which has been fixed in setuptools_darcs-1.2.9. Hopefully we will not need to bundle a copy of setuptools_darcs-1.2.9 in with Tahoe-LAFS and can instead rely on it to be downloaded from PyPI or bundled in the "tahoe deps" separate tarball.
68] 
69[tests: fix pyflakes warnings in bench_dirnode.py
70zooko@zooko.com**20100521202511
71 Ignore-this: f23d55b4ed05e52865032c65a15753c4
72] 
73[setup: if the string '--reporter=bwverbose-coverage' appears on sys.argv then you need trialcoverage
74zooko@zooko.com**20100521122226
75 Ignore-this: e760c45dcfb5a43c1dc1e8a27346bdc2
76] 
77[tests: don't let bench_dirnode.py do stuff and have side-effects at import time (unless __name__ == '__main__')
78zooko@zooko.com**20100521122052
79 Ignore-this: 96144a412250d9bbb5fccbf83b8753b8
80] 
81[tests: increase timeout to give François's ARM buildslave a chance to complete the tests
82zooko@zooko.com**20100520134526
83 Ignore-this: 3dd399fdc8b91149c82b52f955b50833
84] 
85[run_trial.darcspath
86freestorm77@gmail.com**20100510232829
87 Ignore-this: 5ebb4df74e9ea8a4bdb22b65373d1ff2
88] 
89[docs: line-wrap README.txt
90zooko@zooko.com**20100518174240
91 Ignore-this: 670a02d360df7de51ebdcf4fae752577
92] 
93[Hush pyflakes warnings
94Kevan Carstensen <kevan@isnotajoke.com>**20100515184344
95 Ignore-this: fd602c3bba115057770715c36a87b400
96] 
97[setup: new improved misc/show-tool-versions.py
98zooko@zooko.com**20100516050122
99 Ignore-this: ce9b1de1b35b07d733e6cf823b66335a
100] 
101[Improve code coverage of the Tahoe2PeerSelector tests.
102Kevan Carstensen <kevan@isnotajoke.com>**20100515032913
103 Ignore-this: 793151b63ffa65fdae6915db22d9924a
104] 
105[Remove a comment that no longer makes sense.
106Kevan Carstensen <kevan@isnotajoke.com>**20100514203516
107 Ignore-this: 956983c7e7c7e4477215494dfce8f058
108] 
109[docs: update docs/architecture.txt to more fully and correctly explain the upload procedure
110zooko@zooko.com**20100514043458
111 Ignore-this: 538b6ea256a49fed837500342092efa3
112] 
113[Fix up the behavior of #778, per reviewers' comments
114Kevan Carstensen <kevan@isnotajoke.com>**20100514004917
115 Ignore-this: 9c20b60716125278b5456e8feb396bff
116 
117   - Make some important utility functions clearer and more thoroughly
118     documented.
119   - Assert in upload.servers_of_happiness that the buckets attributes
120     of PeerTrackers passed to it are mutually disjoint.
121   - Get rid of some silly non-Pythonisms that I didn't see when I first
122     wrote these patches.
123   - Make sure that should_add_server returns true when queried about a
124     shnum that it doesn't know about yet.
125   - Change Tahoe2PeerSelector.preexisting_shares to map a shareid to a set
126     of peerids, alter dependencies to deal with that.
127   - Remove upload.should_add_servers, because it is no longer necessary
128   - Move upload.shares_of_happiness and upload.shares_by_server to a utility
129     file.
130   - Change some points in Tahoe2PeerSelector.
131   - Compute servers_of_happiness using a bipartite matching algorithm that
132     we know is optimal instead of an ad-hoc greedy algorithm that isn't.
133   - Change servers_of_happiness to just take a sharemap as an argument,
134     change its callers to merge existing_shares and used_peers before
135     calling it.
136   - Change an error message in the encoder to be more appropriate for
137     servers of happiness.
138   - Clarify the wording of an error message in immutable/upload.py
139   - Refactor a happiness failure message to happinessutil.py, and make
140     immutable/upload.py and immutable/encode.py use it.
141   - Move the word "only" as far to the right as possible in failure
142     messages.
143   - Use a better definition of progress during peer selection.
144   - Do read-only peer share detection queries in parallel, not sequentially.
145   - Clean up logging semantics; print the query statistics whenever an
146     upload is unsuccessful, not just in one case.
147 
148] 
149[Alter the error message when an upload fails, per some comments in #778.
150Kevan Carstensen <kevan@isnotajoke.com>**20091230210344
151 Ignore-this: ba97422b2f9737c46abeb828727beb1
152 
153 When I first implemented #778, I just altered the error messages to refer to
154 servers where they referred to shares. The resulting error messages weren't
155 very good. These are a bit better.
156] 
157[Change "UploadHappinessError" to "UploadUnhappinessError"
158Kevan Carstensen <kevan@isnotajoke.com>**20091205043037
159 Ignore-this: 236b64ab19836854af4993bb5c1b221a
160] 
161[Alter the error message returned when peer selection fails
162Kevan Carstensen <kevan@isnotajoke.com>**20091123002405
163 Ignore-this: b2a7dc163edcab8d9613bfd6907e5166
164 
165 The Tahoe2PeerSelector returned either NoSharesError or NotEnoughSharesError
166 for a variety of error conditions that weren't informatively described by them.
167 This patch creates a new error, UploadHappinessError, replaces uses of
168 NoSharesError and NotEnoughSharesError with it, and alters the error message
169 raised with the errors to be more in line with the new servers_of_happiness
170 behavior. See ticket #834 for more information.
171] 
172[Eliminate overcounting iof servers_of_happiness in Tahoe2PeerSelector; also reorganize some things.
173Kevan Carstensen <kevan@isnotajoke.com>**20091118014542
174 Ignore-this: a6cb032cbff74f4f9d4238faebd99868
175] 
176[Change stray "shares_of_happiness" to "servers_of_happiness"
177Kevan Carstensen <kevan@isnotajoke.com>**20091116212459
178 Ignore-this: 1c971ba8c3c4d2e7ba9f020577b28b73
179] 
180[Alter Tahoe2PeerSelector to make sure that it recognizes existing shares on readonly servers, fixing an issue in #778
181Kevan Carstensen <kevan@isnotajoke.com>**20091116192805
182 Ignore-this: 15289f4d709e03851ed0587b286fd955
183] 
184[Alter 'immutable/encode.py' and 'immutable/upload.py' to use servers_of_happiness instead of shares_of_happiness.
185Kevan Carstensen <kevan@isnotajoke.com>**20091104111222
186 Ignore-this: abb3283314820a8bbf9b5d0cbfbb57c8
187] 
188[Alter the signature of set_shareholders in IEncoder to add a 'servermap' parameter, which gives IEncoders enough information to perform a sane check for servers_of_happiness.
189Kevan Carstensen <kevan@isnotajoke.com>**20091104033241
190 Ignore-this: b3a6649a8ac66431beca1026a31fed94
191] 
192[Alter CiphertextDownloader to work with servers_of_happiness
193Kevan Carstensen <kevan@isnotajoke.com>**20090924041932
194 Ignore-this: e81edccf0308c2d3bedbc4cf217da197
195] 
196[Revisions of the #778 tests, per reviewers' comments
197Kevan Carstensen <kevan@isnotajoke.com>**20100514012542
198 Ignore-this: 735bbc7f663dce633caeb3b66a53cf6e
199 
200 - Fix comments and confusing naming.
201 - Add tests for the new error messages suggested by David-Sarah
202   and Zooko.
203 - Alter existing tests for new error messages.
204 - Make sure that the tests continue to work with the trunk.
205 - Add a test for a mutual disjointedness assertion that I added to
206   upload.servers_of_happiness.
207 - Fix the comments to correctly reflect read-onlyness
208 - Add a test for an edge case in should_add_server
209 - Add an assertion to make sure that share redistribution works as it
210   should
211 - Alter tests to work with revised servers_of_happiness semantics
212 - Remove tests for should_add_server, since that function no longer exists.
213 - Alter tests to know about merge_peers, and to use it before calling
214   servers_of_happiness.
215 - Add tests for merge_peers.
216 - Add Zooko's puzzles to the tests.
217 - Edit encoding tests to expect the new kind of failure message.
218 - Edit tests to expect error messages with the word "only" moved as far
219   to the right as possible.
220 - Extended and cleaned up some helper functions.
221 - Changed some tests to call more appropriate helper functions.
222 - Added a test for the failing redistribution algorithm
223 - Added a test for the progress message
224 - Added a test for the upper bound on readonly peer share discovery.
225 
226] 
227[Alter various unit tests to work with the new happy behavior
228Kevan Carstensen <kevan@isnotajoke.com>**20100107181325
229 Ignore-this: 132032bbf865e63a079f869b663be34a
230] 
231[Replace "UploadHappinessError" with "UploadUnhappinessError" in tests.
232Kevan Carstensen <kevan@isnotajoke.com>**20091205043453
233 Ignore-this: 83f4bc50c697d21b5f4e2a4cd91862ca
234] 
235[Add tests for the behavior described in #834.
236Kevan Carstensen <kevan@isnotajoke.com>**20091123012008
237 Ignore-this: d8e0aa0f3f7965ce9b5cea843c6d6f9f
238] 
239[Re-work 'test_upload.py' to be more readable; add more tests for #778
240Kevan Carstensen <kevan@isnotajoke.com>**20091116192334
241 Ignore-this: 7e8565f92fe51dece5ae28daf442d659
242] 
243[Test Tahoe2PeerSelector to make sure that it recognizeses existing shares on readonly servers
244Kevan Carstensen <kevan@isnotajoke.com>**20091109003735
245 Ignore-this: 12f9b4cff5752fca7ed32a6ebcff6446
246] 
247[Add more tests for comment:53 in ticket #778
248Kevan Carstensen <kevan@isnotajoke.com>**20091104112849
249 Ignore-this: 3bb2edd299a944cc9586e14d5d83ec8c
250] 
251[Add a test for upload.shares_by_server
252Kevan Carstensen <kevan@isnotajoke.com>**20091104111324
253 Ignore-this: f9802e82d6982a93e00f92e0b276f018
254] 
255[Minor tweak to an existing test -- make the first server read-write, instead of read-only
256Kevan Carstensen <kevan@isnotajoke.com>**20091104034232
257 Ignore-this: a951a46c93f7f58dd44d93d8623b2aee
258] 
259[Alter tests to use the new form of set_shareholders
260Kevan Carstensen <kevan@isnotajoke.com>**20091104033602
261 Ignore-this: 3deac11fc831618d11441317463ef830
262] 
263[Refactor some behavior into a mixin, and add tests for the behavior described in #778
264"Kevan Carstensen" <kevan@isnotajoke.com>**20091030091908
265 Ignore-this: a6f9797057ca135579b249af3b2b66ac
266] 
267[Alter NoNetworkGrid to allow the creation of readonly servers for testing purposes.
268Kevan Carstensen <kevan@isnotajoke.com>**20091018013013
269 Ignore-this: e12cd7c4ddeb65305c5a7e08df57c754
270] 
271[Update 'docs/architecture.txt' to reflect readonly share discovery
272kevan@isnotajoke.com**20100514003852
273 Ignore-this: 7ead71b34df3b1ecfdcfd3cb2882e4f9
274] 
275[Alter the wording in docs/architecture.txt to more accurately describe the servers_of_happiness behavior.
276Kevan Carstensen <kevan@isnotajoke.com>**20100428002455
277 Ignore-this: 6eff7fa756858a1c6f73728d989544cc
278] 
279[Alter wording in 'interfaces.py' to be correct wrt #778
280"Kevan Carstensen" <kevan@isnotajoke.com>**20091205034005
281 Ignore-this: c9913c700ac14e7a63569458b06980e0
282] 
283[Update 'docs/configuration.txt' to reflect the servers_of_happiness behavior.
284Kevan Carstensen <kevan@isnotajoke.com>**20091205033813
285 Ignore-this: 5e1cb171f8239bfb5b565d73c75ac2b8
286] 
287[Clarify quickstart instructions for installing pywin32
288david-sarah@jacaranda.org**20100511180300
289 Ignore-this: d4668359673600d2acbc7cd8dd44b93c
290] 
291[web: add a simple test that you can load directory.xhtml
292zooko@zooko.com**20100510063729
293 Ignore-this: e49b25fa3c67b3c7a56c8b1ae01bb463
294] 
295[setup: fix typos in misc/show-tool-versions.py
296zooko@zooko.com**20100510063615
297 Ignore-this: 2181b1303a0e288e7a9ebd4c4855628
298] 
299[setup: show code-coverage tool versions in show-tools-versions.py
300zooko@zooko.com**20100510062955
301 Ignore-this: 4b4c68eb3780b762c8dbbd22b39df7cf
302] 
303[docs: update README, mv it to README.txt, update setup.py
304zooko@zooko.com**20100504094340
305 Ignore-this: 40e28ca36c299ea1fd12d3b91e5b421c
306] 
307[Dependency on Windmill test framework is not needed yet.
308david-sarah@jacaranda.org**20100504161043
309 Ignore-this: be088712bec650d4ef24766c0026ebc8
310] 
311[tests: pass z to tar so that BSD tar will know to ungzip
312zooko@zooko.com**20100504090628
313 Ignore-this: 1339e493f255e8fc0b01b70478f23a09
314] 
315[setup: update comments and URLs in setup.cfg
316zooko@zooko.com**20100504061653
317 Ignore-this: f97692807c74bcab56d33100c899f829
318] 
319[setup: reorder and extend the show-tool-versions script, the better to glean information about our new buildslaves
320zooko@zooko.com**20100504045643
321 Ignore-this: 836084b56b8d4ee8f1de1f4efb706d36
322] 
323[CLI: Support for https url in option --node-url
324Francois Deppierraz <francois@ctrlaltdel.ch>**20100430185609
325 Ignore-this: 1717176b4d27c877e6bc67a944d9bf34
326 
327 This patch modifies the regular expression used for verifying of '--node-url'
328 parameter.  Support for accessing a Tahoe gateway over HTTPS was already
329 present, thanks to Python's urllib.
330 
331] 
332[backupdb.did_create_directory: use REPLACE INTO, not INSERT INTO + ignore error
333Brian Warner <warner@lothar.com>**20100428050803
334 Ignore-this: 1fca7b8f364a21ae413be8767161e32f
335 
336 This handles the case where we upload a new tahoe directory for a
337 previously-processed local directory, possibly creating a new dircap (if the
338 metadata had changed). Now we replace the old dirhash->dircap record. The
339 previous behavior left the old record in place (with the old dircap and
340 timestamps), so we'd never stop creating new directories and never converge
341 on a null backup.
342] 
343["tahoe webopen": add --info flag, to get ?t=info
344Brian Warner <warner@lothar.com>**20100424233003
345 Ignore-this: 126b0bb6db340fabacb623d295eb45fa
346 
347 Also fix some trailing whitespace.
348] 
349[docs: install.html http-equiv refresh to quickstart.html
350zooko@zooko.com**20100421165708
351 Ignore-this: 52b4b619f9dde5886ae2cd7f1f3b734b
352] 
353[docs: install.html -> quickstart.html
354zooko@zooko.com**20100421155757
355 Ignore-this: 6084e203909306bed93efb09d0e6181d
356 It is not called "installing" because that implies that it is going to change the configuration of your operating system. It is not called "building" because that implies that you need developer tools like a compiler. Also I added a stern warning against looking at the "InstallDetails" wiki page, which I have renamed to "AdvancedInstall".
357] 
358[Fix another typo in tahoe_storagespace munin plugin
359david-sarah@jacaranda.org**20100416220935
360 Ignore-this: ad1f7aa66b554174f91dfb2b7a3ea5f3
361] 
362[Add dependency on windmill >= 1.3
363david-sarah@jacaranda.org**20100416190404
364 Ignore-this: 4437a7a464e92d6c9012926b18676211
365] 
366[licensing: phrase the OpenSSL-exemption in the vocabulary of copyright instead of computer technology, and replicate the exemption from the GPL to the TGPPL
367zooko@zooko.com**20100414232521
368 Ignore-this: a5494b2f582a295544c6cad3f245e91
369] 
370[munin-tahoe_storagespace
371freestorm77@gmail.com**20100221203626
372 Ignore-this: 14d6d6a587afe1f8883152bf2e46b4aa
373 
374 Plugin configuration rename
375 
376] 
377[setup: add licensing declaration for setuptools (noticed by the FSF compliance folks)
378zooko@zooko.com**20100309184415
379 Ignore-this: 2dfa7d812d65fec7c72ddbf0de609ccb
380] 
381[setup: fix error in licensing declaration from Shawn Willden, as noted by the FSF compliance division
382zooko@zooko.com**20100309163736
383 Ignore-this: c0623d27e469799d86cabf67921a13f8
384] 
385[CREDITS to Jacob Appelbaum
386zooko@zooko.com**20100304015616
387 Ignore-this: 70db493abbc23968fcc8db93f386ea54
388] 
389[desert-island-build-with-proper-versions
390jacob@appelbaum.net**20100304013858] 
391[docs: a few small edits to try to guide newcomers through the docs
392zooko@zooko.com**20100303231902
393 Ignore-this: a6aab44f5bf5ad97ea73e6976bc4042d
394 These edits were suggested by my watching over Jake Appelbaum's shoulder as he completely ignored/skipped/missed install.html and also as he decided that debian.txt wouldn't help him with basic installation. Then I threw in a few docs edits that have been sitting around in my sandbox asking to be committed for months.
395] 
396[TAG allmydata-tahoe-1.6.1
397david-sarah@jacaranda.org**20100228062314
398 Ignore-this: eb5f03ada8ea953ee7780e7fe068539
399] 
400Patch bundle hash:
401e1c6f0d8008e1d6aa6f39803a2f4d020113fa2ab