Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents

What is OpenSync?

Table of Contents

OpenSync™ is an open - source software service platform that delivers and manages user devices and network management elements to enable customized Cloud services deliverydefined networking framework to reliably and dynamically deliver and modify programmable services at scale in CPEs and consumer networking devices. Learn more at https://www.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?

OpenSync maintenance is currently done by Plume Design Inc., in cooperation with main contributors and adopters.

...

Why does OpenSync use the

...

® sign?

OpenSync name is a trade mark registered trademark of Plume Design, Inc.

...

Is OpenSync software free?

OpenSync is licensed under the 3-clause BSD license and is therefore free software. The 3-clause BSD license is approved by the Open Source Initiative. Read the entire copy of the license on the legal page.

...

Which is the latest OpenSync version?

Latest releases are published on https://plumedesign.atlassian.net/wiki/spaces/PML/pages/14411628548 and announced via mailing list announce@opensync.io. Subscribe to this mailing list here Download OpenSync. Join our mailing list and confluence to be always up-to-date.

...

When is the next OpenSync release?

OpenSync should be released on bi-monthly cadence although the monthly releases are treated as code drops and not recommend to be used in production. In 2023 there is a target to release releases one release every 12 months. Each release has three long-term versions (LTS) releases which that can be used in production. Next release and milestone is mentioned in https://plumedesign.atlassian.net/wiki/spaces/PML/pages/14411628548.

What does monthly vs. long-term versioning look like?

Code Block
X.1.0
X.1.1
X.1.2 (Q1) -> LTS X.2.Y
X.3.0 
X.3.1
X.3.2 (Q2) -> LTS X.4.Y
X.5.0
X.5.1
X.5.2 (Q3) -> LTS X.6.Y
X.7.0
X.7.1  
X.7.2 (Q4) -> LTS X.8.Y

...

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?

  1. 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.

  2. 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.

  3. 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).

Oldest 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.

...

You can contribute to OpenSync anytime by following rules and workflows in https://plumedesign.atlassian.net/wiki/spaces/PML/pages/14411628625 and workflows in Contribute and they will be added into the current development release. In case you want to backporting changes into older release, best to reach out over info@opensync.io.

...

OpenSync repositories are hosted on GitHub. Repositories and releases are also laid out in https://plumedesign.atlassian.net/wiki/spaces/PML/pages/14411628548. Download OpenSync .

...

What does OpenSync consist of?

...

Which SoC platforms does OpenSync support?

Publicly available are OpenSync supports the following SoC platforms:

  • Qualcomm

  • Broadcom

  • RDK-B (All SoC supported under RDK-B community. Reference board is Turris Omnia )

  • OpenWRT (All SoC supported under OpenWRT using platform/cfg80211. Reference board is Linksys MR8300)

...

  • Mediatek

  • Maxlinear

  • Quantenna

  • NXP

  • Celeno

Additionally, SoC vendors compliant to the open-source RDK 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@opensync.io and let’s talk about how OpenSync can be supported on other SoC platforms.

...

Which SDK distributions support OpenSync?

...

Details can be also seen in https://plumedesign.atlassian.net/wiki/spaces/PML/pages/14411628590 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: https://plumedesign.atlassian.net/wiki/spaces/PML/pages/14326497311

...

Feature Support Matrix

Panel
panelIconIdatlassian-info
panelIcon:info:
bgColor#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 3rdparty components and are also marked in feature matrix.

...

What is the required BCM SDK version for OpenSync builds?

In https://plumedesign.atlassian.net/wiki/spaces/PML/pages/14411628590 you will see, Check Compatibility shows where OpenSync was stabilized and deployed. All other SDK which are not labeled, it doesn’t that is not compatible but maybe you will need Any deviations requires an adaptation. It is your responsibility 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 changesand upstream the changes to OpenSync.

...

How to synchronize OVSDB and TR-069/TR-181 data models?

...

Details are here https://plumedesignopensync.atlassian.net/wiki/spaces/PMLOCC/pages/1441149749339920140311/Requirements#External-DB-Integration

...

How do OpenSync managers trigger the get status?

...

OpenSync can use multiple access zones to manage access privileges of the connecting devices. Each access zone is accessible using a unique set of keys (Wi-Fi passwords), any of which can be used to access the SSID. Please see Requirements | MultiPSK https://opensync.atlassian.net/wiki/spaces/OCC/pages/39920140311/Requirements#Multi-psk for more details.

The feature is internally called MPSK (multi_PSK), where we can assign more than one key for one SSID. It is a function of hostapd. We created patches which have already been upstreamed to hostapd.

...

FUT does not require any connection to the cloud, as the tests are intended to verify OpenSync implementation before going into next test stage and that is end to end test.

...

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 CRATOS/OSRT

...

necessary to run FUT?

...

Comprehensive Reference Apparatus for Testing OpenSync (CRATOS) / OSRT is mandatory to run FUT. In future we plan to give option to also be run outside of OSRT/CRATOS but that comes with limitation since some test requires additional HW like clients/power switch/…

...

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?

...

If you detect that your tests are not passing after starting the OpenSync integration, use these steps to diagnose the cause of failures:

...

In case of hybrid solution (OpenSync plus other management system) there is ability to use eXchange Manager (XM). More can be found here.