Merge branch 'playground'

.github/test_playground.sh

@@ -0,0 +1,90 @@
+#!/bin/bash
+
+set -e
+
+error=0
+
+function pr_bold() {
+    echo -e "\033[1m$@\033[0m"
+}
+
+function run_on() {
+    set +e
+    docker-compose exec -T $1 bash -c "$2"
+
+    if [ $? -eq 0 ]; then
+        res="OK"
+    else
+        res="Failed"
+        error=1
+    fi
+
+    set -e
+
+    pr_bold "$1: $2 $res"
+}
+
+docker-compose version
+
+cd tools/playground
+
+if [ "$CI" == "true" ]; then
+    export INSTALL_FROM_SRC=1
+fi
+
+docker-compose build
+
+docker-compose up -d
+
+# Let run.sh configure ARouteServer...
+echo -n "Waiting a bit till run.sh configures everything... "
+sleep 60
+echo "OK, let's move now!"
+
+run_on rs 'birdc show protocols | grep BGP | grep Established | wc -l | grep 2'
+
+run_on alice_lg 'curl -L http://10.0.0.2:29184/protocols/bgp'
+
+run_on client_2 'birdc show route count | grep "2 of 2 routes for 2 networks"'
+run_on client_2 'birdc show route | grep 193.0.0.0/21 | grep "via 10.0.0.11"'
+
+# Valid routes on the RS.
+run_on rs 'birdc show route count | grep "3 of 3 routes for 3 networks"'
+
+for prefix in \
+    192.136.136.0/24 \
+    193.0.0.0/21 \
+    193.0.22.0/23
+do
+    run_on rs "birdc show route $prefix | grep $prefix"
+done
+
+# Filtered routes on the RS.
+run_on rs 'birdc show route filtered count | grep "4 of 4 routes for 4 networks"'
+
+for prefix in \
+    10.0.0.0/24 \
+    192.168.0.0/24 \
+    193.0.0.1/32 \
+    202.12.29.0/24
+do
+    run_on rs "birdc show route filtered $prefix | grep $prefix"
+done
+
+run_on rs "birdc show route filtered 10.0.0.0/24 all | grep '(64500, 65520, 3)'"
+run_on rs "birdc show route filtered 202.12.29.0/24 all | grep '(64500, 65520, 9)'"
+
+pr_bold "Testing localhost, Alice at port 8080..."
+curl -L http://127.0.0.1:8080 | grep 'Alice - The friendly BGP looking glass'
+pr_bold "Testing localhost, Alice at port 8080... OK"
+
+echo ""
+echo ""
+
+if [ $error -eq 0 ]; then
+    pr_bold "Tests completed successfully!"
+    exit 0
+else:
+    pr_bold "Tests failed :-("
+    exit 1
+fi

.github/workflows/test_playground.yml

@@ -0,0 +1,18 @@
+name: Playground tests
+
+on: push
+
+jobs:
+  test-playground:
+    name: Playground tests
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Run Playground tests
+        run: .github/test_playground.sh
+        env:
+          DEFAULT_BRANCH: main
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

COPYRIGHT

@@ -1,4 +1,4 @@
-# Copyright (C) 2017-2020 Pier Carlo Chiodi
+# Copyright (C) 2017-2021 Pier Carlo Chiodi
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by

README.rst

@@ -46,6 +46,8 @@ How it works
 
 **Validation** and testing of the configurations generated with this tool are performed using the built-in **live tests** framework: `Docker`_ instances are used to simulate several scenarios and to validate the behaviour of the route server after configuring it with ARouteServer. More details on the `Live tests <https://arouteserver.readthedocs.io/en/latest/LIVETESTS.html>`_ section.
 
+A Docker-based `playground <https://github.com/pierky/arouteserver/tree/master/tools/playground>`__ is available to experiment with the tool in a virtual IXP environment.
+
 .. _bgpq3: https://github.com/snar/bgpq3
 .. _bgpq4: https://github.com/bgp/bgpq4
 .. _PeeringDB: https://www.peeringdb.com/
@@ -116,6 +118,8 @@ Features
 
 - Related tools:
 
+  - The `Playground <https://github.com/pierky/arouteserver/tree/master/tools/playground>`__, to experiment with the tool in a virtual IXP environment.
+
   - `Invalid routes reporter <https://arouteserver.readthedocs.io/en/latest/TOOLS.html#invalid-routes-reporter>`__, to log or report invalid routes and their reject reason.
 
 A comprehensive list of features can be found within the comments of the distributed configuration file on `GitHub <https://github.com/pierky/arouteserver/blob/master/config.d/general.yml>`__ or on the `documentation web page <https://arouteserver.readthedocs.io/en/latest/GENERAL.html>`__.
@@ -159,6 +163,8 @@ Who is using ARouteServer?
 
 - `GAVLIX <https://gavlix.se/>`__.
 
+- `IX Australia <https://www.ix.asn.au/>`__, BIRD v2.
+
 - `IX-Denver <http://ix-denver.org/>`__, BIRD.
 
 - `MBIX <http://www.mbix.ca/>`__, BIRD.
@@ -169,6 +175,8 @@ Who is using ARouteServer?
 
 - `NIXI Mumbai (GPX) <https://nixi.in/>`__, BIRD.
 
+- `NZIX <https://ix.nz/>`__, BIRD v2.
+
 - `PIT-IX <https://pit-ix.net/>`__, BIRD.
 
 - `QCIX <http://www.qcix.net/>`__, BIRD.

docs/CONFIG.rst

@@ -35,6 +35,8 @@ Route server's general configuration and policies are outlined in the ``general.
 
 Configuration details and options can be found within the distributed `general <https://github.com/pierky/arouteserver/blob/master/config.d/general.yml>`__ and `clients <https://github.com/pierky/arouteserver/blob/master/config.d/clients.yml>`__ configuration files on GitHub or in the :doc:`GENERAL` page.
 
+A Docker-based `playground <https://github.com/pierky/arouteserver/tree/master/tools/playground>`__ is available to experiment with the settings in a virtual IXP environment.
+
 Details about some particular topics are reported below.
 
 .. contents::

docs/FEATURES.rst

@@ -36,6 +36,8 @@ How it works
 
 **Validation** and testing of the configurations generated with this tool are performed using the built-in **live tests** framework: `Docker`_ instances are used to simulate several scenarios and to validate the behaviour of the route server after configuring it with ARouteServer. More details on the `Live tests <https://arouteserver.readthedocs.io/en/latest/LIVETESTS.html>`_ section.
 
+A Docker-based `playground <https://github.com/pierky/arouteserver/tree/master/tools/playground>`__ is available to experiment with the tool in a virtual IXP environment.
+
 .. _bgpq3: https://github.com/snar/bgpq3
 .. _bgpq4: https://github.com/bgp/bgpq4
 .. _PeeringDB: https://www.peeringdb.com/
@@ -106,6 +108,8 @@ Features
 
 - Related tools:
 
+  - The `Playground <https://github.com/pierky/arouteserver/tree/master/tools/playground>`__, to experiment with the tool in a virtual IXP environment.
+
   - `Invalid routes reporter <https://arouteserver.readthedocs.io/en/latest/TOOLS.html#invalid-routes-reporter>`__, to log or report invalid routes and their reject reason.
 
 A comprehensive list of features can be found within the comments of the distributed configuration file on `GitHub <https://github.com/pierky/arouteserver/blob/master/config.d/general.yml>`__ or on the `documentation web page <https://arouteserver.readthedocs.io/en/latest/GENERAL.html>`__.

docs/INSTALLATION.rst

@@ -1,6 +1,9 @@
 Installation
 ============
 
+.. Hint::
+   A Docker-based `playground <https://github.com/pierky/arouteserver/tree/master/tools/playground>`__ is available to experiment with the installation and configuration steps reported in this section.
+
 Dependencies
 ------------
 

docs/STATUS.txt

@@ -25,6 +25,8 @@ Who is using ARouteServer?
 
 - `GAVLIX <https://gavlix.se/>`__.
 
+- `IX Australia <https://www.ix.asn.au/>`__, BIRD v2.
+
 - `IX-Denver <http://ix-denver.org/>`__, BIRD.
 
 - `MBIX <http://www.mbix.ca/>`__, BIRD.
@@ -35,6 +37,8 @@ Who is using ARouteServer?
 
 - `NIXI Mumbai (GPX) <https://nixi.in/>`__, BIRD.
 
+- `NZIX <https://ix.nz/>`__, BIRD v2.
+
 - `PIT-IX <https://pit-ix.net/>`__, BIRD.
 
 - `QCIX <http://www.qcix.net/>`__, BIRD.

docs/TOOLS.rst

@@ -1,5 +1,20 @@
-.. DO NOT EDIT: this file is automatically created by /utils/build_doc
-
 Tools
 =====
-.. include:: TOOLS_invalid_routes_reporter.rst
+
+Playground
+----------
+
+This is a Docker-based playground that can be use to experiment with ARouteServer.
+
+It offers and environment with several actors, configured to represent specific scenarios that can often be found on a real IX platform: a route server, some clients that announce some good and some bad routes, a looking glass.
+
+The idea is to let the users play with the whole environment and see how easy it is to deploy a secure, feature-rich route server.
+
+For more information: https://github.com/pierky/arouteserver/tree/master/tools/playground
+
+Invalid routes reporter
+-----------------------
+
+This script is intended to be used as an `ExaBGP <https://github.com/Exa-Networks/exabgp>`_ process to elaborate and report/log invalid routes received by route servers that have been previously configured using the `"tag" reject policy option <https://arouteserver.readthedocs.io/en/latest/CONFIG.html#reject-policy>`_ of ARouteServer.
+
+For more information: https://invalidroutesreporter.readthedocs.io

docs/USAGE.rst

@@ -37,6 +37,9 @@ It can be scheduled at regular intervals to re-build the configuration (for exam
         cp /etc/bird/bird4.new /etc/bird/bird4.conf && \
         birdcl configure
 
+.. Hint::
+   A Docker-based `playground <https://github.com/pierky/arouteserver/tree/master/tools/playground>`__ is available to experiment with the tool.
+
 .. _perform-graceful-shutdown:
 
 Route server graceful shutdown

pierky/__init__.py

@@ -1,4 +1,4 @@
-# Copyright (C) 2017-2020 Pier Carlo Chiodi
+# Copyright (C) 2017-2021 Pier Carlo Chiodi
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by

pierky/arouteserver/__init__.py

@@ -1,4 +1,4 @@
-# Copyright (C) 2017-2020 Pier Carlo Chiodi
+# Copyright (C) 2017-2021 Pier Carlo Chiodi
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by

pierky/arouteserver/arin_db_dump.py

@@ -1,4 +1,4 @@
-# Copyright (C) 2017-2020 Pier Carlo Chiodi
+# Copyright (C) 2017-2021 Pier Carlo Chiodi
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by

pierky/arouteserver/ask.py

@@ -1,4 +1,4 @@
-# Copyright (C) 2017-2020 Pier Carlo Chiodi
+# Copyright (C) 2017-2021 Pier Carlo Chiodi
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by

pierky/arouteserver/builder.py

@@ -1,4 +1,4 @@
-# Copyright (C) 2017-2020 Pier Carlo Chiodi
+# Copyright (C) 2017-2021 Pier Carlo Chiodi
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by

pierky/arouteserver/cached_objects.py

@@ -1,4 +1,4 @@
-# Copyright (C) 2017-2020 Pier Carlo Chiodi
+# Copyright (C) 2017-2021 Pier Carlo Chiodi
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by

pierky/arouteserver/commands/__init__.py

@@ -1,4 +1,4 @@
-# Copyright (C) 2017-2020 Pier Carlo Chiodi
+# Copyright (C) 2017-2021 Pier Carlo Chiodi
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by

pierky/arouteserver/commands/base.py

@@ -1,4 +1,4 @@
-# Copyright (C) 2017-2020 Pier Carlo Chiodi
+# Copyright (C) 2017-2021 Pier Carlo Chiodi
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by

pierky/arouteserver/commands/check_new_release.py

@@ -1,4 +1,4 @@
-# Copyright (C) 2017-2020 Pier Carlo Chiodi
+# Copyright (C) 2017-2021 Pier Carlo Chiodi
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by

pierky/arouteserver/commands/clients_from_euroix.py

@@ -1,4 +1,4 @@
-# Copyright (C) 2017-2020 Pier Carlo Chiodi
+# Copyright (C) 2017-2021 Pier Carlo Chiodi
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by

pierky/arouteserver/commands/clients_from_peeringdb.py

@@ -1,4 +1,4 @@
-# Copyright (C) 2017-2020 Pier Carlo Chiodi
+# Copyright (C) 2017-2021 Pier Carlo Chiodi
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by

pierky/arouteserver/commands/configure.py

@@ -1,4 +1,4 @@
-# Copyright (C) 2017-2020 Pier Carlo Chiodi
+# Copyright (C) 2017-2021 Pier Carlo Chiodi
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by

pierky/arouteserver/commands/init_scenario.py

@@ -1,4 +1,4 @@
-# Copyright (C) 2017-2020 Pier Carlo Chiodi
+# Copyright (C) 2017-2021 Pier Carlo Chiodi
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by

pierky/arouteserver/commands/ixf_member_list_from_clients.py

@@ -1,4 +1,4 @@
-# Copyright (C) 2017-2020 Pier Carlo Chiodi
+# Copyright (C) 2017-2021 Pier Carlo Chiodi
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by

pierky/arouteserver/commands/setup.py

@@ -1,4 +1,4 @@
-# Copyright (C) 2017-2020 Pier Carlo Chiodi
+# Copyright (C) 2017-2021 Pier Carlo Chiodi
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by

pierky/arouteserver/commands/setup_templates.py

@@ -1,4 +1,4 @@
-# Copyright (C) 2017-2020 Pier Carlo Chiodi
+# Copyright (C) 2017-2021 Pier Carlo Chiodi
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by

pierky/arouteserver/commands/show_config.py

@@ -1,4 +1,4 @@
-# Copyright (C) 2017-2020 Pier Carlo Chiodi
+# Copyright (C) 2017-2021 Pier Carlo Chiodi
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by

pierky/arouteserver/commands/tpl_rendering.py

@@ -1,4 +1,4 @@
-# Copyright (C) 2017-2020 Pier Carlo Chiodi
+# Copyright (C) 2017-2021 Pier Carlo Chiodi
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by

pierky/arouteserver/commands/verify_templates.py

@@ -1,4 +1,4 @@
-# Copyright (C) 2017-2020 Pier Carlo Chiodi
+# Copyright (C) 2017-2021 Pier Carlo Chiodi
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by

pierky/arouteserver/config/__init__.py

@@ -1,4 +1,4 @@
-# Copyright (C) 2017-2020 Pier Carlo Chiodi
+# Copyright (C) 2017-2021 Pier Carlo Chiodi
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by

pierky/arouteserver/config/asns.py

@@ -1,4 +1,4 @@
-# Copyright (C) 2017-2020 Pier Carlo Chiodi
+# Copyright (C) 2017-2021 Pier Carlo Chiodi
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by

pierky/arouteserver/config/base.py

@@ -1,4 +1,4 @@
-# Copyright (C) 2017-2020 Pier Carlo Chiodi
+# Copyright (C) 2017-2021 Pier Carlo Chiodi
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by

pierky/arouteserver/config/bogons.py

@@ -1,4 +1,4 @@
-# Copyright (C) 2017-2020 Pier Carlo Chiodi
+# Copyright (C) 2017-2021 Pier Carlo Chiodi
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by

pierky/arouteserver/config/clients.py

@@ -1,4 +1,4 @@
-# Copyright (C) 2017-2020 Pier Carlo Chiodi
+# Copyright (C) 2017-2021 Pier Carlo Chiodi
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by

pierky/arouteserver/config/general.py

@@ -1,4 +1,4 @@
-# Copyright (C) 2017-2020 Pier Carlo Chiodi
+# Copyright (C) 2017-2021 Pier Carlo Chiodi
 #
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by