nils/gluon
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

gluon-hoodselector: docs: fix spelling/grammar

Browse Source
This commit is contained in:
Andreas Ziegler 2018-07-16 23:51:32 +02:00 committed by Jan-Tarek Butt
parent f0d0edde57
commit b84cfca245
1 changed files with 34 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

70
docs/package/gluon-hoodselector.rst
View File

@ -9,16 +9,16 @@ decentralised mesh-networks.
Background informations Background informations
----------------------- -----------------------
The main problem of the Nordwest Freifunk community was the fast increasing of The main problem of the Nordwest Freifunk community was the quickly rising
amount of nodes in the network. This affected indirectly the stability of the number of nodes in the network. This indirectly affected the stability of the
network because also the noise inside the network e.g. management traffic from network because the noise inside the network, e.g. management traffic from
the batman-adv protocoll was increasing. Inside the community there were some the batman-adv protocol, was rising, too. Inside the community there were some
ideas like to build seperated firmwares for each region. Kind of idea ideas like building separate firmwares for each region. This kind of solution
will have problems in resplitting regions again or even problems of scattered would have problems with splitting regions again and problems with scattered
nodes, which belongs to an another region. Therefore we decide to develop an nodes, which belong to an other region. Therefore we decided to develop a
dynamic and decentralized management of kind of region called hoods. dynamic and decentralised management of regions called hoods.
The Hoodselectors task is to choose belonged hoods in an inteligent way and The Hoodselector's task is to choose the "right" hoods in an intelligent way
ensure to hold the network together and accessible. and to hold the network together and accessible.
A hood is defined by geostationary fixed shapes by using longitude & latitude A hood is defined by geostationary fixed shapes by using longitude & latitude
in combination with the domain configuration system. Below you can see a visual in combination with the domain configuration system. Below you can see a visual
@ -29,56 +29,54 @@ example of regional hoods:
Hoodselector logic Hoodselector logic
------------------ ------------------
In following there is an abstract state diagramm which should give an overview The following is an abstract state diagramm which gives an overview
of the process: of the process:
.. image:: gluon-hoodselector.svg .. image:: gluon-hoodselector.svg
The sequence of this diagramm is given the priorty of running modes. The sequence of this diagramm is given the priority of running modes.
Each mode will be explained seperatedly below. Each mode will be explained seperatedly below.
VPN-MODE VPN-mode
^^^^^^^^ ^^^^^^^^
This mode will be only entered if a router can see batman-adv Gateways over VPN. This mode will be entered only if a router can see batman-adv gateways over VPN.
Means only routers which have a vpn connection to supernodes will enter and set Routers which have a VPN connection to a supernode will set their hood based on
the hood base on their position if they have one. If a node has a position their position if they have one. If a node has a position which is outside of
which is outside of all definded shapes, it will set the default hood. If no all defined shapes, it will set the default hood. If no position is set,
position exists, the node will continue with the next mode. This mode will be the node will continue with the next mode. The VPN mode will be entered first.
entered at first. The reason is because the Hoodselector takes This way, the Hoodselector takes care of holding nodes around supernodes
care of holding nodes arround supernodes e.g. to ensure that nodes can always to ensure that nodes can at least reach the autoupdate server.
reach at least the autoupdate server.
Hood Hood
---- ----
A hood bases on the related domain configuration with some additional A hood bases on the related domain configuration with some additional
configurations. There are two types of hoods: one without any defined shapes configuration. There are two types of hoods: one without any defined shapes
which has to be unique and other which contains shapes. which has to be unique and others which contain shapes.
* **default hood** * **default hood**
defaulthood: The default hood doesn’t have shapes and is the inverted form of defaulthood: The default hood doesn’t have shapes and is the inverted form of
all other hoods with geo coordinates. It will be entered if no node match to a all other hoods with geo coordinates. It will be entered if no node matches to a
real hood. In the Nordwest Freifunk situation we defined the old network as real hood. A suggested approach is to define the "old" network as default hood
default hood and continuously migrated parts from there to shape defined hoods and gradually migrate parts from there to shape defined hoods ("real hood").
named "real hood"
* **real hood** * **real hood**
A real hood contains shapes, which are described by three dimensional array and A real hood contains shapes, which are described by three dimensional arrays and
represents the geographical size of the real hood. There are 2 possible represents the geographical size of the real hood. There are two possible
definitions of those shapes. The first one are rectangulars definded which definitions of these shapes. The first one is using rectangulars so that only
means just two points per box are needed to reconstruct it. two coordinates per box are needed to reconstruct it (see below for an example).
(see below for an example). The second one are normal polygons which can have The second one is using polygons which can have multible edges.
multible edges. Each real hood can have multible defined shapes. Each real hood can have multiple defined shapes.
.. image:: rectangle-example.svg .. image:: rectangle-example.svg
site.conf site.conf
--------- ---------
The designer of the shapes should always ensure that no overleaping poligons The designer of the shapes should always ensure that no overlapping polygons
will be created! will be created!
Here is an example of a rectangular definition of a shape: Here is an example of a rectangular definition of a shape:
Example:: Example::
@ -98,7 +96,7 @@ Example::
}, },
}, },
Here in an example of a Trigon polygon defined shape: Here is an example of a trigon polygon defined shape:
Example:: Example::
hoodselector = { hoodselector = {
@ -120,4 +118,4 @@ Example::
}, },
}, },
This package is not compatible with the :doc:`gluon-config-mode-domain-select`. This package is incompatible with the :doc:`gluon-config-mode-domain-select`.