scottk/wlan-cloud-ucentralgw
1
0
Fork 0
mirror of https://github.com/Telecominfraproject/wlan-cloud-ucentralgw.git synced 2025-10-29 18:02:27 +00:00
Code Issues Packages Projects Releases 10 Wiki Activity

https://telecominfraproject.atlassian.net/browse/WIFI-10797

Browse Source 
Signed-off-by: stephb9959 <stephane.bourque@gmail.com>
This commit is contained in:
stephb9959
2022-09-08 22:55:20 -07:00
parent 0c5087960e
commit 183f06e5fa
2 changed files with 31 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
MICRO_SERVICE_PROTOCOL.md
View File

@@ -18,17 +18,29 @@ System messages are what maintains the collection of micro-services working on t
} }
``` ```
### Responsibilities
Each micro service is responsible to generate its own messages and keep track of messages coming from other
micro services. This is necessary so that any micro service may reach our any other micro service. This provides
discovery for any micro service. All current micro services provided in OpenWiFi perform these functions. If you leverage
the C++ framework, this functionality if performed automatically.
### `event-type` ### `event-type`
When a service joins the bus, it should generate an event-type of `join`. When a service shutdown, it should generate a `leave` event-type. Every 30 seconds, a service Each micro service is responsible to generate and consume these events
should generate a `keep-alive` message.
#### `join` event
When a service start and joins the bus, it should generate an event-type of `join`.
### `leave` event
When a service shuts down, it should generate a `leave` event-type.
### `keep-alive` event
Every 30 seconds, a service should generate a `keep-alive` message.
### `id` ### `id`
You should generate a random number from some unique factor for the system. This ID is used to identify different services. You should reuse that ID You should generate a random number from some unique factor for the system. This ID is used to identify different services. You should reuse that ID
when you restart. when you restart.
## Micro-service maintaining bus state
A micro-service should maintain its own lists of available micro-services by looking at the messages it receives and keep a list.
## The `type` ## The `type`
The `type` in the system message is oen of the following: The `type` in the system message is oen of the following:
```c++ ```c++
@@ -47,11 +59,11 @@ The `type` in the system message is oen of the following:
The `type` is what you should use to find the `privateEndPoint` you are looking to communicate with. The `type` is what you should use to find the `privateEndPoint` you are looking to communicate with.
### Example ### Example
Assume you want to communicate with the gateway t pconfigure a device. Assume you want to communicate with the gateway to configure a device.
```text ```text
1. Look into my list of current Micro-services for the type=owgw. 1. Look into my list of current Micro-services for the type=owgw.
2. Use the priovateEndPoint associated with that entry 2. Use the privateEndPoint associated with that entry
``` ```
## REST API calls on the private interface ## REST API calls on the private interface
@@ -72,9 +84,9 @@ This is the `publicEndPoint` you included in your `system-messages`.
This method can _only_ be used to any another `privateEndPoint` in the system. You can use the exact same EndPoints provided in the OpenAPI files for any of the services. This method can _only_ be used to any another `privateEndPoint` in the system. You can use the exact same EndPoints provided in the OpenAPI files for any of the services.
## OpenAPI Integration ## OpenAPI Integration
To appear in the UI consoles, a micro-service should ne able to handle a get to the `/api/v1/system` endpoint on its `publicEndPoint` interface. To appear in the UI consoles, a microservice should be able to handle a get to the `/api/v1/system` endpoint on its `publicEndPoint` interface.
Here is a brief description of what the micro-service should answer: Here is a brief description of what the microservice should answer:
```yaml ```yaml
/system: /system:
get: get:

12
README.md
View File

@@ -11,16 +11,16 @@ In order to build the uCentralGW, you will need to install its dependencies, whi
- boost - boost
- POCO 1.10.1 or later - POCO 1.10.1 or later
- a C++17 compiler - a C++17 compiler
- libyaml
- openssl - openssl
- libpq-dev (PortgreSQL development libraries) - libpq-dev (PortgreSQL development libraries)
- mysql-client (MySQL client) - mysql-client (MySQL client)
- librdkafka - librdkafka
- cppkafka - cppkafka
-
The build is done in 2 parts. The first part is to build a local copy of the framework tailored to your environment. This The build is done in 2 parts. The first part is to build a local copy of the framework tailored to your environment. This
framework is called [Poco](https://github.com/pocoproject/poco). The version used in this project has a couple of fixes framework is called [Poco](https://github.com/pocoproject/poco). The version used in this project has a couple of fixes
from the master copy needed for cmake. Please use the version of this [Poco fix](https://github.com/stephb9959/poco). Building from the master copy needed for cmake. Please use the version of this [Poco fix](https://github.com/AriliaWireless/poco). Building
Poco may take several minutes depending on the platform you are building on. Poco may take several minutes depending on the platform you are building on.
### Ubuntu ### Ubuntu
@@ -58,6 +58,14 @@ cmake ..
make -j make -j
sudo make install sudo make install
git clone https://github.com/fmtlib/fmt --branch 9.0.0 /fmtlib
cd fmtlib
mkdir cmake-build
cd cmake-build
cmake ..
make
make install
cd ~ cd ~
git clone https://github.com/Telecominfraproject/wlan-cloud-ucentralgw git clone https://github.com/Telecominfraproject/wlan-cloud-ucentralgw
cd wlan-cloud-ucentralgw cd wlan-cloud-ucentralgw