This repository contains the source code for global management plane of OMuProCU Core. The whole project can be seen here
This part of the framework is used in the paper Orchestrating Multi-Tenant Code Updates Across Multiple Programmable Switches and Resilient Multi-Tenant Network Programmability for Adaptive Service Placement.
The framework proposed in the used proprietary software and APIs to initialize hardware, etc. after updating the hardware. Since these are licensed, this was removed, and must be added again or done manually, to get the full functional version used in the paper!
- Python 3.8
- Pip 3.21.1
- Kubernetes Distribution (e.g. K3s) on OMuProCU managed devices
- Accelerator Hardware (Tofino 1 chip or BMv2) with managed OMuProCU
As first step, we recommend creating virtual environment:
python3 -m venv .venv
source .venv.bin
Then, you need to install the python packages needed in this repository:
pip3 install -r requirements.txt
Also, you need to build and install OMuProCU-utils pip packages.
cd ../OMuProCU_utils
pip3 install -r requirements.txt
python3 setup.py sdist
pip3 install ../OMuProCU_utils
ATTENTION: The programmable switch must be started and ready for reconfiguration! Also, OMuProCU must be started at all desired devices! This is not part of the global view framework!
The management_process.py contains the mangement process which starts also all other components in the right order.
So running python3 management_process.py will start the orchestrator with default parameters.
The OMuProCU core consists of different microservices:
Also, there are some modules which are used from the OMuProCU-utils package like:
- Validator
- Persistor
- Tenant Communcation Controller
- Protobuf Message Descriptions and its GRPC interfaces
The core of the OMuProCU is the Management Process which is covered in the management_process.py. It contains the submission process for TDCs and health check pipeline control as well as the topology manager as global view. Also, the state management for LAG/port configurations and provider maintained tables is done by this component.
This component health_monitor.py checks the health of OMuProCU nodes and deployments applied to nodes.
This contains the structure of the topology which should be managed. Also, the state of each node in the topology is managed there.
In this file, the configuration for tenants is saved which consist of:
- Tenant ID as key (number)
- Name of the tenant
- VNIs which the tenant can use for its accelerated CNFs.
- Names of deployed TDCs
- Names of the main ingresses defined in the submitted TDCs (ATTENTION: This will be automatically configured!)
If any extern should not be used by a tenant, this can be added into the list of the associated accelerator. Validate it the same way as the OMuProCU does.
This file contains the network topology configuration for the OMuProCU system that describes the structure and state of each node in the network topology.
There are three different categories available:
- Endpoint (e.g., Hosts or other OMuProCU unmanaged devices/networks)
- Edge Device (e.g., devices at the edge which possesses links to unmanaged nodes in the topology)
- Center Device (e.g., central devices in the topology)
There are multiple topology files in the config directory available:
- LAG setup (as used in the paper
Orchestrating Multi-Tenant Code Updates Across Multiple Programmable Switches) - 5G evaluation setup [default] (as used in the paper
Resilient Multi-Tenant Network Programmability for Adaptive Service Placement)
This is the main config file for MD-OMuProCU where e.g., GRPC Server addresses can be defined.
The repository contains a python-based CLI to interact with the Global Management Plane which can be started by typing:
python3 moc_shellThe CLI supports different parts:
- Create/Update/Delete MD-TDC deployments from files (e.g.,
create mdtdc-files/MD-TDC-Ping.yaml) - Connectivity Check (e.g.,
connectivity) - Rules Updates for each OMuProCU-supported device (see below)
The MOC Shell supports Rules Updater commands. The structure is split into provider tables and tenant tables commands:
# Provider rules operations
rules provider {create | update | delete} <device> <provider_table_name> <provider_table_key> <provider_table_value>
# Tenant rules operations
rules tenant {create | update | delete} <device> <tenant_table_name> <match_fields_string> <action_name> <action_params>
As example, a command to add an entry into the ipv4_host table and an entry in a table of the tenant CNF Pinger:
# Provider table rules operation
rules provider update s3 ipv4_host 10.100.0.222 101
# Tenant table rules operation
rules tenant create s2 listenerIps '{"hdr.inner_ipv4.dst_addr": "10.100.0.222", "hdr.inner_icmp.isValid": 1, "hdr.inner_icmp.type": 8}' send_ping_reply '{}'
To start MD-OMuProCU and OMuProCUs on each device, you can use our dashboard script which creates a tmux session where these components will be started. Also, the MOC Shell will be started in a separate window in the session.
To start the dashboard, you can use the following command:
./md-omuprocu -s
To start the dashboard in debug mode, you can use the following command:
./md-omuprocu -d
These two can also be combined to start MD-OMuProCU and the OMuProCUs and the debug shells on each device.
The dashboard can be attached if running by executing
./md-omuprocu -a
Killing the dashboard is done by entering
./md-omuprocu -k