September 2018 - tor-commits - lists.torproject.org

[sbws/master] Use conf.getint and getpath
by pastly＠torproject.org 05 Sep '18

05 Sep '18

commit 5e363d8b9bba1225029a2317c0d58673429585e8 Author: Matt Traudt <sirmatt(a)ksu.edu> Date: Wed Sep 5 10:56:31 2018 -0400 Use conf.getint and getpath getpath is necessary so that ~ is expanded GH: closes #241 trac: implements #26937 --- sbws/util/fs.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/sbws/util/fs.py b/sbws/util/fs.py index 9621b6f..c7a5de7 100644 --- a/sbws/util/fs.py +++ b/sbws/util/fs.py @@ -20,7 +20,7 @@ def sbws_required_disk_space(conf): # ~1000 is the length of a line when the result is successfull # ~4550 is the number of lines of the biggest result file size_result_file = 4550 * 1000 - num_result_files = int(conf['general']['data_period']) + num_result_files = conf.getint('general', 'data_period') # not counting compressed files space_v3bw_files = size_v3bw_file * num_v3bw_files space_result_files = size_result_file * num_result_files @@ -48,7 +48,7 @@ def is_low_space(conf): what is needed for sbws and False otherwise needs. """ disk_required_mb = sbws_required_disk_space(conf) - disk_avail_mb = df(conf['paths']['sbws_home']) + disk_avail_mb = df(conf.getpath('paths', 'sbws_home')) if disk_avail_mb < disk_required_mb: log.warn("The space left on the device (%s MiB) is less than " "the minimum recommended to run sbws (%s MiB)."

1 0

[sbws/master] Reword changelog entry about system requirements
by pastly＠torproject.org 05 Sep '18

05 Sep '18

commit 56553055692792daf516b9da282cc5183ccdb712 Author: Matt Traudt <sirmatt(a)ksu.edu> Date: Wed Sep 5 11:11:21 2018 -0400 Reword changelog entry about system requirements trac: finishes #26937 --- CHANGELOG.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 37b79f7..27795be 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -9,8 +9,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0. ### Added -- Add system physical requirements, but do not warn (which requires to make - syscalls). (#26937) +- Add system physical requirements section to INSTALL (#26937) ### Fixed

1 0

[sbws/master] Add system physical requirements
by pastly＠torproject.org 05 Sep '18

05 Sep '18

commit 5601e2d891d4a4e7302e127eb3c2e0045c0b066c Author: juga0 <juga(a)riseup.net> Date: Mon Sep 3 12:43:02 2018 +0000 Add system physical requirements --- INSTALL.rst | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/INSTALL.rst b/INSTALL.rst index 3821aaf..9d5c8f5 100644 --- a/INSTALL.rst +++ b/INSTALL.rst @@ -98,6 +98,31 @@ To build the documentation diagrams:: The generated diagrams will be in ``docs/build/_images/``. +System physical requirements +----------------------------- + +- Bandwidth: at least 20MB/s (160 Mbit/s). The more the better. +- Free RAM: at least 1.5GB +- Free disk: at least 3GB + +``sbws`` and its dependencies need around 20MB of disk space. +After 90 days ``sbws`` data files use around 3GB. +If ``sbws`` is configured to log to files (by default will log to the +system log), it will need a maximum of 500MB. + +It is recommended to set up an automatic disk space monitoring on ``sbws`` data +and log partitions. + +Details about ``sbws`` data: + +``sbws`` produces around 100MB of data a day. +By default raw results' files are compressed after 10 days and deleted after 90. +The bandwidth files are compressed after 7 days and deleted after 1. +After 90 days, the disk space used by the data will be aproximately 3GB. +It will not increase further. +If ``sbws`` is configured to log to files, logs will be rotated after they +are 10MB and it will keep 50 rotated log files. + .. _virtualenv: https://virtualenv.pypa.io/en/stable/installation/ .. _Stem: https://stem.torproject.org/ .. _socks: http://docs.python-requests.org/en/master/user/advanced/#socks

1 0

[sbws/master] Merge branch 'ticket26937_02' from juga, thanks
by pastly＠torproject.org 05 Sep '18

05 Sep '18

commit 75be1aa2060880bd534593d0bc6cd58d5f4db0de Merge: 5e363d8 a9e4fbd Author: Matt Traudt <sirmatt(a)ksu.edu> Date: Wed Sep 5 11:16:51 2018 -0400 Merge branch 'ticket26937_02' from juga, thanks CHANGELOG.md | 6 +++++- INSTALL.rst | 25 +++++++++++++++++++++++++ 2 files changed, 30 insertions(+), 1 deletion(-)

1 0

[sbws/master] Use same definition as in metrics.tpo
by pastly＠torproject.org 05 Sep '18

05 Sep '18

commit 6c2a20d29c14cef5b082f0e75c166a281f7d59d2 Author: juga0 <juga(a)riseup.net> Date: Tue Aug 28 14:31:06 2018 +0000 Use same definition as in metrics.tpo Let's try to reuse terms and reuse definitions, terms are already confusing enough. --- docs/source/glossary.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/source/glossary.rst b/docs/source/glossary.rst index 251b72f..4c0a45b 100644 --- a/docs/source/glossary.rst +++ b/docs/source/glossary.rst @@ -4,9 +4,9 @@ Glossary .. glossary:: directory authority - One of the trusted entities in the Tor network. Calculates a consensus - with the other directory authorities about what relays are running and - much much more. + a special-purpose relay that maintains a list of currently-running + relays and periodically publishes a consensus together with the other + directory authorities. [#]_ bandwidth authority A :term:`directory authority` that measures and votes about Tor relay

1 0

[sbws/master] Add term used in the specification
by pastly＠torproject.org 05 Sep '18

05 Sep '18

commit 3e997cfa7b3b33ae6bf25e4266cb71fda7222abc Author: juga0 <juga(a)riseup.net> Date: Tue Aug 28 14:45:13 2018 +0000 Add term used in the specification and that can be also used in DEPLOY.rst --- docs/source/glossary.rst | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/source/glossary.rst b/docs/source/glossary.rst index 2658783..eba3143 100644 --- a/docs/source/glossary.rst +++ b/docs/source/glossary.rst @@ -18,6 +18,11 @@ Glossary It is also called :term:`generator` when it is the same tool that is used to generate :term:`bandwidth list file` s. + generator + Term to refer to the tool that generates the + :term:`bandwidth list file` s. Often used as a synomym for + :term:`scanner`. + sbws scanner The sbws command that a :term:`bandwidth authority` runs continuously to gather information about how fast Tor relays are. The results from

1 0

[sbws/master] Add term used in the specification
by pastly＠torproject.org 05 Sep '18

05 Sep '18

commit 4338313b8ca277c6ad34ebfeaf5abc0195a576cc Author: juga0 <juga(a)riseup.net> Date: Tue Aug 28 14:44:15 2018 +0000 Add term used in the specification and that can be also used in DEPLOY.rst --- docs/source/glossary.rst | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/source/glossary.rst b/docs/source/glossary.rst index 6f0b98b..2658783 100644 --- a/docs/source/glossary.rst +++ b/docs/source/glossary.rst @@ -13,6 +13,11 @@ Glossary :term:`generator` or obtain :term:`bandwidth list file` s from a :term:`generator`. + scanner + Term to refer to the process that measures the relays' bandwidth. + It is also called :term:`generator` when it is the same tool that is + used to generate :term:`bandwidth list file` s. + sbws scanner The sbws command that a :term:`bandwidth authority` runs continuously to gather information about how fast Tor relays are. The results from

1 0

[sbws/master] Add term used in the specification
by pastly＠torproject.org 05 Sep '18

05 Sep '18

commit 85e7f33d03d32d7110fe786583951d0b93c6e766 Author: juga0 <juga(a)riseup.net> Date: Tue Aug 28 14:45:28 2018 +0000 Add term used in the specification and that can be also used in DEPLOY.rst --- docs/source/glossary.rst | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/source/glossary.rst b/docs/source/glossary.rst index eba3143..ab4bf29 100644 --- a/docs/source/glossary.rst +++ b/docs/source/glossary.rst @@ -23,6 +23,12 @@ Glossary :term:`bandwidth list file` s. Often used as a synomym for :term:`scanner`. + bandwidth list file + The file generated by :term:`generator` s that is read by the + :term:`directory authority` s and included in their votes. + See `bandwidth-file-spec.txt <https://gitweb.torproject.org/torspec.git/tree/bandwidth-file-spec.txt>`_ + to know about the file specification. + sbws scanner The sbws command that a :term:`bandwidth authority` runs continuously to gather information about how fast Tor relays are. The results from

1 0

[sbws/master] Reuse terms used in the specification
by pastly＠torproject.org 05 Sep '18

05 Sep '18

commit db731a22b1c30a6a0678e5ba4a4fb6a138eee078 Author: juga0 <juga(a)riseup.net> Date: Tue Aug 28 14:42:49 2018 +0000 Reuse terms used in the specification --- docs/source/glossary.rst | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/docs/source/glossary.rst b/docs/source/glossary.rst index 4c0a45b..6f0b98b 100644 --- a/docs/source/glossary.rst +++ b/docs/source/glossary.rst @@ -9,10 +9,9 @@ Glossary directory authorities. [#]_ bandwidth authority - A :term:`directory authority` that measures and votes about Tor relay - bandwidths. In the context of sbws, it performs measurements with - :term:`sbws scanner` and creates :term:`v3bw files <v3bw file>` - periodically with :term:`sbws generate` + A :term:`directory authority` that runs a :term:`scanner` and a + :term:`generator` or obtain :term:`bandwidth list file` s from a + :term:`generator`. sbws scanner The sbws command that a :term:`bandwidth authority` runs continuously

1 0

[sbws/master] Simplify definition with specification terms
by pastly＠torproject.org 05 Sep '18

05 Sep '18

commit 093283236c73cbf32c308a33c01ef7572998883c Author: juga0 <juga(a)riseup.net> Date: Tue Aug 28 14:46:53 2018 +0000 Simplify definition with specification terms --- docs/source/glossary.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/source/glossary.rst b/docs/source/glossary.rst index 394f5f5..2b5d56d 100644 --- a/docs/source/glossary.rst +++ b/docs/source/glossary.rst @@ -36,8 +36,8 @@ Glossary The ``sbws`` command used to run ``sbws`` as a :term:`generator`. v3bw file - The file generated by :term:`sbws generate` that a :term:`bandwidth - authority` reads to vote about how fast relays are. + The term used by ``sbws`` to refer to :term:`bandwidth list file` + v1.1.0. .. literalinclude:: v3bw.txt :caption: A v3bw file

1 0