github pages

README.md

@@ -1,4 +1,4 @@
-# RtBrick BNG Blaster
+# RtBrick - Routing Protocol and BNG Blaster
 
 ![Build](https://github.com/rtbrick/bngblaster/workflows/Build/badge.svg?branch=main)
 [![Linux](https://img.shields.io/badge/OS-linux-lightgrey)](https://rtbrick.github.io/bngblaster/install)
@@ -8,7 +8,7 @@
 
 **The open network tester for the IP networking community.**
 
-The **BNG Blaster** is an open-source network tester for **access** and **routing** protocols.
+The **Routing Protocol and BNG Blaster** is an open-source network tester for **routing** and **access** protocols.
 
 Originally developed as an access protocol tester, the BNG Blaster has undergone a 
 significant evolution, transforming into a comprehensive network testing tool that 

docs/_sources/index.rst.txt

@@ -1,9 +1,10 @@
-BNG Blaster
-===========
+RtBrick - Routing Protocol and BNG Blaster
+==========================================
 
 **The open network tester for the IP networking community.**
 
-The **BNG Blaster** is an open-source network tester for **access** and **routing** protocols.
+The **Routing Protocol and BNG Blaster** is an open-source 
+network tester for **routing** and **access** protocols.
 
 Originally developed as an access protocol tester, the BNG Blaster has undergone a 
 significant evolution, transforming into a comprehensive network testing tool that 
@@ -140,6 +141,11 @@ YouTube
 * `DENOG13 (2021) <https://youtu.be/LVg6rlVEfNU>`_ 
 * `Introduction (2021) <https://youtu.be/EHJ70p0_Sw0>`_
 
+Trainings and Examples:
+-----------------------
+
+* https://github.com/rtbrick/bngblaster-training
+
 Sources
 -------
 

docs/_sources/nat.rst.txt

@@ -171,6 +171,7 @@ NAT gateway.
 
 TCP RAW Streams
 ~~~~~~~~~~~~~~~
+
 A new option called **raw-tcp** is added to the stream configuraton. 
 If enabled, UDP-like traffic with a constant rate is sent using a 
 static (RAW) TCP header.
@@ -349,6 +350,13 @@ where X-Client-Ip and Port shows the IP address and port assigned from the NAT g
 Unfortunately HTTP client/server scaling is limited, therefore raw-TCP
 streams is the better option to test NAT on scale. 
 
+ICMP Client
+~~~~~~~~~~~
+
+The :ref:`ICMP client <icmp>` makes it possible to initiate pings from NATed sessions to network 
+interfaces or other endpoint, allowing you to verify that ICMP traffic is correctly translated 
+by the NAT device under test.
+
 Scaling
 ~~~~~~~
 The number of UDP and raw-TCP traffic streams can be further expanded by 

docs/_sources/troubleshooting.rst.txt

@@ -32,6 +32,7 @@ The following list shows all supported logging options.
 * ``dpdk``: log DPDK events
 * ``packet``: log packet events
 * ``http``: log HTTP events
+* ``icmp``: log ICMP events
 
 .. code-block:: none
     

docs/index.html

@@ -4,7 +4,7 @@
   <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
 
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-  <title>BNG Blaster &mdash; BNG Blaster 0.9 documentation</title>
+  <title>RtBrick - Routing Protocol and BNG Blaster &mdash; BNG Blaster 0.9 documentation</title>
       <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=80d5e7a1" />
       <link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=19f00094" />
       <link rel="stylesheet" type="text/css" href="_static/tabs.css?v=a5c4661c" />
@@ -80,7 +80,7 @@
           <div role="navigation" aria-label="Page navigation">
   <ul class="wy-breadcrumbs">
       <li><a href="#" class="icon icon-home" aria-label="Home"></a></li>
-      <li class="breadcrumb-item active">BNG Blaster</li>
+      <li class="breadcrumb-item active">RtBrick - Routing Protocol and BNG Blaster</li>
       <li class="wy-breadcrumbs-aside">
             <a href="_sources/index.rst.txt" rel="nofollow"> View page source</a>
       </li>
@@ -90,10 +90,11 @@
           <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
            <div itemprop="articleBody">
 
-  <section id="bng-blaster">
-<h1>BNG Blaster<a class="headerlink" href="#bng-blaster" title="Link to this heading"></a></h1>
+  <section id="rtbrick-routing-protocol-and-bng-blaster">
+<h1>RtBrick - Routing Protocol and BNG Blaster<a class="headerlink" href="#rtbrick-routing-protocol-and-bng-blaster" title="Link to this heading"></a></h1>
 <p><strong>The open network tester for the IP networking community.</strong></p>
-<p>The <strong>BNG Blaster</strong> is an open-source network tester for <strong>access</strong> and <strong>routing</strong> protocols.</p>
+<p>The <strong>Routing Protocol and BNG Blaster</strong> is an open-source
+network tester for <strong>routing</strong> and <strong>access</strong> protocols.</p>
 <p>Originally developed as an access protocol tester, the BNG Blaster has undergone a
 significant evolution, transforming into a comprehensive network testing tool that
 now encompasses both access and routing functionalities. Its scope has expanded beyond
@@ -215,6 +216,12 @@ <h2>YouTube<a class="headerlink" href="#youtube" title="Link to this heading">
 <li><p><a class="reference external" href="https://youtu.be/EHJ70p0_Sw0">Introduction (2021)</a></p></li>
 </ul>
 </section>
+<section id="trainings-and-examples">
+<h2>Trainings and Examples:<a class="headerlink" href="#trainings-and-examples" title="Link to this heading"></a></h2>
+<ul class="simple">
+<li><p><a class="reference external" href="https://github.com/rtbrick/bngblaster-training">https://github.com/rtbrick/bngblaster-training</a></p></li>
+</ul>
+</section>
 <section id="sources">
 <h2>Sources<a class="headerlink" href="#sources" title="Link to this heading"></a></h2>
 <ul class="simple">

docs/install.html

@@ -24,7 +24,7 @@
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
     <link rel="next" title="Quickstart Guide" href="quickstart.html" />
-    <link rel="prev" title="BNG Blaster" href="index.html" /> 
+    <link rel="prev" title="RtBrick - Routing Protocol and BNG Blaster" href="index.html" /> 
 </head>
 
 <body class="wy-body-for-nav"> 
@@ -299,7 +299,7 @@ <h2>Running BNG Blaster<a class="headerlink" href="#running-bng-blaster" title="
            </div>
           </div>
           <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
-        <a href="index.html" class="btn btn-neutral float-left" title="BNG Blaster" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
+        <a href="index.html" class="btn btn-neutral float-left" title="RtBrick - Routing Protocol and BNG Blaster" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
         <a href="quickstart.html" class="btn btn-neutral float-right" title="Quickstart Guide" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
     </div>
 

docs/nat.html

@@ -64,6 +64,7 @@
 <li class="toctree-l3"><a class="reference internal" href="#tcp-raw-streams">TCP RAW Streams</a></li>
 <li class="toctree-l3"><a class="reference internal" href="#stream-setup-interval">Stream Setup interval</a></li>
 <li class="toctree-l3"><a class="reference internal" href="#http-nat-extension">HTTP NAT Extension</a></li>
+<li class="toctree-l3"><a class="reference internal" href="#icmp-client">ICMP Client</a></li>
 <li class="toctree-l3"><a class="reference internal" href="#scaling">Scaling</a></li>
 </ul>
 </li>
@@ -427,6 +428,12 @@ <h3>HTTP NAT Extension<a class="headerlink" href="#http-nat-extension" title="Li
 <p>Unfortunately HTTP client/server scaling is limited, therefore raw-TCP
 streams is the better option to test NAT on scale.</p>
 </section>
+<section id="icmp-client">
+<h3>ICMP Client<a class="headerlink" href="#icmp-client" title="Link to this heading"></a></h3>
+<p>The <a class="reference internal" href="icmp.html#icmp"><span class="std std-ref">ICMP client</span></a> makes it possible to initiate pings from NATed sessions to network
+interfaces or other endpoint, allowing you to verify that ICMP traffic is correctly translated
+by the NAT device under test.</p>
+</section>
 <section id="scaling">
 <h3>Scaling<a class="headerlink" href="#scaling" title="Link to this heading"></a></h3>
 <p>The number of UDP and raw-TCP traffic streams can be further expanded by

docs/troubleshooting.html

@@ -126,6 +126,7 @@ <h1>Troubleshooting<a class="headerlink" href="#troubleshooting" title="Link to
 <li><p><code class="docutils literal notranslate"><span class="pre">dpdk</span></code>: log DPDK events</p></li>
 <li><p><code class="docutils literal notranslate"><span class="pre">packet</span></code>: log packet events</p></li>
 <li><p><code class="docutils literal notranslate"><span class="pre">http</span></code>: log HTTP events</p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">icmp</span></code>: log ICMP events</p></li>
 </ul>
 <div class="highlight-none notranslate"><div class="highlight"><pre><span></span>$ sudo bngblaster -C test.json -L test.log -l ip -l isis -l bgp
 </pre></div>

docsrc/sources/index.rst

@@ -1,9 +1,10 @@
-BNG Blaster
-===========
+RtBrick - Routing Protocol and BNG Blaster
+==========================================
 
 **The open network tester for the IP networking community.**
 
-The **BNG Blaster** is an open-source network tester for **access** and **routing** protocols.
+The **Routing Protocol and BNG Blaster** is an open-source 
+network tester for **routing** and **access** protocols.
 
 Originally developed as an access protocol tester, the BNG Blaster has undergone a 
 significant evolution, transforming into a comprehensive network testing tool that 
@@ -140,6 +141,11 @@ YouTube
 * `DENOG13 (2021) <https://youtu.be/LVg6rlVEfNU>`_ 
 * `Introduction (2021) <https://youtu.be/EHJ70p0_Sw0>`_
 
+Trainings and Examples:
+-----------------------
+
+* https://github.com/rtbrick/bngblaster-training
+
 Sources
 -------
 

docsrc/sources/nat.rst

@@ -171,6 +171,7 @@ NAT gateway.
 
 TCP RAW Streams
 ~~~~~~~~~~~~~~~
+
 A new option called **raw-tcp** is added to the stream configuraton. 
 If enabled, UDP-like traffic with a constant rate is sent using a 
 static (RAW) TCP header.
@@ -349,6 +350,13 @@ where X-Client-Ip and Port shows the IP address and port assigned from the NAT g
 Unfortunately HTTP client/server scaling is limited, therefore raw-TCP
 streams is the better option to test NAT on scale. 
 
+ICMP Client
+~~~~~~~~~~~
+
+The :ref:`ICMP client <icmp>` makes it possible to initiate pings from NATed sessions to network 
+interfaces or other endpoint, allowing you to verify that ICMP traffic is correctly translated 
+by the NAT device under test.
+
 Scaling
 ~~~~~~~
 The number of UDP and raw-TCP traffic streams can be further expanded by 

docsrc/sources/troubleshooting.rst

@@ -32,6 +32,7 @@ The following list shows all supported logging options.
 * ``dpdk``: log DPDK events
 * ``packet``: log packet events
 * ``http``: log HTTP events
+* ``icmp``: log ICMP events
 
 .. code-block:: none