Requirements
- 1 Minimum hardware specification
- 2 Dependent libraries
- 3 Device identification parameters
- 4 Firmware version format
- 5 Secure cloud connection
- 6 Firewall rules
- 7 Node reboot method
- 8 Remote upgrade support
- 9 Watchdog
- 10 WiFi virtual access points (VAP)
- 11 Additional Requirements
- 11.1 Configuration and Statistics
- 11.1.1 OVS, OVSDB
- 11.1.2 Basic Telemetry
- 11.1.3 Persistent Storage
- 11.2 Gateway Integration
- 11.2.1 Active or Passive mode
- 11.2.2 External DB Integration
- 11.3 Network Protocols
- 11.3.1 IPv4, IPv6
- 11.4 IPTV
- 11.4.1 IPTV Traffic Separation
- 11.5 WiFi Modes
- 11.5.1 11ax (WiFi 6)
- 11.5.2 WiFi6E
- 11.6 WiFi Mesh
- 11.6.1 Topology Management
- 11.6.2 GRE Backhaul
- 11.6.3 Multi-AP Backhaul (4addr)
- 11.7 WiFi Features
- 11.7.1 Multi-psk
- 11.7.2 Dynamic Frequency Selection (DFS)
- 11.7.3 Zero-wait DFS
- 11.7.4 DPP
- 11.7.5 HaaHs Public WiFi
- 11.8 Band and Client Steering
- 11.8.1 Basic/Legacy, 11k/11v Steering
- 11.8.2 Advanced Features
- 11.9 WPS Support
- 11.9.1 WPS from App
- 11.10 Third Party Services
- 11.10.1 FSM Plugins
- 11.11 Small Business
- 11.11.1 Captive Portal
- 11.11.2 Rate Limiting
- 11.1 Configuration and Statistics
Minimum hardware specification
Once OpenSync is running on a device (gateway or extender), you can expect memory and CPU usage as stated in the table below.
The expected memory footprint does not include third-party services and plugins. To include these in your memory consumption estimations, please contact info@opensync.io.
Hardware | Minimal requirement |
---|---|
Flash | OpenSync: 5 MB |
RAM | OpenSync: 75 MBytes |
CPU | Single core: 750 MHz |
Temporary file system
OpenSync requires a minimum of 16 MB storage for the tmpfs (temporary file system).
Persistent storage
There should be a minimum of 7 MB persist storage for features like reboot reasons, WAN configuration. For details refer to Requirements | Persistent Storage
Dependent libraries
OpenSync is optimized for Linux operating systems with kernel version 3.3 or higher. In addition, OpenSync requires minimal the following libraries:
Purpose | Library | Recommended Version |
---|---|---|
toolchain | [libc.so.0] |
|
system | [libssl.so.1.0.0] | openssl-1.0.2k |
applications | [libjansson.so.4 | jansson-2.7 |
openvswitch | [libncurses] | ncurses-6.1 |
Device identification parameters
To correctly identify and manage the connected devices, OpenSync requires basic device information parameters.
Device identification parameters (stored in AWLAN_Node
table):
ID - must be unique per node
model name - Defines the node model
Case sensitive
Should not have leading or trailing spaces
Must be unique in the world
Match regex pattern:
^[A-Za-z0-9_-]*
firmware version - details below
Firmware version format
To ensure node compability with the SDN controller, the firmware package version must be named using a specific format. The firmware package version starts with at least two numerals, split by a dot. The expected format is:
major.minor[.revision][.patch][-build][-githash][-profile]
Example: 1.2.4-8-ga46f46c-dev
Component | Mandatory / Optional | Value type |
Major | Mandatory | Integer |
Minor | Mandatory | Integer |
Revision | Optional | Integer |
Patch | Optional | Integer |
Build number | Optional | Integer |
Git hash | Optional | String |
Firmware profile (development or production) | Optional | String |
Secure cloud connection
One of the top OpenSync priorities is ensuring the highest level of data privacy by enforcing state-of-the-art security standards, such as client authentication and data encryption for all the nodes that connect to the OpenSync SDN contoller. These security mechanisms require node certificates and encryption keys. Connection is secure by using TLS 1.2 and two way SSL mutual authentication.
Details on certificate creating and storing are defined at integration time with each partner individually.
Firewall rules
OpenSync is a cloud-controlled and cloud-managed software. As such, OpenSync requires cloud connectivity. Firewall rules must allow the necessary cloud connection:
allow 443 port for OVSDB and MQTT connection to the SDN controller
Node reboot method
OpenSync requires the ability to enforce a safe full-node reboot and general OpenSync implementation is in OSP layer.
Remote upgrade support
To enable OpenSync updates, the connected nodes must support full firmware upgrades which we provide over generic tool called safeupdate
. Images should be encrypted.
Details on upgrade implementation are defined at integration time with each partner individually.
Watchdog
OpenSync runs as embedded software and therefore requires a mechanism that detects potential malfunctions and automatically initiates the recovery procedure. One such mechanism is the Watchdog.
Currently OpenSync does not provide implementation and we suggest to use software or hardware-based watchdog. Hardware watchdog is recommended.
WiFi virtual access points (VAP)
There should be 8 VAP per radio available (1 STA + 7 AP’s) for OpenSync to use simultaneously. SDN controller will orchestrate them per customer needs in runtime.
Additional Requirements
Feature Group | Feature | Requirements Document |
---|---|---|
Configuration and Statistics | OVS, OVSDB |
|
Basic Telemetry |
| |
Persistent Storage |
| |
Gateway Integration | Active or Passive mode |
|
External DB Integration |
| |
Network Protocols | IPv4, IPv6 |
|
IPTV | IPTV Traffic Separation |
|
WiFi Modes | 11ax (WiFi 6) |
|
WiFi6E |
| |
WiFi Mesh | Topology Management |
|
GRE Backhaul |
| |
Multi-AP Backhaul (4addr) |
| |
WiFi Features | Multi-psk |
|
Dynamic Frequency Selection (DFS) |
| |
Zero-wait DFS |
| |
DPP |
| |
HaaHs Public WiFi |
| |
Band and Client SteeringAlso refer to FAQ | Band and Client Steering | Basic/Legacy, 11k/11v Steering |
|
Advanced Features |
| |
WPS Support | WPS from App |
|
Third Party Services | FSM Plugins |
|
Small Business | Captive Portal |
|
Rate Limiting |
|