Skip to content

Latest commit

 

History

History
96 lines (80 loc) · 4.64 KB

README.md

File metadata and controls

96 lines (80 loc) · 4.64 KB
Raw

OpenWifi User Self-Care portal (OWSUB)

What is it?

The OWSUB is a service for the TIP OpenWiFi CloudSDK (OWSDK). OWSUB provides a subscriber management service to the Subscriber App and interacts with the rest of the Cloud SDK. OWSUB, like all other OWSDK microservices, is defined using an OpenAPI definition and uses the ucentral communication protocol to interact with Access Points. To use the OWSUB, you either need to build it or use the Docker version.

OpenAPI

You may get static page with OpenAPI docs generated from the definition on GitHub Page.

Building

To build the microservice from source, please follow the instructions in here

Docker

To use the CLoudSDK deployment please follow here Also, you may use Swagger UI with OpenAPI definition file raw link (i.e. latest version file) to get interactive docs page.

Expected directory layout

From the directory where your cloned source is, you will need to create the certs, logs, and uploads directories.

mkdir certs
mkdir certs/cas
mkdir logs
mkdir uploads

You should now have the following:

--+-- certs
  |   +--- cas
  +-- cmake
  +-- cmake-build
  +-- logs
  +-- src
  +-- test_scripts
  +-- openapi
  +-- uploads
  +-- owsub.properties

Certificate

The OWSUB uses a certificate to provide security for the REST API Certificate to secure the Northbound API.

The certs directory

For all deployments, you will need the following certs directory, populated with the proper files.

certs ---+--- restapi-ca.pem
         +--- restapi-cert.pem
         +--- restapi-key.pem

Firewall Considerations

Port Description Configurable
16006 Default port for REST API Access to the OWSUB yes

Environment variables

The following environment variables should be set from the root directory of the service. They tell the OWSUB process where to find the configuration and the root directory.

export OWSUB_ROOT=`pwd`
export OWSUB_CONFIG=`pwd`

You can run the shell script set_env.sh from the microservice root.

OWSUB Service Configuration

The configuration is kept in a file called owsub.properties. To understand the content of this file, please look here

Kafka topics

Toe read more about Kafka, follow the document

Contributions

We need more contributors. Should you wish to contribute, please follow the contributions document.

Pull Requests

Please create a branch with the Jira addressing the issue you are fixing or the feature you are implementing. Create a pull-request from the branch into master.

Additional OWSDK Microservices

Here is a list of additional OWSDK microservices

Name Description Link OpenAPI
OWSEC Security Service here here
OWGW Controller Service here here
OWFMS Firmware Management Service here here
OWPROV Provisioning Service here here
OWANALYTICS Analytics Service here here
OWSUB Subscriber Service here here