Skip to content

Commit

Permalink
update github pages
Browse files Browse the repository at this point in the history
  • Loading branch information
GIC-de committed Jan 13, 2023
1 parent 2640172 commit 7a38a89
Show file tree
Hide file tree
Showing 85 changed files with 1,534 additions and 138 deletions.
4 changes: 4 additions & 0 deletions docs/_sources/api/index.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -189,6 +189,10 @@ BGP
---
.. include:: bgp.rst

LDP
---
.. include:: ldp.rst

CFM
---
.. include:: cfm.rst
Expand Down
35 changes: 35 additions & 0 deletions docs/_sources/api/ldp.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
.. list-table::
:header-rows: 1

* - Attribute
- Description
- Mandatory Arguments
- Optional Arguments
* - `ldp-adjacencies`
- Display all LDP adjacencies
-
- `ldp-instance-id`
* - `ldp-sessions`
- Display all matching LDP sessions
-
- `ldp-instance-id`, `local-ipv4-address`, `peer-ipv4-address`
* - `ldp-database`
- Display LDP database
- `ldp-instance-id`
-
* - `ldp-disconnect`
- Disconnect all matching LDP sessions
-
- `ldp-instance-id`, `local-ipv4-address`, `peer-ipv4-address`
* - `ldp-teardown`
- Teardown LDP
-
-
* - `ldp-raw-update-list`
- List all loaded LDP RAW update files
-
-
* - `ldp-raw-update`
- Update all matching LDP session
- `file`
- `ldp-instance-id`, `local-ipv4-address`, `peer-ipv4-address`
4 changes: 2 additions & 2 deletions docs/_sources/configuration/bgp.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,8 @@
* - `peer-as`
- BGP peer AS
- local AS
* - `holdtime`
- BGP holdtime in seconds
* - `hold-time`
- BGP hold-time in seconds
- 90
* - `id`
- BGP identifier
Expand Down
6 changes: 5 additions & 1 deletion docs/_sources/configuration/index.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -114,4 +114,8 @@ ISIS External Connections

BGP
---
.. include:: bgp.rst
.. include:: bgp.rst

LDP
---
.. include:: ldp.rst
4 changes: 2 additions & 2 deletions docs/_sources/configuration/isis.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,8 @@
* - `hello-padding`
- ISIS hello padding
- false
* - `holding-time`
- ISIS holding time in seconds
* - `hold-time`
- ISIS hold time in seconds
- 30
* - `lsp-lifetime`
- ISIS LSP lifetime in seconds
Expand Down
36 changes: 36 additions & 0 deletions docs/_sources/configuration/ldp.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
.. code-block:: json
{ "ldp": {} }
.. list-table::
:widths: 25 50 25
:header-rows: 1

* - Attribute
- Description
- Default
* - `instance-id`
- LDP instance identifier
-
* - `keepalive-time`
- LDP keepalive time in seconds
- 15
* - `hold-time`
- LDP hold time in seconds
- 30
* - `hostname`
- LDP hostname
- bngblaster
* - `lsr-id`
- LDP LSR identifier
- 10.10.10.10
* - `teardown-time`
- LDP teardown time in seconds
- 5
* - `ipv4-transport-address`
- LDP transport address
- `lsr-id`
* - `raw-update-file`
- LDP RAW update file
-
3 changes: 3 additions & 0 deletions docs/_sources/configuration/sessions.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,9 @@
* - `start-delay`
- Wait N seconds after all interfaces are resolved before starting sessions
- 0
* - `reconnect`
- Automatically reconnect sessions (PPPoE and IPoE) if terminated
- false
* - `autostart`
- Start sessions automatically
- true
Expand Down
7 changes: 5 additions & 2 deletions docs/_sources/configuration/streams.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -95,17 +95,20 @@
- MPLS send (TX) label (inner label)
-
* - `tx-label2-exp`
- EXP bits of the first label (inner label)
- EXP bits of the second label (inner label)
- 0
* - `tx-label2-ttl`
- TTL of the first label (inner label)
- TTL of the second label (inner label)
- 255
* - `rx-label1`
- Expected receive MPLS label (outer label)
-
* - `rx-label2`
- Expected receive MPLS label (inner label)
-
* - `ldp-ipv4-lookup-address`
- Dynamically resolve outer label
-

For L2TP downstream traffic, the IPv4 TOS is applied to the outer IPv4
and inner IPv4 header.
Expand Down
9 changes: 5 additions & 4 deletions docs/_sources/index.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ BNG Blaster
===========

The **BNG Blaster** is an open-source network tester
for access and routing protocols. It can emulate massive
for access and routing protocols. It can emulate a huge amount of
PPPoE and IPoE (DHCP) subscribers including IPTV, and L2TP (LNS).
There are various routing protocols supported like ISIS and BGP.
So you can use it for end-to-end BNG and non-BNG router testing.
Expand Down Expand Up @@ -41,10 +41,11 @@ RtBrick and many more.

.. tab:: Routing Protocols

* Emulate ISIS topologies with thousands of nodes
* Support for ISIS Segment Routing
* Setup thousands of BGP sessions with millions of prefixes
* Verify MPLS labels for millions of flows
* Emulate ISIS topologies with thousands of nodes
* Support for ISIS Segment Routing
* Support for LDP and traffic streams with dynamically resolved labels
* Support all routing protocols with link aggregation (LAG)
* ...

Expand Down Expand Up @@ -122,7 +123,7 @@ Copyright
---------
.. |copy| unicode:: U+000A9 .. COPYRIGHT SIGN

Copyright |copy| 2020-2022, RtBrick, Inc.
Copyright |copy| 2020-2023, RtBrick, Inc.

Contact
-------
Expand Down
13 changes: 10 additions & 3 deletions docs/_sources/install.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,14 @@ The following steps are required to build the BNG Blaster with experimental

Tested with DPDK version 21.11.2 (LTS) and Ubuntu 22.04 (LTS)!

Download and Install DPDK:
It is recommended to install the DPDK development package if possible:

.. code-block:: none
sudo apt install dpdk libdpdk-dev
This package does not support all NIC types (e.g. Mellanox, ...),
which requires downloading and installing DPDK manually:
https://doc.dpdk.org/guides/linux_gsg/build_dpdk.html

.. code-block:: none
Expand Down Expand Up @@ -205,8 +212,8 @@ Running BNG Blaster
-------------------

The BNG Blaster needs permission to send raw packets and change network interface
settings. The easiest way to run the BNG Blaster is either as the root user or with
sudo:
settings. The easiest way to run the BNG Blaster is either as the root user or
with `sudo`:

.. code-block:: none
Expand Down
71 changes: 68 additions & 3 deletions docs/_sources/quickstart.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -519,7 +519,7 @@ Finally, start the BNG Blaster in another terminal window.
Apr 08 14:53:52.904389 All network interfaces resolved
Apr 08 14:53:53.904448 BGP (veth1.2 192.168.92.2 - 192.168.92.1) state changed from idle -> connect
Apr 08 14:53:53.905659 BGP (veth1.2 192.168.92.2 - 192.168.92.1) state changed from connect -> opensent
Apr 08 14:53:53.907888 BGP (veth1.2 192.168.92.2 - 192.168.92.1) open message received with peer AS: 65001, holdtime: 90s
Apr 08 14:53:53.907888 BGP (veth1.2 192.168.92.2 - 192.168.92.1) open message received with peer AS: 65001, hold-time: 90s
Apr 08 14:53:53.907903 BGP (veth1.2 192.168.92.2 - 192.168.92.1) state changed from opensent -> openconfirm
Apr 08 14:53:53.907917 BGP (veth1.2 192.168.92.2 - 192.168.92.1) state changed from openconfirm -> established
Apr 08 14:53:54.907989 BGP (veth1.2 192.168.92.2 - 192.168.92.1) raw update start
Expand All @@ -544,11 +544,11 @@ from where you started the BNG Blaster and enter the following command.
"local-address": "192.168.92.2",
"local-id": "1.2.3.4",
"local-as": 65001,
"local-holdtime": 90,
"local-hold-time": 90,
"peer-address": "192.168.92.1",
"peer-id": "1.92.168.192",
"peer-as": 65001,
"peer-holdtime": 90,
"peer-hold-time": 90,
"state": "established",
"raw-update-state": "done",
"raw-update-file": "out.bgp",
Expand Down Expand Up @@ -646,3 +646,68 @@ Finally, you can withdraw them again.
bgpupdate -a 65001 -n 192.168.92.2 -p 22.0.0.0/28 -P 100000 -f withdraw.bgp --withdraw
sudo bngblaster-cli run.sock bgp-raw-update file withdraw.bgp
LDP
---

In the following example, we create two connected :ref:`LDP <ldp>` instances.

**ldp.json:**

.. code-block:: json
{
"interfaces": {
"capture-include-streams": true,
"network": [
{
"interface": "veth1.1",
"address": "10.0.0.1/24",
"gateway": "10.0.0.2",
"ldp-instance-id": 1
},
{
"interface": "veth1.2",
"address": "10.0.0.2/24",
"gateway": "10.0.0.1",
"ldp-instance-id": 2
}
]
},
"ldp": [
{
"instance-id": 1,
"lsr-id": "10.2.3.1",
"raw-update-file": "out.ldp"
},
{
"instance-id": 2,
"lsr-id": "10.2.3.2"
}
],
"streams": [
{
"name": "S1",
"type": "ipv4",
"direction": "downstream",
"priority": 128,
"network-interface": "veth1.2",
"destination-ipv4-address": "100.0.0.1",
"ldp-ipv4-lookup-address": "13.37.0.1",
"pps": 1
}
]
}
Use the included tool ``ldpupdate`` to generate an LDP update file
with 10 labeled IPv4 prefixes.

.. code-block:: none
ldpupdate -l 10.2.3.1 -p 13.37.0.0/32 -P 10 -M 10000
Now you can start the BNG Blaster with this configuration.

.. code-block:: none
sudo bngblaster -C ldp.json -l ldp -S run.sock -P ldp.pcap
4 changes: 2 additions & 2 deletions docs/_sources/routing/bgp.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -67,8 +67,8 @@ but not limited to update messages.

.. code-block:: none
0 1 2 3
0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
0 1 2 3
0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
| |
+ +
Expand Down
3 changes: 2 additions & 1 deletion docs/_sources/routing/index.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,6 @@ router testing.
:maxdepth: 1

isis.rst
bgp.rst
mpls.rst
bgp.rst
ldp.rst
Loading

0 comments on commit 7a38a89

Please sign in to comment.