From 693ea8a26f5d5bf14a8d4c05d8d8340b1619574f Mon Sep 17 00:00:00 2001 From: Christian Giese Date: Mon, 2 May 2022 17:40:19 +0200 Subject: [PATCH 1/2] update documentation sources --- docsrc/sources/controller.rst | 24 ++++++++++++++++++++++++ docsrc/sources/index.rst | 1 + 2 files changed, 25 insertions(+) create mode 100644 docsrc/sources/controller.rst diff --git a/docsrc/sources/controller.rst b/docsrc/sources/controller.rst new file mode 100644 index 00000000..1dc825fe --- /dev/null +++ b/docsrc/sources/controller.rst @@ -0,0 +1,24 @@ +.. _controller: + +Controller +========== + +The BNG Blaster controller provides a REST API to start and stop multiple test instances. +It exposes the BNG Blaster :ref:`JSON RPC API ` as REST API and provides endpoints +to download logs and reports. + +https://github.com/rtbrick/bngblaster-controller + +Installation +------------ + +The BNG Blaster controller should run on any modern linux distribution +but is primary tested on Ubuntu 18.04 LTS and Ubuntu 20.04 LTS. + +Download and install debian package: https://github.com/rtbrick/bngblaster-controller/releases + +API +--- + +https://rtbrick.github.io/bngblaster-controller/ + diff --git a/docsrc/sources/index.rst b/docsrc/sources/index.rst index 5380aa14..099d7788 100644 --- a/docsrc/sources/index.rst +++ b/docsrc/sources/index.rst @@ -71,6 +71,7 @@ Contents reports configuration/index api/index + controller troubleshooting reference/index faq From a5939fc24e768727d91ac1fe168eeade936fc0b7 Mon Sep 17 00:00:00 2001 From: Christian Giese Date: Mon, 2 May 2022 17:40:37 +0200 Subject: [PATCH 2/2] update github pages --- docs/_sources/controller.rst.txt | 24 ++++ docs/_sources/index.rst.txt | 1 + docs/access/index.html | 1 + docs/access/ipoe.html | 1 + docs/access/l2bsa.html | 1 + docs/access/l2tp.html | 1 + docs/access/li.html | 1 + docs/access/multicast.html | 1 + docs/access/pppoe.html | 1 + docs/access/traffic.html | 1 + docs/api/bgp.html | 1 + docs/api/cfm.html | 1 + docs/api/igmp.html | 1 + docs/api/index.html | 5 +- docs/api/interfaces.html | 1 + docs/api/isis.html | 1 + docs/api/l2tp.html | 1 + docs/api/li.html | 1 + docs/api/ppp.html | 1 + docs/api/sessions.html | 1 + docs/api/streams.html | 1 + docs/api/traffic.html | 1 + docs/configuration/access_line.html | 1 + docs/configuration/access_line_profiles.html | 1 + docs/configuration/bgp.html | 1 + docs/configuration/dhcp.html | 1 + docs/configuration/dhcpv6.html | 1 + docs/configuration/igmp.html | 1 + docs/configuration/index.html | 1 + docs/configuration/interfaces.html | 1 + docs/configuration/interfaces_a10nsp.html | 1 + docs/configuration/interfaces_access.html | 1 + docs/configuration/interfaces_network.html | 1 + docs/configuration/ipoe.html | 1 + docs/configuration/isis.html | 1 + docs/configuration/isis_external.html | 1 + .../isis_external_connections.html | 1 + docs/configuration/lns.html | 1 + docs/configuration/ppp.html | 1 + docs/configuration/ppp_authentication.html | 1 + docs/configuration/ppp_ip6cp.html | 1 + docs/configuration/ppp_ipcp.html | 1 + docs/configuration/ppp_lcp.html | 1 + docs/configuration/pppoe.html | 1 + docs/configuration/session_traffic.html | 1 + docs/configuration/sessions.html | 1 + docs/configuration/streams.html | 1 + docs/configuration/traffic.html | 1 + docs/controller.html | 135 ++++++++++++++++++ docs/faq.html | 1 + docs/genindex.html | 1 + docs/index.html | 2 + docs/install.html | 1 + docs/interfaces.html | 1 + docs/objects.inv | Bin 1141 -> 1164 bytes docs/quickstart.html | 1 + docs/reference/architecture.html | 1 + docs/reference/index.html | 1 + docs/reference/traffic.html | 1 + docs/reports.html | 1 + docs/routing/bgp.html | 1 + docs/routing/index.html | 1 + docs/routing/isis.html | 1 + docs/routing/mpls.html | 1 + docs/search.html | 1 + docs/searchindex.js | 2 +- docs/streams.html | 1 + docs/troubleshooting.html | 5 +- 68 files changed, 229 insertions(+), 5 deletions(-) create mode 100644 docs/_sources/controller.rst.txt create mode 100644 docs/controller.html diff --git a/docs/_sources/controller.rst.txt b/docs/_sources/controller.rst.txt new file mode 100644 index 00000000..1dc825fe --- /dev/null +++ b/docs/_sources/controller.rst.txt @@ -0,0 +1,24 @@ +.. _controller: + +Controller +========== + +The BNG Blaster controller provides a REST API to start and stop multiple test instances. +It exposes the BNG Blaster :ref:`JSON RPC API ` as REST API and provides endpoints +to download logs and reports. + +https://github.com/rtbrick/bngblaster-controller + +Installation +------------ + +The BNG Blaster controller should run on any modern linux distribution +but is primary tested on Ubuntu 18.04 LTS and Ubuntu 20.04 LTS. + +Download and install debian package: https://github.com/rtbrick/bngblaster-controller/releases + +API +--- + +https://rtbrick.github.io/bngblaster-controller/ + diff --git a/docs/_sources/index.rst.txt b/docs/_sources/index.rst.txt index 5380aa14..099d7788 100644 --- a/docs/_sources/index.rst.txt +++ b/docs/_sources/index.rst.txt @@ -71,6 +71,7 @@ Contents reports configuration/index api/index + controller troubleshooting reference/index faq diff --git a/docs/access/index.html b/docs/access/index.html index f91f29c0..3ca38dc2 100644 --- a/docs/access/index.html +++ b/docs/access/index.html @@ -58,6 +58,7 @@ Reports Configuration API/CLI +Controller Troubleshooting Reference Frequently Asked Questions diff --git a/docs/access/ipoe.html b/docs/access/ipoe.html index f84be7b7..b7deafd5 100644 --- a/docs/access/ipoe.html +++ b/docs/access/ipoe.html @@ -68,6 +68,7 @@ Reports Configuration API/CLI +Controller Troubleshooting Reference Frequently Asked Questions diff --git a/docs/access/l2bsa.html b/docs/access/l2bsa.html index 1af8dbb6..d226bf15 100644 --- a/docs/access/l2bsa.html +++ b/docs/access/l2bsa.html @@ -58,6 +58,7 @@ Reports Configuration API/CLI +Controller Troubleshooting Reference Frequently Asked Questions diff --git a/docs/access/l2tp.html b/docs/access/l2tp.html index e4d90c25..3ff249de 100644 --- a/docs/access/l2tp.html +++ b/docs/access/l2tp.html @@ -64,6 +64,7 @@ Reports Configuration API/CLI +Controller Troubleshooting Reference Frequently Asked Questions diff --git a/docs/access/li.html b/docs/access/li.html index f4e239d7..4c33eea1 100644 --- a/docs/access/li.html +++ b/docs/access/li.html @@ -58,6 +58,7 @@ Reports Configuration API/CLI +Controller Troubleshooting Reference Frequently Asked Questions diff --git a/docs/access/multicast.html b/docs/access/multicast.html index d2e57516..18d4bd79 100644 --- a/docs/access/multicast.html +++ b/docs/access/multicast.html @@ -64,6 +64,7 @@ Reports Configuration API/CLI +Controller Troubleshooting Reference Frequently Asked Questions diff --git a/docs/access/pppoe.html b/docs/access/pppoe.html index 69103964..5f2833cf 100644 --- a/docs/access/pppoe.html +++ b/docs/access/pppoe.html @@ -71,6 +71,7 @@ Reports Configuration API/CLI +Controller Troubleshooting Reference Frequently Asked Questions diff --git a/docs/access/traffic.html b/docs/access/traffic.html index 31310b1a..440aec05 100644 --- a/docs/access/traffic.html +++ b/docs/access/traffic.html @@ -62,6 +62,7 @@ Reports Configuration API/CLI +Controller Troubleshooting Reference Frequently Asked Questions diff --git a/docs/api/bgp.html b/docs/api/bgp.html index b2a5c3d8..f4cfe803 100644 --- a/docs/api/bgp.html +++ b/docs/api/bgp.html @@ -47,6 +47,7 @@ Reports Configuration API/CLI +Controller Troubleshooting Reference Frequently Asked Questions diff --git a/docs/api/cfm.html b/docs/api/cfm.html index 6d664cee..65aab96d 100644 --- a/docs/api/cfm.html +++ b/docs/api/cfm.html @@ -47,6 +47,7 @@ Reports Configuration API/CLI +Controller Troubleshooting Reference Frequently Asked Questions diff --git a/docs/api/igmp.html b/docs/api/igmp.html index ff528d2f..7d8d319a 100644 --- a/docs/api/igmp.html +++ b/docs/api/igmp.html @@ -47,6 +47,7 @@ Reports Configuration API/CLI +Controller Troubleshooting Reference Frequently Asked Questions diff --git a/docs/api/index.html b/docs/api/index.html index 7c775b6b..7c1eec3a 100644 --- a/docs/api/index.html +++ b/docs/api/index.html @@ -19,7 +19,7 @@ - + @@ -63,6 +63,7 @@ Legal Interception (LI) +Controller Troubleshooting Reference Frequently Asked Questions @@ -696,7 +697,7 @@ session-id for which a connect speed update is requested.