<p>This section walks you through the process of running experiments in TeraFlowSDN on top of a machine running MicroK8s Kubernetes platform.
The guide includes the details on configuring the Python environment, some basic commands you might need, configuring the network topology, and executing different experiments.</p>
<p>Note that the steps followed here are likely to work regardless of the platform where TeraFlowSDN is deployed over.</p>
<p>Note also that this guide will keep growing with the new experiments and demonstrations that are being carried out involving the ETSI TeraFlowSDN controller.</p>
<p><strong>Important:</strong> The NBIs, workflows and drivers have to be considered as experimental. The configuration and monitoring capabilities they support are limited, partially implemented, or tested only with specific laboratory equipment. Use them with care.</p>
<p>This functional test reproduces the live demonstration <em>Demonstration of Zero-touch Device and L3-VPN Service Management Using the TeraFlow Cloud-native SDN Controller</em> carried out at <ahref="https://ieeexplore.ieee.org/document/9748575">OFC'22</a> / <ahref="https://research.chalmers.se/en/publication/c397ef36-837f-416d-a44d-6d3b561d582a">Open access</a>.</p>
<p>The main features demonstrated are:</p>
<ul>
<li>Bootstrapping of devices</li>
<li>Monitoring of device endpoints</li>
<li>Management of L3VPN services</li>
<li>Integration with ETSI OpenSourceMANO</li>
</ul>
<h3><u>Functional test folder</h3>
<p></u></p>
<p>This functional test can be found in folder <code>./src/tests/ofc22/</code>.</p>
<h3><u>Execute with real devices</h3>
<p></u></p>
<p>This functional test is designed to operate both with real and emulated devices.
By default, emulated devices are used; however, if you have access to real devices, you can create/modify the files <code>./src/tests/ofc22/tests/Objects.py</code> and <code>./src/tests/ofc22/tests/Credentials.py</code> to point to your devices, and map to your own network topology.
Otherwise, you can modify the <code>./src/tests/ofc22/tests/descriptors_emulated.json</code> that is designed to be uploaded through the WebUI instead of using the command line scripts.
Note that the default scenario assumes devices R2 and R4 are always emulated, while
devices R1, R3, and O1 can be configured as emulated or real devices.</p>
<p><strong>Important</strong>: The device drivers operating with real devices, e.g., OpenConfigDriver,
P4Driver, and TransportApiDriver, have to be considered as experimental.
The configuration and monitoring capabilities they support are
limited or partially implemented/tested. Use them with care.</p>
<h3><u>Deployment and Dependencies</h3>
<p></u></p>
<p>To run this functional test, it is assumed you have deployed a MicroK8s-based Kubernetes environment and a TeraFlowSDN controller instance as described in the <ahref="https://tfs.etsi.org/documentation/develop/deployment_guide/">Tutorial: Deployment Guide</a>, and you configured the Python environment as described in <ahref="https://tfs.etsi.org/documentation/develop/development_guide/#211-python">Tutorial: Development Guide > Configure Environment > Python</a>.</p>
<h3><u>Access to the WebUI and Dashboard</h3>
<p></u></p>
<p>When the deployment completes, you can connect to the TeraFlowSDN WebUI and Dashboards as described in <ahref="https://tfs.etsi.org/documentation/develop/deployment_guide/#14-webui-and-grafana-dashboards">Tutorial: Deployment Guide > WebUI and Grafana Dashboards</a></p>
<p>Notes:</p>
<ul>
<li>the default credentials for the Grafana Dashboiard is user/pass: <code>admin</code>/<code>admin123+</code>.</li>
<li>in Grafana, you will find the <em>L3-Monitorng</em> in the <em>Starred dashboards</em> section.</li>
</ul>
<h3><u>Test execution</h3>
<p></u></p>
<p>Before executing the tests, we need to prepare a few things.</p>
<p>First, you need to make sure that you have all the gRPC-generate code in your folder.
To do so, run:</p>
<pre><code>proto/generate_code_python.sh
</code></pre>
<p>Then, it is time to deploy TeraFlowSDN with the correct specification for this scenario.
Make sure to load your deployment variables for this scenario by:</p>
<pre><code>source src/tests/ofc22/deploy_specs.sh
</code></pre>
<p>Then, you need to deploy the components by running:</p>
<pre><code>./deploy/all.sh
</code></pre>
<p>After the deployment is finished, you need to load the environment variables to support the execution of the tests by:</p>
<pre><code>source tfs_runtime_env_vars.sh
</code></pre>
<p>To execute this functional test, four main steps needs to be carried out:</p>
<ol>
<li>Device bootstrapping</li>
<li>L3VPN Service creation</li>
<li>L3VPN Service removal</li>
<li>Cleanup</li>
</ol>
<p>Upon the execution of each test progresses, a report will be generated indicating <em>PASSED</em> / <em>FAILED</em> / <em>SKIPPED</em>. If there is some error during the execution, you should see a detailed report on the error. See the troubleshooting section if needed.</p>
<p>You can check the logs of the different components using the appropriate <code>scripts/show_logs_[component].sh</code> scripts after you execute each step.</p>
<p>There are two ways to execute the functional tests, <em>running all the tests with a single script</em> or <em>running each test independently</em>.
In the following we start with the first option, then we comment on how to run each test independently.</p>
<p><strong>Running all tests with a single script</strong></p>
<p>We have a script that executes all the steps at once.
It is meant for being used to test if all components involved in this scenario are working correct.
To run all the functional tests, you can run:</p>
<pre><code>src/tests/ofc22/run_tests.sh
</code></pre>
<p>The following sections explain each one of the steps.</p>
<p><strong>Device bootstrapping</strong></p>
<p>This step configures some basic entities (Context and Topology), the devices, and the
links in the topology.
The expected results are:</p>
<ul>
<li>The devices to be added into the Topology.</li>
<li>The devices to be pre-configured and initialized as ENABLED by the Automation component.</li>
<li>The monitoring for the device ports (named as endpoints in TeraFlowSDN) to be activated and data collection to automatically start.</li>
<li>The links to be added to the topology.</li>
</ul>
<p>To run this step, you can do it from the WebUI by uploading the file <code>./ofc22/tests/descriptors_emulated.json</code> that
contains the descriptors of the contexts, topologies, devices, and links, or by
<p>When the script finishes, check the WebUI <em>Services</em> tab. You should see that two services have been created, one for the optical layer and another for the packet layer.
Besides, you can check the <em>Devices</em> tab to see the configuration rules that have been configured in each device. In the Grafana Dashboard, given that there is now a service configured, you should see the plots with the monitored data for the device. By default, device R1-EMU is selected.</p>
<p><strong>L3VPN Service removal</strong></p>
<p>This step deconfigures the previously created services emulating the request an OSM WIM would make by means of a Mock OSM instance.</p>
<p>When the script finishes, check the WebUI <em>Services</em> tab. You should see that the two services have been removed. Besides, in the <em>Devices</em> tab you can see that the appropriate configuration rules have been deconfigured. In the Grafana Dashboard, given that there is no service configured, you should see a 0-valued flat plot again.</p>
<p><strong>Cleanup</strong></p>
<p>This last step performs a cleanup of the scenario removing all the TeraFlowSDN entities for completeness.
<p>When the script finishes, check the WebUI <em>Devices</em> tab, you should see that the devices have been removed. Besides, in the <em>Services</em> tab you can see that the "admin" Context has no services given that that context has been removed.</p>
<p>This functional test reproduces the experimental assessment of <em>Experimental Demonstration of Transport Network Slicing with SLA Using the TeraFlowSDN Controller</em> presented at <ahref="https://www.optica.org/en-us/events/topical_meetings/ecoc/schedule/?day=Tuesday#Tuesday">ECOC'22</a> / <ahref="https://ieeexplore.ieee.org/abstract/document/9979396">IEEEXplore</a>.</p>
<p>The main features demonstrated are:</p>
<ul>
<li>Disjoint DC-2-DC L2VPN Service management</li>
<li>Integration with ETSI OpenSourceMANO</li>
</ul>
<h3><u>Functional test folder</h3>
<p></u></p>
<p>This functional test can be found in folder <code>./src/tests/ecoc22/</code>.</p>
<h3><u>Execute with real devices</h3>
<p></u></p>
<p>This functional test has only been tested with emulated devices; however, if you have access to real devices, you can modify the files <code>./src/tests/ecoc22/tests/Objects.py</code> and <code>./src/tests/ecoc22/tests/Credentials.py</code> to point to your devices, and map to your network topology. Otherwise, you can modify the <code>./src/tests/ecoc22/tests/descriptors_emulated.json</code> that is designed to be uploaded through the WebUI instead of using the command line scripts.</p>
<p><strong>Important</strong>: The device drivers operating with real devices, e.g., OpenConfigDriver,
P4Driver, and TransportApiDriver, have to be considered as experimental.
The configuration and monitoring capabilities they support are
limited or partially implemented/tested. Use them with care.</p>
<h3><u>Deployment and Dependencies</h3>
<p></u></p>
<p>To run this functional test, it is assumed you have deployed a MicroK8s-based Kubernetes environment and a TeraFlowSDN controller instance as described in the <ahref="https://tfs.etsi.org/documentation/develop/deployment_guide/">Tutorial: Deployment Guide</a>, and you configured the Python environment as described in <ahref="https://tfs.etsi.org/documentation/develop/development_guide/#211-python">Tutorial: Development Guide > Configure Environment > Python</a>.</p>
<h3><u>Access to the WebUI</h3>
<p></u></p>
<p>When the deployment completes, you can connect to the TeraFlowSDN WebUI as described in <ahref="https://tfs.etsi.org/documentation/develop/deployment_guide/#14-webui-and-grafana-dashboards">Tutorial: Deployment Guide > WebUI and Grafana Dashboards</a></p>
<p>Notes:</p>
<ul>
<li>this experiment does not make use of Monitoring, so Grafana is not used.</li>
<li>the default credentials for the Grafana Dashboard is user/pass: <code>admin</code>/<code>admin123+</code>.</li>
<li>this functional test does not involve the Monitoring component, so no monitoring
data is plotted in Grafana.</li>
</ul>
<h3><u>Test execution</h3>
<p></u></p>
<p>Before executing the tests, we need to prepare a few things.</p>
<p>First, you need to make sure that you have all the gRPC-generate code in your folder. To do so, run:</p>
<pre><code>proto/generate_code_python.sh
</code></pre>
<p>Second, it is time to deploy TeraFlowSDN with the correct specification for this scenario. Make sure to load your deployment variables for this scenario by:</p>
<p>Then, you need to deploy the components by running:</p>
<pre><code>./deploy/all.sh
</code></pre>
<p>After the deployment is finished, you need to load the environment variables to support the execution of the tests by:</p>
<pre><code>source tfs_runtime_env_vars.sh
</code></pre>
<p>To execute this functional test, four main steps needs to be carried out:</p>
<ol>
<li>Device bootstrapping</li>
<li>L2VPN Slice and Services creation</li>
<li>L2VPN Slice and Services removal</li>
<li>Cleanup</li>
</ol>
<p>Upon the execution of each test progresses, a report will be generated indicating
<em>PASSED</em> / <em>FAILED</em> / <em>SKIPPED</em>. If there is some error during the execution, you should see a detailed report on the error. See the troubleshooting section if needed.</p>
<p>You can check the logs of the different components using the appropriate
<code>scripts/show_logs_[component].sh</code> scripts after you execute each step.</p>
<p><strong>Device bootstrapping</strong></p>
<p>This step configures some basic entities (Context and Topology), the devices, and the links in the topology.
The expected results are:</p>
<ul>
<li>The devices to be added into the Topology.</li>
<li>The devices to be pre-configured and initialized as <em>ENABLED</em> by the Automation component.</li>
<li>The links to be added to the topology.</li>
</ul>
<p>To run this step, you can do it from the WebUI by uploading the file <code>./src/tests/ecoc22/tests/descriptors_emulated.json</code> that contains the descriptors of the contexts, topologies, devices, and links, or by executing the <code>./src/tests/ecoc22/run_test_01_bootstrap.sh</code> script.</p>
<p>In the WebUI, select the <em>admin</em> Context. Then, in the <em>Devices</em> tab you should see that 5 different emulated devices have been
created and activated: 4 packet routers, and 1 optical Open Line System (OLS) controller. Besides, in the <em>Services</em> tab you should see that there is no service created. </p>
<p><strong>L2VPN Slice and Services creation</strong></p>
<p>This step configures a new service emulating the request an OSM WIM would make by means of a Mock OSM instance.</p>
<p>To run this step, execute the <code>./src/tests/ecoc22/run_test_02_create_service.sh</code> script.</p>
<p>When the script finishes, check the WebUI <em>Slices</em> and <em>Services</em> tab. You should see that, for the connectivity service requested by MockOSM, one slice has been created, three services have been created (two for the optical layer and another for the packet layer). Note that the two services for the optical layer correspond to the primary (service_uuid ending with ":0") and the backup (service_uuid ending with ":1") services. Each of the services indicates the connections and sub-services that are supporting them. Besides, you can check the <em>Devices</em> tab to see the configuration rules that have been
configured in each device.</p>
<p><strong>L2VPN Slice and Services removal</strong></p>
<p>This step deconfigures the previously created slices and services emulating the request an OSM WIM would make by means of a Mock OSM instance.</p>
<p>To run this step, execute the <code>./src/tests/ecoc22/run_test_03_delete_service.sh</code> script, or delete the slice from the WebUI.</p>
<p>When the script finishes, check the WebUI <em>Slices</em> and <em>Services</em> tab. You should see that the slice and the services have been removed.
Besides, in the <em>Devices</em> tab you can see that the appropriate configuration rules have been deconfigured.</p>
<p><strong>Cleanup</strong></p>
<p>This last step performs a cleanup of the scenario removing all the TeraFlowSDN entities for completeness.</p>
<p>To run this step, execute the <code>./src/tests/ecoc22/run_test_04_cleanup.sh</code> script.</p>
<p>When the script finishes, check the WebUI <em>Devices</em> tab, you should see that the devices have been removed. Besides, in the <em>Slices</em> and <em>Services</em> tab you can see that the <em>admin</em> Context has no services given that that context has been removed.</p>
<h2id="33-oecc-psc22-demo-work-in-progress"><strong>3.3. OECC-PSC'22 Demo (Work In Progress)</strong></h2>
<p><strong>Page under construction.</strong></p>
<p>The main features demonstrated are:</p>
<ul>
<li>Interdomain Slices</li>
</ul>
<h2id="34-nfv-sdn22-demo-work-in-progress"><strong>3.4. NFV-SDN'22 Demo (Work In Progress)</strong></h2>
