aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authort3sserakt <t3ss@posteo.de>2023-02-15 15:51:31 +0100
committert3sserakt <t3ss@posteo.de>2023-02-15 16:04:27 +0100
commit3a94e087e3c4ef8b64adca9a4b7090ea66b8f96b (patch)
tree81f66a67e16b54393ded651ab912e5c1d64b856e
parent84fb8a340c8877c1c4ca3e9a36d68f4da91014c4 (diff)
downloadwww-3a94e087e3c4ef8b64adca9a4b7090ea66b8f96b.tar.gz
www-3a94e087e3c4ef8b64adca9a4b7090ea66b8f96b.zip
fixed EBNF configuration syntax description, added L20 milestone 5 documentation.
Diffstat
-rw-r--r--template/l2o/index.html.j22
-rw-r--r--template/l2o/mile5.html.j2184
-rw-r--r--template/l2o/testng.html.j23
3 files changed, 187 insertions, 2 deletions
diff --git a/template/l2o/index.html.j2 b/template/l2o/index.html.j2
index c6c7f0b5..a4ff4da9 100644
--- a/template/l2o/index.html.j2
+++ b/template/l2o/index.html.j2
@@ -172,7 +172,7 @@
172 <p> 172 <p>
173 {% trans %} 173 {% trans %}
174 The CI contains test case with a peer setup containing peer behind a NAT. The test cases 174 The CI contains test case with a peer setup containing peer behind a NAT. The test cases
175 proof that each peer can be reached, even if that peer is behind a NAT. The test case are measuring the performance. This measurement is used to compare with the outcome of the next milestone. This result of this milestone will be a first stable release. 175 proof that each peer can be reached, even if that peer is behind a NAT. The test case are measuring the performance. This measurement is used to compare with the outcome of the next milestone. This result of this milestone will be a first stable release. <a href="mile5.html">Details</a>
176 {% endtrans %} 176 {% endtrans %}
177 </p><br/> 177 </p><br/>
178 </section> 178 </section>
diff --git a/template/l2o/mile5.html.j2 b/template/l2o/mile5.html.j2
new file mode 100644
index 00000000..4601ee79
--- /dev/null
+++ b/template/l2o/mile5.html.j2
@@ -0,0 +1,184 @@
1{% extends "common/base.j2" %}
2{% block body_content %}
3<main id="maincontent">
4<article class="container">
5
6 <header>
7 <h1>{{ _("NGI Assure project: Layer-2-Overlay") }}</h1>
8 </header>
9
10 <div class="row">
11 <div class="col-2 d-none d-lg-block"><!-- for large viewports show menu for better orientation -->
12 <nav class="nav subnav position-fixed flex-column border-right" style="position:fixed">
13 <a class="nav-link" href="index.html#idea">{{ _("Project main page") }}</a>
14 </nav>
15 </div>
16 <div class="col">
17
18 <h2>Implementation details milestone 5</h2><br/>
19
20 <section>
21 <h4><a name="netjail" class="subnav-anchor"></a>{{ _("Testing Framework") }}</h4><br/>
22 <p>
23 {% trans %}
24 <ul>
25 <li>Added so called barrier functionality, which is a set of commands to easy implement a barrier. A barrier is some point in time during execution of a test which if reached can trigger some action. For details have a look into commits 34e1c58cb39a649c9a4c551681cedf19807b85f0, ba4d141be09651b452270fc21f062d50bd3f738a and 2c2b2911e1585dc378dbb88d4dd6aaec37b00316.</li>
26 </ul>
27 {% endtrans %}
28 </p>
29 <p>
30 Even more details in commits fc99f54070e04c043c14f2244f85833ecf6b00c4, 95a1edacccd9b3bf769a144a12d41946d0ac25dc and 247230d737e3e4709392148bfabbde25871b6914
31 </p>
32 </section>
33
34 <section>
35 <h4><a name="netjail" class="subnav-anchor"></a>{{ _("TNG Service") }}</h4><br/>
36 <p>
37 {% trans %}
38 <ul>
39 <li>Added nat reversal code to tcp communicator. Prepared udp communicator.</li>
40 <li>Added tcp icmp nat hole punching test case script, and fixed bugs occuring during shutdown.</li>
41 <ul>
42 <li>src/transport/test_transport_nat_icmp_tcp.sh</li>
43 </ul>
44 <li>Added performance test case.</li>
45 <ul>
46 <li>src/transport/test_transport_plugin_cmd_simple_send_performance.c</li>
47 <li>src/transport/test_transport_simple_send_performance.sh</li>
48 <li>src/transport/test_transport_simple_send_performance_topo.conf</li>
49 <li>src/transport/transport_api_cmd_send_simple_performance.c</li>
50 </ul>
51 <li>Fixed bug happening during check for pending validation requests after
52 nat reversal.</li>
53 <li>Fixed bug of QueueEntry deleted too early.</li>
54 <li>Fixed bug about missing synchronisation between client and service queue
55 in Transport Core API.</li>
56 <li>Fixed bug of not sending the changed window size, which takes into account the used and lost data.</li>
57 </ul>
58 {% endtrans %}
59 </p>
60 <p>
61 Even more details in commits fc99f54070e04c043c14f2244f85833ecf6b00c4, 95a1edacccd9b3bf769a144a12d41946d0ac25dc and 247230d737e3e4709392148bfabbde25871b6914
62 </p>
63 </section>
64
65 <section>
66 <h4><a name="netjail" class="subnav-anchor"></a>{{ _("Master Loop") }}</h4>
67 <p>
68 {% trans %}
69 <table width="100%">
70 <tr>
71 <td width="60%" style="vertical-align: top;">src/transport/test_transport_simple_send_dv_inverse.sh</td><td width="55%" style="vertical-align: top;">Added script to start the inverse distance vector test case.</td>
72 <tr>
73 <td></td><td> </td>
74 </tr>
75 <tr>
76 <td width="60%" style="vertical-align: top;">src/transport/test_transport_simple_send_dv_circle.sh</td><td width="55%" style="vertical-align: top;">Added script to start the circle distance vector test case.</td>
77 <tr>
78 </table>
79 {% endtrans %}
80 </p>
81 <h4><a name="netjail" class="subnav-anchor"></a>{{ _("Local Loop") }}</h4>
82 <p>
83 {% trans %}
84 <table width="100%">
85 <tr>
86 <td width="60%" style="vertical-align: top;">src/transport/transport_api_cmd_connecting_peers.c</td><td width="40%" style="vertical-align: top;">Added logic to handle counting additonal connection per peer.</td>
87 <tr>
88 <td></td><td> </td>
89 </tr>
90 <tr>
91 <td width="60%" style="vertical-align: top;">src/transport/test_transport_plugin_cmd_simple_send_dv.c</td><td width="40%" style="vertical-align: top;">Added plugin which creates the commands for the distance vector test cases.</td>
92 <tr>
93 </table>
94 {% endtrans %}
95 </p>
96 <h4><a name="netjail" class="subnav-anchor"></a>{{ _("Configuration") }}</h4>
97 <p>
98 {% trans %}
99 <ul>
100 <li>Added configuration to be able to start executables on a router node</li>
101 <ul>
102 <li>contrib/netjail/netjail_core.sh</li>
103 <li>contrib/netjail/netjail_start.sh</li>
104 <li>contrib/netjail/topo.sh</li>
105 </ul>
106 </ul></br>
107 <table width="100%">
108 <tr>
109 <td width="60%" style="vertical-align: top;">src/transport/test_transport_nat_upnp_topo.conf</td><td width="40%" style="vertical-align: top;">Added topology file for nat upnp test case</td>
110 <tr>
111 <td></td><td> </td>
112 </tr>
113 <tr>
114 <td width="60%" style="vertical-align: top;">contrib/netjail/netjail_start.sh</td><td width="40%" style="vertical-align: top;">Handing over the global number of the router node to the script running
115 on that node. (8e1bf27b11)</td>
116 <tr>
117 </table></br>
118 <ul>
119 <li>miniupnpd only works with public IP addresses. (c524f91a6)</li>
120 <ul>
121 <li>contrib/netjail/netjail_start.sh</li>
122 <li>src/testing/gnunet-cmds-helper.c</li>
123 <li>src/testing/testing.c</li>
124 </ul>
125 </ul>
126 <ul>
127 <li>Changed the format of the interface names to make miniupnpd happy. (4aec035ea)</li>
128 <ul>
129 <li>contrib/netjail/netjail_core.sh</li>
130 <li>src/testing/testing_api_cmd_netjail_start_cmds_helper.c</li>
131 </ul>
132 </ul>
133 <ul>
134 <li>Cleanup after scripts which were running on netjail nodes. (9d6ace0b9)</li>
135 <ul>
136 <li>contrib/netjail/netjail_stop.sh</li>
137 </ul>
138 </ul></br>
139 <table width="100%">
140 <tr>
141 <td width="60%" style="vertical-align: top;">src/transport/test_transport_nat_icmp_tcp_topo.conf</td><td width="40%" style="vertical-align: top;">Added topology file for tcp icmp nat hole punching test case.</td>
142 <tr>
143 </table></br>
144 <ul>
145 <li>Added code to configure connection attempts to natted peers. (6de2cb8f7a)</li>
146 <ul>
147 <li>src/testing/testing.c</li>
148 <li>src/transport/transport_api_cmd_connecting_peers.c</li>
149 </ul>
150 </ul>
151 <ul>
152 <li>Added code in the netjail scripts to enable router nodes to forward icmp requests
153 and response. (a21cb1820)</li>
154 <ul>
155 <li>contrib/netjail/netjail_core.sh</li>
156 <li>contrib/netjail/netjail_start.sh</li>
157 </ul>
158 </ul>
159 {% endtrans %}
160 </p>
161 </section>
162 <section>
163 <h4><a name="netjail" class="subnav-anchor"></a>{{ _("Performance Measurement") }}</h4>
164 <p>
165 {% trans %}
166 The outcome of the performance measurement was 20 MByte/s for packet size of 65000 bytes.
167
168 For this measurement the TNG layer was using tcp only, because there was an unfixed bug, if running tcp and udp in parallel.
169 {% endtrans %}
170 </p>
171 </section>
172 <section>
173 <h4><a name="netjail" class="subnav-anchor"></a>{{ _("API Documentation") }}</h4>
174 <p>
175 {% trans %}
176 Documentation of the new <a href='https://docs.gnunet.org/doxygen/d2/dc4/group__TNG.html'>TNG Api</a>.
177 {% endtrans %}
178 </p>
179 </section>
180 </div>
181 </div>
182
183</article>
184{% endblock body_content %}
diff --git a/template/l2o/testng.html.j2 b/template/l2o/testng.html.j2
index fbaf77a0..4509b756 100644
--- a/template/l2o/testng.html.j2
+++ b/template/l2o/testng.html.j2
@@ -91,7 +91,7 @@ Zero = "0" ;<br/><br/>
91NaturalNumber = NumeralWithoutZero, { Numeral } ;<br/><br/> 91NaturalNumber = NumeralWithoutZero, { Numeral } ;<br/><br/>
92PluginName = Letter , { ( Letter | "_" ) } ;<br/><br/> 92PluginName = Letter , { ( Letter | "_" ) } ;<br/><br/>
93IndexOfGlobalNode = Zero | NaturalNumber ;<br/><br/> 93IndexOfGlobalNode = Zero | NaturalNumber ;<br/><br/>
94EstablishConnectionToPeerViaProtocol = "{" "connect", ":" EstablishConnectionToPeerViaProtocolValue "}" ;<br/><br/> 94EstablishConnectionToPeerViaProtocol = "{" "connect", ":" EstablishConnectionToPeerViaProtocolValues "}" ;<br/><br/>
95ProtocolPortToOpen = "tcp_port" | "udp_port" ;<br/><br/> 95ProtocolPortToOpen = "tcp_port" | "udp_port" ;<br/><br/>
96switch = On | Off ;<br/><br/> 96switch = On | Off ;<br/><br/>
97SubnetIndex = NaturalNumber ;<br/><br/> 97SubnetIndex = NaturalNumber ;<br/><br/>
@@ -99,6 +99,7 @@ NodeIndexInSubnet = NaturalNumber ;<br/><br/>
99NumeralWithoutZero = "0" | Numeral ;<br/><br/> 99NumeralWithoutZero = "0" | Numeral ;<br/><br/>
100Numeral = "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9" ;<br/><br/> 100Numeral = "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9" ;<br/><br/>
101Letter = "A" | "B" | ... | "Z" | "a" | ... | "z";<br/><br/> 101Letter = "A" | "B" | ... | "Z" | "a" | ... | "z";<br/><br/>
102EstablishConnectionToPeerViaProtocolValues = EstablishConnectionToPeerViaProtocolValue { "|", EstablishConnectionToPeerViaProtocolValue }
102EstablishConnectionToPeerViaProtocolValue = "{", ( GlobalPeer | SubnetPeer ), ":", Protocol, "}" ;<br/><br/> 103EstablishConnectionToPeerViaProtocolValue = "{", ( GlobalPeer | SubnetPeer ), ":", Protocol, "}" ;<br/><br/>
103On = 1 ;<br/><br/> 104On = 1 ;<br/><br/>
104Off = 0 ;<br/><br/> 105Off = 0 ;<br/><br/>
generated by cgit v1.2.3 (git 2.39.1) at 2024-04-24 09:44:00 +0000