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

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

Browse Source 
Signed-off-by: stephb9959 <stephane.bourque@gmail.com>
This commit is contained in:
stephb9959
2023-02-26 22:42:39 -08:00
parent 6cd1c9a0f6
commit 3366b933bf
2 changed files with 27 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

42
README.md
View File

@@ -19,30 +19,45 @@ To build the microservice from source, please follow the instructions in [here](
## Docker ## Docker
To use the CLoudSDK deployment please follow [here](https://github.com/Telecominfraproject/wlan-cloud-ucentral-deploy) To use the CLoudSDK deployment please follow [here](https://github.com/Telecominfraproject/wlan-cloud-ucentral-deploy)
### After completing the build
After completing the build, you can remove the Poco source as it is no longer needed.
#### Expected directory layout #### Expected directory layout
From the directory where your cloned source is, you will need to create the `certs`, `logs`, and `data`. From the directory where your cloned source is, you will need to create the `certs`, `logs`, and `uploads` directories.
```shell ```bash
mkdir certs mkdir certs
mkdir certs/cas
mkdir logs mkdir logs
mkdir data mkdir uploads
```
You should now have the following:
```text
--+-- certs
| +--- cas
+-- cmake
+-- cmake-build
+-- logs
+-- src
+-- test_scripts
+-- openapi
+-- uploads
+-- owsec.properties
``` ```
### Certificates ### Certificate
Love'em of hate'em, we gotta use'em. So we tried to make this as easy as possible for you. The OWFMS uses a certificate to provide security for the REST API Certificate to secure the Northbound API.
#### The `certs` directory #### The `certs` directory
For all deployments, you will need the following `certs` directory, populated with the proper files. For all deployments, you will need the following `certs` directory, populated with the proper files.
```asm ```text
certs ---+--- certs ---+--- restapi-ca.pem
+--- restapi-ca.pem
+--- restapi-cert.pem +--- restapi-cert.pem
+--- restapi-key.pem +--- restapi-key.pem
``` ```
## Firewall Considerations
| Port | Description | Configurable |
|:------|:----------------------------------------------|:------------:|
| 16003 | Default port for REST API Access to the OWFMS | yes |
### Environment variables ### Environment variables
The following environment variables should be set from the root directory of the service. They tell the OWGW process where to find The following environment variables should be set from the root directory of the service. They tell the OWGW process where to find
the configuration and the root directory. the configuration and the root directory.
@@ -56,11 +71,6 @@ You can run the shell script `set_env.sh` from the microservice root.
The configuration is kept in a file called `owfms.properties`. To understand the content of this file, The configuration is kept in a file called `owfms.properties`. To understand the content of this file,
please look [here](https://github.com/Telecominfraproject/wlan-cloud-ucentralfms/blob/main/CONFIGURATION.md) please look [here](https://github.com/Telecominfraproject/wlan-cloud-ucentralfms/blob/main/CONFIGURATION.md)
## Firewall Considerations
| Port | Description | Configurable |
|:------|:----------------------------------------------|:------------:|
| 16003 | Default port for REST API Access to the OWFMS | yes |
## Kafka topics ## Kafka topics
Toe read more about Kafka, follow the [document](https://github.com/Telecominfraproject/wlan-cloud-ucentralgw/blob/main/KAFKA.md) Toe read more about Kafka, follow the [document](https://github.com/Telecominfraproject/wlan-cloud-ucentralgw/blob/main/KAFKA.md)

2
build
View File

@@ -1 +1 @@
9 10