]> git.rkrishnan.org Git - tahoe-lafs/tahoe-lafs.git/commitdiff
add a provisioning utility page which shows necessary storage space and transfer...
authorBrian Warner <warner@lothar.com>
Mon, 27 Aug 2007 06:44:24 +0000 (23:44 -0700)
committerBrian Warner <warner@lothar.com>
Mon, 27 Aug 2007 06:44:24 +0000 (23:44 -0700)
src/allmydata/provisioning.py [new file with mode: 0644]
src/allmydata/test/test_provisioning.py [new file with mode: 0644]
src/allmydata/web/provisioning.xhtml [new file with mode: 0644]
src/allmydata/web/welcome.xhtml
src/allmydata/webish.py

diff --git a/src/allmydata/provisioning.py b/src/allmydata/provisioning.py
new file mode 100644 (file)
index 0000000..fdfb582
--- /dev/null
@@ -0,0 +1,451 @@
+
+from nevow import inevow, loaders, rend, tags as T
+from twisted.python import util
+
+def getxmlfile(name):
+    return loaders.xmlfile(util.sibpath(__file__, "web/%s" % name))
+
+class ProvisioningTool(rend.Page):
+    addSlash = True
+    docFactory = getxmlfile("provisioning.xhtml")
+
+    def render_forms(self, ctx, data):
+        req = inevow.IRequest(ctx)
+
+        def getarg(name, astype=int):
+            if req.method != "POST":
+                return None
+            if name in req.fields:
+                return astype(req.fields[name].value)
+            return None
+        return self.do_forms(getarg)
+
+
+    def do_forms(self, getarg):
+        filled = getarg("filled", bool)
+
+        def get_and_set(name, options, default=None, astype=int):
+            current_value = getarg(name, astype)
+            i_select = T.select(name=name)
+            for (count, description) in options:
+                count = astype(count)
+                selected = False
+                if ((current_value is not None and count == current_value) or
+                    (current_value is None and count == default)):
+                    o = T.option(value=str(count), selected="true")[description]
+                else:
+                    o = T.option(value=str(count))[description]
+                i_select = i_select[o]
+            if current_value is None:
+                current_value = default
+            return current_value, i_select
+
+        sections = {}
+        def add_input(section, text, entry):
+            if section not in sections:
+                sections[section] = []
+            sections[section].append(T.div[text, ": ", entry])
+
+        def add_output(section, entry):
+            if section not in sections:
+                sections[section] = []
+            sections[section].append(T.div[entry])
+
+        def build_section(section):
+            return T.fieldset[T.legend[section], sections[section]]
+
+        def number(value, suffix=""):
+            scaling = 1
+            if value < 1:
+                fmt = "%1.2g%s"
+            elif value < 100:
+                fmt = "%.1f%s"
+            elif value < 1000:
+                fmt = "%d%s"
+            elif value < 1e6:
+                fmt = "%.2fk%s"; scaling = 1e3
+            elif value < 1e9:
+                fmt = "%.2fM%s"; scaling = 1e6
+            elif value < 1e12:
+                fmt = "%.2fG%s"; scaling = 1e9
+            elif value < 1e15:
+                fmt = "%.2fT%s"; scaling = 1e12
+            elif value < 1e18:
+                fmt = "%.2fP%s"; scaling = 1e15
+            else:
+                fmt = "huge! %g%s"
+            return fmt % (value / scaling, suffix)
+
+        user_counts = [(5, "5 users"),
+                       (50, "50 users"),
+                       (200, "200 users"),
+                       (1000, "1k users"),
+                       (10000, "10k users"),
+                       (50000, "50k users"),
+                       (100000, "100k users"),
+                       (500000, "500k users"),
+                       (1000000, "1M users"),
+                       ]
+        num_users, i_num_users = get_and_set("num_users", user_counts, 50000)
+        add_input("Users",
+                  "How many users are on this network?", i_num_users)
+
+        files_per_user_counts = [(100, "100 files"),
+                                 (1000, "1k files"),
+                                 (10000, "10k files"),
+                                 (100000, "100k files"),
+                                 (1e6, "1M files"),
+                                 ]
+        files_per_user, i_files_per_user = get_and_set("files_per_user",
+                                                       files_per_user_counts,
+                                                       1000)
+        add_input("Users",
+                  "How many files in each user's vdrive? (avg)",
+                  i_files_per_user)
+
+        space_per_user_sizes = [(1e6, "1MB"),
+                                (10e6, "10MB"),
+                                (100e6, "100MB"),
+                                (1e9, "1GB"),
+                                (2e9, "2GB"),
+                                (5e9, "5GB"),
+                                (10e9, "10GB"),
+                                (100e9, "100GB"),
+                                (1e12, "1TB"),
+                                ]
+        space_per_user, i_space_per_user = get_and_set("space_per_user",
+                                                       space_per_user_sizes,
+                                                       1e9)
+        add_input("Users",
+                  "How much data is in each user's vdrive? (avg)",
+                  i_space_per_user)
+
+        sharing_ratios = [(1.0, "1.0x"),
+                          (1.1, "1.1x"),
+                          (2.0, "2.0x"),
+                          ]
+        sharing_ratio, i_sharing_ratio = get_and_set("sharing_ratio",
+                                                     sharing_ratios, 1.0,
+                                                     float)
+        add_input("Users",
+                  "What is the sharing ratio? (1.0x is no-sharing and"
+                  " no convergence)", i_sharing_ratio)
+
+        # Encoding parameters
+        encoding_choices = [("3-of-10", "3-of-10"),
+                            ("25-of-100", "25-of-100"),
+                            ]
+        encoding_parameters, i_encoding_parameters = \
+                             get_and_set("encoding_parameters",
+                                         encoding_choices, "3-of-10", str)
+        encoding_pieces = encoding_parameters.split("-")
+        k = int(encoding_pieces[0])
+        assert encoding_pieces[1] == "of"
+        n = int(encoding_pieces[2])
+        add_input("Servers",
+                  "What are the default encoding parameters?",
+                  i_encoding_parameters)
+
+        # Server info
+        num_server_choices = [ (5, "5 servers"),
+                               (10, "10 servers"),
+                               (30, "30 servers"),
+                               (100, "100 servers"),
+                               (1000, "1k servers"),
+                               (10e3, "10k servers"),
+                               (100e3, "100k servers"),
+                               (1e6, "1M servers"),
+                               ]
+        num_servers, i_num_servers = \
+                     get_and_set("num_servers", num_server_choices, 30, int)
+        add_input("Servers",
+                  "How many servers are there?", i_num_servers)
+
+        # deletion/gc/ownership mode
+        ownership_choices = [ ("A", "no deletion, no gc, no owners"),
+                              ("B", "deletion, no gc, no owners"),
+                              ("C", "deletion, share timers, no owners"),
+                              ("D", "deletion, no gc, yes owners"),
+                              ("E", "deletion, owner timers"),
+                              ]
+        ownership_mode, i_ownership_mode = \
+                        get_and_set("ownership_mode", ownership_choices,
+                                    "A", str)
+        add_input("Servers",
+                  "What is the ownership mode?", i_ownership_mode)
+
+        # client access behavior
+        access_rates = [ (1, "one file per day"),
+                         (10, "10 files per day"),
+                         (100, "100 files per day"),
+                         (1000, "1k files per day"),
+                         (10e3, "10k files per day"),
+                         (100e3, "100k files per day"),
+                         ]
+        download_files_per_day, i_download_rate = \
+                                get_and_set("download_rate", access_rates,
+                                            100, int)
+        add_input("Users",
+                  "How many files are downloaded per day?", i_download_rate)
+        download_rate = 1.0 * download_files_per_day / (24*60*60)
+
+        upload_files_per_day, i_upload_rate = \
+                              get_and_set("upload_rate", access_rates,
+                                          10, int)
+        add_input("Users",
+                  "How many files are uploaded per day?", i_upload_rate)
+        upload_rate = 1.0 * upload_files_per_day / (24*60*60)
+
+        delete_files_per_day, i_delete_rate = \
+                              get_and_set("delete_rate", access_rates,
+                                          10, int)
+        add_input("Users",
+                  "How many files are deleted per day?", i_delete_rate)
+        delete_rate = 1.0 * delete_files_per_day / (24*60*60)
+
+
+        # the value is in days
+        lease_timers = [ (1, "one refresh per day"),
+                         (7, "one refresh per week"),
+                         ]
+        lease_timer, i_lease = \
+                     get_and_set("lease_timer", lease_timers,
+                                 7, int)
+        add_input("Users",
+                  "How frequently do clients refresh files or accounts? "
+                  "(if necessary)",
+                  i_lease)
+        seconds_per_lease = 24*60*60*lease_timer
+
+        if filled:
+            add_output("Users", T.div["Total users: %s" % number(num_users)])
+            add_output("Users",
+                       T.div["Files per user: %s" % number(files_per_user)])
+            file_size = 1.0 * space_per_user / files_per_user
+            add_output("Users",
+                       T.div["Average file size: ", number(file_size)])
+            total_files = num_users * files_per_user / sharing_ratio
+
+            add_output("Grid",
+                       T.div["Total number of files in grid: ",
+                             number(total_files)])
+            total_space = num_users * space_per_user / sharing_ratio
+            add_output("Grid",
+                       T.div["Total volume of plaintext in grid: ",
+                             number(total_space, "B")])
+
+            total_shares = n * total_files
+            add_output("Grid",
+                       T.div["Total shares in grid: ", number(total_shares)])
+            expansion = float(n) / float(k)
+
+            total_usage = expansion * total_space
+            add_output("Grid",
+                       T.div["Share data in grid: ", number(total_usage, "B")])
+
+            if n > num_servers:
+                # silly configuration, causes Tahoe2 to wrap and put multiple
+                # shares on some servers.
+                add_output("Servers",
+                           T.div["non-ideal: more shares than servers"
+                                 " (n=%d, servers=%d)" % (n, num_servers)])
+                # every file has at least one share on every server
+                buckets_per_server = total_files
+                shares_per_server = total_files * ((1.0 * n) / num_servers)
+            else:
+                # if nobody is full, then no lease requests will be turned
+                # down for lack of space, and no two shares for the same file
+                # will share a server. Therefore the chance that any given
+                # file has a share on any given server is n/num_servers.
+                buckets_per_server = total_files * ((1.0 * n) / num_servers)
+                # since each such represented file only puts one share on a
+                # server, the total number of shares per server is the same.
+                shares_per_server = buckets_per_server
+            add_output("Servers",
+                       T.div["Buckets per server: ",
+                             number(buckets_per_server)])
+            add_output("Servers",
+                       T.div["Shares per server: ",
+                             number(shares_per_server)])
+
+            # how much space is used on the storage servers for the shares?
+            #  the share data itself
+            share_data_per_server = total_usage / num_servers
+            add_output("Servers",
+                       T.div["Share data per server: ",
+                             number(share_data_per_server, "B")])
+            # this is determined empirically. H=hashsize=32, for a one-segment
+            # file and 3-of-10 encoding
+            share_validation_per_server = 266 * shares_per_server
+            # this could be 423*buckets_per_server, if we moved the URI
+            # extension into a separate file, but that would actually consume
+            # *more* space (minimum filesize is 4KiB), unless we moved all
+            # shares for a given bucket into a single file.
+            share_uri_extension_per_server = 423 * shares_per_server
+
+            # ownership mode adds per-bucket data
+            H = 32 # depends upon the desired security of delete/refresh caps
+            # bucket_lease_size is the amount of data needed to keep track of
+            # the delete/refresh caps for each bucket.
+            bucket_lease_size = 0
+            client_bucket_refresh_rate = 0
+            owner_table_size = 0
+            if ownership_mode in ("B", "C", "D", "E"):
+                bucket_lease_size = sharing_ratio * 1.0 * H
+            if ownership_mode in ("B", "C"):
+                # refreshes per second per client
+                client_bucket_refresh_rate = (1.0 * n * files_per_user /
+                                              seconds_per_lease)
+                add_output("Users",
+                           T.div["Client share refresh rate (outbound): ",
+                                 number(client_bucket_refresh_rate, "Hz")])
+                server_bucket_refresh_rate = (client_bucket_refresh_rate *
+                                              num_users / num_servers)
+                add_output("Servers",
+                           T.div["Server share refresh rate (inbound): ",
+                                 number(server_bucket_refresh_rate, "Hz")])
+            if ownership_mode in ("D", "E"):
+                # each server must maintain a bidirectional mapping from
+                # buckets to owners. One way to implement this would be to
+                # put a list of four-byte owner numbers into each bucket, and
+                # a list of four-byte share numbers into each owner (although
+                # of course we'd really just throw it into a database and let
+                # the experts take care of the details).
+                owner_table_size = 2*(buckets_per_server * sharing_ratio * 4)
+
+            if ownership_mode in ("E",):
+                # in this mode, clients must refresh one timer per server
+                client_account_refresh_rate = (1.0 * num_servers /
+                                               seconds_per_lease)
+                add_output("Users",
+                           T.div["Client account refresh rate (outbound): ",
+                                 number(client_account_refresh_rate, "Hz")])
+                server_account_refresh_rate = (client_account_refresh_rate *
+                                              num_users / num_servers)
+                add_output("Servers",
+                           T.div["Server account refresh rate (inbound): ",
+                                 number(server_account_refresh_rate, "Hz")])
+
+            # TODO: buckets vs shares here is a bit wonky, but in
+            # non-wrapping grids it shouldn't matter
+            share_lease_per_server = bucket_lease_size * buckets_per_server
+            share_ownertable_per_server = owner_table_size
+
+            share_space_per_server = (share_data_per_server +
+                                      share_validation_per_server +
+                                      share_uri_extension_per_server +
+                                      share_lease_per_server +
+                                      share_ownertable_per_server)
+            add_output("Servers",
+                       T.div["Share space per server: ",
+                             number(share_space_per_server, "B"),
+                             " (data ",
+                             number(share_data_per_server, "B"),
+                             ", validation ",
+                             number(share_validation_per_server, "B"),
+                             ", UEB ",
+                             number(share_uri_extension_per_server, "B"),
+                             ", lease ",
+                             number(share_lease_per_server, "B"),
+                             ", ownertable ",
+                             number(share_ownertable_per_server, "B"),
+                             ")",
+                             ])
+
+            # rates
+            client_download_share_rate = download_rate * k
+            client_download_byte_rate = download_rate * file_size
+            add_output("Users",
+                       T.div["download rate: shares = ",
+                             number(client_download_share_rate, "Hz"),
+                             " , bytes = ",
+                             number(client_download_byte_rate, "Bps"),
+                             ])
+
+            client_upload_share_rate = upload_rate * n
+            # TODO: doesn't include overhead
+            client_upload_byte_rate = upload_rate * file_size * expansion
+            add_output("Users",
+                       T.div["upload rate: shares = ",
+                             number(client_upload_share_rate, "Hz"),
+                             " , bytes = ",
+                             number(client_upload_byte_rate, "Bps"),
+                             ])
+            client_delete_share_rate = delete_rate * n
+
+            server_inbound_share_rate = (client_upload_share_rate *
+                                         num_users / num_servers)
+            server_inbound_byte_rate = (client_upload_byte_rate *
+                                        num_users / num_servers)
+            add_output("Servers",
+                       T.div["upload rate (inbound): shares = ",
+                             number(server_inbound_share_rate, "Hz"),
+                             " , bytes = ",
+                              number(server_inbound_byte_rate, "Bps"),
+                             ])
+
+            server_share_modify_rate = ((client_upload_share_rate +
+                                         client_delete_share_rate) *
+                                         num_users / num_servers)
+            add_output("Servers",
+                       T.div["share modify rate: shares = ",
+                             number(server_share_modify_rate, "Hz"),
+                             ])
+
+            server_outbound_share_rate = (client_download_share_rate *
+                                          num_users / num_servers)
+            server_outbound_byte_rate = (client_download_byte_rate *
+                                         num_users / num_servers)
+            add_output("Servers",
+                       T.div["download rate (outbound): shares = ",
+                             number(server_outbound_share_rate, "Hz"),
+                             " , bytes = ",
+                              number(server_outbound_byte_rate, "Bps"),
+                             ])
+
+
+            total_share_space = num_servers * share_space_per_server
+            add_output("Grid",
+                       T.div["Share space consumed: ",
+                             number(total_share_space, "B")])
+            add_output("Grid",
+                       T.div[" %% validation: %.2f%%" %
+                             (100.0 * share_validation_per_server /
+                              share_space_per_server)])
+            add_output("Grid",
+                       T.div[" %% uri-extension: %.2f%%" %
+                             (100.0 * share_uri_extension_per_server /
+                              share_space_per_server)])
+            add_output("Grid",
+                       T.div[" %% lease data: %.2f%%" %
+                             (100.0 * share_lease_per_server /
+                              share_space_per_server)])
+            add_output("Grid",
+                       T.div[" %% owner data: %.2f%%" %
+                             (100.0 * share_ownertable_per_server /
+                              share_space_per_server)])
+            add_output("Grid",
+                       T.div[" %% share data: %.2f%%" %
+                             (100.0 * share_data_per_server /
+                              share_space_per_server)])
+
+
+        all_sections = []
+        all_sections.append(build_section("Users"))
+        all_sections.append(build_section("Servers"))
+        if "Grid" in sections:
+            all_sections.append(build_section("Grid"))
+
+        f = T.form(action=".", method="post", enctype="multipart/form-data")
+
+        if filled:
+            action = "Recompute"
+        else:
+            action = "Compute"
+
+        f = f[T.input(type="hidden", name="filled", value="true"),
+              T.input(type="submit", value=action),
+              all_sections,
+              ]
+
+        return f
diff --git a/src/allmydata/test/test_provisioning.py b/src/allmydata/test/test_provisioning.py
new file mode 100644 (file)
index 0000000..e93f057
--- /dev/null
@@ -0,0 +1,52 @@
+
+from twisted.trial import unittest
+from allmydata.provisioning import ProvisioningTool
+#from nevow.context import PageContext, RequestContext
+from nevow import inevow
+from zope.interface import implements
+
+class MyRequest:
+    implements(inevow.IRequest)
+    pass
+
+class Provisioning(unittest.TestCase):
+    def getarg(self, name, astype=int):
+        if name in self.fields:
+            return astype(self.fields[name])
+        return None
+
+    def test_load(self):
+        pt = ProvisioningTool()
+        self.fields = {}
+        #r = MyRequest()
+        #r.fields = self.fields
+        #ctx = RequestContext()
+        #unfilled = pt.renderSynchronously(ctx)
+        lots_of_stan = pt.do_forms(self.getarg)
+
+        self.fields = {'filled': True,
+                       "num_users": 50e3,
+                       "files_per_user": 1000,
+                       "space_per_user": 1e9,
+                       "sharing_ratio": 1.0,
+                       "encoding_parameters": "3-of-10",
+                       "num_servers": 30,
+                       "ownership_mode": "A",
+                       "download_rate": 100,
+                       "upload_rate": 10,
+                       "delete_rate": 10,
+                       "lease_timer": 7,
+                       }
+        #filled = pt.renderSynchronously(ctx)
+        more_stan = pt.do_forms(self.getarg)
+
+        # trigger the wraparound configuration
+        self.fields["num_servers"] = 5
+        #filled = pt.renderSynchronously(ctx)
+        more_stan = pt.do_forms(self.getarg)
+
+        # and other ownership modes
+        self.fields["ownership_mode"] = "B"
+        more_stan = pt.do_forms(self.getarg)
+        self.fields["ownership_mode"] = "E"
+        more_stan = pt.do_forms(self.getarg)
diff --git a/src/allmydata/web/provisioning.xhtml b/src/allmydata/web/provisioning.xhtml
new file mode 100644 (file)
index 0000000..f135d61
--- /dev/null
@@ -0,0 +1,19 @@
+<html xmlns:n="http://nevow.com/ns/nevow/0.1">
+  <head>
+    <title>AllMyData - Tahoe - Provisioning Tool</title>
+    <!-- <link href="http://www.allmydata.com/common/css/styles.css"
+          rel="stylesheet" type="text/css"/> -->
+    <link href="/webform_css" rel="stylesheet" type="text/css"/>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+  </head>
+  <body>
+
+<h1>Tahoe Provisioning Tool</h1>
+
+<p>This page will help you determine how much disk space and network
+bandwidth will be required by various sizes and types of Tahoe networks.</p>
+
+<div n:render="forms" />
+
+  </body>
+</html>
index 41661d869b9ddbeb974d885a6fbf0c12569c0352..969d40b0bfcc784e2d5730ecea7cc6aa8ed57557 100644 (file)
@@ -14,7 +14,8 @@
 <div n:render="private_vdrive" />
 
 <div>Please visit the <a href="http://allmydata.org">Tahoe home page</a> for
-code updates and bug reporting.</div>
+code updates and bug reporting. The <a href="provisioning">provisioning
+tool</a> may also be useful.</div>
 
 <h2>Grid Status</h2>
 
index d4adacbd5f746a3b764fa22b2d22ed4dbfefcc28..2801270db14a29dd538335df2bd500b01fb50dbb 100644 (file)
@@ -11,6 +11,7 @@ from allmydata.util import fileutil
 import simplejson
 from allmydata.interfaces import IDownloadTarget, IDirectoryNode, IFileNode
 from allmydata import upload, download
+from allmydata import provisioning
 from zope.interface import implements, Interface
 import urllib
 from formless import webform
@@ -1066,6 +1067,8 @@ class Root(rend.Page):
     child_webform_css = webform.defaultCSS
     child_tahoe_css = nevow_File(util.sibpath(__file__, "web/tahoe.css"))
 
+    child_provisioning = provisioning.ProvisioningTool()
+
     def data_version(self, ctx, data):
         v = IClient(ctx).get_versions()
         return "tahoe: %s, zfec: %s, foolscap: %s, twisted: %s" % \