commits July 2017

commits@lists.open-mesh.org

1 participants
1317 discussions

[doc] backup-redmine/2017-07-13, master: doc: open-mesh/WikiStart (30c5a03b)
by postmaster＠open-mesh.org 14 Jul '17

14 Jul '17

Repository : ssh://git@open-mesh.org/doc On branches: backup-redmine/2017-07-13,master >--------------------------------------------------------------- commit 30c5a03bf7dc8cf26a939c1ac6de6408ecdab5a5 Author: Simon Wunderlich <sw(a)simonwunderlich.de> Date: Sun Nov 9 17:47:02 2008 +0000 doc: open-mesh/WikiStart >--------------------------------------------------------------- 30c5a03bf7dc8cf26a939c1ac6de6408ecdab5a5 open-mesh/WikiStart.textile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/open-mesh/WikiStart.textile b/open-mesh/WikiStart.textile index 27f8e714..befc2ae2 100644 --- a/open-mesh/WikiStart.textile +++ b/open-mesh/WikiStart.textile @@ -9,6 +9,6 @@ * [wiki:UserDocs UserDocs] * [wiki:FAQ FAQ] * [wiki:Experiences Experiences] - * [Wiki:ML Mailing List] + * [wiki:MailingList Mailing List] === Other Projects on open-mesh.org === * [wiki:FFTrace FFTrace] \ No newline at end of file

1 0

[doc] backup-redmine/2017-07-13, master: doc: batmand/RoutingVodoo (76fbc080)
by postmaster＠open-mesh.org 14 Jul '17

14 Jul '17

Repository : ssh://git@open-mesh.org/doc On branches: backup-redmine/2017-07-13,master >--------------------------------------------------------------- commit 76fbc080cc2102e2cc87f0d1379ed330928e8d9f Author: Marek Lindner <mareklindner(a)neomailbox.ch> Date: Sun Nov 9 17:48:15 2008 +0000 doc: batmand/RoutingVodoo >--------------------------------------------------------------- 76fbc080cc2102e2cc87f0d1379ed330928e8d9f batmand/RoutingVodoo.textile | 79 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 79 insertions(+) diff --git a/batmand/RoutingVodoo.textile b/batmand/RoutingVodoo.textile new file mode 100644 index 00000000..19983565 --- /dev/null +++ b/batmand/RoutingVodoo.textile @@ -0,0 +1,79 @@ +With version 0.3 batman became "policy routing" support and thus can use special routing functions provided by the Linux kernel. + +This document explains its purpose and tries to point out why batman is doing it. Please keep in mind: Normally, you wont have to to anything about it ! Batman will take care of all the routing work but it might prove helpful to understand what batman does and why. ;-) + + +'''Routing tables''' + +Linux provides much more routing tables than just the one you can see with the "route" command. Batman makes use of the feature to spread its routing entries over 4 routing tables. To find out which routing tables are used issue "batmand -i" and watch out for the "rt_table" information: + +batmand -i | grep rt_table + +rt_table_networks=65 + +rt_table_hosts=66 + +rt_table_unreach=67 + +rt_table_tunnel=68 + +In the "networks" table you'll find routing entries for announced networks (HNA). + +The "hosts" table contains the entries to all reachable batman nodes. + +The "unreachable" table has a special funtion which will be explained later in this document (purpose section). + +The "tunnel" table contains the default route if the batman client uses the routing_class option and a gateway is available. + +The "route" command provides access to routing table 254. To see or manipulate the routing entries in the other tables you need the "ip" command. It should be shipped with your distribution. To see the content of the hosts table use: + +ip route ls table 66 + + +'''Routing rules''' + +Additionally to more routing tables, Linux offers to set routing rules which opens the possibility to control the packet flow. A rule can be based on certain criteria as source IP / destination IP / incoming interface / etc and will always target a routing table. When a new packet comes in, the kernel will follow the rules from the smallest available rule number until a rule is matched. Then the kernel jumps to the routing table which is pointed to by the rule and tries to find a routing entry there. If nothing is found the routing table will be left and the kernel proceeds with the next rule. Issue "batmand -i" to get the rule numbers used by batman: + +batmand -i | grep rt_prio + +rt_prio_default=6600 + +rt_prio_unreach=6700 + +rt_prio_tunnel=6800 + +To see the rules set by batman use the ip command: + +ip rule + +[..]? + +6600: from all to 105.0.0.0/8 lookup 66 + +6699: from all lookup 65 + +6700: from all to 105.0.0.0/8 lookup 67 + +[..]? + +On a minimal setup batman will set the rules shown above. + +The first rule says: If the packet has a destination IP in the range of 105.0.0.0/8 go to routing table 66 and look if you can find something there. + +The next rule means: All packets should go through our "network" (HNA) table. + +The last rule is similar to the first rule but the kernel will jump to our "unreachable" table. + + +'''What is the purpose of all this ?''' + + 1. Batman can clearly seperate hosts from announced networks. With a simple lookup you can see whether a node is announced or runs batman. + 2. It allows you and batman to easily delete all batman related table entries because the batman tables are well known and distinct. + 3. All batman activity is hidden in the background and does not mess with your manual configuration. You can still manipulate the default table without disturbing batman. + 4. It makes batman more interoperable with other routing protocols. This is very useful for testing scenarios where you want to test two (or more) routing protocols at the same time. + 5. With the unreachable rule we can make batman "faster". Whenever you want to access a node within your network which does not exist, your packets will end in the default route. You never will get an answer until your programm reaches a timeout. The unreachable rule changes this: If the packets destination is in your mesh network and no route exists, the kernel will immediately drop the packet and inform the programm which sent it. + 6. The policy routing "protects" your default route from other nodes. Batman will setup rules around the "tunnel" routing table which make sure that only non-batman interfaces and local traffic can end in the tunnel default route. You can choose your gateway as you like while this decission does not affect others in the network. + 7. The policy routing can be used for many more things, e.g. protecting against announced networks which have the same IP range as your internal network. Without policy routing it happens that you can't reach your internal network anymore because someone else announces the same IP range and your router sends the traffic there. However, this can't be done automatically by batman as the network configurations are too different. Firmware maintainers can tightly integrate batman into their distribution and add this feature. + + +If you want to influence batmans routing policy use the --policy-routing-script option to provide a custom executable. If this option is used batman will send it routing decissions to stdin of that executable instead of manipulation the routing table directly. Now, this executable can alter the rules and routing table entries by manipulating the routing by itself. You can see http://downloads.open-mesh.org/batman/useful-scripts-and-tools/policy_routi… to get a routing script sample. You wont need this option / script unless you want to do something fancy. \ No newline at end of file

1 0

[doc] backup-redmine/2017-07-13, master: doc: open-mesh/Filing (9a6a4a5c)
by postmaster＠open-mesh.org 14 Jul '17

14 Jul '17

1 0

[doc] backup-redmine/2017-07-13, master: doc: open-mesh/Filing (9e911cc4)
by postmaster＠open-mesh.org 14 Jul '17

14 Jul '17

1 0

[doc] backup-redmine/2017-07-13, master: doc: open-mesh/WikiStart (a75dee2c)
by postmaster＠open-mesh.org 14 Jul '17

14 Jul '17

Repository : ssh://git@open-mesh.org/doc On branches: backup-redmine/2017-07-13,master >--------------------------------------------------------------- commit a75dee2c983a8b40acf6b0a131cdb35efca467c6 Author: Sven Eckelmann <sven(a)narfation.org> Date: Wed Jul 11 16:20:57 2007 +0000 doc: open-mesh/WikiStart >--------------------------------------------------------------- a75dee2c983a8b40acf6b0a131cdb35efca467c6 open-mesh/WikiStart.textile | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/open-mesh/WikiStart.textile b/open-mesh/WikiStart.textile index 99181ca0..b90ed394 100644 --- a/open-mesh/WikiStart.textile +++ b/open-mesh/WikiStart.textile @@ -8,11 +8,13 @@ svn co https://dev.open-mesh.org/svn/batman/ We are currently working on three different branches. Namely - * our stable batman branch (the one currently operating in Berlin and Leipzig). It can be checked out with: [[br]] svn co https://dev.open-mesh.org/svn/batman/trunk/batman/ + * our stable batman branch (the one currently operating in Berlin, and others). It can be checked out with: [[br]] svn co https://dev.open-mesh.org/svn/batman/branches/batman-0.2.x/ + + * our development batman branch. It can be checked out with: [[br]] svn co https://dev.open-mesh.org/svn/batman/trunk/batman/ * then, we have an experimental branch which implements some new/other algorithms and features referred to as batman-experimental and accessible via: [[br]] svn co https://dev.open-mesh.org/svn/batman/trunk/batman-experimental - * to build batman advanced which also enables layer-two routing you need to checkout the complete trunk: [[br]] svn co https://dev.open-mesh.org/svn/batman/trunk/ [[br]] Then change to the batman-advanced folder and compile the sources + * to build batman advanced which also enables layer-two routing you need to checkout the complete trunk: [[br]] svn co https://dev.open-mesh.org/svn/batman/trunk/batman-advanced [[br]] Then change to the batman-advanced folder and compile the sources Have a lot of fun and remember:

1 0

[doc] backup-redmine/2017-07-13, master: doc: open-mesh/WikiStart (24e6ff30)
by postmaster＠open-mesh.org 14 Jul '17

14 Jul '17

1 0

[doc] backup-redmine/2017-07-13, master: doc: open-mesh/WikiStart (603d3dc9)
by postmaster＠open-mesh.org 14 Jul '17

14 Jul '17

1 0

[doc] master: doc: Force common line endings for restructuredtext (a5fa9b7)
by postmaster＠open-mesh.org 13 Jul '17

13 Jul '17

Repository : ssh://git@open-mesh.org/doc On branch : master >--------------------------------------------------------------- commit a5fa9b7bacb22476aefff3a98800ee6a7f988430 Author: Sven Eckelmann <sven(a)narfation.org> Date: Thu Jul 13 23:28:43 2017 +0200 doc: Force common line endings for restructuredtext Signed-off-by: Sven Eckelmann <sven(a)narfation.org> >--------------------------------------------------------------- a5fa9b7bacb22476aefff3a98800ee6a7f988430 .gitattributes | 4 ++++ .gitignore | 1 + 2 files changed, 5 insertions(+) diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..55da4e1 --- /dev/null +++ b/.gitattributes @@ -0,0 +1,4 @@ +/.gitignore export-ignore +/.gitattributes export-ignore +*.rst text + diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..a485625 --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +/_build

1 0

[doc] master: doc: Cleanup of alfred documentation (9aaecf8)
by postmaster＠open-mesh.org 13 Jul '17

13 Jul '17

Repository : ssh://git@open-mesh.org/doc On branch : master >--------------------------------------------------------------- commit 9aaecf8de08af65d40d6cc97c578f49fc677484e Author: Sven Eckelmann <sven(a)narfation.org> Date: Thu Jul 13 23:17:37 2017 +0200 doc: Cleanup of alfred documentation Signed-off-by: Sven Eckelmann <sven(a)narfation.org> >--------------------------------------------------------------- 9aaecf8de08af65d40d6cc97c578f49fc677484e alfred/Alfred-gpsd.rst | 1 + alfred/Alfred-output-format-proposal.rst | 7 +- alfred/Alfred.rst | 131 ------------------------------- alfred/Alfred_architecture.rst | 53 ++++++------- alfred/Batadv-vis.rst | 1 + alfred/Building_information.rst | 36 ++++----- alfred/Wiki.rst | 50 ------------ alfred/index.rst | 44 ++++++++++- 8 files changed, 88 insertions(+), 235 deletions(-) diff --git a/alfred/Alfred-gpsd.rst b/alfred/Alfred-gpsd.rst index 0079490..1bfbbfb 100644 --- a/alfred/Alfred-gpsd.rst +++ b/alfred/Alfred-gpsd.rst @@ -1,3 +1,4 @@ +=========== Alfred-gpsd =========== diff --git a/alfred/Alfred-output-format-proposal.rst b/alfred/Alfred-output-format-proposal.rst index c86a5ea..302da52 100644 --- a/alfred/Alfred-output-format-proposal.rst +++ b/alfred/Alfred-output-format-proposal.rst @@ -1,3 +1,4 @@ +========================================= Alfred output format enhancement proposal ========================================= @@ -13,7 +14,7 @@ Here's a proposal which aims for the following three key benefits: - Binary data can be inserted, queried and piped on the shell. Valid UTF8 text only by default -------------------------------- +=============================== *Valid UTF8 text, ASCII, example 1:* @@ -78,7 +79,7 @@ Simply fail with an error return code and message, example: Invalid UTF8 input! Consider using --binary Binary mode switch ------------------- +================== *Store:* @@ -100,7 +101,7 @@ So '$ alfred -r 64' displays the data in base64 (or some other suitable, json string compatible format). Namespaces ----------- +========== *Store:* diff --git a/alfred/Alfred.rst b/alfred/Alfred.rst deleted file mode 100644 index 81db303..0000000 --- a/alfred/Alfred.rst +++ /dev/null @@ -1,131 +0,0 @@ -A.L.F.R.E.D - Almighty Lightweight Fact Remote Exchange Daemon -============================================================== - -| "alfred is a user space daemon to efficiently[tm] flood the network - with useless data - like vis, weather data, network notes, etc" -| > - Marek Lindner, 2012 - -Introduction ------------- - -alfred is a user space daemon for distributing arbitrary local -information over the mesh/network in a decentralized fashion. This data -can be anything which appears to be useful - originally designed to -replace the batman-adv visualization (vis), you may distribute -hostnames, phone books, administration information, DNS information, the -local weather forecast ... - -Typically, alfred runs as unix daemon in the background of the system. A -user may insert information by using the alfred binary on the command -line, or use custom written programs to communicate with alfred directly -through unix sockets. Once the local data is received, the alfred daemon -takes care of distributing this information to other alfred servers on -other nodes somewhere in the network. As addressing scheme IPv6 -link-local multicast addresses are used which do not require any manual -configuration. A user can request data from alfred, and will receive the -information available from all alfred servers in the network. - -See the -`README <https://git.open-mesh.org/alfred.git/blob_plain/refs/heads/master:/README>`__ -for more information or the -`manpage <https://downloads.open-mesh.org/batman/manpages/alfred.8.html>`__ -for usage. - -Further resources ------------------ - -| \* alfred slave on android: https://github.com/basros/alfreda -| \* Wireshark dissector for alfred: - https://github.com/basros/alfred-dissector -| \* [[alfred:alfred architecture\|Alfred architecture]] - technical - information about alfred - -Current applications --------------------- - -There are a few applications currently implemented on top of alfred: - -batadv-vis -~~~~~~~~~~ - -batadv-vis can be used to visualize your batman-adv mesh network. It -read the neighbor information and local client table and distributes -this information via alfred in the network. By gathering this local -information, any vis node can get the whole picture of the network. - -It allows output of different formats (json, graphviz) and replaces the -in-kernel vis functionality found in older batman-adv kernel modules -(<2014). See the sample picture below. For more information, please read -the vis section of the -`README <https://git.open-mesh.org/alfred.git/blob_plain/refs/heads/master:/README>`__ -or the -`manpage <https://downloads.open-mesh.org/batman/manpages/batadv-vis.html>`__ -for usage. - -|image0| - -alfred-gpsd -~~~~~~~~~~~ - -Alfred-gpsd can be used to distibute GPS location information about your -batman-adv mesh network. This information could be, for example, -combined with Vis to visualize your mesh topology with true geographic -layout. For mobile or nomadic nodes, Alfred-gpsd, can get location -information from gpsd. Alternatively, a static location can be passed on -the command line, which is useful for static nodes without a GPS. - -For more information, please read the alfred-gpsd section of the -`README <https://git.open-mesh.org/alfred.git/blob_plain/refs/heads/master:/README>`__ -or the -`manpage <https://downloads.open-mesh.org/batman/manpages/alfred-gpsd.html>`__ -for usage. - -Download --------- - -Release tarballs as well as snapshots are available: - -| \* release tarballs: - [[open-mesh:Download#Download-Released-Source-Code\|Check the Download - page]] -| \* git web directory: https://git.open-mesh.org/alfred.git -| \* git download: git clone git://git.open-mesh.org/alfred.git -| \* - snapshot:https://git.open-mesh.org/alfred.git/snapshot/refs/heads/master.ta… - -OpenWRT installation from routing feed -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Alfred is also part of the routing feed of OpenWRT. For newer OpenWRT, -just use: - -1. Install the alfred package: - -./scripts/feeds install alfred - -3. Run "make menuconfig" and select alfred (available under "Network ---->") - -OpenWRT development feed -~~~~~~~~~~~~~~~~~~~~~~~~ - -There is also a development packet feed for OpenWRT available for -alfred: - -1. add the alfred feed by adding the following line into your -feeds.conf: - -src-git batman git://git.open-mesh.org/openwrt-feed-devel.git - -2. Update and install the feed: - -| ./scripts/feeds update -| ./scripts/feeds install alfred - -3. Run "make menuconfig" and select alfred (available under "Network ---->") - -Finally, re-build Openwrt and enjoy using alfred! :) - -.. |image0| image:: batman-adv-vis-example.png - diff --git a/alfred/Alfred_architecture.rst b/alfred/Alfred_architecture.rst index 26f0a01..1b8f838 100644 --- a/alfred/Alfred_architecture.rst +++ b/alfred/Alfred_architecture.rst @@ -1,8 +1,9 @@ +=================== alfred architecture =================== Introduction ------------- +============ alfred is a user space daemon for distributing arbitrary local information over the mesh/network in a decentralized fashion. This data @@ -21,23 +22,19 @@ link-local multicast addresses are used which do not require any manual configuration. A user can request data from alfred, and will receive the information available from all alfred servers in the network. -More user related information can be found in the [[alfred:Alfred]] -overview page. - Alfred specific terms ---------------------- - -+----------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| node | a node is a device able to run alfred | -+----------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| server | an alfred instance running on a node, able to communicate with alfred processes on other nodes and with clients running on the same node | -+----------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| client | a program which supports the alfred protocol and communicates with the alfred server on the same node | -+----------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| master | an alfred server process which stores incoming data, synchronizes it with other master servers and accepts requests/data from slaves | -+----------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| slave | an alfred server process which only manages its own data, pushes/requests the data to/from **its** master server | -+----------+--------------------------------------------------------------------------------------------------------------------------------------------+ +===================== + +node + a node is a device able to run alfred +server + an alfred instance running on a node, able to communicate with alfred processes on other nodes and with clients running on the same node +client + a program which supports the alfred protocol and communicates with the alfred server on the same node +master + an alfred server process which stores incoming data, synchronizes it with other master servers and accepts requests/data from slaves +slave + an alfred server process which only manages its own data, pushes/requests the data to/from **its** master server Network ------- @@ -64,7 +61,7 @@ best master server to request data when required and to push the data from local clients to the alfred network through master servers. Network layer -~~~~~~~~~~~~~ +------------- All communication between servers in an alfred network is done through IPv6 link-local UDP messages. This only allows communication in the @@ -84,7 +81,7 @@ All the messages are sent through the IANA unregistered UDP/IPv6 port 0x4242 (in decimal: 16962). Detection of neighbors -~~~~~~~~~~~~~~~~~~~~~~ +---------------------- The master server will announce itself using IPv6 link-local multicast messages. This makes it possible to reach all nodes with a single @@ -115,7 +112,7 @@ Detected neighbor servers are automatically dropped after a timeout of 60s since the last announcement was received. Client data exchange -~~~~~~~~~~~~~~~~~~~~ +-------------------- The client communication to the alfred server is done through unix sockets on the same node. The path is defined as /var/run/alfred.sock @@ -161,7 +158,7 @@ The best practice for a client is to implement the handling of error messages even when it is only used together with master servers. Synchronization -~~~~~~~~~~~~~~~ +--------------- Data synchronizations are done master2master and slave2master. The slave will only send data from its clients to a single server. Master servers @@ -187,10 +184,10 @@ Data is automatically pruned from the server storage 600s after the last time it was received/refreshed. Packet formats --------------- +============== General format -~~~~~~~~~~~~~~ +-------------- The data stored in the packet headers is always stored in network byte order (big endian). The packet format is TLV based (type, value, length) @@ -208,7 +205,7 @@ The version field is also only defined for the outer TLV and has to be 0 for the specified first packet format. Master announcement -~~~~~~~~~~~~~~~~~~~ +------------------- |image6| @@ -218,7 +215,7 @@ more information. The receiver has to calculate the mac address of the sender by decoding the link-local IPv6 sender address. Request data -~~~~~~~~~~~~ +------------ |image7| @@ -233,7 +230,7 @@ The transaction id must be unique during the time the request is made and answered. Finish transaction -~~~~~~~~~~~~~~~~~~ +------------------ |image8| @@ -245,7 +242,7 @@ packets has to be equal to the number of alfred\_push\_data packets with the same transaction id to accept the transaction as successful. Inform about an error -~~~~~~~~~~~~~~~~~~~~~ +--------------------- Slave servers send error messages via unix sockets to clients. This tells the client that the request of data from the master server failed. @@ -257,7 +254,7 @@ alfred\_request packet. The only currently used error code is 1. Push data -~~~~~~~~~ +--------- Push data packets are sent/received by clients to send data via unix sockets to/from servers. Clients send it to store data on a server. diff --git a/alfred/Batadv-vis.rst b/alfred/Batadv-vis.rst index e44869b..64914d2 100644 --- a/alfred/Batadv-vis.rst +++ b/alfred/Batadv-vis.rst @@ -1,3 +1,4 @@ +========== Batadv-vis ========== diff --git a/alfred/Building_information.rst b/alfred/Building_information.rst index 5a8e441..9ea7d55 100644 --- a/alfred/Building_information.rst +++ b/alfred/Building_information.rst @@ -1,46 +1,44 @@ +==================== Building information ==================== Release tarballs as well as snapshots are available: -| \* release tarballs: +* release tarballs: [[open-mesh:Download#Download-Released-Source-Code\|Check the Download page]] -| \* git web directory: https://git.open-mesh.org/alfred.git -| \* git download: git clone git://git.open-mesh.org/alfred.git -| \* - snapshot:https://git.open-mesh.org/alfred.git/snapshot/refs/heads/master.ta… +* git web directory: https://git.open-mesh.org/alfred.git +* git download: ``git clone git://git.open-mesh.org/alfred.git`` +* `snapshot <https://git.open-mesh.org/alfred.git/snapshot/refs/heads/master.tar.gz>`__ OpenWRT installation from routing feed -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +====================================== Alfred is also part of the routing feed of OpenWRT. For newer OpenWRT, just use: -1. Install the alfred package: +#. Install the alfred package:: -./scripts/feeds install alfred + ./scripts/feeds install alfred -3. Run "make menuconfig" and select alfred (available under "Network ---->") +#. Run "make menuconfig" and select alfred (available under ``Network --->``) OpenWRT development feed -~~~~~~~~~~~~~~~~~~~~~~~~ +======================== There is also a development packet feed for OpenWRT available for alfred: -1. add the alfred feed by adding the following line into your -feeds.conf: +#. add the alfred feed by adding the following line into your + feeds.conf:: -src-git batman git://git.open-mesh.org/openwrt-feed-devel.git + src-git batman git://git.open-mesh.org/openwrt-feed-devel.git -2. Update and install the feed: +#. Update and install the feed:: -| ./scripts/feeds update -| ./scripts/feeds install alfred + ./scripts/feeds update + ./scripts/feeds install alfred -3. Run "make menuconfig" and select alfred (available under "Network ---->") +#. Run ``make menuconfig`` and select alfred (available under ``Network --->``) Finally, re-build Openwrt and enjoy using alfred! :) diff --git a/alfred/Wiki.rst b/alfred/Wiki.rst deleted file mode 100644 index b75e15e..0000000 --- a/alfred/Wiki.rst +++ /dev/null @@ -1,50 +0,0 @@ -A.L.F.R.E.D - Almighty Lightweight Fact Remote Exchange Daemon -============================================================== - -"alfred is a user space daemon to efficiently[tm] flood the network with -useless data - like vis, weather data, network notes, etc" - -- Marek Lindner, 2012 - -alfred is a user space daemon for distributing arbitrary local -information over the mesh/network in a decentralized fashion. This data -can be anything which appears to be useful - originally designed to -replace the batman-adv visualization (vis), you may distribute -hostnames, phone books, administration information, DNS information, the -local weather forecast ... - -Typically, alfred runs as unix daemon in the background of the system. A -user may insert information by using the alfred binary on the command -line, or use custom written programs to communicate with alfred directly -through unix sockets. Once the local data is received, the alfred daemon -takes care of distributing this information to other alfred servers on -other nodes somewhere in the network. As addressing scheme IPv6 -link-local multicast addresses are used which do not require any manual -configuration. A user can request data from alfred, and will receive the -information available from all alfred servers in the network. - -See the -`README <https://git.open-mesh.org/alfred.git/blob_plain/refs/heads/master:/README>`__ -for more information or the -`manpage <https://downloads.open-mesh.org/batman/manpages/alfred.8.html>`__ -for usage. - -Getting started ---------------- - -| \* [[Building information]] - how to download and build alfred -| \* [[batadv-vis]] - Tool to visualize batman-adv networks -| \* [[alfred-gpsd]] - Share geolocation of mesh nodes - -Developer information ---------------------- - -\* [[Alfred architecture]] - information about topologies, internal -architecture and packet format - -Further resources ------------------ - -| \* alfred slave on android: https://github.com/basros/alfreda -| \* Wireshark dissector for alfred: - https://github.com/basros/alfred-dissector diff --git a/alfred/index.rst b/alfred/index.rst index e1e3aea..7944f90 100644 --- a/alfred/index.rst +++ b/alfred/index.rst @@ -1,13 +1,42 @@ -alfred -====== +============================================================== +A.L.F.R.E.D - Almighty Lightweight Fact Remote Exchange Daemon +============================================================== + + "alfred is a user space daemon to efficiently[tm] flood the network with + useless data - like vis, weather data, network notes, etc" + + - Marek Lindner, 2012 + + +alfred is a user space daemon for distributing arbitrary local +information over the mesh/network in a decentralized fashion. This data +can be anything which appears to be useful - originally designed to +replace the batman-adv visualization (vis), you may distribute +hostnames, phone books, administration information, DNS information, the +local weather forecast ... + +Typically, alfred runs as unix daemon in the background of the system. A +user may insert information by using the alfred binary on the command +line, or use custom written programs to communicate with alfred directly +through unix sockets. Once the local data is received, the alfred daemon +takes care of distributing this information to other alfred servers on +other nodes somewhere in the network. As addressing scheme IPv6 +link-local multicast addresses are used which do not require any manual +configuration. A user can request data from alfred, and will receive the +information available from all alfred servers in the network. + +See the +`README <https://git.open-mesh.org/alfred.git/blob_plain/refs/heads/master:/README>`__ +for more information or the +`manpage <https://downloads.open-mesh.org/batman/manpages/alfred.8.html>`__ +for usage. + Contents: .. toctree:: :maxdepth: 2 - Wiki - Alfred gettingstarted developerinformation @@ -17,3 +46,10 @@ Contents: ======= * :ref:`genindex` + +Further resources +================= + +* alfred slave on android: https://github.com/basros/alfreda +* Wireshark dissector for alfred: + https://github.com/basros/alfred-dissector

1 0

[doc] master: doc: Cleanup of alfred documentation (9abe855)
by postmaster＠open-mesh.org 13 Jul '17

13 Jul '17

Repository : ssh://git@open-mesh.org/doc On branch : master >--------------------------------------------------------------- commit 9abe855e7fc247dd1dce0f25d94f351ea24a3e35 Author: Sven Eckelmann <sven(a)narfation.org> Date: Thu Jul 13 23:17:37 2017 +0200 doc: Cleanup of alfred documentation Signed-off-by: Sven Eckelmann <sven(a)narfation.org> >--------------------------------------------------------------- 9abe855e7fc247dd1dce0f25d94f351ea24a3e35 alfred/Alfred-gpsd.rst | 1 + alfred/Alfred-output-format-proposal.rst | 7 +- alfred/Alfred.rst | 131 ------------------------------- alfred/Alfred_architecture.rst | 50 ++++++------ alfred/Batadv-vis.rst | 1 + alfred/Building_information.rst | 36 ++++----- alfred/Wiki.rst | 50 ------------ alfred/index.rst | 44 ++++++++++- 8 files changed, 88 insertions(+), 232 deletions(-) diff --git a/alfred/Alfred-gpsd.rst b/alfred/Alfred-gpsd.rst index 0079490..1bfbbfb 100644 --- a/alfred/Alfred-gpsd.rst +++ b/alfred/Alfred-gpsd.rst @@ -1,3 +1,4 @@ +=========== Alfred-gpsd =========== diff --git a/alfred/Alfred-output-format-proposal.rst b/alfred/Alfred-output-format-proposal.rst index c86a5ea..302da52 100644 --- a/alfred/Alfred-output-format-proposal.rst +++ b/alfred/Alfred-output-format-proposal.rst @@ -1,3 +1,4 @@ +========================================= Alfred output format enhancement proposal ========================================= @@ -13,7 +14,7 @@ Here's a proposal which aims for the following three key benefits: - Binary data can be inserted, queried and piped on the shell. Valid UTF8 text only by default -------------------------------- +=============================== *Valid UTF8 text, ASCII, example 1:* @@ -78,7 +79,7 @@ Simply fail with an error return code and message, example: Invalid UTF8 input! Consider using --binary Binary mode switch ------------------- +================== *Store:* @@ -100,7 +101,7 @@ So '$ alfred -r 64' displays the data in base64 (or some other suitable, json string compatible format). Namespaces ----------- +========== *Store:* diff --git a/alfred/Alfred.rst b/alfred/Alfred.rst deleted file mode 100644 index 81db303..0000000 --- a/alfred/Alfred.rst +++ /dev/null @@ -1,131 +0,0 @@ -A.L.F.R.E.D - Almighty Lightweight Fact Remote Exchange Daemon -============================================================== - -| "alfred is a user space daemon to efficiently[tm] flood the network - with useless data - like vis, weather data, network notes, etc" -| > - Marek Lindner, 2012 - -Introduction ------------- - -alfred is a user space daemon for distributing arbitrary local -information over the mesh/network in a decentralized fashion. This data -can be anything which appears to be useful - originally designed to -replace the batman-adv visualization (vis), you may distribute -hostnames, phone books, administration information, DNS information, the -local weather forecast ... - -Typically, alfred runs as unix daemon in the background of the system. A -user may insert information by using the alfred binary on the command -line, or use custom written programs to communicate with alfred directly -through unix sockets. Once the local data is received, the alfred daemon -takes care of distributing this information to other alfred servers on -other nodes somewhere in the network. As addressing scheme IPv6 -link-local multicast addresses are used which do not require any manual -configuration. A user can request data from alfred, and will receive the -information available from all alfred servers in the network. - -See the -`README <https://git.open-mesh.org/alfred.git/blob_plain/refs/heads/master:/README>`__ -for more information or the -`manpage <https://downloads.open-mesh.org/batman/manpages/alfred.8.html>`__ -for usage. - -Further resources ------------------ - -| \* alfred slave on android: https://github.com/basros/alfreda -| \* Wireshark dissector for alfred: - https://github.com/basros/alfred-dissector -| \* [[alfred:alfred architecture\|Alfred architecture]] - technical - information about alfred - -Current applications --------------------- - -There are a few applications currently implemented on top of alfred: - -batadv-vis -~~~~~~~~~~ - -batadv-vis can be used to visualize your batman-adv mesh network. It -read the neighbor information and local client table and distributes -this information via alfred in the network. By gathering this local -information, any vis node can get the whole picture of the network. - -It allows output of different formats (json, graphviz) and replaces the -in-kernel vis functionality found in older batman-adv kernel modules -(<2014). See the sample picture below. For more information, please read -the vis section of the -`README <https://git.open-mesh.org/alfred.git/blob_plain/refs/heads/master:/README>`__ -or the -`manpage <https://downloads.open-mesh.org/batman/manpages/batadv-vis.html>`__ -for usage. - -|image0| - -alfred-gpsd -~~~~~~~~~~~ - -Alfred-gpsd can be used to distibute GPS location information about your -batman-adv mesh network. This information could be, for example, -combined with Vis to visualize your mesh topology with true geographic -layout. For mobile or nomadic nodes, Alfred-gpsd, can get location -information from gpsd. Alternatively, a static location can be passed on -the command line, which is useful for static nodes without a GPS. - -For more information, please read the alfred-gpsd section of the -`README <https://git.open-mesh.org/alfred.git/blob_plain/refs/heads/master:/README>`__ -or the -`manpage <https://downloads.open-mesh.org/batman/manpages/alfred-gpsd.html>`__ -for usage. - -Download --------- - -Release tarballs as well as snapshots are available: - -| \* release tarballs: - [[open-mesh:Download#Download-Released-Source-Code\|Check the Download - page]] -| \* git web directory: https://git.open-mesh.org/alfred.git -| \* git download: git clone git://git.open-mesh.org/alfred.git -| \* - snapshot:https://git.open-mesh.org/alfred.git/snapshot/refs/heads/master.ta… - -OpenWRT installation from routing feed -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -Alfred is also part of the routing feed of OpenWRT. For newer OpenWRT, -just use: - -1. Install the alfred package: - -./scripts/feeds install alfred - -3. Run "make menuconfig" and select alfred (available under "Network ---->") - -OpenWRT development feed -~~~~~~~~~~~~~~~~~~~~~~~~ - -There is also a development packet feed for OpenWRT available for -alfred: - -1. add the alfred feed by adding the following line into your -feeds.conf: - -src-git batman git://git.open-mesh.org/openwrt-feed-devel.git - -2. Update and install the feed: - -| ./scripts/feeds update -| ./scripts/feeds install alfred - -3. Run "make menuconfig" and select alfred (available under "Network ---->") - -Finally, re-build Openwrt and enjoy using alfred! :) - -.. |image0| image:: batman-adv-vis-example.png - diff --git a/alfred/Alfred_architecture.rst b/alfred/Alfred_architecture.rst index 26f0a01..c8325e6 100644 --- a/alfred/Alfred_architecture.rst +++ b/alfred/Alfred_architecture.rst @@ -1,8 +1,9 @@ +=================== alfred architecture =================== Introduction ------------- +============ alfred is a user space daemon for distributing arbitrary local information over the mesh/network in a decentralized fashion. This data @@ -25,19 +26,18 @@ More user related information can be found in the [[alfred:Alfred]] overview page. Alfred specific terms ---------------------- - -+----------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| node | a node is a device able to run alfred | -+----------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| server | an alfred instance running on a node, able to communicate with alfred processes on other nodes and with clients running on the same node | -+----------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| client | a program which supports the alfred protocol and communicates with the alfred server on the same node | -+----------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| master | an alfred server process which stores incoming data, synchronizes it with other master servers and accepts requests/data from slaves | -+----------+--------------------------------------------------------------------------------------------------------------------------------------------+ -| slave | an alfred server process which only manages its own data, pushes/requests the data to/from **its** master server | -+----------+--------------------------------------------------------------------------------------------------------------------------------------------+ +===================== + +node + a node is a device able to run alfred +server + an alfred instance running on a node, able to communicate with alfred processes on other nodes and with clients running on the same node +client + a program which supports the alfred protocol and communicates with the alfred server on the same node +master + an alfred server process which stores incoming data, synchronizes it with other master servers and accepts requests/data from slaves +slave + an alfred server process which only manages its own data, pushes/requests the data to/from **its** master server Network ------- @@ -64,7 +64,7 @@ best master server to request data when required and to push the data from local clients to the alfred network through master servers. Network layer -~~~~~~~~~~~~~ +------------- All communication between servers in an alfred network is done through IPv6 link-local UDP messages. This only allows communication in the @@ -84,7 +84,7 @@ All the messages are sent through the IANA unregistered UDP/IPv6 port 0x4242 (in decimal: 16962). Detection of neighbors -~~~~~~~~~~~~~~~~~~~~~~ +---------------------- The master server will announce itself using IPv6 link-local multicast messages. This makes it possible to reach all nodes with a single @@ -115,7 +115,7 @@ Detected neighbor servers are automatically dropped after a timeout of 60s since the last announcement was received. Client data exchange -~~~~~~~~~~~~~~~~~~~~ +-------------------- The client communication to the alfred server is done through unix sockets on the same node. The path is defined as /var/run/alfred.sock @@ -161,7 +161,7 @@ The best practice for a client is to implement the handling of error messages even when it is only used together with master servers. Synchronization -~~~~~~~~~~~~~~~ +--------------- Data synchronizations are done master2master and slave2master. The slave will only send data from its clients to a single server. Master servers @@ -187,10 +187,10 @@ Data is automatically pruned from the server storage 600s after the last time it was received/refreshed. Packet formats --------------- +============== General format -~~~~~~~~~~~~~~ +-------------- The data stored in the packet headers is always stored in network byte order (big endian). The packet format is TLV based (type, value, length) @@ -208,7 +208,7 @@ The version field is also only defined for the outer TLV and has to be 0 for the specified first packet format. Master announcement -~~~~~~~~~~~~~~~~~~~ +------------------- |image6| @@ -218,7 +218,7 @@ more information. The receiver has to calculate the mac address of the sender by decoding the link-local IPv6 sender address. Request data -~~~~~~~~~~~~ +------------ |image7| @@ -233,7 +233,7 @@ The transaction id must be unique during the time the request is made and answered. Finish transaction -~~~~~~~~~~~~~~~~~~ +------------------ |image8| @@ -245,7 +245,7 @@ packets has to be equal to the number of alfred\_push\_data packets with the same transaction id to accept the transaction as successful. Inform about an error -~~~~~~~~~~~~~~~~~~~~~ +--------------------- Slave servers send error messages via unix sockets to clients. This tells the client that the request of data from the master server failed. @@ -257,7 +257,7 @@ alfred\_request packet. The only currently used error code is 1. Push data -~~~~~~~~~ +--------- Push data packets are sent/received by clients to send data via unix sockets to/from servers. Clients send it to store data on a server. diff --git a/alfred/Batadv-vis.rst b/alfred/Batadv-vis.rst index e44869b..64914d2 100644 --- a/alfred/Batadv-vis.rst +++ b/alfred/Batadv-vis.rst @@ -1,3 +1,4 @@ +========== Batadv-vis ========== diff --git a/alfred/Building_information.rst b/alfred/Building_information.rst index 5a8e441..9ea7d55 100644 --- a/alfred/Building_information.rst +++ b/alfred/Building_information.rst @@ -1,46 +1,44 @@ +==================== Building information ==================== Release tarballs as well as snapshots are available: -| \* release tarballs: +* release tarballs: [[open-mesh:Download#Download-Released-Source-Code\|Check the Download page]] -| \* git web directory: https://git.open-mesh.org/alfred.git -| \* git download: git clone git://git.open-mesh.org/alfred.git -| \* - snapshot:https://git.open-mesh.org/alfred.git/snapshot/refs/heads/master.ta… +* git web directory: https://git.open-mesh.org/alfred.git +* git download: ``git clone git://git.open-mesh.org/alfred.git`` +* `snapshot <https://git.open-mesh.org/alfred.git/snapshot/refs/heads/master.tar.gz>`__ OpenWRT installation from routing feed -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +====================================== Alfred is also part of the routing feed of OpenWRT. For newer OpenWRT, just use: -1. Install the alfred package: +#. Install the alfred package:: -./scripts/feeds install alfred + ./scripts/feeds install alfred -3. Run "make menuconfig" and select alfred (available under "Network ---->") +#. Run "make menuconfig" and select alfred (available under ``Network --->``) OpenWRT development feed -~~~~~~~~~~~~~~~~~~~~~~~~ +======================== There is also a development packet feed for OpenWRT available for alfred: -1. add the alfred feed by adding the following line into your -feeds.conf: +#. add the alfred feed by adding the following line into your + feeds.conf:: -src-git batman git://git.open-mesh.org/openwrt-feed-devel.git + src-git batman git://git.open-mesh.org/openwrt-feed-devel.git -2. Update and install the feed: +#. Update and install the feed:: -| ./scripts/feeds update -| ./scripts/feeds install alfred + ./scripts/feeds update + ./scripts/feeds install alfred -3. Run "make menuconfig" and select alfred (available under "Network ---->") +#. Run ``make menuconfig`` and select alfred (available under ``Network --->``) Finally, re-build Openwrt and enjoy using alfred! :) diff --git a/alfred/Wiki.rst b/alfred/Wiki.rst deleted file mode 100644 index b75e15e..0000000 --- a/alfred/Wiki.rst +++ /dev/null @@ -1,50 +0,0 @@ -A.L.F.R.E.D - Almighty Lightweight Fact Remote Exchange Daemon -============================================================== - -"alfred is a user space daemon to efficiently[tm] flood the network with -useless data - like vis, weather data, network notes, etc" - -- Marek Lindner, 2012 - -alfred is a user space daemon for distributing arbitrary local -information over the mesh/network in a decentralized fashion. This data -can be anything which appears to be useful - originally designed to -replace the batman-adv visualization (vis), you may distribute -hostnames, phone books, administration information, DNS information, the -local weather forecast ... - -Typically, alfred runs as unix daemon in the background of the system. A -user may insert information by using the alfred binary on the command -line, or use custom written programs to communicate with alfred directly -through unix sockets. Once the local data is received, the alfred daemon -takes care of distributing this information to other alfred servers on -other nodes somewhere in the network. As addressing scheme IPv6 -link-local multicast addresses are used which do not require any manual -configuration. A user can request data from alfred, and will receive the -information available from all alfred servers in the network. - -See the -`README <https://git.open-mesh.org/alfred.git/blob_plain/refs/heads/master:/README>`__ -for more information or the -`manpage <https://downloads.open-mesh.org/batman/manpages/alfred.8.html>`__ -for usage. - -Getting started ---------------- - -| \* [[Building information]] - how to download and build alfred -| \* [[batadv-vis]] - Tool to visualize batman-adv networks -| \* [[alfred-gpsd]] - Share geolocation of mesh nodes - -Developer information ---------------------- - -\* [[Alfred architecture]] - information about topologies, internal -architecture and packet format - -Further resources ------------------ - -| \* alfred slave on android: https://github.com/basros/alfreda -| \* Wireshark dissector for alfred: - https://github.com/basros/alfred-dissector diff --git a/alfred/index.rst b/alfred/index.rst index e1e3aea..7944f90 100644 --- a/alfred/index.rst +++ b/alfred/index.rst @@ -1,13 +1,42 @@ -alfred -====== +============================================================== +A.L.F.R.E.D - Almighty Lightweight Fact Remote Exchange Daemon +============================================================== + + "alfred is a user space daemon to efficiently[tm] flood the network with + useless data - like vis, weather data, network notes, etc" + + - Marek Lindner, 2012 + + +alfred is a user space daemon for distributing arbitrary local +information over the mesh/network in a decentralized fashion. This data +can be anything which appears to be useful - originally designed to +replace the batman-adv visualization (vis), you may distribute +hostnames, phone books, administration information, DNS information, the +local weather forecast ... + +Typically, alfred runs as unix daemon in the background of the system. A +user may insert information by using the alfred binary on the command +line, or use custom written programs to communicate with alfred directly +through unix sockets. Once the local data is received, the alfred daemon +takes care of distributing this information to other alfred servers on +other nodes somewhere in the network. As addressing scheme IPv6 +link-local multicast addresses are used which do not require any manual +configuration. A user can request data from alfred, and will receive the +information available from all alfred servers in the network. + +See the +`README <https://git.open-mesh.org/alfred.git/blob_plain/refs/heads/master:/README>`__ +for more information or the +`manpage <https://downloads.open-mesh.org/batman/manpages/alfred.8.html>`__ +for usage. + Contents: .. toctree:: :maxdepth: 2 - Wiki - Alfred gettingstarted developerinformation @@ -17,3 +46,10 @@ Contents: ======= * :ref:`genindex` + +Further resources +================= + +* alfred slave on android: https://github.com/basros/alfreda +* Wireshark dissector for alfred: + https://github.com/basros/alfred-dissector

1 0

Jump to page:

2024

2023

2022

2021

2020

2019

2018

2017

2016

2015

2014

2013

2012

2011

2010

2009

commits July 2017