Ticket #1080: running.dpatch

File running.dpatch, 18.9 KB (added by kevan, at 2010-06-14T23:15:29Z)

Alter 'running.html' to mention servers of happiness

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