mirror of
https://github.com/Telecominfraproject/wlan-docs.git
synced 2025-11-02 19:57:51 +00:00
GitBook: [#12] GA general updates
This commit is contained in:
Chris Busch
63
README.md
63
README.md
@@ -2,50 +2,77 @@
|
||||
description: Telecom Infra Project OpenWiFi
|
||||
---
|
||||
|
||||
# OpenWiFi Release 2.6 In Progress
|
||||
# OpenWiFi Release 2.6 GA
|
||||
|
||||
## What is OpenWiFi?
|
||||
|
||||
TIP OpenWiFi is an open source community project that believes in democratizing premium Wi-Fi experiences for multiple market use cases. The TIP approach to OpenWiFi creates an open source disaggregated technology stack without any vendor lock in. OpenWiFi offers premium managed Wi-Fi features, local break-out design, cloud native open source controller, and an open source AP firmware operating system tested nightly.
|
||||
TIP OpenWiFi is an open source community project that believes in democratizing premium Wi-Fi experiences for multiple market use cases. The TIP approach to OpenWiFi creates an open source disaggregated technology stack without any vendor lock in. 
|
||||
|
||||
.png>)
|
||||
Features normally only present in commercial enterprise WLAN offerings are available in TIP OpenWiFi. These premium Wi-Fi features enable a number of market solutions for developers, integrators and operators to explore.
|
||||
|
||||
TIP OpenWiFi is the industry's first CI/CD open source Wi-Fi eco-system. Built nightly with a strong community of Wi-Fi leaders, new features are unit tested in automated RF chambers and checked from cloud to ground for Wi-Fi performance and conformance.
|
||||
TIP OpenWiFi stack enables commercial integrations via cloud native open source services for management and network visibility combined with an open source AP firmware operating system tested nightly.
|
||||
|
||||
OpenWiFi 2.0 introduces management and telemetry based on uCentral offering expanded selection of managed devices including smaller APs and PoE access switches.
|
||||
TIP OpenWiFi Continuous Integration quality testing runs nightly exercising thousands of Wi-Fi performance, conformance and feature unit tests. 
|
||||
|
||||
Support for a broad range of device platforms with the ability for Community to contribute additional device support and or cloud features sets TIP OpenWiFi apart from all other open projects. 
|
||||
|
||||
Joining TIP and the OpenWiFi project is both free and easy. 
|
||||
|
||||
Learn more here: [https://telecominfraproject.com/openwifi/](https://telecominfraproject.com/openwifi/)
|
||||
|
||||
### Getting Started
|
||||
|
||||
The most common use cases for TIP OpenWiFi are managed WLAN most often associated with premium enterprise Wi-Fi service offerings. TIP OpenWiFi presents these premium features over a number of deployment options. 
|
||||
|
||||
TIP OpenWiFi devices have management and telemetry exposed via a single websocket to the OpenWiFi Gateway (OWGW) microservice. The OWGW is supported by database, message bus, and the OpenWiFi Security (OWSEC) microservice for northbound API integration. This represents the minimum to deploy TIP OpenWiFi. 
|
||||
|
||||
This minimum set of services enables commercial vendor integration adding TIP OpenWiFi device support to existing Wi-Fi controllers. 
|
||||
|
||||
Refer to the sections on SDK Installation and Overview for further information. 
|
||||
|
||||
For additional value added services, TIP OpenWiFi also provides User Interface, Firmware Management, Provisioning and Analytics services. All services are independently deployed and integrated based on commercial adoption model.  
|
||||
|
||||
See [Developer Resources](broken-reference) for API level information and [Code Repositories](openwifi-stack/repositories.md) for source code guidance.
|
||||
|
||||
### High Level Features
|
||||
|
||||
#### Each OpenWiFi AP offers:
|
||||
|
||||
* Multiple topologies including :
|
||||
* Bridging, Virtual LAN, VxLAN, NAT Gateway, Local Breakout, Overlay (PPPoE, L2oGRE, L2TP), Mesh, WDS
|
||||
* Local Breakout
|
||||
* Overlay including PPPoE, L2TP, L2oGRE 
|
||||
* IEEE802.11s Mesh and Wireless Distribution System
|
||||
* Bridging, Virtual LAN, VxLAN, NAT Gateway
|
||||
* Multiple authentications including WPA, WPA2, WPA3, Enterprise Radius models, M-PSK
|
||||
* Passpoint R1 and R2 Mobile Offload
|
||||
* Encrypted Zero Touch Provisioning and Cloud Discovery
|
||||
* Autonomous RRM and Channel Control
|
||||
* Captive Portal & ExpressWiFi
|
||||
* Wi-Fi Agile Multiband 
|
||||
* Multi-VAP including topology features per VAP
|
||||
* Dynamic Air Time Fairness
|
||||
* Over the air EDCH QoS, WMM QoS, 802.11-2016 Enterprise QoS
|
||||
* Captive Portal 
|
||||
* Station and Network Telemetry
|
||||
|
||||
#### Each OpenWiFi PoE Switch offers:
|
||||
|
||||
* IEEE802.1Q Virtual LAN
|
||||
* VxLAN
|
||||
* DHCP Snooping & Relay
|
||||
* Multicast
|
||||
* PoE
|
||||
* IEEE802.1x Access Control
|
||||
|
||||
#### Cloud SDK in OpenWiFi offers:
|
||||
|
||||
* Zero Touch Provisioning
|
||||
* Firmware Management
|
||||
* Zero Touch Provisioning & Discovery
|
||||
* Integration Northbound Interface (NBI) RESTful
|
||||
* Data model driven API
|
||||
* Data model driven OpenAPI design
|
||||
* Enterprise Message Bus data access
|
||||
* Cloud Native & Agnostic micro services
|
||||
* Gateway Southbound
|
||||
* Security Northbound
|
||||
* Firmware Management
|
||||
* Web User Interface
|
||||
* Provisioning 
|
||||
* Analytics 
|
||||
|
||||
**OpenWiFi AP Detail List:**
|
||||
|
||||
* Wi-Fi 4 (n) Wi-Fi 5 (ac) Wi-Fi 6 (ax)
|
||||
* Wi-Fi 5 (ac) Wi-Fi 6 (ax) Wi-Fi 6E
|
||||
* Dual Bank Bootloader
|
||||
* Multi-SSID per Radio
|
||||
* SSID Authentications: WPA/WPA2/WPA3 - Mixed, Personal, Enterprise
|
||||
|
||||
78
SUMMARY.md
78
SUMMARY.md
@@ -19,24 +19,24 @@
|
||||
* [Discovery without Cloud](openwifi-stack/cloud-discovery/discovery-without-cloud.md)
|
||||
* [Access Points](openwifi-stack/access-points/README.md)
|
||||
* [Local Device Settings](openwifi-stack/access-points/local-device-settings.md)
|
||||
* [Firmware Management](openwifi-stack/firmware.md)
|
||||
* [Device Provisioning](openwifi-stack/device-provisioning.md)
|
||||
* [Code Repositories](openwifi-stack/repositories.md)
|
||||
* [Artifacts](openwifi-stack/artifacts.md)
|
||||
|
||||
## SDK
|
||||
|
||||
* [Getting Started](sdk/getting-started.md)
|
||||
* [Release 2.x SDK](sdk/sdk.md)
|
||||
* [Provisioning](sdk/provisioning/README.md)
|
||||
* [Release 2.6 SDK](sdk/sdk.md)
|
||||
* [Provisioning for Integrators](sdk/provisioning/README.md)
|
||||
* [Data Model Introduction](sdk/provisioning/data-model-introduction.md)
|
||||
* [Creating a Configuration](sdk/provisioning/creating-a-configuration.md)
|
||||
* [User Interface](sdk/user-interface/README.md)
|
||||
* [User Interface for Admins](sdk/user-interface/README.md)
|
||||
* [Firmware Management](sdk/user-interface/firmware.md)
|
||||
* [Device Provisioning](sdk/user-interface/device-provisioning.md)
|
||||
* [Devices](sdk/user-interface/devices-view/README.md)
|
||||
* [Commands](sdk/user-interface/devices-view/commands.md)
|
||||
* [Statistics](sdk/user-interface/devices-view/statistics.md)
|
||||
* [Command History](sdk/user-interface/devices-view/command-history.md)
|
||||
* [Firmware](sdk/user-interface/firmware.md)
|
||||
* [Firmware](sdk/user-interface/firmware-1.md)
|
||||
* [Monitoring](sdk/monitoring/README.md)
|
||||
* [ELK Integration](sdk/monitoring/elk-integration.md)
|
||||
|
||||
@@ -46,39 +46,41 @@
|
||||
* [Deploy using Docker Compose](sdk-installation/deploy-using-docker-compose.md)
|
||||
* [Deploy using Helm](sdk-installation/deploy-using-helm.md)
|
||||
|
||||
## Configuration Examples
|
||||
## Device Feature Configuration Examples
|
||||
|
||||
* [Basic Device Provisioning](configuration-examples/basic-device-provisioning/README.md)
|
||||
* [Bridge Mode SSID](configuration-examples/basic-device-provisioning/bridge-mode-ssid.md)
|
||||
* [NAT Gateway Mode SSID](configuration-examples/basic-device-provisioning/nat-gateway-mode-ssid.md)
|
||||
* [Multi-VLAN SSID](configuration-examples/basic-device-provisioning/multi-vlan-ssid.md)
|
||||
* [Device Feature Configuration Examples](configuration-examples/device-feature-configuration-examples/README.md)
|
||||
* [Zero Touch Provisioning](configuration-examples/device-feature-configuration-examples/zero-touch-provisioning.md)
|
||||
* [DHCP Relay](configuration-examples/device-feature-configuration-examples/dhcp-relay.md)
|
||||
* [Services](configuration-examples/device-feature-configuration-examples/services.md)
|
||||
* [Metrics](configuration-examples/device-feature-configuration-examples/metrics.md)
|
||||
* [GRE](configuration-examples/device-feature-configuration-examples/gre.md)
|
||||
* [L2TP](configuration-examples/device-feature-configuration-examples/l2tp.md)
|
||||
* [VxLAN](configuration-examples/device-feature-configuration-examples/vxlan.md)
|
||||
* [WDS](configuration-examples/device-feature-configuration-examples/wds-topologies.md)
|
||||
* [Mesh](configuration-examples/device-feature-configuration-examples/mesh.md)
|
||||
* [QoS](configuration-examples/device-feature-configuration-examples/qos.md)
|
||||
* [Dynamic Air Time Fairness](configuration-examples/device-feature-configuration-examples/dynamic-air-time-fairness.md)
|
||||
* [Dynamic Subscriber QoS](configuration-examples/device-feature-configuration-examples/dynamic-subscriber-qos.md)
|
||||
* [Captive Portal](configuration-examples/device-feature-configuration-examples/captive-portal/README.md)
|
||||
* [External Captive Portal](configuration-examples/device-feature-configuration-examples/captive-portal/external-captive-portal.md)
|
||||
* [ExpressWiFi](configuration-examples/device-feature-configuration-examples/expresswifi.md)
|
||||
* [Roaming RRM and SON](configuration-examples/device-feature-configuration-examples/roaming-rrm-and-son.md)
|
||||
* [RADIUS Authenticated SSID](configuration-examples/device-feature-configuration-examples/radius-authenticated-ssid/README.md)
|
||||
* [Dynamic VLANs with RADIUS](configuration-examples/device-feature-configuration-examples/radius-authenticated-ssid/dynamic-vlans-with-radius.md)
|
||||
* [Multi-PSK (MDU Shared Key)](configuration-examples/device-feature-configuration-examples/multi-psk-mdu-multiple-shared-key.md)
|
||||
* [Dynamic Air-Time Policy](configuration-examples/device-feature-configuration-examples/dynamic-air-time-policy.md)
|
||||
* [Passpoint®](configuration-examples/device-feature-configuration-examples/passpoint-r1/README.md)
|
||||
* [Configuration Introduction](configuration-examples/device-feature-configuration-examples/passpoint-r1/configuration-introduction.md)
|
||||
* [Advertising Services](configuration-examples/device-feature-configuration-examples/passpoint-r1/advertising-services.md)
|
||||
* [Passpoint® Configuration](configuration-examples/device-feature-configuration-examples/passpoint-r1/passpoint-r-configuration.md)
|
||||
* [Switching](configuration-examples/device-feature-configuration-examples/switching/README.md)
|
||||
* [Port Speed](configuration-examples/device-feature-configuration-examples/switching/port-speed.md)
|
||||
* [Basic Device Provisioning](device-feature-configuration-examples/basic-device-provisioning/README.md)
|
||||
* [Bridge Mode SSID](device-feature-configuration-examples/basic-device-provisioning/bridge-mode-ssid.md)
|
||||
* [NAT Gateway Mode SSID](device-feature-configuration-examples/basic-device-provisioning/nat-gateway-mode-ssid.md)
|
||||
* [Multi-VLAN SSID](device-feature-configuration-examples/basic-device-provisioning/multi-vlan-ssid.md)
|
||||
* [Device Feature Configuration Examples](device-feature-configuration-examples/device-feature-configuration-examples/README.md)
|
||||
* [Zero Touch Provisioning](device-feature-configuration-examples/device-feature-configuration-examples/zero-touch-provisioning.md)
|
||||
* [DHCP Relay](device-feature-configuration-examples/device-feature-configuration-examples/dhcp-relay.md)
|
||||
* [Services](device-feature-configuration-examples/device-feature-configuration-examples/services.md)
|
||||
* [Metrics](device-feature-configuration-examples/device-feature-configuration-examples/metrics.md)
|
||||
* [GRE](device-feature-configuration-examples/device-feature-configuration-examples/gre.md)
|
||||
* [L2TP](device-feature-configuration-examples/device-feature-configuration-examples/l2tp.md)
|
||||
* [VxLAN](device-feature-configuration-examples/device-feature-configuration-examples/vxlan.md)
|
||||
* [WDS](device-feature-configuration-examples/device-feature-configuration-examples/wds-topologies.md)
|
||||
* [Mesh](device-feature-configuration-examples/device-feature-configuration-examples/mesh.md)
|
||||
* [QoS](device-feature-configuration-examples/device-feature-configuration-examples/qos.md)
|
||||
* [Dynamic Air Time Fairness](device-feature-configuration-examples/device-feature-configuration-examples/dynamic-air-time-fairness.md)
|
||||
* [Dynamic Subscriber QoS](device-feature-configuration-examples/device-feature-configuration-examples/dynamic-subscriber-qos.md)
|
||||
* [Captive Portal](device-feature-configuration-examples/device-feature-configuration-examples/captive-portal/README.md)
|
||||
* [External Captive Portal](device-feature-configuration-examples/device-feature-configuration-examples/captive-portal/external-captive-portal.md)
|
||||
* [ExpressWiFi](device-feature-configuration-examples/device-feature-configuration-examples/expresswifi.md)
|
||||
* [Roaming RRM and SON](device-feature-configuration-examples/device-feature-configuration-examples/roaming-rrm-and-son.md)
|
||||
* [RADIUS Authenticated SSID](device-feature-configuration-examples/device-feature-configuration-examples/radius-authenticated-ssid/README.md)
|
||||
* [Dynamic VLANs with RADIUS](device-feature-configuration-examples/device-feature-configuration-examples/radius-authenticated-ssid/dynamic-vlans-with-radius.md)
|
||||
* [WISPr Subscriber Bandwidth](device-feature-configuration-examples/device-feature-configuration-examples/radius-authenticated-ssid/wispr-subscriber-bandwidth.md)
|
||||
* [RADIUS MAC-Auth](device-feature-configuration-examples/device-feature-configuration-examples/radius-authenticated-ssid/radius-mac-auth.md)
|
||||
* [Multi-PSK (MDU Shared Key)](device-feature-configuration-examples/device-feature-configuration-examples/multi-psk-mdu-multiple-shared-key.md)
|
||||
* [Dynamic Air-Time Policy](device-feature-configuration-examples/device-feature-configuration-examples/dynamic-air-time-policy.md)
|
||||
* [Passpoint®](device-feature-configuration-examples/device-feature-configuration-examples/passpoint-r1/README.md)
|
||||
* [Configuration Introduction](device-feature-configuration-examples/device-feature-configuration-examples/passpoint-r1/configuration-introduction.md)
|
||||
* [Advertising Services](device-feature-configuration-examples/device-feature-configuration-examples/passpoint-r1/advertising-services.md)
|
||||
* [Passpoint® Configuration](device-feature-configuration-examples/device-feature-configuration-examples/passpoint-r1/passpoint-r-configuration.md)
|
||||
* [Switching](device-feature-configuration-examples/device-feature-configuration-examples/switching/README.md)
|
||||
* [Port Speed](device-feature-configuration-examples/device-feature-configuration-examples/switching/port-speed.md)
|
||||
|
||||
## RELEASE
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
# About OpenWifi
|
||||
# About OpenWiFi
|
||||
|
||||
Established in Q42019, the TIP OpenWiFi solution goal has been to break vendor lock-in through disaggregation architectures, open APIs—with common embedded software and management that is both community- and commercially-supported.
|
||||
|
||||
@@ -24,7 +24,7 @@ Membership to the TIP OpenWiFi project is free with the request to contribute as
|
||||
|
||||
Meta Connectivity, is a PG champion of TIP OpenWiFi. All source code in the program is subject to BSD-3 license and in the public domain. No internal Meta tooling or IP is involved in the project.
|
||||
|
||||
## Membership has it's privilege
|
||||
## Membership has its privilege
|
||||
|
||||
To contribute to the project, you must become a member of TIP and the OCW PG.
|
||||
|
||||
@@ -35,4 +35,6 @@ After you become a member, you can access the following resources:
|
||||
* Team collaboration and communication via TIP Slack
|
||||
* Team meetings
|
||||
|
||||
The TIP OpenWiFi group holds regular meetings with Meta Connectivity Development team members with stand up calls every Monday. PG member meetings are bi-weekly on Mondays. For meeting schedules and additional information, see the [OpenWiFi Project Confluence](https://telecominfraproject.atlassian.net/wiki/spaces/WIFI/overview%3E) wiki.
|
||||
The TIP OpenWiFi group holds regular meetings with Meta Connectivity Development team members with stand up calls every Monday. PG member meetings are monthly on first Monday. 
|
||||
|
||||
For meeting schedules and additional information, see the [OpenWiFi Project Confluence](https://telecominfraproject.atlassian.net/wiki/spaces/WIFI/overview%3E) wiki.
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# Example SDK Integrations
|
||||
# Example Partner Integrations
|
||||
|
||||
You can extend deployment opportunities using third-party integrations with the TIP OpenWiFi SDK. For example, with third-party integrations, you can create a controller of multiple services. The services can include device provisioning, firmware management, network management, service assurance, subscriber authentication, captive portal services, IoT and amenity networks all commonly deployed across the MDU market. All of these traditional functions are supported in part by the OpenWiFi API and telemetry data from the OpenWifi SDK.
|
||||
You can extend deployment opportunities using third-party integrations with the TIP OpenWiFi SDK. For example, with third-party integrations, you can create a controller of multiple services. The services can include device provisioning, firmware management, network management, service assurance, subscriber authentication, captive portal services, IoT and amenity networks all commonly deployed across the MDU market. All of these traditional functions are supported in part by the OpenWiFi API and telemetry data from the OpenWiFi SDK.
|
||||
|
||||
## Integration by Vertical
|
||||
|
||||
@@ -10,7 +10,7 @@ The simplest SDK integration is to integrate operator OSS/BSS systems for device
|
||||
|
||||
In this scenario, the operator back office systems including and not limited to assurance and monitoring, inventory management and billing systems, will integrate with the OpenWiFi API and message bus interfaces of the SDK.
|
||||
|
||||
|
||||
|
||||
|
||||
In service provider access, commonly non-fixed subscribers are served using the same technologies present in WLAN Controllers however the network may be provisioned to direct such traffic to stand alone appliances or applications including authentication (AAA) and walled garden / captive portal systems. TIP OpenWiFi systems support such variations.
|
||||
|
||||
@@ -20,7 +20,7 @@ TIP OpenWiFi is a local-breakout based approach therefore user traffic is not mu
|
||||
|
||||
WLAN controllers typically expose network visibility, subscriber management including authentication, roaming and RRM control, visualization of per Wi-Fi client performance including client session information, client session throughput, client session quality. Most controllers will implement some SON functionality where managing RF resources and channel planning are provided centrally at the controller and pushed across the managed WLAN.
|
||||
|
||||
|
||||
|
||||
|
||||
While TIP OpenWiFi is a local breakout enabled solution, vendors who wish to aggregate all subscriber traffic through the WLAN Controller should provision the use of one of the AP NOS supported network encapsulations.
|
||||
|
||||
@@ -30,7 +30,7 @@ Another model that is found in venue, enterprise and some service providers is a
|
||||
|
||||
In scenarios where the deployment is a venue, hotspot or service provider, the NAC will also offer a payment gateway enabling the solution to monetize network access. Common to the NAC solution is the ability to manage various headless devices, IoT elements, and provide DPI (Deep Packet Inspection ) capabilities based on knowledge of the Wi-Fi client, device type, how it authenticated and from where in the network it currently resides. These systems may be inline or more preferably out-of-band based and in the latter is where integration to the SDK is intended for synchronizing provisioned Wi-Fi devices via the SDK with authentication and security offerings of the NAC platform.
|
||||
|
||||
|
||||
|
||||
|
||||
Device provisioning occurs through the SDK, which in turn includes provisioning of Virtual Access Point (VAP) to direct authentication to the NAC. Subscriber device authentication traffic arrives at the NAC which manages this according to the operator defined policies. In the case of a captive portal, NAC systems typically include portal redirection that may be WISPr based, or Coova based and some may include Passpoint support.
|
||||
|
||||
@@ -42,34 +42,18 @@ TIP OpenWiFi has a diverse and rich ecosystem of members who solve a number of o
|
||||
|
||||
JoinDigital is an MDU Managed Service Provider. Within the JoinDigital portfolio are Small Medium Business (SMB) customers served as part of an MSP for the entire building. JoinDigital offers all the services a building requires including security, amenity networks, IoT integration, subscriber / tennant vlan management, hotspot services for common areas and more.
|
||||
|
||||
|
||||
|
||||
JoinDigital is an example of an MDU managed service provider who leverages their own OSS/BSS systems much the way a service provider would provide broadband provisioning of subscriber services. As such, JoinDigital integrated their existing billing, network management, assurance and inventory with the SDK directly.
|
||||
|
||||
|
||||
|
||||
### Indio Networks
|
||||
|
||||
Indio offers a diverse range of wireless network solutions for service provider and venue operator markets. They serve markets worldwide for Wi-Fi management, hotspot and IoT solutions.
|
||||
|
||||
|
||||
|
||||
Indio WiOS cloud platform was integrated with the SDK to bring device provisioning, firmware management and telemetry into the WiOS cloud management platform. This enabled Indio to simultaneously offer support for their own hardware devices running OpenWiFi in addition to the full range of platforms available via all the ODM partners, all possible from the WiOS interface. In this model Indio appears to OpenWiFi as a disaggregated WLAN Controller when integrated to the SDK offering a variety of wireless features.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### EdgeCore
|
||||
|
||||
EdgeCore provides a WLAN Controller that is more closely aligned to the enterprise or venue market. There are features such as hotspot enablement, and built-in subscriber authentication with strong focus on Wi-Fi quality both in AP device and subscriber client device. Dashboards offer strong service and network management capabilities with integration to the SDK at the device provisioning, firmware management and telemetry level.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
### Lindsay Broadband
|
||||
|
||||
Lindsay Broadband is a direct supplier to the Cable MSO industry. A strong focus on outdoor wireless and wireline products, Lindsay has been enabling Wi-Fi in particular from the Cable MSO aerial strand for years. As the Cable MSO exhibits the service provider model of OSS/BSS integration to device provisioning, it has been simple for Lindsay to define a solution using just the SDK with support from the ecosystem.
|
||||
@@ -78,10 +62,8 @@ The cable strand device has been hardware engineered to include a TIP OpenWiFi i
|
||||
|
||||
Lindsay is currently manufacturing several dozen strand based devices for their customer trials of OpenWiFi.
|
||||
|
||||
|
||||
|
||||
|
||||
For the Cable MSO deployment, the MSO OSS/BSS system is involved from the standpoint of network management and device provisioning integration to the SDK. The MSO may complement the subscriber management and services offered by adding NAC style out of band captive portal systems integrated via the SDK in addition to enabling OpenRoaming and Passpoint services for mobile offload and secure client access.
|
||||
|
||||
### Summary SDK Integrations
|
||||
|
||||
|
||||
###
|
||||
|
||||
@@ -2,11 +2,11 @@
|
||||
|
||||
TIP OpenWiFi supports Wi-Fi 5 (802.11ac), Wi-Fi 6 (802.11ax) and Wi-Fi 6E (6GHz 802.11ax) in a mix of indoor and outdoor, ceiling to wall, desk, pole and strand environments.
|
||||
|
||||
For TIP OpenWiFi, a mix of ODMs deliver a diverse portfolio including CIG, Actiontech, EdgeCore, Cybertan, Wallys, Lindsay, HFCL and Inventum.
|
||||
For TIP OpenWiFi, a mix of ODMs deliver a diverse portfolio including CIG, Actiontech, EdgeCore, Cybertan, Arcadyan, Wallys, Lindsay, HFCL and Inventum.
|
||||
|
||||
|
||||
|
||||
## Currently supported hardward
|
||||
## Currently supported hardware
|
||||
|
||||
The list of supported hardware continues to grow. TIP members can access the Confluence site that lists all currently supported hardware.
|
||||
|
||||
|
||||
@@ -1,6 +0,0 @@
|
||||
---
|
||||
description: TIP OpenWiFi 2.0
|
||||
---
|
||||
|
||||
# Dynamic Air Time Fairness
|
||||
|
||||
@@ -1,6 +0,0 @@
|
||||
---
|
||||
description: OpenWiFi
|
||||
---
|
||||
|
||||
# QoS
|
||||
|
||||
@@ -0,0 +1,38 @@
|
||||
---
|
||||
description: TIP OpenWiFi 2.0
|
||||
---
|
||||
|
||||
# Dynamic Air Time Fairness
|
||||
|
||||
Complimenting enterprise QoS in OpenWiFi is support for Dynamic Air Time Fairness. 
|
||||
|
||||
Air Time Fairness (ATF) governs the Wireless Multimedia (WMM) operations on the air interface with influence of the scheduler.
|
||||
|
||||
The Distributed Coordination Function (DCF) which is the underlying Media Access Control system to Wi-Fi is generally governed by equality rules at the air interface, every UE is equal. 
|
||||
|
||||
Traffic handling building blocks over time have layered onto Wi-Fi to handle contention access in certain queueing terms.
|
||||
|
||||
OpenWiFi WMM Supports the following class selector profiles:
|
||||
|
||||
* Enterprise
|
||||
* RFC8325
|
||||
* 3GPP
|
||||
|
||||
|
||||
|
||||
Air Time Fairness Example:
|
||||
|
||||
```
|
||||
"services": {
|
||||
"airtime-fairness": {
|
||||
"voice-weight": 4,
|
||||
"packet-threshold": 100,
|
||||
"bulk-threshold": 50,
|
||||
"priority-threshold": 30,
|
||||
"weight-normal": 256,
|
||||
"weight-priority": 384,
|
||||
"weight-bulk": 128
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
@@ -0,0 +1,86 @@
|
||||
---
|
||||
description: OpenWiFi
|
||||
---
|
||||
|
||||
# QoS
|
||||
|
||||
Quality of service for Wi-Fi involves multiple functions. 
|
||||
|
||||
IEEE802.11e says stations will send multiple QoS data frames followed by a block ack request (BAR). The AP will send a block ack frame back that includes a bitmap that indicates which frames were received. 
|
||||
|
||||
The 802.11ac-2013 standard states that all data frames be sent as QoS data frames. 
|
||||
|
||||
IEEE802.11-2016 Enterprise QoS Includes action frames for many categories such as spectrum management, QoS, HT, VHT, radio measurements, and more 802.11 QoS is achieved by giving high priority queues a statistical advantage at winning contention. 
|
||||
|
||||
TIP OpenWiFi implements IEEE802.11-2016 Enterprise QoS features in the following way:
|
||||
|
||||
* Traffic Classifiers fully mapping Wireless Multi-Media with DSCP in 802.11-2016 terms 
|
||||
* Matches by port, range, and or DNS FQDN 
|
||||
* Designed as eBPF Traffic Classifiers TIP OpenWiFi QoS works in Bridge, NAT & VLAN modes
|
||||
* Enables total Bandwidth to rate-cap forwarding Future per SSID based Traffic Classifiers
|
||||
|
||||
OpenWiFi additionally implements standard buffer bloat control when handling queue behavior during shaping. This feature is known as Qosify. Qosify will set Cake queue discipline behavior using an eBPF classifier to set DSCP per packet as part of wirespeed operations in the Linux kernel. 
|
||||
|
||||
### How it works
|
||||
|
||||
Follow the OpenWiFi data model for QoS rules bound to interface via select-ports setting upstream and downstream bandwidth, DSCP marking, protocol and port with an optional FQDN dynamic application match via DNS. Define the wireless-multimedia chosen behavior to set air interface queues.
|
||||
|
||||
TIP OpenWiFi enumerates defined QoS provisioning, as applications or port and protocol matches occur, the Wi-Fi Traffic Identifier (TID) value is set accordingly.  
|
||||
|
||||
|
||||
|
||||
OpenWiFi WMM Supports the following class selector profiles:
|
||||
|
||||
* Enterprise
|
||||
* RFC8325
|
||||
* 3GPP
|
||||
|
||||
|
||||
|
||||
#### Example QoS Definition
|
||||
|
||||
```
|
||||
"globals": {
|
||||
"wireless-multimedia": {
|
||||
"profile": "rfc8325"
|
||||
}
|
||||
|
||||
"services": {
|
||||
"quality-of-service": {
|
||||
"select-ports": [ "WAN" ],
|
||||
"bandwidth_up": 1000,
|
||||
"bandwidth_down": 1000,
|
||||
"bulk-detection": {
|
||||
"dscp": "CS1",
|
||||
"packets-per-second": 500
|
||||
},
|
||||
"classifier": [
|
||||
{
|
||||
"dscp": "CS1",
|
||||
"ports": [
|
||||
{ "protocol": "any", "port": 53 },
|
||||
{ "protocol": "tcp", "port": 80 }
|
||||
],
|
||||
"dns": [
|
||||
{ "fqdn": "telecominfraproject.com", "suffix-matching": false }
|
||||
]
|
||||
}, {
|
||||
"dscp": "AF41",
|
||||
"dns": [
|
||||
{ "fqdn": "zoom.us" }
|
||||
]
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
In the above example, select-ports was set as WAN. Should the access point have an SSID associated to the WAN interface, the defined QoS settings become applied to both Wi-Fi air interface and the Ethernet interface. By default WAN is chosen for all classification and shaping. 
|
||||
|
||||
Bulk detection functions to optimize bulk traffic flows measured in average packet size and packets per second. When bulk-detection is triggered, marking with Diffserv Code Point (DSCP) is possible. Default is CS0. 
|
||||
|
||||
Classifier works to specifically trigger on conditional criteria of ports, dns matching individually or in combination with either or both tcp or udp protocols for classification in DSCP terms. When port is set it may be individual or up to an end port when setting range-end value. 
|
||||
|
||||
If matching traffic enters already classified in DSCP terms, OpenWiFi by default will reclassify based on the classifier conditions defined unless reclassify is set to false.  
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,54 @@
|
||||
# RADIUS MAC-Auth
|
||||
|
||||
When deploying headless devices such as IoT services, MAC based authentication dedicated to a unique SSID may be required. TIP OpenWiFi supports MAC-Auth for any SSID when configured with RADIUS parameters set to "mac-filter" true.
|
||||
|
||||
|
||||
|
||||
Example 
|
||||
|
||||
```
|
||||
"interfaces": [
|
||||
{
|
||||
"name": "WAN",
|
||||
"role": "upstream",
|
||||
"ethernet": [
|
||||
{
|
||||
"select-ports": [
|
||||
"WAN*"
|
||||
]
|
||||
}
|
||||
],
|
||||
"ipv4": {
|
||||
"addressing": "dynamic"
|
||||
},
|
||||
"ssids": [
|
||||
{
|
||||
"name": "OpenWiFi Headless",
|
||||
"wifi-bands": [
|
||||
"5G", "2G"
|
||||
],
|
||||
"bss-mode": "ap",
|
||||
"encryption": {
|
||||
"proto": "none",
|
||||
"ieee80211w": "optional"
|
||||
},
|
||||
"radius": {
|
||||
"authentication": {
|
||||
"host": "192.168.178.192",
|
||||
"port": 1812,
|
||||
"secret": "secret",
|
||||
"mac-filter": true
|
||||
},
|
||||
"accounting": {
|
||||
"host": "192.168.178.192",
|
||||
"port": 1813,
|
||||
"secret": "secret"
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
},
|
||||
```
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,17 @@
|
||||
---
|
||||
description: TIP OpenWiFi
|
||||
---
|
||||
|
||||
# WISPr Subscriber Bandwidth
|
||||
|
||||
OpenWiFi supports WISPr Attribute Value Pairs (AVP)s for setting per authenticated subscriber bandwidth in uplink and downlink. 
|
||||
|
||||
Provided the SSID has been configured for RADIUS authentication, any access-accept retuned with WISPr Max-Up and Max-Down values, OpenWiFi will restrict per subscriber traffic to these rates. 
|
||||
|
||||
**RADIUS Subscriber WISPr Speed Definition:**
|
||||
|
||||
```
|
||||
WISPr-Bandwidth-Max-Up := 100,
|
||||
WISPr-Bandwidth-Max-Down := 100
|
||||
```
|
||||
|
||||
@@ -1,7 +0,0 @@
|
||||
# OpenWiFi Firmware
|
||||
|
||||
One of the highest management costs for operators is delivering firmware to the production network.
|
||||
|
||||
TIP OpenWiFi provides an out-of-the-box firmware management service—controlled using the Firmware dashboard or the firmware API.
|
||||
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
---
|
||||
description: 2.4 Repository Information
|
||||
description: Repository Information
|
||||
---
|
||||
|
||||
# Code Repositories
|
||||
|
||||
@@ -6,28 +6,17 @@ description: TIP OpenWiFi 2.x
|
||||
|
||||
OpenWiFi 2.0 Minimum Viable Product at the end of July, 2021 enables a cloud native and cloud agnostic Software Development Kit (SDK) with management and deployment support for a wide range of Access Point and PoE network switch platforms.
|
||||
|
||||
## Initial release 2.0 SDK includes:
|
||||
## Release 2.6 SDK includes:
|
||||
|
||||
* Zero Touch Cloud Discovery
|
||||
* Firmware Management
|
||||
* User Interface
|
||||
* Device List
|
||||
* Device Reboot
|
||||
* Device LED Blink
|
||||
* Device Remote Packet Capture
|
||||
* Device Configuration
|
||||
* Device Factory Reset
|
||||
* Device Remote TTY shell
|
||||
* Remote Wi-Fi Scan
|
||||
* Associations
|
||||
* UE (Wi-Fi Clients)
|
||||
* Mesh and WDS Clients
|
||||
* MCS, NSS, RSSI, Channel, SSID, Tx/Rx
|
||||
* Device Health Check
|
||||
* Interface Statistics
|
||||
* Device Command History
|
||||
* Venue Provisioning 
|
||||
* Analytics Aggregation
|
||||
* Venue Dashboards 
|
||||
* User Interface for Provisioning & Analytics
|
||||
* Gateway Service - RADIUS Proxy
|
||||
|
||||
|
||||
Upcoming sprint for August includes Dynamic Provisioning service support for template based device configuration.
|
||||
|
||||
OpenWiFi 2.0 SDK is deployable as both a Docker Compose or a Helm on Kubernetes model. See [this](broken-reference) section for installation instructions.
|
||||
|
||||
|
||||
@@ -10,11 +10,11 @@ uCentral is set to become a leading component of OpenWrt, as such will have a di
|
||||
|
||||
Within the model it is possible to provision or return state for all aspects of an OpenWiFi based device easily structured as a JSON payload.
|
||||
|
||||
The complete data model may be found here : [https://ucentral.io/docs/ucentral-schema.html](https://ucentral.io/docs/ucentral-schema.html)
|
||||
The complete data model may be found here :[ ](https://github.com/Telecominfraproject/wlan-ucentral-schema)[https://github.com/Telecominfraproject/wlan-ucentral-schema](https://github.com/Telecominfraproject/wlan-ucentral-schema)
|
||||
|
||||
## Organization
|
||||
|
||||
Each device has a Universally Unique Identifier (UUID). For each device, the configuration presented either manually, via the future Provisioning service from OpenWifi or via a commercial controller generation of provisioning data, the high level relationships of the schema may be understood as follows.
|
||||
Each device has a Universally Unique Identifier (UUID). For each device, the configuration presented either manually, via the future Provisioning service from OpenWiFi or via a commercial controller generation of provisioning data, the high level relationships of the schema may be understood as follows.
|
||||
|
||||
 (1).png>)
|
||||
|
||||
|
||||
@@ -1,10 +1,10 @@
|
||||
---
|
||||
description: TIP OpenWiFi 2.x
|
||||
description: TIP OpenWiFi 2.6
|
||||
---
|
||||
|
||||
# Release 2.x SDK
|
||||
# Release 2.6 SDK
|
||||
|
||||
Release 2.x SDK offers a number of ways to consume OpenWiFi. Available as a single Docker for just the uCentralGW or as a set of microservices offering increasing value to consume helps multiple eco-system partners use as much or as little as desired to integrate with or build a commercial product on the TIP OpenWiFi SDK.
|
||||
Release 2.6 SDK offers a number of ways to consume OpenWiFi. Available as a single Docker for just the uCentralGW or as a set of microservices offering increasing value to consume helps multiple eco-system partners use as much or as little as desired to integrate with or build a commercial product on the TIP OpenWiFi SDK.
|
||||
|
||||
Initial features of the 2.0 SDK at MVP include:
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# About Device Provisioning
|
||||
# Device Provisioning
|
||||
|
||||
|
||||
|
||||
|
||||
The OpenWiFi solution can be applied to a diverse number of use cases from enterprise networks, service provider access, and hotspots. OpenWiFi offers a variety of managed services from small to very large venues of roaming, client shared-key management, client steering, mobile offload, QoS-based services, and Layer 2 and Layer 3 breakout and overlay options. The Provisioning service provides a view into the network as a whole, and venues with entity-based control.
|
||||
|
||||
@@ -18,9 +18,9 @@ You can manage device inventory for both assigned and unassigned states. As devi
|
||||
|
||||
Each inventory record, regardless of assignment state can be viewed in the OpenWifi dashboard.
|
||||
|
||||
{width="6.4in" height="3.0in"}Use the SDK UI to assign a device to a venue, review device configurations, update record tags or delete a device.
|
||||
<img src="../../about-openwifi/media/image13.png" alt="" data-size="original">{width="6.4in" height="3.0in"}Use the SDK UI to assign a device to a venue, review device configurations, update record tags or delete a device.
|
||||
|
||||
|
||||
|
||||
|
||||
### Bulk Inventory API
|
||||
|
||||
@@ -52,18 +52,18 @@ Choosing to assign the device to a specific MDU location as an example can be do
|
||||
|
||||
Devices can be assigned to the MDU—which may be an actual venue such as a building or a tenant operator with child venues.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## Provisioning Templates
|
||||
|
||||
Use the Create Configuration window to create a configuration template for a specific venue or device.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
For example, a configuration template for a local area network could include: address translation and local DHCP for on-premises devices, WAN interface with DHCP for IPv4/IPv6 service, and a basic Wi-Fi configuration.
|
||||
35
sdk/user-interface/firmware-1.md
Normal file
35
sdk/user-interface/firmware-1.md
Normal file
@@ -0,0 +1,35 @@
|
||||
---
|
||||
description: OpenWiFi 2.0 SDK
|
||||
---
|
||||
|
||||
# Firmware
|
||||
|
||||
Firmware management service integrates across all OpenWiFi Gateways deployed in a cluster enabling updates to running firmware either from the latest published version, or any other released version.
|
||||
|
||||
## Dashboard
|
||||
|
||||
Firmware dashboard provides a single view for overall health of deployed device firmware. Latest firmware charts, device firmware version distribution, distribution of device by type and current connected devices.
|
||||
|
||||
|
||||
|
||||
## Device Table
|
||||
|
||||
From the Devices table, any device with a newer firmware published by TIP OpenWiFi is indicated with a yellow icon. Selecting this icon presents the option to upgrade to latest or specify which firmware to use.
|
||||
|
||||
|
||||
|
||||
When the upgrade has been sent successfully, a green Success dialog will display in the upper right on the screen. Devices with latest firmware version will show a green firmware icon in the Devices row.
|
||||
|
||||
## Firmware Management Service
|
||||
|
||||
Viewing the contents of Firmware Management Service is available from the left navigation, select Firmware.
|
||||
|
||||
Once in Firmware, it is possible to search by device model for all known firmware revisions.
|
||||
|
||||
|
||||
|
||||
If in the Device Table reference above, instead of selecting Upgrade to Latest, the specific URI location of any available firmware is found using the Firmware table.
|
||||
|
||||
Selecting Details will present information for any firmware row, including the URI which may be copied into the Choose Custom Firmware dialog prompt accordingly.
|
||||
|
||||
|
||||
@@ -1,35 +1,7 @@
|
||||
---
|
||||
description: OpenWiFi 2.0 SDK
|
||||
---
|
||||
# Firmware Management
|
||||
|
||||
# Firmware
|
||||
One of the highest management costs for operators is delivering firmware to the production network.
|
||||
|
||||
Firmware management service integrates across all OpenWiFi Gateways deployed in a cluster enabling updates to running firmware either from the latest published version, or any other released version.
|
||||
TIP OpenWiFi provides an out-of-the-box firmware management service—controlled using the Firmware dashboard or the firmware API.
|
||||
|
||||
## Dashboard
|
||||
|
||||
Firmware dashboard provides a single view for overall health of deployed device firmware. Latest firmware charts, device firmware version distribution, distribution of device by type and current connected devices.
|
||||
|
||||
|
||||
|
||||
## Device Table
|
||||
|
||||
From the Devices table, any device with a newer firmware published by TIP OpenWiFi is indicated with a yellow icon. Selecting this icon presents the option to upgrade to latest or specify which firmware to use.
|
||||
|
||||
|
||||
|
||||
When the upgrade has been sent successfully, a green Success dialog will display in the upper right on the screen. Devices with latest firmware version will show a green firmware icon in the Devices row.
|
||||
|
||||
## Firmware Management Service
|
||||
|
||||
Viewing the contents of Firmware Management Service is available from the left navigation, select Firmware.
|
||||
|
||||
Once in Firmware, it is possible to search by device model for all known firmware revisions.
|
||||
|
||||
|
||||
|
||||
If in the Device Table reference above, instead of selecting Upgrade to Latest, the specific URI location of any available firmware is found using the Firmware table.
|
||||
|
||||
Selecting Details will present information for any firmware row, including the URI which may be copied into the Choose Custom Firmware dialog prompt accordingly.
|
||||
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user