diff --git a/README.md b/README.md index cd7d479..6f21721 100644 --- a/README.md +++ b/README.md @@ -11,18 +11,61 @@ like all other OWSDK microservices, is defined using an OpenAPI definition and u protocol to interact with Access Points. To use the OWSUB, you either need to [build it](#building) or use the [Docker version](#docker). +## OpenAPI +You may get static page with OpenAPI docs generated from the definition on [GitHub Page](https://telecominfraproject.github.io/wlan-cloud-userportal/). + ## Building To build the microservice from source, please follow the instructions in [here](./BUILDING.md) ## Docker To use the CLoudSDK deployment please follow [here](https://github.com/Telecominfraproject/wlan-cloud-ucentral-deploy) +Also, you may use [Swagger UI](https://petstore.swagger.io/#/) with OpenAPI definition file raw link (i.e. [latest version file](https://raw.githubusercontent.com/Telecominfraproject/wlan-cloud-userportal/main/openapi/owanalytics.yaml)) 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. +```bash +mkdir certs +mkdir certs/cas +mkdir logs +mkdir uploads +``` +You should now have the following: +```text +--+-- 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. + +```text +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 OWGW process where to find +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. ```bash -export OWGW_ROOT=`pwd` -export OWGW_CONFIG=`pwd` +export OWSUB_ROOT=`pwd` +export OWSUB_CONFIG=`pwd` ``` You can run the shell script `set_env.sh` from the microservice root. @@ -30,16 +73,6 @@ You can run the shell script `set_env.sh` from the microservice root. The configuration is kept in a file called `owsub.properties`. To understand the content of this file, please look [here](https://github.com/Telecominfraproject/wlan-cloud-userportal/blob/main/CONFIGURATION.md) -## OpenAPI -You may get static page with OpenAPI docs generated from the definition on [GitHub Page](https://telecominfraproject.github.io/wlan-cloud-userportal/). - -Also, you may use [Swagger UI](https://petstore.swagger.io/#/) with OpenAPI definition file raw link (i.e. [latest version file](https://raw.githubusercontent.com/Telecominfraproject/wlan-cloud-userportal/main/openapi/owanalytics.yaml)) to get interactive docs page. - -## Firewall Considerations -| Port | Description | Configurable | -|:------|:--------------------------------------------|:------------:| -| 16006 | Default port for REST API Access to the OWSUB | yes | - ## Kafka topics Toe read more about Kafka, follow the [document](https://github.com/Telecominfraproject/wlan-cloud-ucentralgw/blob/main/KAFKA.md) diff --git a/build b/build index 301160a..f11c82a 100644 --- a/build +++ b/build @@ -1 +1 @@ -8 \ No newline at end of file +9 \ No newline at end of file diff --git a/cmake-build-debug/.cmake/api/v1/reply/index-2023-02-27T06-31-33-0234.json b/cmake-build-debug/.cmake/api/v1/reply/index-2023-02-27T06-31-33-0234.json new file mode 100644 index 0000000..b5f4a96 --- /dev/null +++ b/cmake-build-debug/.cmake/api/v1/reply/index-2023-02-27T06-31-33-0234.json @@ -0,0 +1,108 @@ +{ + "cmake" : + { + "generator" : + { + "multiConfig" : false, + "name" : "Unix Makefiles" + }, + "paths" : + { + "cmake" : "/Applications/CLion.app/Contents/bin/cmake/mac/bin/cmake", + "cpack" : "/Applications/CLion.app/Contents/bin/cmake/mac/bin/cpack", + "ctest" : "/Applications/CLion.app/Contents/bin/cmake/mac/bin/ctest", + "root" : "/Applications/CLion.app/Contents/bin/cmake/mac/share/cmake-3.23" + }, + "version" : + { + "isDirty" : false, + "major" : 3, + "minor" : 23, + "patch" : 2, + "string" : "3.23.2", + "suffix" : "" + } + }, + "objects" : + [ + { + "jsonFile" : "codemodel-v2-0d6bebbf65a3da552bf4.json", + "kind" : "codemodel", + "version" : + { + "major" : 2, + "minor" : 4 + } + }, + { + "jsonFile" : "cache-v2-dc18603c31de90ea876e.json", + "kind" : "cache", + "version" : + { + "major" : 2, + "minor" : 0 + } + }, + { + "jsonFile" : "cmakeFiles-v1-ef1430b24f88d2e46d9f.json", + "kind" : "cmakeFiles", + "version" : + { + "major" : 1, + "minor" : 0 + } + }, + { + "jsonFile" : "toolchains-v1-b57293a485ebf36c82cc.json", + "kind" : "toolchains", + "version" : + { + "major" : 1, + "minor" : 0 + } + } + ], + "reply" : + { + "cache-v2" : + { + "jsonFile" : "cache-v2-dc18603c31de90ea876e.json", + "kind" : "cache", + "version" : + { + "major" : 2, + "minor" : 0 + } + }, + "cmakeFiles-v1" : + { + "jsonFile" : "cmakeFiles-v1-ef1430b24f88d2e46d9f.json", + "kind" : "cmakeFiles", + "version" : + { + "major" : 1, + "minor" : 0 + } + }, + "codemodel-v2" : + { + "jsonFile" : "codemodel-v2-0d6bebbf65a3da552bf4.json", + "kind" : "codemodel", + "version" : + { + "major" : 2, + "minor" : 4 + } + }, + "toolchains-v1" : + { + "jsonFile" : "toolchains-v1-b57293a485ebf36c82cc.json", + "kind" : "toolchains", + "version" : + { + "major" : 1, + "minor" : 0 + } + } + } +}