scottk/wlan-docs
1
0
Fork 0
mirror of https://github.com/Telecominfraproject/wlan-docs.git synced 2025-11-02 19:57:51 +00:00
Code Issues Packages Projects Releases Wiki Activity

GitBook: [master] 25 pages modified

Browse Source
This commit is contained in:
Chris Busch
2021-03-30 12:32:07 +00:00
committed by gitbook-bot
parent 6f50e0d410
commit 649d03b1fb
10 changed files with 47 additions and 34 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
SUMMARY.md
View File

@@ -3,10 +3,10 @@
* [Open Wi-Fi](README.md)
* [Ordering Open Wi-Fi APs](ordering-open-wi-fi-aps.md)
* [Getting Started](getting-started/README.md)
* [Controller Installation](getting-started/controller-installation/README.md)
* [Cloud SDK Installation](getting-started/controller-installation/README.md)
* [AWS Install](getting-started/controller-installation/aws-install.md)
* [MicroK8s Install](getting-started/controller-installation/microk8s-install.md)
* [Controller](getting-started/controller.md)
* [Cloud SDK](getting-started/controller.md)
* [Access Points](getting-started/access-points.md)
* [User Interface](user-interface/README.md)
* [Dashboard](user-interface/dashboard.md)
@@ -15,7 +15,7 @@
* [System](user-interface/system.md)
* [Accounts](user-interface/accounts.md)
* [API](api/README.md)
* [Swagger](api/swagger.md)
* [Cloud SDK Open API and Swagger](api/swagger.md)
## MDU Quick Start

14
api/swagger.md
View File

@@ -1,14 +1,24 @@
# Swagger
---
description: Online and Local Open API Access
---
# Cloud SDK Open API and Swagger
TIP Open Wi-Fi controller implements an Open API compliant NorthBound Interface \(NBI\) to assist with integration and related back office features.
Swagger is a useful tool to explore and learn any system API. Running a local Swagger instance requires a current version of NodeJS installed.
### Online Cloud SDK Open API
Current SDK open API is available at the following URL: [CloudSDK Open API](https://l.workplace.com/l.php?u=https%3A%2F%2Fapi.lab.wlan.tip.build%2F&h=AT2qj4RJnFaxruxpxP2s8O-XjRQMEbCC7aoVbHaHxmOxgfOgi5LHv6lWdCU4aV8x2vJcsxGmY-UKxb8W86xaDH-VtVLomBcBkdEHVxlpssluOoSPiIMC-vXU0NtGW44qktgKDJc934Dl2kr0QnRyZw)
### Obtain latest TIP Controller Open API data model
When running a local instance of Swagger, first obtain the most current Cloud SDK open API from source control:
{% embed url="https://github.com/Telecominfraproject/wlan-cloud-services/blob/master/portal-services/src/main/resources/portal-services-openapi.yaml" caption="TIP Github repo link to Open API data model " %}
### Install Swagger
#### Install Swagger
```text
mkdir ~/swagger

8
getting-started/README.md
View File

@@ -1,13 +1,15 @@
# Getting Started
Deploying the TIP Open Wi-Fi solution into a lab or into production is simple to do and. Some basic pre-requisites should be satisfied before beginning.
Deploying the TIP Open Wi-Fi solution into a lab or into production is simple to do.
Some basic pre-requisites should be satisfied before beginning.
Please ensure the following are known before beginning installation:
Ensure the following are known before beginning installation:
* Fully Qualified Domain Name \(FQDN\) is available and configurable
* Internet Protocol \(IP\) subnet with Dynamic Host Configuration Protocol \(DHCP\) for access points is available
* Internet Protocol \(IP\) subnet with static addressing is available for Cloud SDK
* If using VLAN features of the access points, an IEEE 802.1q compliant Ethernet switch and VLAN topology are supported in your network
* Network traffic is permitted for the following ports:
* Network traffic is permitted for the following ports from Access Points to Cloud SDK:
* 80
* 443
* 1883

8
getting-started/controller-installation/README.md
View File

@@ -1,10 +1,10 @@
# Controller Installation
# Cloud SDK Installation
Open Wi-Fi controller may be deployed to both public and private cloud environments.
Open Wi-Fi Cloud SDK may be deployed to both public and private cloud environments.
Native Helm charts exist to support automated deployment of the controller PODs and containers into AWS and microk8s Kubernetes platforms.
Helm charts support automated deployment of the Cloud SDK PODs and containers into AWS and MicroK8s Kubernetes platforms.
The following pages provide step-by-step instructions to deploy in public cloud \(AWS\) or private on-premises \(microk8s\) cloud.
The following pages provide step-by-step instructions to deploy in public cloud \(AWS\) or private on-premises \(MicroK8s\) cloud.
{% page-ref page="aws-install.md" %}

12
getting-started/controller.md
View File

@@ -1,17 +1,17 @@
---
description: TIP Open Wi-Fi Controller
description: TIP Open Wi-Fi
---
# Controller
# Cloud SDK
With the controller now installed into either a public cloud or on premises cloud, logging in with default username **support@example.com** and password **support** are now possible.
With the Cloud SDK now installed into either a public cloud or on premises, logging in with default username **support@example.com** and password **support** are now possible.
![Controller Login Page](../.gitbook/assets/screen-shot-2020-11-29-at-4.25.44-pm.png)
![Default Login Page](../.gitbook/assets/screen-shot-2020-11-29-at-4.25.44-pm.png)
Once successfully logged in, please refer to [User Interface](../user-interface/) documentation for further details of specific controller configuration.
Once successfully logged in, please refer to [User Interface](../user-interface/) documentation for further details of specific configuration.
{% hint style="info" %}
Current TIP Controller deploys using self-signed certificates. This requires accepting the self-signed certificate in the UI for the following URLs:
Current TIP Cloud SDK deploys using self-signed certificates. This requires accepting the self-signed certificate in the UI for the following URLs:
https://wlan-ui.wlan.local
https://wlan-ui-graphql.wlan.local
Navigate to both URLs and accept the certificate exception.

2
ordering-open-wi-fi-aps.md
View File

@@ -4,7 +4,7 @@ description: TIP Wi-Fi Member Access Point Ordering Information
# Ordering Open Wi-Fi APs
TIP Wi-Fi members may contact the ODM manufacturers in the TIP WI-Fi eco-system using the information posted within Community Confluence page.
TIP Wi-Fi members may contact the ODM manufacturers in the TIP Wi-Fi eco-system using the information posted within Community Confluence page.
{% embed url="https://telecominfraproject.atlassian.net/wiki/spaces/WIFI/pages/112689187/AP+Hardware" %}

6
user-interface/README.md
View File

@@ -1,12 +1,14 @@
---
description: TIP SDK
description: TIP Cloud SDK
---
# User Interface
## Navigating the UI
TIP open source SDK offers a web based user interface supporting many common configurations. The web based interface uses the SDK API. It is possible to further extend functionality of the SDK user interface or to create other interfaces using the SDK API.
TIP open source SDK offers a web based user interface supporting many common configurations. The web based interface uses the SDK north bound API.
It is possible to further extend functionality of the SDK user interface or to create other interfaces using the SDK API.
### Log In

7
user-interface/dashboard.md
View File

@@ -4,7 +4,7 @@ description: Cloud SDK Default Landing Page
# Dashboard
TIP Cloud SDK is organized into main components organized along the top of the screen.
TIP Cloud SDK is organized into main components presented along the top of the screen.
![Cloud SDK User Interface Top Navigation](../.gitbook/assets/screen-shot-2021-03-28-at-1.25.04-pm.png)
@@ -12,10 +12,9 @@ Dashboard is the default landing page for the user interface.
Network enables management of Access Points and display of Client Devices status.
Profiles enables template based management of all provisioning parameters.
System enables Manufacturer OUI Updates, Firmware Updates, Auto-Provisioning and Client Block List.
Users enables configuration of local user accounts of the Cloud SDK.
Users enables configuration of local user accounts of the Cloud SDK.
Alarm indicates an error condition has occurred with one or multiple Access Points.
Gear icon to LogOut.
Gear icon to Log Out.
### Dashboard Components

16
user-interface/network.md
View File

@@ -10,22 +10,22 @@ From the Network page it is possible to create organizational regions to group d
### Location Tree
In a future release it will be possible to assign devices to new locations to help in building an administrative hierarchy supporting convenient organization of device to service location. This functionality is exposed in the API and may be further refined in subsequent UI releases.
In a future release it will be possible to assign devices to new locations to help in building an administrative hierarchy supporting convenient organization of device to service location. This functionality is exposed in the API and may be further refined in subsequent open source UI releases.
### Access Points
For each Access Point that has contacted Cloud SDK, a row will populate within Access Points.
Specific information for each Access Point including Device name, alarm state, model and IP address are shown.
For each access point that has contacted Cloud SDK, a row will populate within Access Points.
Specific information for each device including Device name, alarm state, model and IP address are shown.
Along the right side of each Access Point row are Profile, Channel, Occupancy, Noise Floor and Devices.
Channel indicates the current provisioned RF Channel for each radio in the Access Point.
Channel indicates the current provisioned RF Channel for each radio in the device.
Occupancy indicates available RF bandwidth for Wi-Fi clients as a value over 100.
Noise Floor represents the reported RF noise condition being measured by the Access Point within the operating channel and reported to the Cloud SDK.
Devices indicated the total associated clients for each radio in the Access Point.
Noise Floor represents the reported RF noise condition being measured by the device within the operating channel and reported to the Cloud SDK.
Devices indicated the total associated clients for each radio in the access point.
#### Access Point Device Record
Each Access Point managed by Cloud SDK inherits provisioning information from Profiles in addition to supporting device specific configurations and reporting device specific operating conditions.
Each access point managed by Cloud SDK inherits provisioning information from Profiles in addition to supporting device specific configurations and reporting device specific operating conditions.
![Selecting an Access Point Record](../.gitbook/assets/screen-shot-2021-03-28-at-4.40.46-pm.png)
@@ -37,7 +37,7 @@ Location permits the assignment of the device to a location in Cloud SDK hierarc
![Device Operating System Statistics](../.gitbook/assets/screen-shot-2021-03-28-at-4.48.02-pm.png)
Operating System Stats are sent to Cloud SDK from each Access Point using the MQTT interface. These statistics are regularly received as part of the overall telemetry stream.
Operating System Stats are sent to Cloud SDK from each device using the MQTT interface. These statistics are regularly received as part of the overall telemetry stream.
#### Firmware

2
user-interface/profiles.md
View File

@@ -19,6 +19,6 @@ Sample default templates are provided on initial startup of Cloud SDK.
| RADIUS | Authentication Authorization Accounting Configuration per SSID |
| Equipment AP | 1:1 or 1:Many Device Association to RF Profile and SSID |
| Captive Portal | Access Point Captive Portal configuration parameters |
| Passpoint | R1 & R2 Compliant IEEE802.11u configuration parameters |
| Passpoint | R1 & R2 Compliant IEEE 802.11u configuration parameters |
| Passpoint ID Provider | R2 Compliant Offload, Venue, NAI and OpenRoaming configuration parameters |