| Table of Contents |
|---|
General Information
What is OpenSync?
| Table of Contents |
|---|
OpenSync™ OpenSync is an open source software defined networking framework to reliably and dynamically deliver and modify programmable services at scale in CPEs and consumer networking devices. Learn more at https://opensync.io/
...
Who is the author of OpenSync?
Plume Design, Inc. was the initial author. Before Plume contributed it to open source in 2018, it was called PML. Learn more at https://www.opensync.io/about
...
Who is the maintainer of OpenSync?
...
When is the next OpenSync release?
Next release and milestone is mentioned in Download OpenSync. OpenSync releases one release every 12 months. Each release has three long-term versions (LTS) that can be integrated into CPEs or consumer networking devices. Each OpenSync release is stable for 2.5 years after which it is marked as end-of-life.
What is the difference between “mainline”, “stable”, and “longterm” releases?
Mainline - The latest stable release is marked as “mainline”. Although it has successfully exited its stabilization cycle, it is likely to be amended with “bugfix” releases.
Stable - Releases marked as “stable” typically already have a number of adopters, who use it in production. Additional “bugfix” or “maintenance” releases are less likely at this stage.
Long term - If a release is widely adopted, it may receive bug fixes for a longer period. Such releases are marked as “longterm” also known as long-term support branch (LTS).
Old releases are eventually ‘retired’ and are marked as “end-of-life”. Maintainers will not release any additional bug fixes for such releases. Adopters of existing integrations should consider moving to a newer stable release. No support will be provided for adopters wishing to create new integrations based on “end-of-life” releases.
What is a spike?
Before starting development efforts on a new feature with many unknowns, spike serves as an information gathering project. A spike does not include actual development work on the feature, but helps you estimate how much work the feature would require.
After a finished spike, you should know about the project requirements, limitations, testing scenarios, and potential introduction of new technologies or standardsOpenSync releases are described in the Roadmap .
...
When is end of support (EoS) and what does it mean?
End of support occurs 2.5 years after the general availability (GA) release of OpenSync. After this period, no further support, patches, or code fixes will be provided, except for fixes related to critical security vulnerabilities.
...
When is end of life (EoL) and what does it mean?
End of life (EOL) is reached 3 years after the GA release of OpenSync. At this stage, no support, additional patches, or fixes will be provided, including those for critical security vulnerabilities.
...
When can I send my contributions to OpenSync?
...
NOTE: Some older SDK versions might require the sdk/overlay component to enable OpenSync for specific devices. Overlays are available per request on integration@opensync info@opensync.io.
...
Which SoC platforms does OpenSync support?
OpenSync supports Publicly available are the following SoC platforms:
...
Additionally, SoC vendors compliant to the open-source RDK-B and OpenWRT SDK and target layer APIs are supported. SDK and driver versions can be seen in Check Compatibility or Download OpenSync. If your platform is not listed here, please contact integration@opensyncinfo@opensync.io and let’s talk about how OpenSync can be supported on other SoC platforms.
...
Qualcomm SDK
Broadcom SDK
RDK-B
OpenWRT
Android
Details can be also seen in Check Compatibility and in case your SDK is not labeled, it doesn’t that is not compatible but maybe you will need to adapt OpenSync or SDK overlay to your flavor of SDK and best that you also upstream those changes, so next OpenSync will include those changes.
...
All features per release can be found here: Feature Support Matrix
| Panel | |
|---|---|
| panelIconId | atlassian-info | panelIcon | :
| Info | |
| #EAE6FF | Some services or features might require special libraries, tools and licensing, and therefore cannot be part of the public OpenSync components. These services require various |
...
What is the role of Open vSwitch (OVS) in OpenSync?
OpenSync was created around the SDN concept, in which OVS represents the heart of the system. OpenSync expands the default set of OVSDB management tables with dedicated wireless and L3 networking tables. In addition to managing the networking features of devices, these tables enable the cloud to also manage the wireless features of devicesOpen vSwitch offers a variety of features that OpenSync has utilized, particularly before the integration of Linux SDN. Currently, the primary focus of OVS in OpenSync is its role in supporting northbound APIs, which are managed through OVSDB for OpenSync management.
...
How to connect the OpenSync enabled devices to the Cloud?
OpenSync uses the OVS database management protocol (OVSDB) for device provisioning and management. The OpenSync enabled devices can therefore be managed by any SDN controller using the OVSDB protocol. To connect your device to the cloud, we will provide a cloud environment for you if you are a certified partner. Please get in touch with us at info@opensync.io to know more.
...
Integration
How can an OpenSync integration be tested?
...
RDK-B Central Wiki features section ‘How to integrate OpenSync onto a RDK-B platform’ where you can get tips to help you with your integration efforts.
...
...
Which OpenSync managers are mandatory?
...
Best is to create the new target in your vendor directory and compare it with native target build. Select or deselect Kconfig options that you use stub or null implementation based on your requriments.
What are the OpenSync prerequisites for Broadcom-based devices?
All prerequisites are defined in SDK overlay package.
What is the required BCM SDK version for OpenSync builds?
Check Compatibility shows where OpenSync was stabilized and deployed. Any deviations requires an adaptation. It is your responsibility to adapt OpenSync or SDK overlay and upstream the changes to OpenSyncbased on your requirements.
...
What are the OpenSync prerequisites for Broadcom-based devices?
All prerequisites are defined in SDK overlay package.
...
How to synchronize OVSDB and TR-069/TR-181 data models?
...
| Code Block |
|---|
#define SCHEMA_SET_STR(FIELD, VALUE) \
do { \
STRSCPY(FIELD, (VALUE)); \
FIELD##_exists = true; \
FIELD##_present = true; \
} while (0)
|
Updating an OVSDB record:
If
_partial_updateis set to true, only the fields which are.X_presentwill be updated.If the field has to be unset then
.X_existshas to be set to false, otherwise.X_existsis set to true and value stored in X.If
._partial_updateis set to false, then ALL the fields are updated.
In other words, these combinations are possible for partial updates:
.X_present=false: don't update field X.X_present=true,.X_exists=false: unset field .X (set to an empty value - delete).X_present=true,.X_exists=true,.X=value: set field X to value
Code Block struct schema_Netfilter set; memset(&set, 0, sizeof(set)); set._partial_update = true; SCHEMA_SET_INT(set.enable, enable); where = ovsdb_where_simple(SCHEMA_COLUMN(Netfilter, name), rule);
...
Is LED behavior defined for each state in theosp_led_statetable, or is it up to the vendor to define LED behavior?
...
Confirm that the values for backhaul interfaces in
Wifi_VIF_ConfigandWifi_VIF_Statetables match.Check
Wifi_Inet_ConfigandWifi_Inet_Statetables to confirm that DHCP server is configured for backhaul interfaces.Check the
Wifi_Associated_Clientstable to see if any backhaul clients appear connected. Row UUIDs from this table are listed in theWifi_VIF_Config.associated_clientstable for the VIF they are connected to.Check DHCP leases to make sure the leases are showing up in OVSDB, and that a lease exists for the connected extender (
DHCP_leased_IP).Check the
Wifi_Inet-Configtable to see if the cloud inserted apgdX-YYYinterface to create a GRE tunnel. If an extender was assigned a DHCP lease of169.254.3.5, look forpgd3-5.Check
tcpdumpon thepgdX-YYYinterface to look for DHCP requests, and then check on LAN bridge wherepgdX-YYYis inserted to make sure it's also receiving DHCP request and that it responds to the Pod.
Band and Client Steering
...
What is the difference between band steering and client steering?
Band steering:
Controlled by device
Scenario is pre-assocation client connection
It’s following the rules applied within
Band_Steering_ConfigandBand_Steering_Clients
...
Controlled by cloud/service provider
Uses AI to define best option for that client
Triggers action within
Band_Steering_ConfigandBand_Steering_Clients
...
FUT
Does running FUT scripts require cloud connection?
FUT does not require any connection to the cloud, as the tests verify OpenSync implementation.
...
Is SSH access to the DUT necessary?
SSH management access (VLAN) to the device under test (DUT) is essential for FUT as well as for the OpenSync integration process in general. This is the default way to execute commands on devices.
...
Is OSRT/CRATOS
...
necessary to run FUT?
OpenSync Reference Testbed (OSRT) or Comprehensive Reference Apparatus for Testing OpenSync (CRATOS) / OSRT is mandatory to run FUT.
...
Are any HW changes on OSRT/CRATOS supported?
The OSRT/CRATOS comes equipped with reference devices which are ready for executing of the FUT directly. To validate OpenSync integration on your devices, these devices will have to be used instead of the reference devices provided in OSRT/CRATOS reference devices.
...
Which modifications of the FUT are required to test my specific device?
Some of the device-specific config parameters should be adapted and maintained by the integrator. See the FUT User Manual for more details.
...
What are the FUT troubleshooting steps?
If you detect that your tests are not passing, use these steps to diagnose the cause of failures:
Ensure your FUT test cases are configured correctly.
Incorrect input parameters for test scripts cause testcase failures.Ensure your device parameter values are correct.
The device-specific configuration parameters are important for the entire OpenSync integration, regardless of the testing framework. The OpenSync device must interface with the testing framework and the cloud. Unexpected behavior can be a consequence of any misconfigured parameters.Identify if your testcase failures are caused by FUT misconfiguration or incorrect OpenSync integration.
See the FUT User Manual for further debugging steps.
...
Where is FUT repository and documentation?
Repository is located here and documentation is in the same repository.
...
Cloud
How do OpenSync node connect to the cloud?
The OpenSync Connection Manager (CM) reads the redirector address (redirector_addr). After resolving the redirector address , it will update the manager address (manager_addr) and create connection to the cloud. Details can be found in the code.
...
How MQTT traffic is sent to the cloud?
In AWLAN_node table there are three set of fields mqtt_settings, mqtt_topics, mqtt_headers, where you configure MQTT settings on the OpenSync node. That would be grab by Queue manager (QM) and will push MQTT data to the MQTT subscriber. If you want to extend the MQTT, you need enhancements on both sides (OpenSync and cloud).
...
Cloud redirector does not respond. How can I check my SSL connection?
Compete the below steps to check your SSL connection in case of a non-responsive Cloud redirector.
Test the ssh connection from your computer. For example, run this command:
Code Block curl -iv https://<redirector URL>
Observe what kind of error is reported. Does the redirector connection become active? If everything is ok, you should see the following status:
Code Block Connected to <redirector URL> (12.345.333.333) port 443 (#0)
This message indicates that you are able to reach the redirector and to establish the TCP connection.
The connection might close due to the following reason:
Code Block SSL certificate problem
In this case, try handing over the certificate files to curl:
Code Block curl -iv --cacert </path/to/ca.pem> --cert </path/to/client.pem> --key </path/to/client.key> https://<redirector URL>
When done, you should be able to establish the SSL connection. If the above steps are effective, repeat the steps for your specific device.
...
Which OVSDB tables are updated for OpenFlow? Which manager handles this process?
OpenFlow Manager (OM) manages all the OpenFlow operations and OVSDB tables are labeled in the code. OpenFlow is deprecated with introduction of Linux SDN.
...
How does OpenSync propagate the changed settings?
OpenSync uses build-in OpenvSwitch functionality with OVSDB in case of native OpenSync implementation. So every internal/external process which can hookup to OVSDB, it will get notification or ability to change setting the northbound API. All OpenSync managers are hookup to OVSDB, so they propage from northbound to southbound and vice versa.
In case of hybrid solution (OpenSync plus other management system) there is ability to use eXchange Manager (XM). More can be found here.
...
How is the connection kept alive between OpenSync and the cloud?
There are two connections to the cloud: OVSDB (for management) and MQTT (for statistics or events). We leverage their built-in technologies, and you can learn more through the following resources:
...