Open Broadband: Broadband Access Abstraction (OB-BAA)

Version 4.1.1

Table of Contents

  1. Introduction
  2. Overview
  3. Architecture
  4. Installing OB-BAA
  5. Using OB-BAA

Introduction

The Broadband Forum is a non-profit corporation organized to create guidelines for broadband network system development and deployment. This Design Document has been approved by members of the Forum. This Design Document is subject to change. This Design Document is copyrighted by the Broadband Forum, and all rights are reserved. Portions of this Design Document may be copyrighted by Broadband Forum members.

Intellectual Property

Recipients of this Design Document are requested to submit, with their comments, notification of any relevant patent claims or other intellectual property rights of which they may be aware that might be infringed by any implementation of this Design Document, or use of any software code normatively referenced in this Design Document, and to provide supporting documentation.

Terms of Use

License

Broadband Forum hereby grants you the right, without charge, on a perpetual, non-exclusive and worldwide basis, to utilize the Technical Report for the purpose of developing, making, having made, using, marketing, importing, offering to sell or license, and selling or licensing, and to otherwise distribute, products complying with the Design Document, in all cases subject to the conditions set forth in this notice and any relevant patent and other intellectual property rights of third parties (which may include members of Broadband Forum). This license grant does not include the right to sublicense, modify or create derivative works based upon the Design Document except to the extent this Design Document includes text implementable in computer code, in which case your right under this License to create and modify derivative works is limited to modifying and creating derivative works of such code. For the avoidance of doubt, except as qualified by the preceding sentence, products implementing this Design Document are not deemed to be derivative works of the Design Document.

NO WARRANTIES

THIS DESIGN DOCUMENT IS BEING OFFERED WITHOUT ANY WARRANTY WHATSOEVER, AND IN PARTICULAR, ANY WARRANTY OF NONINFRINGEMENT IS EXPRESSLY DISCLAIMED. ANY USE OF THIS DESIGN DOCUMENT SHALL BE MADE ENTIRELY AT THE IMPLEMENTER’S OWN RISK, AND NEITHER THE BROADBAND FORUM, NOR ANY OF ITS MEMBERS OR SUBMITTERS, SHALL HAVE ANY LIABILITY WHATSOEVER TO ANY IMPLEMENTER OR THIRD PARTY FOR ANY DAMAGES OF ANY NATURE WHATSOEVER, DIRECTLY OR INDIRECTLY, ARISING FROM THE USE OF THIS DESIGN DOCUMENT.

THIRD PARTY RIGHTS

Without limiting the generality of Section 2 above, BROADBAND FORUM ASSUMES NO RESPONSIBILITY TO COMPILE, CONFIRM, UPDATE OR MAKE PUBLIC ANY THIRD PARTY ASSERTIONS OF PATENT OR OTHER INTELLECTUAL PROPERTY RIGHTS THAT MIGHT NOW OR IN THE FUTURE BE INFRINGED BY AN IMPLEMENTATION OF THE DESIGN DOCUMENT IN ITS CURRENT, OR IN ANY FUTURE FORM. IF ANY SUCH RIGHTS ARE DESCRIBED ON THE DESIGN DOCUMENT, BROADBAND FORUM TAKES NO POSITION AS TO THE VALIDITY OR INVALIDITY OF SUCH ASSERTIONS, OR THAT ALL SUCH ASSERTIONS THAT HAVE OR MAY BE MADE ARE SO LISTED.

The text of this notice must be included in all copies of this Design Document.

Revision History

Release 4

Release 3

Release 2

Release 1

Participants

Altice Altran ATT Broadcom
BT Calix CenturyLink ChinaMobile
ChinaTelecom ChinaUnicom DZS CommScope
Fiberhome Furukawa Huawei ISKRATEL
nbn Nokia Orange Tibit
TelecomItalia UNH ZTE  

How to Get Involved

Involvement in OB-BAA requires that you sign the Broadband Forum's Contribution License Agreement (CLA)/Project Participation Agreement (PDF), and then send the signed agreement to: info@broadband-forum.org.

Issues and bugs can be submitted using the Issues feature on the OB-BAA Github repository.

License

The OB-BAA project's license is structure is to provide a RAND-Z (Apache 2.0) license for the program's software license and keep the Broadband Forum’s license for the project's artifacts.

Program (Software) License

The OB-BAA project is considered a RAND-Z open source project for program deliverable (e.g, source code and associated object code). The program deliverables use the Apache 2.0 license.

Project Artifacts

The OB-BAA project's artifacts (e.g., documentation, architecture specifications, functional behavior descriptions, Epics, Stories) use the Broadband Forums IPR policy.

Third Party Tools and License

The following tools are used by the OB-BAA project:

Software Name Purpose Vendor Paid/Open Source License Details
Netopeer2 NETCONF device simulator CESNET Open Source BSD-3 Github link
Atom NETCONF client text editor Atom Open Source MIT Documentation link
atom-netconf NETCONF package for the Atom editor Nokia Open Source MIT Github link
protoc Protocol Buffer Compiler gRPC Authors Open Source BSD-style Github link

The following tools are used in and delivered by the OB-BAA project:

Software Name Purpose Vendor Paid/Open Source License Details
HSQL DB YANG Datastore HyperSQL Open Source BSD Documentation link
Apache Karaf Container Apache Open Source Apache 2.0 Documentation link
JSch Simple adapter JCraft Open Source BSD Documentation link
SNMP4j Sample SNMP adapter SNMP4j Open Source Apache 2.0 Documentation link
InfluxDBv2 Time series DB InfluxData Open Source MIT Repository link
Kakfa Distributed Streaming platform Apache Open Source Apache 2.0 Documentation link
ZooKeeper Highly reliable distributed coordination Apache Open Source Apache 2.0 Documentation link
Python Programming Language PSF Open Source BSD Documentation link
kafka-python Kafka-Python Implementation kafka-python Open Source Apache 2.0 Documentation link

The following tools are used in and delivered for the Control Relay Service by the OB-BAA project:

Software Name Purpose Vendor Paid/Open Source License Details
github.com/Juniper/go-netconf Simple NETCONF client base on RFC6241 and RFC6242. Support for SSH transport Juniper Open Source BSD 2 Github link
github.com/golang/mock Mocking framework for the Go programming language Go Project Open Source Apache 2.0 Github link
github.com/golang/protobuf Go support for protocol buffers Google Open Source BSD Github link
github.com/google/go-cmp For comparing whether two values are semantically equal Go Project Open Source BSD 3 Github link
github.com/google/gopacket Packet decoding Google Open Source BSD Github link
github.com/kr/text Manipulating paragraphs of text Many Open Source MIT Github link
github.com/niemeyer/pretty Provides colors to the logger Many Open Source MIT Github link
github.com/rifflock/lfshook Local filesystem hook for Logrus Many Open Source MIT Github link
github.com/sirupsen/logrus Structured logger for Go Many Open Source MIT Github link
github.com/stretchr/testify Framework for testing Go code Many Open Source MIT Github link
github.com/ziutek/telnet Provides simple interface for interacting with Telnet connection. (indirect dependency) Michal Derkacz Open Source Proprietary of Michal Derkacz (BSD 3 like) Github link
google.golang.org/genproto Go generated proto packages Google Open Source Apache 2.0 Github link
google.golang.org/grpc The Go implementation of gRPC Google Open Source Apache 2.0 Github link
google.golang.org/protobuf Go support for protocol buffers Google Open Source BSD Github link

Overview –>