source: trunk/docs/glossary.rst

Last change on this file was 06219ad, checked in by blaisep <blaise@…>, at 2024-10-17T17:16:41Z

Fix trac 4116 and create a global dynamic glossary

Add a global Sphinx generated glossary.
Link the static GBS glossary to the global glossary.

  • Property mode set to 100644
File size: 2.2 KB
Line 
1.. -*- coding: utf-8 -*-
2
3============================
4Glossary of Tahoe-LAFS Terms
5============================
6
7
8.. glossary::
9
10   `Foolscap <https://github.com/warner/foolscap/>`_
11     an RPC/RMI (Remote Procedure Call / Remote Method Invocation) protocol for use with Twisted
12
13   storage server
14     a Tahoe-LAFS process configured to offer storage and reachable over the network for store and retrieve operations
15
16   storage service
17     a Python object held in memory in the storage server which provides the implementation of the storage protocol
18
19   introducer
20     a Tahoe-LAFS process at a known location configured to re-publish announcements about the location of storage servers
21
22   :ref:`fURLs <fURLs>`
23     a self-authenticating URL-like string which can be used to locate a remote object using the Foolscap protocol
24     (the storage service is an example of such an object)
25
26   :ref:`NURLs <NURLs>`
27     a self-authenticating URL-like string almost exactly like a fURL but without being tied to Foolscap
28
29   swissnum
30     a short random string which is part of a fURL/NURL and which acts as a shared secret to authorize clients to use a storage service
31
32   lease
33     state associated with a share informing a storage server of the duration of storage desired by a client
34
35   share
36     a single unit of client-provided arbitrary data to be stored by a storage server
37     (in practice, one of the outputs of applying ZFEC encoding to some ciphertext with some additional metadata attached)
38
39   bucket
40     a group of one or more immutable shares held by a storage server and having a common storage index
41
42   slot
43     a group of one or more mutable shares held by a storage server and having a common storage index
44     (sometimes "slot" is considered a synonym for "storage index of a slot")
45
46   storage index
47     a 16 byte string which can address a slot or a bucket
48     (in practice, derived by hashing the encryption key associated with contents of that slot or bucket)
49
50   write enabler
51     a short secret string which storage servers require to be presented before allowing mutation of any mutable share
52
53   lease renew secret
54     a short secret string which storage servers required to be presented before allowing a particular lease to be renewed
Note: See TracBrowser for help on using the repository browser.