Compare commits

..

1 Commits

Author SHA1 Message Date
oblom0v
fde3917fad Change image tag to rc version 2021-08-31 13:44:07 +02:00
252 changed files with 8967 additions and 26733 deletions

View File

@@ -1,178 +0,0 @@
---
Language: Cpp
# BasedOnStyle: LLVM
AccessModifierOffset: -2
AlignAfterOpenBracket: Align
AlignArrayOfStructures: None
AlignConsecutiveMacros: None
AlignConsecutiveAssignments: None
AlignConsecutiveBitFields: None
AlignConsecutiveDeclarations: None
AlignEscapedNewlines: Right
AlignOperands: Align
AlignTrailingComments: true
AllowAllArgumentsOnNextLine: true
AllowAllConstructorInitializersOnNextLine: true
AllowAllParametersOfDeclarationOnNextLine: true
AllowShortEnumsOnASingleLine: true
AllowShortBlocksOnASingleLine: Never
AllowShortCaseLabelsOnASingleLine: false
AllowShortFunctionsOnASingleLine: All
AllowShortLambdasOnASingleLine: All
AllowShortIfStatementsOnASingleLine: Never
AllowShortLoopsOnASingleLine: false
AlwaysBreakAfterDefinitionReturnType: None
AlwaysBreakAfterReturnType: None
AlwaysBreakBeforeMultilineStrings: false
AlwaysBreakTemplateDeclarations: MultiLine
AttributeMacros:
- __capability
BinPackArguments: true
BinPackParameters: true
BraceWrapping:
AfterCaseLabel: false
AfterClass: false
AfterControlStatement: Never
AfterEnum: false
AfterFunction: false
AfterNamespace: false
AfterObjCDeclaration: false
AfterStruct: false
AfterUnion: false
AfterExternBlock: false
BeforeCatch: false
BeforeElse: false
BeforeLambdaBody: false
BeforeWhile: false
IndentBraces: false
SplitEmptyFunction: true
SplitEmptyRecord: true
SplitEmptyNamespace: true
BreakBeforeBinaryOperators: None
BreakBeforeConceptDeclarations: true
BreakBeforeBraces: Attach
BreakBeforeInheritanceComma: false
BreakInheritanceList: BeforeColon
BreakBeforeTernaryOperators: true
BreakConstructorInitializersBeforeComma: false
BreakConstructorInitializers: BeforeColon
BreakAfterJavaFieldAnnotations: false
BreakStringLiterals: true
ColumnLimit: 100
CommentPragmas: '^ IWYU pragma:'
CompactNamespaces: false
ConstructorInitializerAllOnOneLineOrOnePerLine: false
ConstructorInitializerIndentWidth: 4
ContinuationIndentWidth: 4
Cpp11BracedListStyle: true
DeriveLineEnding: true
DerivePointerAlignment: false
DisableFormat: false
EmptyLineAfterAccessModifier: Never
EmptyLineBeforeAccessModifier: LogicalBlock
ExperimentalAutoDetectBinPacking: false
FixNamespaceComments: true
ForEachMacros:
- foreach
- Q_FOREACH
- BOOST_FOREACH
IfMacros:
- KJ_IF_MAYBE
IncludeBlocks: Preserve
IncludeCategories:
- Regex: '^"(llvm|llvm-c|clang|clang-c)/'
Priority: 2
SortPriority: 0
CaseSensitive: false
- Regex: '^(<|"(gtest|gmock|isl|json)/)'
Priority: 3
SortPriority: 0
CaseSensitive: false
- Regex: '.*'
Priority: 1
SortPriority: 0
CaseSensitive: false
IncludeIsMainRegex: '(Test)?$'
IncludeIsMainSourceRegex: ''
IndentAccessModifiers: false
IndentCaseLabels: false
IndentCaseBlocks: false
IndentGotoLabels: true
IndentPPDirectives: None
IndentExternBlock: AfterExternBlock
IndentRequires: false
IndentWidth: 4
IndentWrappedFunctionNames: false
InsertTrailingCommas: None
JavaScriptQuotes: Leave
JavaScriptWrapImports: true
KeepEmptyLinesAtTheStartOfBlocks: true
LambdaBodyIndentation: Signature
MacroBlockBegin: ''
MacroBlockEnd: ''
MaxEmptyLinesToKeep: 1
NamespaceIndentation: All
ObjCBinPackProtocolList: Auto
ObjCBlockIndentWidth: 2
ObjCBreakBeforeNestedBlockParam: true
ObjCSpaceAfterProperty: false
ObjCSpaceBeforeProtocolList: true
PenaltyBreakAssignment: 2
PenaltyBreakBeforeFirstCallParameter: 19
PenaltyBreakComment: 300
PenaltyBreakFirstLessLess: 120
PenaltyBreakString: 1000
PenaltyBreakTemplateDeclaration: 10
PenaltyExcessCharacter: 1000000
PenaltyReturnTypeOnItsOwnLine: 60
PenaltyIndentedWhitespace: 0
PointerAlignment: Right
PPIndentWidth: -1
ReferenceAlignment: Pointer
ReflowComments: true
ShortNamespaceLines: 1
SortIncludes: CaseSensitive
SortJavaStaticImport: Before
SortUsingDeclarations: true
SpaceAfterCStyleCast: false
SpaceAfterLogicalNot: false
SpaceAfterTemplateKeyword: true
SpaceBeforeAssignmentOperators: true
SpaceBeforeCaseColon: false
SpaceBeforeCpp11BracedList: false
SpaceBeforeCtorInitializerColon: true
SpaceBeforeInheritanceColon: true
SpaceBeforeParens: ControlStatements
SpaceAroundPointerQualifiers: Default
SpaceBeforeRangeBasedForLoopColon: true
SpaceInEmptyBlock: false
SpaceInEmptyParentheses: false
SpacesBeforeTrailingComments: 1
SpacesInAngles: Never
SpacesInConditionalStatement: false
SpacesInContainerLiterals: true
SpacesInCStyleCastParentheses: false
SpacesInLineCommentPrefix:
Minimum: 1
Maximum: -1
SpacesInParentheses: false
SpacesInSquareBrackets: false
SpaceBeforeSquareBrackets: false
BitFieldColonSpacing: Both
Standard: Latest
StatementAttributeLikeMacros:
- Q_EMIT
StatementMacros:
- Q_UNUSED
- QT_REQUIRE_VERSION
TabWidth: 4
UseCRLF: false
UseTab: Always
WhitespaceSensitiveMacros:
- STRINGIZE
- PP_STRINGIZE
- BOOST_PP_STRINGIZE
- NS_SWIFT_NAME
- CF_SWIFT_NAME
...

View File

@@ -13,7 +13,6 @@ on:
pull_request: pull_request:
branches: branches:
- main - main
- 'release/*'
defaults: defaults:
run: run:
@@ -26,78 +25,41 @@ jobs:
DOCKER_REGISTRY_URL: tip-tip-wlan-cloud-ucentral.jfrog.io DOCKER_REGISTRY_URL: tip-tip-wlan-cloud-ucentral.jfrog.io
DOCKER_REGISTRY_USERNAME: ucentral DOCKER_REGISTRY_USERNAME: ucentral
steps: steps:
- name: Checkout actions repo - uses: actions/checkout@v2
uses: actions/checkout@v3
with:
repository: Telecominfraproject/.github
path: github
- name: Build and push Docker image - name: Build Docker image
uses: ./github/composite-actions/docker-image-build run: docker build -t wlan-cloud-ucentralfms:${{ github.sha }} .
with:
image_name: owfms
registry: tip-tip-wlan-cloud-ucentral.jfrog.io
registry_user: ucentral
registry_password: ${{ secrets.DOCKER_REGISTRY_PASSWORD }}
- name: Notify on failure via Slack - name: Tag Docker image
if: failure() && github.ref == 'refs/heads/main'
uses: rtCamp/action-slack-notify@v2
env:
SLACK_USERNAME: GitHub Actions failure notifier
SLACK_WEBHOOK: ${{ secrets.SLACK_WEBHOOK }}
SLACK_COLOR: "${{ job.status }}"
SLACK_ICON: https://raw.githubusercontent.com/quintessence/slack-icons/master/images/github-logo-slack-icon.png
SLACK_TITLE: Docker build failed for OWFMS service
trigger-testing:
if: startsWith(github.ref, 'refs/pull/')
runs-on: ubuntu-latest
needs: docker
steps:
- name: Get base branch name and set as output
id: get_base_branch
run: | run: |
echo "branch=$(echo ${GITHUB_BASE_REF##*/})" >> $GITHUB_OUTPUT TAGS="${{ github.sha }}"
echo "owgw_branch=$(echo ${GITHUB_BASE_REF##*/} | sed 's/main/master/g')" >> $GITHUB_OUTPUT if [[ ${GITHUB_REF} == "refs/heads/"* ]]
then
- name: Checkout actions repo CURRENT_TAG=$(echo ${GITHUB_REF#refs/heads/} | tr '/' '-')
uses: actions/checkout@v3 TAGS="$TAGS $CURRENT_TAG"
else
if [[ ${GITHUB_REF} == "refs/tags/"* ]]
then
CURRENT_TAG=$(echo ${GITHUB_REF#refs/tags/} | tr '/' '-')
TAGS="$TAGS $CURRENT_TAG"
else # PR build
CURRENT_TAG=$(echo ${GITHUB_HEAD_REF#refs/heads/} | tr '/' '-')
TAGS="$TAGS $CURRENT_TAG"
fi
fi
echo "Result tags: $TAGS"
for tag in $TAGS; do
docker tag wlan-cloud-ucentralfms:${{ github.sha }} ${{ env.DOCKER_REGISTRY_URL }}/ucentralfms:$tag
done
- name: Log into Docker registry
if: startsWith(github.ref, 'refs/tags/') || startsWith(github.ref, 'refs/pull/') || github.ref == 'refs/heads/main'
uses: docker/login-action@v1
with: with:
repository: Telecominfraproject/.github registry: ${{ env.DOCKER_REGISTRY_URL }}
path: github username: ${{ env.DOCKER_REGISTRY_USERNAME }}
password: ${{ secrets.DOCKER_REGISTRY_PASSWORD }}
- name: Trigger testing of OpenWifi Docker Compose deployment and wait for result - name: Push Docker images
uses: ./github/composite-actions/trigger-workflow-and-wait if: startsWith(github.ref, 'refs/tags/') || startsWith(github.ref, 'refs/pull/') || github.ref == 'refs/heads/main'
env: run: |
BASE_BRANCH: ${{ steps.get_base_branch.outputs.branch }} docker images | grep ${{ env.DOCKER_REGISTRY_URL }}/ucentralfms | awk -F ' ' '{print $1":"$2}' | xargs -I {} docker push {}
OWGW_BASE_BRANCH: ${{ steps.get_base_branch.outputs.owgw_branch }}
with:
owner: Telecominfraproject
repo: wlan-testing
workflow: ow_docker-compose.yml
token: ${{ secrets.WLAN_TESTING_PAT }}
ref: master
inputs: '{"deployment_version": "${{ env.BASE_BRANCH }}", "owgw_version": "${{ env.OWGW_BASE_BRANCH }}", "owsec_version": "${{ env.BASE_BRANCH }}", "owfms_version": "${{ github.sha }}", "owprov_version": "${{ env.BASE_BRANCH }}", "owanalytics_version": "${{ env.BASE_BRANCH }}", "owsub_version": "${{ env.BASE_BRANCH }}", "microservice": "owfms"}'
trigger-deploy-to-dev:
runs-on: ubuntu-latest
if: github.ref == 'refs/heads/main'
needs:
- docker
steps:
- name: Checkout actions repo
uses: actions/checkout@v3
with:
repository: Telecominfraproject/.github
path: github
- name: Trigger deployment of the latest version to dev instance and wait for result
uses: ./github/composite-actions/trigger-workflow-and-wait
with:
owner: Telecominfraproject
repo: wlan-testing
workflow: ucentralgw-dev-deployment.yaml
token: ${{ secrets.WLAN_TESTING_PAT }}
ref: master
inputs: '{"force_latest": "true"}'

View File

@@ -4,7 +4,6 @@ on:
pull_request: pull_request:
branches: branches:
- main - main
- 'release/*'
types: [ closed ] types: [ closed ]
defaults: defaults:
@@ -17,10 +16,4 @@ jobs:
steps: steps:
- run: | - run: |
export PR_BRANCH_TAG=$(echo ${GITHUB_HEAD_REF#refs/heads/} | tr '/' '-') export PR_BRANCH_TAG=$(echo ${GITHUB_HEAD_REF#refs/heads/} | tr '/' '-')
curl -uucentral:${{ secrets.DOCKER_REGISTRY_PASSWORD }} -X DELETE "https://tip.jfrog.io/artifactory/tip-wlan-cloud-ucentral/ucentralfms/$PR_BRANCH_TAG"
if [[ ! $PR_BRANCH_TAG =~ (main|master|release-*) ]]; then
echo "PR branch is $PR_BRANCH_TAG, deleting Docker image"
curl -s -uucentral:${{ secrets.DOCKER_REGISTRY_PASSWORD }} -X DELETE "https://tip.jfrog.io/artifactory/tip-wlan-cloud-ucentral/owfms/$PR_BRANCH_TAG"
else
echo "PR branch is $PR_BRANCH_TAG, not deleting Docker image"
fi

View File

@@ -1,24 +0,0 @@
name: Ensure Jira issue is linked
on:
pull_request:
types: [opened, edited, reopened, synchronize]
branches:
- 'release/*'
jobs:
check_for_issue_key:
runs-on: ubuntu-latest
steps:
- name: Checkout actions repo
uses: actions/checkout@v2
with:
repository: Telecominfraproject/.github
path: github
- name: Run JIRA check
uses: ./github/composite-actions/enforce-jira-issue-key
with:
jira_base_url: ${{ secrets.TIP_JIRA_URL }}
jira_user_email: ${{ secrets.TIP_JIRA_USER_EMAIL }}
jira_api_token: ${{ secrets.TIP_JIRA_API_TOKEN }}

View File

@@ -1,41 +0,0 @@
name: Update OpenAPI docs on GitHub Pages
on:
push:
paths:
- 'openapi/**'
branches:
- main
workflow_dispatch:
defaults:
run:
shell: bash
jobs:
docsgen:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Generate static HTML page with docs from OpenAPI definition
run: |
docker run --rm -v "${PWD}:/local" openapitools/openapi-generator-cli:v6.2.1 generate -i https://raw.githubusercontent.com/Telecominfraproject/wlan-cloud-ucentralfms/main/openapi/owfms.yaml -g html2 --skip-validate-spec -o /local/
- name: Update OpenAPI docs
run: |
mkdir tmp-docs
mv index.html tmp-docs/index.html
mkdir -p ~/.ssh
ssh-keyscan -H github.com >> ~/.ssh/known_hosts
echo https://tip-automation:${{ secrets.GIT_PUSH_PAT }}@github.com > ~/.git-credentials
git config --global credential.helper store
git config --global user.email "tip-automation@telecominfraproject.com"
git config --global user.name "TIP Automation User"
git pull
git checkout gh-pages || git checkout -b gh-pages
rm -rf docs
mv tmp-docs docs
git add docs
git commit -m'Update OpenAPI docs for GitHub pages'
git push --set-upstream origin gh-pages

View File

@@ -1,46 +0,0 @@
name: Release chart package
on:
push:
tags:
- 'v*'
defaults:
run:
shell: bash
jobs:
helm-package:
runs-on: ubuntu-20.04
env:
HELM_REPO_URL: https://tip.jfrog.io/artifactory/tip-wlan-cloud-ucentral-helm/
HELM_REPO_USERNAME: ucentral
steps:
- name: Checkout uCentral assembly chart repo
uses: actions/checkout@v2
with:
path: wlan-cloud-ucentralfms
- name: Build package
working-directory: wlan-cloud-ucentralfms/helm
run: |
helm plugin install https://github.com/aslafy-z/helm-git --version 0.10.0
helm repo add bitnami https://charts.bitnami.com/bitnami
helm repo update
helm dependency update
mkdir dist
helm package . -d dist
- name: Generate GitHub release body
working-directory: wlan-cloud-ucentralfms/helm
run: |
pip3 install yq -q
echo "Docker image - tip-tip-wlan-cloud-ucentral.jfrog.io/owfms:$GITHUB_REF_NAME" > release.txt
echo "Helm charted may be attached to this release" >> release.txt
echo "Deployment artifacts may be found in https://github.com/Telecominfraproject/wlan-cloud-ucentral-deploy/tree/$GITHUB_REF_NAME" >> release.txt
- name: Create GitHub release
uses: softprops/action-gh-release@v1
with:
body_path: wlan-cloud-ucentralfms/helm/release.txt
files: wlan-cloud-ucentralfms/helm/dist/*

5
.gitignore vendored
View File

@@ -9,8 +9,6 @@ install_manifest.txt
compile_commands.json compile_commands.json
CTestTestfile.cmake CTestTestfile.cmake
certs/*.* certs/*.*
/logs/
/data/
_deps _deps
*.pem *.pem
*.id *.id
@@ -20,4 +18,5 @@ _deps
*.zip *.zip
result.json result.json
pidfile pidfile
test_scripts/curl/result.json

View File

@@ -1,122 +0,0 @@
# Building from source
In order to build the OWFMS, you will need to install its dependencies, which includes the following:
- cmake
- boost
- POCO 1.10.1 or later
- a C++17 compiler
- openssl
- libpq-dev (PortgreSQL development libraries)
- mysql-client (MySQL client)
- librdkafka
- cppkafka
Building is a 2 part process. The first part is to build a local copy of the framework tailored to your environment. This
framework is [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
Poco may take several minutes depending on the platform you are building on.
## Ubuntu
These instructions have proven to work on Ubuntu 20.4.
```bash
sudo apt install git cmake g++ libssl-dev libmariabd-dev unixodbc-dev
sudo apt install libpq-dev libaprutil1-dev apache2-dev libboost-all-dev
sudo apt install librdkafka-dev liblua5.3-dev
git clone https://github.com/stephb9959/poco
cd poco
mkdir cmake-build
cd cmake-build
cmake ..
cmake --build . --config Release
sudo cmake --build . --target install
git clone https://github.com/stephb9959/cppkafka
cd cppkafka
mkdir cmake-build
cd cmake-build
cmake ..
cmake --build . --config Release
sudo cmake --build . --target install
cd ~
git clone https://github.com/Telecominfraproject/wlan-cloud-ucentralgw
cd wlan-cloud-ucentralgw
mkdir cmake-build
cd cmake-build
cmake ..
make
```
## Fedora
The following instructions have proven to work on Fedora 33
```bash
sudo yum install cmake g++ openssl-devel unixODBC-devel mysql-devel mysql apr-util-devel boost boost-devel
sudo yum install yaml-cpp-devel lua-devel
sudo dnf install postgresql.x86_64 librdkafka-devel
sudo dnf install postgresql-devel
git clone https://github.com/stephb9959/poco
cd poco
mkdir cmake-build
cd cmake-build
cmake ..
cmake --build . --config Release
sudo cmake --build . --target install
git clone https://github.com/stephb9959/cppkafka
cd cppkafka
mkdir cmake-build
cd cmake-build
cmake ..
cmake --build . --config Release
sudo cmake --build . --target install
cd ~
git clone https://github.com/Telecominfraproject/wlan-cloud-ucentralfms
cd wlan-cloud-ucentralfms
mkdir cmake-build
cd cmake-build
cmake ..
make
```
## OSX Build
The following instructions have proven to work on OSX Big Sur. You need to install [Homebrew](https://brew.sh/). You must also have installed [XCode for OS X](https://www.freecodecamp.org/news/how-to-download-and-install-xcode/).
```bash
brew install openssl
brew install cmake
brew install libpq
brew install mysql-client
brew install apr
brew install apr-util
brew install boost
brew install yaml-cpp
brew install postgresql
brew install unixodbc
brew install librdkafka
git clone https://github.com/stephb9959/poco
cd poco
mkdir cmake-build
cd cmake-build
cmake ..
cmake --build . --config Release -j
sudo cmake --build . --target install
git clone https://github.com/stephb9959/cppkafka
cd cppkafka
mkdir cmake-build
cd cmake-build
cmake ..
cmake --build . --config Release
sudo cmake --build . --target install
cd ~
git clone https://github.com/Telecominfraproject/wlan-cloud-ucentralfms
cd wlan-cloud-ucentralfms
mkdir cmake-build
cd cmake-build
cmake ..
make -j
```

61
CLI.md
View File

@@ -1,10 +1,10 @@
# Firmware Service (FMS) CLI Documentation # Firmware Service (FMS) CLI Documentation
## Before using the CLI ## Before using the CLI
You must set the environment variable `OWSEC`. You must specify the host and port for the security service You must set the environment variable `UCENTRALSEC`. You must specify the host and port for the security service
associated with the FMS Service. Here is an example associated with the FMS Service. Here is an example
```csh ```csh
export OWSEC=mysecurityservice.example.com:16001 export UCENTRALSEC=mysecurityservice,example.com:16001
``` ```
Once set, you can start using the `CLI`. Once set, you can start using the `CLI`.
@@ -12,48 +12,37 @@ Once set, you can start using the `CLI`.
Most commands will take from 0 to 2 parameters. You should include all parameters in double quotes when possible. Most commands will take from 0 to 2 parameters. You should include all parameters in double quotes when possible.
## The commands ## The commands
### getfirmwares
Get a lit of firmwares.
### latestfirmware <device_type> ### `cli getfirmwares <device_type>`
Get the latest firmware for the device_type specified. This will list all firmwares that apply to the `device_type`. You can get a list of `device_types` with the `cli devicetypes` command.
### revisions ### `latestfirmware <device_type>`
Get a list of revisions available. Get the latest firmware version for a given `device_type`.
### devicetypes ### `cli revisions`
Get the list of device types supported. Get the list of currently available revisions.
### firmwareage <device_type> <revision> ### `cli devicetypes`
Calculate how out of date a specific release it. Retrieve the list of known `device_types`
### gethistory <device serial number> ### `cli firmwareage <device_type> <revision>`
Get the device firmware history. If you specify your `device_type` and `revision`, the system will do its best to estimate how
far in the past you `revision` is compared to the latest revision.
### connecteddevice <device serial number> ### `cli gethistory <serialNumber>`
Get the device status. Get the revision history for a given device.
### connectedDevices ### `cli connecteddevices`
Get the list of connected devices. Get a list of the currently known devices and the last connection information we have about the,
### devicereport ### `cli connecteddevice <serialNumber>`
Get the dashboard. Get the information relevant to a specific device.
### setloglevel <subsystem> <loglevel> ### `cli devicereport`
Set the log level for s specific subsystem. Give a simplified dashboard report of the data in the service.
### getloglevels ### `cli fmsversion`
Get the current log levels for all subsystems. Display the version of the service.
### getloglevelnames
Get the log level names available.
### getsubsystemnames
Get the list of subsystems.
### systeminfo
Get basic system information.
### reloadsubsystem <subsystem name>
Reload the configuration for a subsystem.
### `cli fmstimes`
Display the uptime and start time of the service.

View File

@@ -1,5 +1,5 @@
cmake_minimum_required(VERSION 3.13) cmake_minimum_required(VERSION 3.13)
project(owfms VERSION 3.0.0) project(ucentralfms VERSION 2.1.0)
set(CMAKE_CXX_STANDARD 17) set(CMAKE_CXX_STANDARD 17)
@@ -15,37 +15,27 @@ if(UNIX AND NOT APPLE)
endif() endif()
if(EXISTS ${CMAKE_CURRENT_SOURCE_DIR}/build) if(EXISTS ${CMAKE_CURRENT_SOURCE_DIR}/build)
file(READ ${CMAKE_CURRENT_SOURCE_DIR}/build BUILD_NUM) file(READ build BUILD_NUM)
if(BUILD_INCREMENT) if(BUILD_INCREMENT)
MATH(EXPR BUILD_NUM "${BUILD_NUM}+1") MATH(EXPR BUILD_NUM "${BUILD_NUM}+1")
file(WRITE ${CMAKE_CURRENT_SOURCE_DIR}/build ${BUILD_NUM}) file(WRITE build ${BUILD_NUM})
endif() endif()
else() else()
set(BUILD_NUM 1) set(BUILD_NUM 1)
file(WRITE ${CMAKE_CURRENT_SOURCE_DIR}/build ${BUILD_NUM}) file(WRITE build ${BUILD_NUM})
endif() endif()
find_package(Git QUIET) set(BUILD_SHARED_LIBS 1)
if(GIT_FOUND AND EXISTS "${PROJECT_SOURCE_DIR}/.git") add_definitions(-DAPP_VERSION="${CMAKE_PROJECT_VERSION}" -DBUILD_NUMBER="${BUILD_NUM}" -DAWS_CUSTOM_MEMORY_MANAGEMENT)
execute_process(COMMAND ${GIT_EXECUTABLE} rev-parse --short HEAD
WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
RESULT_VARIABLE GIT_RESULT
OUTPUT_VARIABLE GIT_HASH)
if(NOT GIT_RESULT EQUAL "0")
message(FATAL_ERROR "git rev-parse --short HEAD failed with ${GIT_RESULT}")
endif()
string(REGEX REPLACE "\n$" "" GIT_HASH "${GIT_HASH}")
endif()
# set(BUILD_SHARED_LIBS 1) set(Boost_USE_STATIC_LIBS OFF)
# add_definitions(-DAWS_CUSTOM_MEMORY_MANAGEMENT) set(Boost_USE_MULTITHREADED ON)
set(Boost_USE_STATIC_RUNTIME OFF)
find_package(Boost REQUIRED system)
find_package(OpenSSL REQUIRED) find_package(OpenSSL REQUIRED)
find_package(fmt REQUIRED)
find_package(ZLIB REQUIRED)
find_package(Poco REQUIRED COMPONENTS Crypto JWT Net Util NetSSL Data DataSQLite)
find_package(AWSSDK REQUIRED COMPONENTS s3) find_package(AWSSDK REQUIRED COMPONENTS s3)
find_package(ZLIB REQUIRED) find_package(Poco REQUIRED COMPONENTS Crypto JWT Net Util NetSSL Data DataSQLite)
if(SMALL_BUILD) if(SMALL_BUILD)
find_package(Poco REQUIRED COMPONENTS Crypto JWT Net Util NetSSL Data DataSQLite) find_package(Poco REQUIRED COMPONENTS Crypto JWT Net Util NetSSL Data DataSQLite)
@@ -58,106 +48,49 @@ endif()
include_directories(/usr/local/include /usr/local/opt/openssl/include src include/kafka /usr/local/opt/mysql-client/include) include_directories(/usr/local/include /usr/local/opt/openssl/include src include/kafka /usr/local/opt/mysql-client/include)
configure_file(src/ow_version.h.in ${PROJECT_SOURCE_DIR}/src/ow_version.h @ONLY) add_executable( ucentralfms
build
src/Dashboard.cpp src/Dashboard.h
src/Daemon.cpp src/Daemon.h
src/StorageService.cpp src/StorageService.h
src/storage_tables.cpp
src/storage_setup.cpp
src/SubSystemServer.cpp src/SubSystemServer.h
src/RESTAPI_handler.cpp src/RESTAPI_handler.h
src/storage_firmwares.cpp
src/Utils.cpp src/Utils.h
src/RESTAPI_server.cpp src/RESTAPI_server.h
src/RESTAPI_firmwaresHandler.cpp src/RESTAPI_firmwaresHandler.h
src/RESTAPI_firmwareHandler.cpp src/RESTAPI_firmwareHandler.h
src/RESTAPI_GWobjects.cpp src/RESTAPI_GWobjects.h
src/ALBHealthCheckServer.h
src/ManifestCreator.cpp src/ManifestCreator.h
src/KafkaManager.cpp src/KafkaManager.h
src/MicroService.h src/MicroService.cpp
src/AuthClient.h src/AuthClient.cpp
src/RESTAPI_SecurityObjects.cpp src/RESTAPI_SecurityObjects.h
src/RESTAPI_system_command.cpp src/RESTAPI_system_command.h
src/OpenAPIRequest.h src/OpenAPIRequest.cpp
src/RESTAPI_InternalServer.cpp src/RESTAPI_InternalServer.h
src/RESTAPI_utils.cpp src/RESTAPI_utils.h
src/RESTAPI_FMSObjects.cpp src/RESTAPI_FMSObjects.h
src/storage_firmwares.h src/storage_history.cpp
src/storage_history.h src/storage_deviceTypes.cpp
src/RESTAPI_historyHandler.cpp src/RESTAPI_historyHandler.h
src/NewConnectionHandler.cpp src/NewConnectionHandler.h
src/LatestFirmwareCache.cpp src/LatestFirmwareCache.h
src/DeviceCache.cpp src/DeviceCache.h
src/RESTAPI_firmwareAgeHandler.cpp src/RESTAPI_firmwareAgeHandler.h
src/storage_deviceInfo.cpp src/storage_deviceInfo.h
src/RESTAPI_connectedDevicesHandler.cpp src/RESTAPI_connectedDevicesHandler.h
src/FirmwareCache.cpp src/FirmwareCache.h
src/RESTAPI_connectedDeviceHandler.cpp src/RESTAPI_connectedDeviceHandler.h
src/RESTAPI_deviceReportHandler.cpp src/RESTAPI_deviceReportHandler.h
src/OpenWifiTypes.h )
add_compile_options(-Wall -Wextra) target_link_libraries(ucentralfms PUBLIC
add_definitions(-DPOCO_LOG_DEBUG="1" -DBOOST_NO_CXX98_FUNCTION_BASE=1) ${Poco_LIBRARIES} ${MySQL_LIBRARIES}
${Boost_LIBRARIES}
if(ASAN) ${ZLIB_LIBRARIES} ${AWSSDK_LINK_LIBRARIES}
add_compile_options(-fsanitize=address) CppKafka::cppkafka )
add_link_options(-fsanitize=address)
endif()
add_executable( owfms
build
src/ow_version.h.in
src/framework/CountryCodes.h
src/framework/KafkaTopics.h
src/framework/MicroService.h
src/framework/OpenWifiTypes.h
src/framework/orm.h
src/framework/StorageClass.h
src/framework/MicroServiceErrorHandler.h
src/framework/UI_WebSocketClientServer.cpp
src/framework/UI_WebSocketClientServer.h
src/framework/UI_WebSocketClientNotifications.cpp
src/framework/UI_WebSocketClientNotifications.h
src/framework/utils.h
src/framework/utils.cpp
src/framework/AppServiceRegistry.h
src/framework/SubSystemServer.cpp
src/framework/SubSystemServer.h
src/framework/RESTAPI_utils.h
src/framework/AuthClient.cpp
src/framework/AuthClient.h
src/framework/MicroServiceNames.h
src/framework/MicroServiceFuncs.h
src/framework/OpenAPIRequests.cpp
src/framework/OpenAPIRequests.h
src/framework/MicroServiceFuncs.cpp
src/framework/ALBserver.cpp
src/framework/ALBserver.h
src/framework/KafkaManager.cpp
src/framework/KafkaManager.h
src/framework/RESTAPI_RateLimiter.h
src/framework/WebSocketLogger.h
src/framework/RESTAPI_GenericServerAccounting.h
src/framework/RESTAPI_SystemConfiguration.h
src/framework/CIDR.h
src/framework/RESTAPI_Handler.cpp
src/framework/RESTAPI_Handler.h
src/framework/RESTAPI_ExtServer.h
src/framework/RESTAPI_ExtServer.cpp
src/framework/RESTAPI_IntServer.cpp
src/framework/RESTAPI_IntServer.h
src/framework/RESTAPI_SystemCommand.h
src/framework/RESTAPI_WebSocketServer.h
src/framework/EventBusManager.cpp
src/framework/EventBusManager.h
src/framework/RESTAPI_PartHandler.h
src/framework/MicroService.cpp
src/framework/MicroServiceExtra.h
src/framework/default_device_types.h
src/RESTObjects/RESTAPI_SecurityObjects.h src/RESTObjects/RESTAPI_SecurityObjects.cpp
src/RESTObjects/RESTAPI_GWobjects.h src/RESTObjects/RESTAPI_GWobjects.cpp
src/RESTObjects/RESTAPI_FMSObjects.h src/RESTObjects/RESTAPI_FMSObjects.cpp
src/RESTObjects/RESTAPI_CertObjects.cpp src/RESTObjects/RESTAPI_CertObjects.h
src/RESTObjects/RESTAPI_OWLSobjects.cpp src/RESTObjects/RESTAPI_OWLSobjects.h
src/RESTObjects/RESTAPI_ProvObjects.cpp src/RESTObjects/RESTAPI_ProvObjects.h
src/RESTObjects/RESTAPI_AnalyticsObjects.cpp src/RESTObjects/RESTAPI_AnalyticsObjects.h
src/RESTObjects/RESTAPI_SubObjects.cpp src/RESTObjects/RESTAPI_SubObjects.h
src/RESTAPI/RESTAPI_firmwaresHandler.cpp src/RESTAPI/RESTAPI_firmwaresHandler.h
src/RESTAPI/RESTAPI_firmwareHandler.cpp src/RESTAPI/RESTAPI_firmwareHandler.h
src/RESTAPI/RESTAPI_historyHandler.cpp src/RESTAPI/RESTAPI_historyHandler.h
src/RESTAPI/RESTAPI_firmwareAgeHandler.cpp src/RESTAPI/RESTAPI_firmwareAgeHandler.h
src/RESTAPI/RESTAPI_connectedDevicesHandler.cpp src/RESTAPI/RESTAPI_connectedDevicesHandler.h
src/RESTAPI/RESTAPI_deviceReportHandler.cpp src/RESTAPI/RESTAPI_deviceReportHandler.h
src/RESTAPI/RESTAPI_connectedDeviceHandler.cpp src/RESTAPI/RESTAPI_connectedDeviceHandler.h
src/RESTAPI/RESTAPI_Routers.cpp
src/Dashboard.cpp src/Dashboard.h
src/Daemon.cpp src/Daemon.h
src/StorageService.cpp src/StorageService.h
src/ManifestCreator.cpp src/ManifestCreator.h
src/NewConnectionHandler.cpp src/NewConnectionHandler.h
src/LatestFirmwareCache.cpp src/LatestFirmwareCache.h
src/DeviceCache.cpp src/DeviceCache.h
src/FirmwareCache.cpp src/FirmwareCache.h
src/SDK/Prov_SDK.cpp src/SDK/Prov_SDK.h
src/AutoUpdater.cpp src/AutoUpdater.h src/SDK/GW_SDK.cpp src/SDK/GW_SDK.h
src/NewCommandHandler.cpp src/NewCommandHandler.h
src/storage/orm_history.cpp src/storage/orm_history.h
src/storage/orm_firmwares.cpp src/storage/orm_firmwares.h
src/storage/orm_deviceInfo.cpp src/storage/orm_deviceInfo.h
src/RESTAPI/RESTAPI_deviceInformation_handler.cpp
src/RESTAPI/RESTAPI_deviceInformation_handler.h)
target_link_libraries( owfms PUBLIC
${Poco_LIBRARIES}
${MySQL_LIBRARIES}
${ZLIB_LIBRARIES}
${AWSSDK_LINK_LIBRARIES}
fmt::fmt
resolv
CppKafka::cppkafka
)

View File

@@ -1,250 +0,0 @@
# OWFMS Configuration
Here is the list of parameters you can configure in the `owfms.properties` file.
## OWFMS Specific Parameters
### OWFMS behaviour
```properties
firmwaredb.refresh = 86400
firmwaredb.maxage = 90
autoupdater.enabled = true
```
#### firmwaredb.refresh
How often to refresh the FMS DB, in seconds. Should never be less than 6 hours. It does take 10-20 minutes to
create a refresh. The default is 24 hours.
#### firmwaredb.maxage
The maximum age of firmware kept in the DB (in days). Do not go more than 6 months. The default is 3 months.
#### autoupdater.enabled
The determins if the FMS autoupdates its database. You should leave this to `true`.
### S3 information
The actual data for all the firmware is kept in a TIP bucket. The following parameters allow you to change the bucket.
You should never need to do this unless you need to implement your own FMS server.
```properties
s3.bucketname = ucentral-ap-firmware
s3.region = us-east-1
s3.secret = *******************************************
s3.key = *******************************************
s3.retry = 60
s3.bucket.uri = ucentral-ap-firmware.s3.amazonaws.com
s3.endpoint.https = true
s3.endpointOverride = ""
s3.useVirtualAdressing = true
```
#### s3.bucketname
The S3 bucket name.
#### s3.region
The region for this bucket.
#### s3.secret
The AWS secret for access to this S3 bucket
#### s3.key
The AWS key for access for this S3 bucket
#### s3.retry = 60
The AWS retry window in seconds.
#### s3.bucket.uri = ucentral-ap-firmware.s3.amazonaws.com
The URI to the S3 bucket
#### s3.endpointOverride = ""
The Endpoint Address to override if you using a different provider that not AWS.
#### s3.endpoint.https = true
The Endpoint Method if you using a HTTP endpoint
#### s3.useVirtualAdressing = true
In a virtual-hostedstyle URI, the bucket name is part of the domain name in the URL. (Not supported by all providers)
## Generic OpenWiFi SDK parameters
### REST API External parameters
These are the parameters required for the configuration of the external facing REST API server
```properties
openwifi.restapi.host.0.backlog = 100
openwifi.restapi.host.0.security = relaxed
openwifi.restapi.host.0.rootca = $OWFMS_ROOT/certs/restapi-ca.pem
openwifi.restapi.host.0.address = *
openwifi.restapi.host.0.port = 16004
openwifi.restapi.host.0.cert = $OWFMS_ROOT/certs/restapi-cert.pem
openwifi.restapi.host.0.key = $OWFMS_ROOT/certs/restapi-key.pem
openwifi.restapi.host.0.key.password = mypassword
```
#### openwifi.restapi.host.0.backlog
This is the number of concurrent REST API calls that maybe be kept in the backlog for processing. That's a good rule of thumb. Never go above 500.
#### openwifi.restapi.host.0.rootca
This is the root file of your own certificate CA in `pem` format.
#### openwifi.restapi.host.0.cert
This is your own server certificate in `pem` format..
#### openwifi.restapi.host.0.key
This is the private key associated with your own certificate in `pem` format.
#### openwifi.restapi.host.0.address
Leve this a `*` in the case you want to bind to all interfaces on your gateway host or select the address of a single interface.
#### openwifi.restapi.host.0.port
The port on which the REST API server is listening. By default, this is 16002.
#### openwifi.restapi.host.0.security
Leave this as `relaxed` for now for devices.
#### openwifi.restapi.host.0.key.password
If you key file uses a password, please enter it here.
### REST API Intra microservice parameters
The following parameters describe the configuration for the inter-microservice HTTP server. You may use the same certificate/key
you are using for your extenral server or another certificate.
```properties
openwifi.internal.restapi.host.0.backlog = 100
openwifi.internal.restapi.host.0.security = relaxed
openwifi.internal.restapi.host.0.rootca = $OWFMS_ROOT/certs/restapi-ca.pem
openwifi.internal.restapi.host.0.address = *
openwifi.internal.restapi.host.0.port = 17004
openwifi.internal.restapi.host.0.cert = $OWFMS_ROOT/certs/restapi-cert.pem
openwifi.internal.restapi.host.0.key = $OWFMS_ROOT/certs/restapi-key.pem
openwifi.internal.restapi.host.0.key.password = mypassword
```
#### openwifi.internal.host.0.backlog
This is the number of concurrent REST API calls that maybe be kept in the backlog for processing. That's a good rule of thumb. Never go above 500.
#### openwifi.internal.host.0.rootca
This is the root file of your own certificate CA in `pem` format.
#### openwifi.internal.host.0.cert
This is your own server certificate in `pem` format..
#### openwifi.internal.host.0.key
This is the private key associated with your own certificate in `pem` format.
#### openwifi.internal.host.0.address
Leve this a `*` in the case you want to bind to all interfaces on your gateway host or select the address of a single interface.
#### openwifi.internal.host.0.port
The port on which the REST API server is listening. By default, this is 17002.
#### openwifi.internal.host.0.security
Leave this as `relaxed` for now for devices.
#### openwifi.internal.host.0.key.password
If you key file uses a password, please enter it here.
### Microservice information
These are different Microservie parameters. Following is a brief explanation.
```properties
openwifi.service.key = $OWFMS_ROOT/certs/restapi-key.pem
openwifi.service.key.password = mypassword
openwifi.system.data = $OWFMS_ROOT/data
openwifi.system.uri.private = https://localhost:17004
openwifi.system.uri.public = https://ucentral.dpaas.arilia.com:16002
openwifi.system.uri.ui = https://ucentral-ui.arilia.com
openwifi.security.restapi.disable = false
openwifi.system.commandchannel = /tmp/app.ucentralfms
openwifi.autoprovisioning = true
```
#### openwifi.service.key
From time to time, the microservice must encrypt information. This is the key it should use. You may use the
same keey as you RESTAPI or your server.
#### openwifi.service.key.password
The password for the `openwifi.service.key`
#### openwifi.system.data
The location of system data. This path must exist.
#### openwifi.system.uri.private
The URI to reach the controller on the internal port.
#### openwifi.system.uri.public
The URI to reach the controller from the outside world.
#### openwifi.system.uri.ui
The URI of the UI to manage this service
#### openwifi.security.restapi.disable
This allows to disable security for internal and external API calls. This should only be used if the controller
sits behind an application load balancer that will actually do TLS. Setting this to `true` disables security.
#### openwifi.system.commandchannel
The UNIX socket command channel used by this service.
#### openwifi.autoprovisioning
Allow unknown devices to be provisioned by the system.
### ALB Support
In order to support an application load balancer health check verification, your need to provide the following parameters.
```properties
alb.enable = true
alb.port = 16104
```
### Kafka
The controller use Kafka, like all the other microservices. You must configure the kafka section in order for the
system to work.
```properties
openwifi.kafka.group.id = firmware
openwifi.kafka.client.id = firmware1
openwifi.kafka.enable = true
openwifi.kafka.brokerlist = my_Kafka.example.com:9092
openwifi.kafka.auto.commit = false
openwifi.kafka.queue.buffering.max.ms = 50
```
### openwifi.kafka.group.id
The group ID is a single word that should identify the type of service tuning. In the case `firmware`
### openwifi.kafka.client.id
The client ID is a single service within that group ID. Each participant must have a unique client ID.
### openwifi.kafka.enable
Kafka should always be enabled.
### openwifi.kafka.brokerlist
The list of servers where your Kafka server is running. Comma separated.
### openwifi.kafka.auto.commit
Auto commit flag in Kafka. Leave as `false`.
### openwifi.kafka.queue.buffering.max.ms
Kafka buffering. Leave as `50`.
### Kafka security
If you intend to use SSL, you should look into Kafka Connect and specify the certificates below.
```properties
penwifi.kafka.ssl.ca.location =
openwifi.kafka.ssl.certificate.location =
openwifi.kafka.ssl.key.location =
openwifi.kafka.ssl.key.password =
```
### DB Type
The controller supports 3 types of Database. SQLite should only be used for sites with less than 100 APs or for testing in the lab.
In order to select which database to use, you must set the `storage.type` value to sqlite, postgresql, or mysql.
```properties
storage.type = sqlite
#storage.type = postgresql
#storage.type = mysql
```
### Storage SQLite parameters
Additional parameters to set for SQLite. The only important one is `storage.type.sqlite.db` which is the database name on disk.
```properties
storage.type.sqlite.db = firmware.db
storage.type.sqlite.idletime = 120
storage.type.sqlite.maxsessions = 128
```
### Storage Postgres
Additional parameters to set if you select Postgres for your database. You must specify `host`, `username`, `password`,
`database`, and `port`.
```properties
storage.type.postgresql.maxsessions = 64
storage.type.postgresql.idletime = 60
storage.type.postgresql.host = localhost
storage.type.postgresql.username = firmware
storage.type.postgresql.password = firmware
storage.type.postgresql.database = firmware
storage.type.postgresql.port = 5432
storage.type.postgresql.connectiontimeout = 60
```
### Storage MySQL/MariaDB
Additional parameters to set if you select mysql for your database. You must specify `host`, `username`, `password`,
`database`, and `port`.
```properties
storage.type.mysql.maxsessions = 64
storage.type.mysql.idletime = 60
storage.type.mysql.host = localhost
storage.type.postgresql.username = firmware
storage.type.postgresql.password = firmware
storage.type.postgresql.database = firmware
storage.type.mysql.port = 3306
storage.type.mysql.connectiontimeout = 60
```
### Logging Parameters
The microservice provides extensive logging. If you would like to keep logging on disk, set the `logging.type = file`. If you only want
console logging, `set logging.type = console`. When selecting file, `logging.path` must exist. `logging.level` sets the
basic logging level for the entire controller. `logging.websocket` disables WebSocket logging.
```properties
logging.type = file
logging.path = $OWFMS_ROOT/logs
logging.level = information
logging.asynch = true
logging.websocket = false
```

View File

@@ -1,38 +0,0 @@
# How to Contribute
We'd love to accept your patches and contributions to this project. There are
just a few small guidelines you need to follow.
## Version of C++
This project is based on the C++17 standard and compiles as-is on most platforms
using either clang or g++. Do not use C++21 or C++23 features for now. Some core
libraries used in this project do not support C++21 or C++23 yet.
## Variable Naming
Naming of pretty much anything uses Pascal naming. Longer explicit names using casing.
Member variable naming adds a `_` at the end of the vars. Try to
keep this standard going. Sometimes you must override a base class function and then of course
you need to follow the base class.
## This is a cmake project
This is a cmake project, and you need to adhere to the cmake rules. If you need
to add a package to the CMakeList, you need to ensure that the package is available
on all required platforms and compiles. Remember that this project runs on Linux, OS X,
and the Raspberry PI.
## Licensed packages
When adding a package, you must also state the licensing for the package. MIT, BSD, Apache licenses
are acceptable. No commercial licenses are allowed.
## clang formatting
Please format your code using the included `.clang-format` file included in the project.
```bash
clang-format -i --style=<project root>/.clang-format myfile.cpp
```
## Pull Requests
All submissions, including submissions by project members, require review. We
accept GitHub pull requests. Please create a branch with the Jira name for addressing the issue you are fixing or the
feature you are implementing.
Create a pull-request from the branch into master.

View File

@@ -1,39 +1,28 @@
ARG DEBIAN_VERSION=11.5-slim FROM alpine AS builder
ARG POCO_VERSION=poco-tip-v2
ARG CPPKAFKA_VERSION=tip-v1
ARG VALIJASON_VERSION=tip-v1
ARG APP_NAME=owfms
ARG APP_HOME_DIR=/openwifi
FROM debian:$DEBIAN_VERSION AS build-base RUN apk add --update --no-cache \
openssl openssh \
ncurses-libs \
bash util-linux coreutils curl \
make cmake gcc g++ libstdc++ libgcc git zlib-dev \
openssl-dev boost-dev curl-dev util-linux-dev \
unixodbc-dev postgresql-dev mariadb-dev \
librdkafka-dev
RUN apt-get update && apt-get install --no-install-recommends -y \ RUN git clone https://github.com/stephb9959/poco /poco
make cmake g++ git curl zip unzip pkg-config \ RUN git clone https://github.com/stephb9959/cppkafka /cppkafka
libpq-dev libmariadb-dev libmariadbclient-dev-compat \ RUN git clone --recurse-submodules https://github.com/aws/aws-sdk-cpp /aws-sdk-cpp
librdkafka-dev libboost-all-dev libssl-dev \
zlib1g-dev ca-certificates libcurl4-openssl-dev libfmt-dev
FROM build-base AS poco-build WORKDIR /aws-sdk-cpp
ARG POCO_VERSION
ADD https://api.github.com/repos/AriliaWireless/poco/git/refs/tags/${POCO_VERSION} version.json
RUN git clone https://github.com/AriliaWireless/poco --branch ${POCO_VERSION} /poco
WORKDIR /poco
RUN mkdir cmake-build RUN mkdir cmake-build
WORKDIR cmake-build WORKDIR cmake-build
RUN cmake .. RUN cmake .. -DBUILD_ONLY="s3" \
-DCMAKE_BUILD_TYPE=Release \
-DCMAKE_CXX_FLAGS="-Wno-error=stringop-overflow -Wno-error=uninitialized" \
-DAUTORUN_UNIT_TESTS=OFF
RUN cmake --build . --config Release -j8 RUN cmake --build . --config Release -j8
RUN cmake --build . --target install RUN cmake --build . --target install
FROM build-base AS cppkafka-build
ARG CPPKAFKA_VERSION
ADD https://api.github.com/repos/AriliaWireless/cppkafka/git/refs/tags/${CPPKAFKA_VERSION} version.json
RUN git clone https://github.com/AriliaWireless/cppkafka --branch ${CPPKAFKA_VERSION} /cppkafka
WORKDIR /cppkafka WORKDIR /cppkafka
RUN mkdir cmake-build RUN mkdir cmake-build
WORKDIR cmake-build WORKDIR cmake-build
@@ -41,73 +30,45 @@ RUN cmake ..
RUN cmake --build . --config Release -j8 RUN cmake --build . --config Release -j8
RUN cmake --build . --target install RUN cmake --build . --target install
FROM build-base AS app-build WORKDIR /poco
ARG APP_NAME
ADD CMakeLists.txt build /${APP_NAME}/
ADD overlays /${APP_NAME}/overlays
ADD cmake /${APP_NAME}/cmake
ADD src /${APP_NAME}/src
ADD .git /${APP_NAME}/.git
ARG VCPKG_VERSION=2022.11.14
RUN git clone --depth 1 --branch ${VCPKG_VERSION} https://github.com/microsoft/vcpkg && \
./vcpkg/bootstrap-vcpkg.sh && \
mkdir /vcpkg/custom-triplets && \
cp /vcpkg/triplets/x64-linux.cmake /vcpkg/custom-triplets/x64-linux.cmake && \
sed -i 's/set(VCPKG_LIBRARY.*/set(VCPKG_LIBRARY_LINKAGE dynamic)/g' /vcpkg/custom-triplets/x64-linux.cmake && \
./vcpkg/vcpkg install aws-sdk-cpp[s3]:x64-linux json-schema-validator:x64-linux --overlay-triplets=/vcpkg/custom-triplets --overlay-ports=/owfms/overlays
COPY --from=poco-build /usr/local/include /usr/local/include
COPY --from=poco-build /usr/local/lib /usr/local/lib
COPY --from=cppkafka-build /usr/local/include /usr/local/include
COPY --from=cppkafka-build /usr/local/lib /usr/local/lib
WORKDIR /${APP_NAME}
RUN mkdir cmake-build RUN mkdir cmake-build
WORKDIR /${APP_NAME}/cmake-build WORKDIR cmake-build
RUN cmake -DCMAKE_TOOLCHAIN_FILE=/vcpkg/scripts/buildsystems/vcpkg.cmake .. RUN cmake ..
RUN cmake --build . --config Release -j8
RUN cmake --build . --target install
ADD CMakeLists.txt build /ucentralfms/
ADD cmake /ucentralfms/cmake
ADD src /ucentralfms/src
WORKDIR /ucentralfms
RUN mkdir cmake-build
WORKDIR /ucentralfms/cmake-build
RUN cmake ..
RUN cmake --build . --config Release -j8 RUN cmake --build . --config Release -j8
FROM debian:$DEBIAN_VERSION FROM alpine
ARG APP_NAME ENV UCENTRALFMS_USER=ucentralfms \
ARG APP_HOME_DIR UCENTRALFMS_ROOT=/ucentralfms-data \
UCENTRALFMS_CONFIG=/ucentralfms-data
ENV APP_NAME=$APP_NAME \ RUN addgroup -S "$UCENTRALFMS_USER" && \
APP_USER=$APP_NAME \ adduser -S -G "$UCENTRALFMS_USER" "$UCENTRALFMS_USER"
APP_ROOT=/$APP_NAME-data \
APP_CONFIG=/$APP_NAME-data \
APP_HOME_DIR=$APP_HOME_DIR
RUN useradd $APP_USER RUN mkdir /ucentral
RUN mkdir -p "$UCENTRALFMS_ROOT" "$UCENTRALFMS_CONFIG" && \
chown "$UCENTRALFMS_USER": "$UCENTRALFMS_ROOT" "$UCENTRALFMS_CONFIG"
RUN apk add --update --no-cache librdkafka curl-dev mariadb-connector-c libpq unixodbc su-exec
RUN mkdir $APP_HOME_DIR COPY --from=builder /ucentralfms/cmake-build/ucentralfms /ucentral/ucentralfms
RUN mkdir -p "$APP_ROOT" "$APP_CONFIG" && \ COPY --from=builder /cppkafka/cmake-build/src/lib/* /lib/
chown "$APP_USER": "$APP_ROOT" "$APP_CONFIG" COPY --from=builder /poco/cmake-build/lib/* /lib/
COPY --from=builder /aws-sdk-cpp/cmake-build/aws-cpp-sdk-core/libaws-cpp-sdk-core.so /lib/
RUN apt-get update && apt-get install --no-install-recommends -y \ COPY --from=builder /aws-sdk-cpp/cmake-build/aws-cpp-sdk-s3/libaws-cpp-sdk-s3.so /lib/
librdkafka++1 gosu gettext ca-certificates bash jq curl wget \
libmariadb-dev-compat libpq5 postgresql-client libfmt7 sqlite3
COPY readiness_check /readiness_check
COPY test_scripts/curl/cli /cli
COPY $APP_NAME.properties.tmpl /
COPY docker-entrypoint.sh /
COPY wait-for-postgres.sh /
RUN wget https://raw.githubusercontent.com/Telecominfraproject/wlan-cloud-ucentral-deploy/main/docker-compose/certs/restapi-ca.pem \
-O /usr/local/share/ca-certificates/restapi-ca-selfsigned.crt
COPY --from=app-build /$APP_NAME/cmake-build/$APP_NAME $APP_HOME_DIR/$APP_NAME
COPY --from=app-build /vcpkg/installed/x64-linux/lib/ /usr/local/lib/
COPY --from=cppkafka-build /cppkafka/cmake-build/src/lib/ /usr/local/lib/
COPY --from=poco-build /poco/cmake-build/lib/ /usr/local/lib/
RUN ldconfig
EXPOSE 16004 17004 16104 EXPOSE 16004 17004 16104
COPY docker-entrypoint.sh /
ENTRYPOINT ["/docker-entrypoint.sh"] ENTRYPOINT ["/docker-entrypoint.sh"]
CMD ${APP_HOME_DIR}/${APP_NAME} CMD ["/ucentral/ucentralfms"]

230
README.md
View File

@@ -1,7 +1,3 @@
<p align="center">
<img src="images/project/logo.svg" width="200"/>
</p>
# uCentralFMS # uCentralFMS
## What is this? ## What is this?
@@ -9,87 +5,173 @@ The uCentralFMS is a micro-service part of the OpenWiFi ecosystem. uCentralFMS i
to facilitate the task of upgrade and maintaining the proper firmware for all the devices to facilitate the task of upgrade and maintaining the proper firmware for all the devices
used in your OpenWiFi solution. You may either [build it](#building) or use the [Docker version](#docker). used in your OpenWiFi solution. You may either [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-ucentralfms/).
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-ucentralfms/main/openapi/owfms.yaml)) to get interactive docs page.
## Building ## Building
To build the microservice from source, please follow the instructions in [here](./BUILDING.md) In order to build the uCentralFMS, you will need to install its dependencies, which includes the following:
- cmake
- boost
- POCO 1.10.1 or later
- a C++17 compiler
- openssl
- libpq-dev (PortgreSQL development libraries)
- mysql-client (MySQL client)
- librdkafka
- cppkafka
## Docker Building is a 2 part process. The first part is to build a local copy of the framework tailored to your environment. This
To use the CLoudSDK deployment please follow [here](https://github.com/Telecominfraproject/wlan-cloud-ucentral-deploy) framework is [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
Poco may take several minutes depending on the platform you are building on.
### Ubuntu
These instructions have proven to work on Ubuntu 20.4.
```
sudo apt install git cmake g++ libssl-dev libmariabd-dev unixodbc-dev
sudo apt install libpq-dev libaprutil1-dev apache2-dev libboost-all-dev
sudo apt install librdkafka-dev liblua5.3-dev
git clone https://github.com/stephb9959/poco
cd poco
mkdir cmake-build
cd cmake-build
cmake ..
cmake --build . --config Release
sudo cmake --build . --target install
git clone https://github.com/stephb9959/cppkafka
cd cppkafka
mkdir cmake-build
cd cmake-build
cmake ..
cmake --build . --config Release
sudo cmake --build . --target install
cd ~
git clone https://github.com/Telecominfraproject/wlan-cloud-ucentralgw
cd wlan-cloud-ucentralgw
mkdir cmake-build
cd cmake-build
cmake ..
make
```
### Fedora
The following instructions have proven to work on Fedora 33
```
sudo yum install cmake g++ openssl-devel unixODBC-devel mysql-devel mysql apr-util-devel boost boost-devel
sudo yum install yaml-cpp-devel lua-devel
sudo dnf install postgresql.x86_64 librdkafka-devel
sudo dnf install postgresql-devel
git clone https://github.com/stephb9959/poco
cd poco
mkdir cmake-build
cd cmake-build
cmake ..
cmake --build . --config Release
sudo cmake --build . --target install
git clone https://github.com/stephb9959/cppkafka
cd cppkafka
mkdir cmake-build
cd cmake-build
cmake ..
cmake --build . --config Release
sudo cmake --build . --target install
cd ~
git clone https://github.com/Telecominfraproject/wlan-cloud-ucentralfms
cd wlan-cloud-ucentralfms
mkdir cmake-build
cd cmake-build
cmake ..
make
```
### OSX Build
The following instructions have proven to work on OSX Big Sur. You need to install [Homebrew](https://brew.sh/). You must also have installed [XCode for OS X](https://www.freecodecamp.org/news/how-to-download-and-install-xcode/).
```
brew install openssl
brew install cmake
brew install libpq
brew install mysql-client
brew install apr
brew install apr-util
brew install boost
brew install yaml-cpp
brew install postgresql
brew install unixodbc
brew install librdkafka
git clone https://github.com/stephb9959/poco
cd poco
mkdir cmake-build
cd cmake-build
cmake ..
cmake --build . --config Release -j
sudo cmake --build . --target install
git clone https://github.com/stephb9959/cppkafka
cd cppkafka
mkdir cmake-build
cd cmake-build
cmake ..
cmake --build . --config Release
sudo cmake --build . --target install
cd ~
git clone https://github.com/Telecominfraproject/wlan-cloud-ucentralfms
cd wlan-cloud-ucentralfms
mkdir cmake-build
cd cmake-build
cmake ..
make -j
```
### Raspberry
The build on a rPI takes a while. You can shorten that build time and requirements by disabling all the larger database
support. You can build with only SQLite support by not installing the packages for ODBC, PostgreSQL, and MySQL by
adding -DSMALL_BUILD=1 on the cmake build line.
```
sudo apt install git cmake g++ libssl-dev libaprutil1-dev apache2-dev libboost-all-dev libyaml-cpp-dev
git clone https://github.com/stephb9959/poco
cd poco
mkdir cmake-build
cd cmake-build
cmake ..
cmake --build . --config Release
sudo cmake --build . --target install
cd ~
git clone https://github.com/Telecominfraproject/wlan-cloud-ucentralfms
cd wlan-cloud-ucentralfms
mkdir cmake-build
cd cmake-build
cmake -DSMALL_BUILD=1 ..
make
```
### 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 `uploads` directories. From the directory where your cloned source is, you will need to create the `certs`, `logs`, and `data`.
```bash ```shell
mkdir certs mkdir certs
mkdir certs/cas
mkdir logs mkdir logs
mkdir uploads mkdir data
```
You should now have the following:
```text
--+-- certs
| +--- cas
+-- cmake
+-- cmake-build
+-- logs
+-- src
+-- test_scripts
+-- openapi
+-- uploads
+-- owsec.properties
``` ```
### Certificate ### Certificates
The OWFMS uses a certificate to provide security for the REST API Certificate to secure the Northbound API. Love'em of hate'em, we gotta use'em. So we tried to make this as easy as possible for you.
#### 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.
```text ```asm
certs ---+--- restapi-ca.pem certs ---+--- root.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
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.
```bash
export OWGW_ROOT=`pwd`
export OWGW_CONFIG=`pwd`
```
You can run the shell script `set_env.sh` from the microservice root.
### OWFMS Service Configuration
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)
## Kafka topics
Toe read more about Kafka, follow the [document](https://github.com/Telecominfraproject/wlan-cloud-ucentralgw/blob/main/KAFKA.md)
## Contributions
We need more contributors. Should you wish to contribute,
please follow the [contributions](https://github.com/Telecominfraproject/wlan-cloud-ucentralgw/blob/master/CONTRIBUTING.md) 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](https://github.com/Telecominfraproject/wlan-cloud-ucentralsec) | [here](https://github.com/Telecominfraproject/wlan-cloud-ucentralsec/blob/main/openpapi/owsec.yaml) |
| OWGW | Controller Service | [here](https://github.com/Telecominfraproject/wlan-cloud-ucentralgw) | [here](https://github.com/Telecominfraproject/wlan-cloud-ucentralgw/blob/master/openapi/owgw.yaml) |
| OWFMS | Firmware Management Service | [here](https://github.com/Telecominfraproject/wlan-cloud-ucentralfms) | [here](https://github.com/Telecominfraproject/wlan-cloud-ucentralfms/blob/main/openapi/owfms.yaml) |
| OWPROV | Provisioning Service | [here](https://github.com/Telecominfraproject/wlan-cloud-owprov) | [here](https://github.com/Telecominfraproject/wlan-cloud-owprov/blob/main/openapi/owprov.yaml) |
| OWANALYTICS | Analytics Service | [here](https://github.com/Telecominfraproject/wlan-cloud-analytics) | [here](https://github.com/Telecominfraproject/wlan-cloud-analytics/blob/main/openapi/owanalytics.yaml) |
| OWSUB | Subscriber Service | [here](https://github.com/Telecominfraproject/wlan-cloud-userportal) | [here](https://github.com/Telecominfraproject/wlan-cloud-userportal/blob/main/openapi/userportal.yaml) |

2
build
View File

@@ -1 +1 @@
2 14

View File

@@ -1,63 +1,11 @@
#!/bin/bash #!/bin/sh
set -e set -e
if [ "$SELFSIGNED_CERTS" = 'true' ]; then if [ "$1" = '/ucentral/ucentralfms' -a "$(id -u)" = '0' ]; then
update-ca-certificates
fi
if [[ "$TEMPLATE_CONFIG" = 'true' ]]; then
RESTAPI_HOST_ROOTCA=${RESTAPI_HOST_ROOTCA:-"\$OWFMS_ROOT/certs/restapi-ca.pem"} \
RESTAPI_HOST_PORT=${RESTAPI_HOST_PORT:-"16004"} \
RESTAPI_HOST_CERT=${RESTAPI_HOST_CERT:-"\$OWFMS_ROOT/certs/restapi-cert.pem"} \
RESTAPI_HOST_KEY=${RESTAPI_HOST_KEY:-"\$OWFMS_ROOT/certs/restapi-key.pem"} \
RESTAPI_HOST_KEY_PASSWORD=${RESTAPI_HOST_KEY_PASSWORD:-"mypassword"} \
INTERNAL_RESTAPI_HOST_ROOTCA=${INTERNAL_RESTAPI_HOST_ROOTCA:-"\$OWFMS_ROOT/certs/restapi-ca.pem"} \
INTERNAL_RESTAPI_HOST_PORT=${INTERNAL_RESTAPI_HOST_PORT:-"17004"} \
INTERNAL_RESTAPI_HOST_CERT=${INTERNAL_RESTAPI_HOST_CERT:-"\$OWFMS_ROOT/certs/restapi-cert.pem"} \
INTERNAL_RESTAPI_HOST_KEY=${INTERNAL_RESTAPI_HOST_KEY:-"\$OWFMS_ROOT/certs/restapi-key.pem"} \
INTERNAL_RESTAPI_HOST_KEY_PASSWORD=${INTERNAL_RESTAPI_HOST_KEY_PASSWORD:-"mypassword"} \
SERVICE_KEY=${SERVICE_KEY:-"\$OWFMS_ROOT/certs/restapi-key.pem"} \
SERVICE_KEY_PASSWORD=${SERVICE_KEY_PASSWORD:-"mypassword"} \
SYSTEM_DATA=${SYSTEM_DATA:-"\$OWFMS_ROOT/data"} \
SYSTEM_URI_PRIVATE=${SYSTEM_URI_PRIVATE:-"https://localhost:17004"} \
SYSTEM_URI_PUBLIC=${SYSTEM_URI_PUBLIC:-"https://localhost:16004"} \
SYSTEM_URI_UI=${SYSTEM_URI_UI:-"http://localhost"} \
SECURITY_RESTAPI_DISABLE=${SECURITY_RESTAPI_DISABLE:-"false"} \
FIRMWAREDB_REFRESH=${FIRMWAREDB_REFRESH:-"86400"} \
FIRMWAREDB_MAXAGE=${FIRMWAREDB_MAXAGE:-"90"} \
S3_VIRTUAL_ADRESSING=${S3_VIRTUAL_ADRESSING:-"true"} \
S3_HTTPS=${S3_HTTPS:-"true"} \
S3_ENDPOINT=${S3_ENDPOINT:-""} \
S3_BUCKETNAME=${S3_BUCKETNAME:-"ucentral-ap-firmware"} \
S3_REGION=${S3_REGION:-"us-east-1"} \
S3_SECRET=${S3_SECRET:-"*******************************************"} \
S3_KEY=${S3_KEY:-"*******************************************"} \
S3_BUCKET_URI=${S3_BUCKET_URI:-"ucentral-ap-firmware.s3.amazonaws.com"} \
KAFKA_ENABLE=${KAFKA_ENABLE:-"true"} \
KAFKA_BROKERLIST=${KAFKA_BROKERLIST:-"localhost:9092"} \
KAFKA_SSL_CA_LOCATION=${KAFKA_SSL_CA_LOCATION:-""} \
KAFKA_SSL_CERTIFICATE_LOCATION=${KAFKA_SSL_CERTIFICATE_LOCATION:-""} \
KAFKA_SSL_KEY_LOCATION=${KAFKA_SSL_KEY_LOCATION:-""} \
KAFKA_SSL_KEY_PASSWORD=${KAFKA_SSL_KEY_PASSWORD:-""} \
STORAGE_TYPE=${STORAGE_TYPE:-"sqlite"} \
STORAGE_TYPE_POSTGRESQL_HOST=${STORAGE_TYPE_POSTGRESQL_HOST:-"localhost"} \
STORAGE_TYPE_POSTGRESQL_USERNAME=${STORAGE_TYPE_POSTGRESQL_USERNAME:-"owfms"} \
STORAGE_TYPE_POSTGRESQL_PASSWORD=${STORAGE_TYPE_POSTGRESQL_PASSWORD:-"owfms"} \
STORAGE_TYPE_POSTGRESQL_DATABASE=${STORAGE_TYPE_POSTGRESQL_DATABASE:-"owfms"} \
STORAGE_TYPE_POSTGRESQL_PORT=${STORAGE_TYPE_POSTGRESQL_PORT:-"5432"} \
STORAGE_TYPE_MYSQL_HOST=${STORAGE_TYPE_MYSQL_HOST:-"localhost"} \
STORAGE_TYPE_MYSQL_USERNAME=${STORAGE_TYPE_MYSQL_USERNAME:-"owfms"} \
STORAGE_TYPE_MYSQL_PASSWORD=${STORAGE_TYPE_MYSQL_PASSWORD:-"owfms"} \
STORAGE_TYPE_MYSQL_DATABASE=${STORAGE_TYPE_MYSQL_DATABASE:-"owfms"} \
STORAGE_TYPE_MYSQL_PORT=${STORAGE_TYPE_MYSQL_PORT:-"3306"} \
envsubst < /owfms.properties.tmpl > $OWFMS_CONFIG/owfms.properties
fi
if [ "$1" = '/openwifi/owfms' -a "$(id -u)" = '0' ]; then
if [ "$RUN_CHOWN" = 'true' ]; then if [ "$RUN_CHOWN" = 'true' ]; then
chown -R "$OWFMS_USER": "$OWFMS_ROOT" "$OWFMS_CONFIG" chown -R "$UCENTRALFMS_USER": "$UCENTRALFMS_ROOT" "$UCENTRALFMS_CONFIG"
fi fi
exec gosu "$OWFMS_USER" "$@" exec su-exec "$UCENTRALFMS_USER" "$@"
fi fi
exec "$@" exec "$@"

2
helm/.gitignore vendored
View File

@@ -1,3 +1 @@
*.swp *.swp
Chart.lock
charts/

View File

@@ -1,18 +1,18 @@
apiVersion: v2 apiVersion: v2
appVersion: "1.0" appVersion: "1.0"
description: A Helm chart for Kubernetes description: A Helm chart for Kubernetes
name: owfms name: ucentralfms
version: 0.1.0 version: 0.1.0
dependencies: dependencies:
- name: postgresql - name: postgresql
repository: https://tip.jfrog.io/artifactory/tip-wlan-cloud-ucentral-helm/ repository: https://charts.bitnami.com/bitnami
version: 10.9.2 version: 10.9.2
condition: postgresql.enabled condition: postgresql.enabled
- name: mysql - name: mysql
repository: https://tip.jfrog.io/artifactory/tip-wlan-cloud-ucentral-helm/ repository: https://charts.bitnami.com/bitnami
version: 8.8.3 version: 8.8.3
condition: mysql.enabled condition: mysql.enabled
- name: mariadb - name: mariadb
repository: https://tip.jfrog.io/artifactory/tip-wlan-cloud-ucentral-helm/ repository: https://charts.bitnami.com/bitnami
version: 9.4.2 version: 9.4.2
condition: mariadb.enabled condition: mariadb.enabled

View File

@@ -1,6 +1,6 @@
# owfms # ucentralfms
This Helm chart helps to deploy OpenWIFI Firmware service (further on refered as __Firmware__) to the Kubernetes clusters. It is mainly used in [assembly chart](https://github.com/Telecominfraproject/wlan-cloud-ucentral-deploy/tree/main/chart) as uCentralSec requires other services as dependencies that are considered in that Helm chart. This chart is purposed to define deployment logic close to the application code itself and define default values that could be overriden during deployment. This Helm chart helps to deploy uCentralSec to the Kubernetes clusters. It is mainly used in [assembly chart](https://github.com/Telecominfraproject/wlan-cloud-ucentral-deploy/tree/main/chart) as uCentralSec requires other services as dependencies that are considered in that Helm chart. This chart is purposed to define deployment logic close to the application code itself and define default values that could be overriden during deployment.
## TL;DR; ## TL;DR;
@@ -11,7 +11,7 @@ $ helm install .
## Introduction ## Introduction
This chart bootstraps the Firmware on a [Kubernetes](http://kubernetes.io) cluster using the [Helm](https://helm.sh) package manager. This chart bootstraps an ucentralfms on a [Kubernetes](http://kubernetes.io) cluster using the [Helm](https://helm.sh) package manager.
## Installing the Chart ## Installing the Chart
@@ -20,10 +20,10 @@ Currently this chart is not assembled in charts archives, so [helm-git](https://
To install the chart with the release name `my-release`: To install the chart with the release name `my-release`:
```bash ```bash
$ helm install --name my-release git+https://github.com/Telecominfraproject/wlan-cloud-ucentralfms@helm/owfms-0.1.0.tgz?ref=main $ helm install --name my-release git+https://github.com/Telecominfraproject/wlan-cloud-ucentralfms@helm?ref=main
``` ```
The command deploys the Firmware on the Kubernetes cluster in the default configuration. The [configuration](#configuration) section lists the parameters that can be configured during installation. The command deploys ucentralfms on the Kubernetes cluster in the default configuration. The [configuration](#configuration) section lists the parameters that can be configured during installation.
> **Tip**: List all releases using `helm list` > **Tip**: List all releases using `helm list`
@@ -47,31 +47,30 @@ The following table lists the configurable parameters of the chart and their def
| strategyType | string | Application deployment strategy | `'Recreate'` | | strategyType | string | Application deployment strategy | `'Recreate'` |
| nameOverride | string | Override to be used for application deployment | | | nameOverride | string | Override to be used for application deployment | |
| fullnameOverride | string | Override to be used for application deployment (has priority over nameOverride) | | | fullnameOverride | string | Override to be used for application deployment (has priority over nameOverride) | |
| images.owfms.repository | string | Docker image repository | | | images.ucentralfms.repository | string | Docker image repository | |
| images.owfms.tag | string | Docker image tag | `'master'` | | images.ucentralfms.tag | string | Docker image tag | `'master'` |
| images.owfms.pullPolicy | string | Docker image pull policy | `'Always'` | | images.ucentralfms.pullPolicy | string | Docker image pull policy | `'Always'` |
| services.owfms.type | string | OpenWIFI Firmware service type | `'LoadBalancer'` | | services.ucentralfms.type | string | uCentralSec service type | `'LoadBalancer'` |
| services.owfms.ports.restapi.servicePort | number | REST API endpoint port to be exposed on service | `16001` | | services.ucentralfms.ports.restapi.servicePort | number | REST API endpoint port to be exposed on service | `16001` |
| services.owfms.ports.restapi.targetPort | number | REST API endpoint port to be targeted by service | `16001` | | services.ucentralfms.ports.restapi.targetPort | number | REST API endpoint port to be targeted by service | `16001` |
| services.owfms.ports.restapi.protocol | string | REST API endpoint protocol | `'TCP'` | | services.ucentralfms.ports.restapi.protocol | string | REST API endpoint protocol | `'TCP'` |
| services.owfms.ports.restapiinternal.servicePort | string | Internal REST API endpoint port to be exposed on service | `17001` | | services.ucentralfms.ports.restapiinternal.servicePort | string | Internal REST API endpoint port to be exposed on service | `17001` |
| services.owfms.ports.restapiinternal.targetPort | number | Internal REST API endpoint port to be targeted by service | `17001` | | services.ucentralfms.ports.restapiinternal.targetPort | number | Internal REST API endpoint port to be targeted by service | `17001` |
| services.owfms.ports.restapiinternal.protocol | string | Internal REST API endpoint protocol | `'TCP'` | | services.ucentralfms.ports.restapiinternal.protocol | string | Internal REST API endpoint protocol | `'TCP'` |
| checks.owfms.liveness.httpGet.path | string | Liveness check path to be used | `'/'` | | checks.ucentralfms.liveness.httpGet.path | string | Liveness check path to be used | `'/'` |
| checks.owfms.liveness.httpGet.port | number | Liveness check port to be used (should be pointint to ALB endpoint) | `16101` | | checks.ucentralfms.liveness.httpGet.port | number | Liveness check port to be used (should be pointint to ALB endpoint) | `16101` |
| checks.owfms.readiness.httpGet.path | string | Readiness check path to be used | `'/'` | | checks.ucentralfms.readiness.httpGet.path | string | Readiness check path to be used | `'/'` |
| checks.owfms.readiness.httpGet.port | number | Readiness check port to be used (should be pointint to ALB endpoint) | `16101` | | checks.ucentralfms.readiness.httpGet.port | number | Readiness check port to be used (should be pointint to ALB endpoint) | `16101` |
| ingresses.restapi.enabled | boolean | Defines if REST API endpoint should be exposed via Ingress controller | `False` | | ingresses.restapi.enabled | boolean | Defines if REST API endpoint should be exposed via Ingress controller | `False` |
| ingresses.restapi.hosts | array | List of hosts for exposed REST API | | | ingresses.restapi.hosts | array | List of hosts for exposed REST API | |
| ingresses.restapi.paths | array | List of paths to be exposed for REST API | | | ingresses.restapi.paths | array | List of paths to be exposed for REST API | |
| volumes.owfms | array | Defines list of volumes to be attached to the Firmware | | | volumes.ucentralfms | array | Defines list of volumes to be attached to uCentralSec | |
| persistence.enabled | boolean | Defines if the Firmware requires Persistent Volume (required for permanent files storage and SQLite DB if enabled) | `True` | | persistence.enabled | boolean | Defines if uCentralSec requires Persistent Volume (required for permanent files storage and SQLite DB if enabled) | `True` |
| persistence.accessModes | array | Defines PV access modes | | | persistence.accessModes | array | Defines PV access modes | |
| persistence.size | string | Defines PV size | `'10Gi'` | | persistence.size | string | Defines PV size | `'10Gi'` |
| public_env_variables | hash | Defines list of environment variables to be passed to the Firmware | | | public_env_variables | hash | Defines list of environment variables to be passed to uCentralSec | |
| configProperties | hash | Configuration properties that should be passed to the application in `owfms.properties`. May be passed by key in set (i.e. `configProperties."rtty\.token"`) | | | configProperties | hash | Configuration properties that should be passed to the application in `ucentralfms.properties`. May be passed by key in set (i.e. `configProperties."rtty\.token"`) | |
| existingCertsSecret | string | Existing Kubernetes secret containing all required certificates and private keys for microservice operation. If set, certificates from `certs` key are ignored | `""` | | certs | hash | Defines files (keys and certificates) that should be passed to uCentralSec (PEM format is adviced to be used) (see `volumes.ucentralfms` on where it is mounted) | |
| certs | hash | Defines files (keys and certificates) that should be passed to the Gateway (PEM format is adviced to be used) (see `volumes.owfms` on where it is mounted). If `existingCertsSecret` is set, certificates passed this way will not be used. | |
Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example, Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example,

View File

@@ -1,4 +1,4 @@
{{- define "owfms.config" -}} {{- define "ucentralfms.config" -}}
{{- range $key, $value := .Values.configProperties }} {{- range $key, $value := .Values.configProperties }}
{{ $key }} = {{ $value }} {{ $key }} = {{ $value }}
{{- end }} {{- end }}

View File

@@ -2,7 +2,7 @@
{{/* {{/*
Expand the name of the chart. Expand the name of the chart.
*/}} */}}
{{- define "owfms.name" -}} {{- define "ucentralfms.name" -}}
{{- default .Chart.Name .Values.nameOverride | trunc 63 | trimSuffix "-" -}} {{- default .Chart.Name .Values.nameOverride | trunc 63 | trimSuffix "-" -}}
{{- end -}} {{- end -}}
@@ -11,7 +11,7 @@ Create a default fully qualified app name.
We truncate at 63 chars because some Kubernetes name fields are limited to this (by the DNS naming spec). We truncate at 63 chars because some Kubernetes name fields are limited to this (by the DNS naming spec).
If release name contains chart name it will be used as a full name. If release name contains chart name it will be used as a full name.
*/}} */}}
{{- define "owfms.fullname" -}} {{- define "ucentralfms.fullname" -}}
{{- if .Values.fullnameOverride -}} {{- if .Values.fullnameOverride -}}
{{- .Values.fullnameOverride | trunc 63 | trimSuffix "-" -}} {{- .Values.fullnameOverride | trunc 63 | trimSuffix "-" -}}
{{- else -}} {{- else -}}
@@ -27,16 +27,6 @@ If release name contains chart name it will be used as a full name.
{{/* {{/*
Create chart name and version as used by the chart label. Create chart name and version as used by the chart label.
*/}} */}}
{{- define "owfms.chart" -}} {{- define "ucentralfms.chart" -}}
{{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" -}} {{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" -}}
{{- end -}} {{- end -}}
{{- define "owfms.ingress.apiVersion" -}}
{{- if .Capabilities.APIVersions.Has "networking.k8s.io/v1" -}}
{{- print "networking.k8s.io/v1" -}}
{{- else if .Capabilities.APIVersions.Has "networking.k8s.io/v1beta1" -}}
{{- print "networking.k8s.io/v1beta1" -}}
{{- else -}}
{{- print "extensions/v1beta1" -}}
{{- end -}}
{{- end -}}

View File

@@ -1,90 +1,42 @@
{{- $root := . -}} {{- $root := . -}}
{{- $storageType := index .Values.configProperties "storage.type" -}}
--- ---
apiVersion: apps/v1 apiVersion: apps/v1
kind: Deployment kind: Deployment
metadata: metadata:
name: {{ include "owfms.fullname" . }} name: {{ include "ucentralfms.fullname" . }}
labels: labels:
app.kubernetes.io/name: {{ include "owfms.name" . }} app.kubernetes.io/name: {{ include "ucentralfms.name" . }}
helm.sh/chart: {{ include "owfms.chart" . }} helm.sh/chart: {{ include "ucentralfms.chart" . }}
app.kubernetes.io/instance: {{ .Release.Name }} app.kubernetes.io/instance: {{ .Release.Name }}
app.kubernetes.io/managed-by: {{ .Release.Service }} app.kubernetes.io/managed-by: {{ .Release.Service }}
spec: spec:
replicas: {{ .Values.replicaCount }} replicas: {{ .Values.replicaCount }}
strategy: strategy:
type: {{ .Values.strategyType }} type: {{ .Values.strategyType }}
revisionHistoryLimit: {{ .Values.revisionHistoryLimit }}
selector: selector:
matchLabels: matchLabels:
app.kubernetes.io/name: {{ include "owfms.name" . }} app.kubernetes.io/name: {{ include "ucentralfms.name" . }}
app.kubernetes.io/instance: {{ .Release.Name }} app.kubernetes.io/instance: {{ .Release.Name }}
{{- with .Values.services.owfms.labels }} {{- with .Values.services.ucentralfms.labels }}
{{- toYaml . | nindent 6 }} {{- toYaml . | nindent 6 }}
{{- end }} {{- end }}
template: template:
metadata: metadata:
annotations: annotations:
checksum/config: {{ include "owfms.config" . | sha256sum }} checksum/config: {{ include "ucentralfms.config" . | sha256sum }}
{{- with .Values.podAnnotations }}
{{- toYaml . | nindent 8 }}
{{- end }}
labels: labels:
app.kubernetes.io/name: {{ include "owfms.name" . }} app.kubernetes.io/name: {{ include "ucentralfms.name" . }}
app.kubernetes.io/instance: {{ .Release.Name }} app.kubernetes.io/instance: {{ .Release.Name }}
{{- with .Values.services.owfms.labels }} {{- with .Values.services.ucentralfms.labels }}
{{- toYaml . | nindent 8 }} {{- toYaml . | nindent 8 }}
{{- end }} {{- end }}
spec: spec:
initContainers:
- name: wait-kafka
image: "{{ .Values.images.dockerize.repository }}:{{ .Values.images.dockerize.tag }}"
imagePullPolicy: {{ .Values.images.dockerize.pullPolicy }}
args:
- -wait
- tcp://{{ index .Values.configProperties "openwifi.kafka.brokerlist" }}
- -timeout
- 600s
{{- if eq $storageType "postgresql" }}
- name: wait-postgres
image: "{{ .Values.images.owfms.repository }}:{{ .Values.images.owfms.tag }}"
imagePullPolicy: {{ .Values.images.owfms.pullPolicy }}
command:
- /wait-for-postgres.sh
- {{ index .Values.configProperties "storage.type.postgresql.host" }}
- echo
- "PostgreSQL is ready"
env:
- name: KUBERNETES_DEPLOYED
value: "{{ now }}"
{{- range $key, $value := .Values.public_env_variables }}
- name: {{ $key }}
value: {{ $value | quote }}
{{- end }}
{{- range $key, $value := .Values.secret_env_variables }}
- name: {{ $key }}
valueFrom:
secretKeyRef:
name: {{ include "owfms.fullname" $root }}-env
key: {{ $key }}
{{- end }}
volumeMounts:
{{- range .Values.volumes.owfms }}
- name: {{ .name }}
mountPath: {{ .mountPath }}
{{- if .subPath }}
subPath: {{ .subPath }}
{{- end }}
{{- end }}
{{- end }}
containers: containers:
- name: owfms - name: ucentralfms
image: "{{ .Values.images.owfms.repository }}:{{ .Values.images.owfms.tag }}" image: "{{ .Values.images.ucentralfms.repository }}:{{ .Values.images.ucentralfms.tag }}"
imagePullPolicy: {{ .Values.images.owfms.pullPolicy }} imagePullPolicy: {{ .Values.images.ucentralfms.pullPolicy }}
env: env:
- name: KUBERNETES_DEPLOYED - name: KUBERNETES_DEPLOYED
@@ -97,19 +49,19 @@ spec:
- name: {{ $key }} - name: {{ $key }}
valueFrom: valueFrom:
secretKeyRef: secretKeyRef:
name: {{ include "owfms.fullname" $root }}-env name: {{ include "ucentralfms.fullname" $root }}-env
key: {{ $key }} key: {{ $key }}
{{- end }} {{- end }}
ports: ports:
{{- range $port, $portValue := .Values.services.owfms.ports }} {{- range $port, $portValue := .Values.services.ucentralfms.ports }}
- name: {{ $port }} - name: {{ $port }}
containerPort: {{ $portValue.targetPort }} containerPort: {{ $portValue.targetPort }}
protocol: {{ $portValue.protocol }} protocol: {{ $portValue.protocol }}
{{- end }} {{- end }}
volumeMounts: volumeMounts:
{{- range .Values.volumes.owfms }} {{- range .Values.volumes.ucentralfms }}
- name: {{ .name }} - name: {{ .name }}
mountPath: {{ .mountPath }} mountPath: {{ .mountPath }}
{{- if .subPath }} {{- if .subPath }}
@@ -117,13 +69,13 @@ spec:
{{- end }} {{- end }}
{{- end }} {{- end }}
{{- if .Values.checks.owfms.liveness }} {{- if .Values.checks.ucentralfms.liveness }}
livenessProbe: livenessProbe:
{{- toYaml .Values.checks.owfms.liveness | nindent 12 }} {{- toYaml .Values.checks.ucentralfms.liveness | nindent 12 }}
{{- end }} {{- end }}
{{- if .Values.checks.owfms.readiness }} {{- if .Values.checks.ucentralfms.readiness }}
readinessProbe: readinessProbe:
{{- toYaml .Values.checks.owfms.readiness | nindent 12 }} {{- toYaml .Values.checks.ucentralfms.readiness | nindent 12 }}
{{- end }} {{- end }}
{{- with .Values.resources }} {{- with .Values.resources }}
@@ -131,15 +83,13 @@ spec:
{{- toYaml . | nindent 12 }} {{- toYaml . | nindent 12 }}
{{- end }} {{- end }}
{{- with .Values.securityContext }}
securityContext: securityContext:
{{- toYaml . | nindent 8 }} fsGroup: 101
{{- end }}
imagePullSecrets: imagePullSecrets:
{{- range $image, $imageValue := .Values.images }} {{- range $image, $imageValue := .Values.images }}
{{- if $imageValue.regcred }} {{- if $imageValue.regcred }}
- name: {{ include "owfms.fullname" $root }}-{{ $image }}-regcred - name: {{ include "ucentralfms.fullname" $root }}-{{ $image }}-regcred
{{- end }} {{- end }}
{{- end }} {{- end }}

View File

@@ -2,13 +2,13 @@
{{- range $ingress, $ingressValue := .Values.ingresses }} {{- range $ingress, $ingressValue := .Values.ingresses }}
{{- if $ingressValue.enabled }} {{- if $ingressValue.enabled }}
--- ---
apiVersion: {{ include "owfms.ingress.apiVersion" $root }} apiVersion: extensions/v1beta1
kind: Ingress kind: Ingress
metadata: metadata:
name: {{ include "owfms.fullname" $root }}-{{ $ingress }} name: {{ include "ucentralfms.fullname" $root }}-{{ $ingress }}
labels: labels:
app.kubernetes.io/name: {{ include "owfms.name" $root }} app.kubernetes.io/name: {{ include "ucentralfms.name" $root }}
helm.sh/chart: {{ include "owfms.chart" $root }} helm.sh/chart: {{ include "ucentralfms.chart" $root }}
app.kubernetes.io/instance: {{ $root.Release.Name }} app.kubernetes.io/instance: {{ $root.Release.Name }}
app.kubernetes.io/managed-by: {{ $root.Release.Service }} app.kubernetes.io/managed-by: {{ $root.Release.Service }}
{{- with $ingressValue.annotations }} {{- with $ingressValue.annotations }}
@@ -36,23 +36,9 @@ spec:
paths: paths:
{{- range $ingressValue.paths }} {{- range $ingressValue.paths }}
- path: {{ .path }} - path: {{ .path }}
{{- if $root.Capabilities.APIVersions.Has "networking.k8s.io/v1" }}
pathType: {{ .pathType | default "ImplementationSpecific" }}
{{- end }}
backend: backend:
{{- if $root.Capabilities.APIVersions.Has "networking.k8s.io/v1" }} serviceName: {{ include "ucentralfms.fullname" $root }}-{{ .serviceName }}
service:
name: {{ include "owfms.fullname" $root }}-{{ .serviceName }}
port:
{{- if kindIs "string" .servicePort }}
name: {{ .servicePort }}
{{- else }}
number: {{ .servicePort }}
{{- end }}
{{- else }}
serviceName: {{ include "owfms.fullname" $root }}-{{ .serviceName }}
servicePort: {{ .servicePort }} servicePort: {{ .servicePort }}
{{- end }}
{{- end }} {{- end }}
{{- end }} {{- end }}

View File

@@ -3,10 +3,10 @@
apiVersion: v1 apiVersion: v1
kind: PersistentVolumeClaim kind: PersistentVolumeClaim
metadata: metadata:
name: {{ template "owfms.fullname" . }}-pvc name: {{ template "ucentralfms.fullname" . }}-pvc
labels: labels:
app.kubernetes.io/name: {{ include "owfms.name" . }} app.kubernetes.io/name: {{ include "ucentralfms.name" . }}
helm.sh/chart: {{ include "owfms.chart" . }} helm.sh/chart: {{ include "ucentralfms.chart" . }}
app.kubernetes.io/instance: {{ .Release.Name }} app.kubernetes.io/instance: {{ .Release.Name }}
app.kubernetes.io/managed-by: {{ .Release.Service }} app.kubernetes.io/managed-by: {{ .Release.Service }}
{{- with .Values.persistence.annotations }} {{- with .Values.persistence.annotations }}

View File

@@ -2,11 +2,11 @@
apiVersion: v1 apiVersion: v1
metadata: metadata:
labels: labels:
app.kuberentes.io/name: {{ include "owfms.name" . }} app.kuberentes.io/name: {{ include "ucentralfms.name" . }}
helm.sh/chart: {{ include "owfms.chart" . }} helm.sh/chart: {{ include "ucentralfms.chart" . }}
app.kubernetes.io/instance: {{ .Release.Name }} app.kubernetes.io/instance: {{ .Release.Name }}
app.kubernetes.io/managed-by: {{ .Release.Service }} app.kubernetes.io/managed-by: {{ .Release.Service }}
name: {{ include "owfms.fullname" . }}-certs name: {{ include "ucentralfms.fullname" . }}-certs
kind: Secret kind: Secret
type: Opaque type: Opaque
data: data:

View File

@@ -2,12 +2,12 @@
apiVersion: v1 apiVersion: v1
metadata: metadata:
labels: labels:
app.kuberentes.io/name: {{ include "owfms.name" . }} app.kuberentes.io/name: {{ include "ucentralfms.name" . }}
helm.sh/chart: {{ include "owfms.chart" . }} helm.sh/chart: {{ include "ucentralfms.chart" . }}
app.kubernetes.io/instance: {{ .Release.Name }} app.kubernetes.io/instance: {{ .Release.Name }}
app.kubernetes.io/managed-by: {{ .Release.Service }} app.kubernetes.io/managed-by: {{ .Release.Service }}
name: {{ include "owfms.fullname" . }}-config name: {{ include "ucentralfms.fullname" . }}-config
kind: Secret kind: Secret
type: Opaque type: Opaque
data: data:
owfms.properties: {{ include "owfms.config" . | b64enc }} ucentralfms.properties: {{ include "ucentralfms.config" . | b64enc }}

View File

@@ -2,11 +2,11 @@
apiVersion: v1 apiVersion: v1
metadata: metadata:
labels: labels:
app.kuberentes.io/name: {{ include "owfms.name" . }} app.kuberentes.io/name: {{ include "ucentralfms.name" . }}
helm.sh/chart: {{ include "owfms.chart" . }} helm.sh/chart: {{ include "ucentralfms.chart" . }}
app.kubernetes.io/instance: {{ .Release.Name }} app.kubernetes.io/instance: {{ .Release.Name }}
app.kubernetes.io/managed-by: {{ .Release.Service }} app.kubernetes.io/managed-by: {{ .Release.Service }}
name: {{ include "owfms.fullname" . }}-env name: {{ include "ucentralfms.fullname" . }}-env
kind: Secret kind: Secret
type: Opaque type: Opaque
data: data:

View File

@@ -10,11 +10,11 @@ kind: Secret
type: kubernetes.io/dockerconfigjson type: kubernetes.io/dockerconfigjson
metadata: metadata:
labels: labels:
app.kuberentes.io/name: {{ include "owfms.name" $root }} app.kuberentes.io/name: {{ include "ucentralfms.name" $root }}
helm.sh/chart: {{ include "owfms.chart" $root }} helm.sh/chart: {{ include "ucentralfms.chart" $root }}
app.kubernetes.io/instance: {{ $root.Release.Name }} app.kubernetes.io/instance: {{ $root.Release.Name }}
app.kubernetes.io/managed-by: {{ $root.Release.Service }} app.kubernetes.io/managed-by: {{ $root.Release.Service }}
name: {{ include "owfms.fullname" $root }}-{{ $image }}-regcred name: {{ include "ucentralfms.fullname" $root }}-{{ $image }}-regcred
data: data:
.dockerconfigjson: {{ template "imagePullSecret" $imageValue.regcred }} .dockerconfigjson: {{ template "imagePullSecret" $imageValue.regcred }}
{{- end }} {{- end }}

View File

@@ -4,14 +4,14 @@
apiVersion: v1 apiVersion: v1
kind: Service kind: Service
metadata: metadata:
name: {{ include "owfms.fullname" $root }}-{{ $service }} name: {{ include "ucentralfms.fullname" $root }}-{{ $service }}
{{- with $serviceValue.annotations }} {{- with $serviceValue.annotations }}
annotations: annotations:
{{- toYaml . | nindent 4 }} {{- toYaml . | nindent 4 }}
{{- end }} {{- end }}
labels: labels:
app.kubernetes.io/name: {{ include "owfms.name" $root }} app.kubernetes.io/name: {{ include "ucentralfms.name" $root }}
helm.sh/chart: {{ include "owfms.chart" $root }} helm.sh/chart: {{ include "ucentralfms.chart" $root }}
app.kubernetes.io/instance: {{ $root.Release.Name }} app.kubernetes.io/instance: {{ $root.Release.Name }}
app.kubernetes.io/managed-by: {{ $root.Release.Service }} app.kubernetes.io/managed-by: {{ $root.Release.Service }}
@@ -39,7 +39,7 @@ spec:
{{- end }} {{- end }}
{{- end }} {{- end }}
selector: selector:
app.kubernetes.io/name: {{ include "owfms.name" $root }} app.kubernetes.io/name: {{ include "ucentralfms.name" $root }}
app.kubernetes.io/instance: {{ $root.Release.Name }} app.kubernetes.io/instance: {{ $root.Release.Name }}
{{- with $serviceValue.labels }} {{- with $serviceValue.labels }}
{{- toYaml . | nindent 4 }} {{- toYaml . | nindent 4 }}

View File

@@ -1,28 +1,23 @@
# System # System
replicaCount: 1 replicaCount: 1
strategyType: Recreate strategyType: Recreate
revisionHistoryLimit: 2
nameOverride: "" nameOverride: ""
fullnameOverride: "" fullnameOverride: ""
images: images:
owfms: ucentralfms:
repository: tip-tip-wlan-cloud-ucentral.jfrog.io/owfms repository: tip-tip-wlan-cloud-ucentral.jfrog.io/ucentralfms
tag: v3.0.0-RC1 tag: v2.1.0-RC1
pullPolicy: Always pullPolicy: Always
# regcred: # regcred:
# registry: tip-tip-wlan-cloud-ucentral.jfrog.io # registry: tip-tip-wlan-cloud-ucentral.jfrog.io
# username: username # username: username
# password: password # password: password
dockerize:
repository: tip-tip-wlan-cloud-ucentral.jfrog.io/dockerize
tag: 0.16.0
pullPolicy: IfNotPresent
services: services:
owfms: ucentralfms:
type: ClusterIP type: LoadBalancer
ports: ports:
restapi: restapi:
servicePort: 16004 servicePort: 16004
@@ -34,15 +29,15 @@ services:
protocol: TCP protocol: TCP
checks: checks:
owfms: ucentralfms:
liveness: liveness:
httpGet: httpGet:
path: / path: /
port: 16104 port: 16104
readiness: readiness:
exec: httpGet:
command: path: /
- /readiness_check port: 16104
ingresses: ingresses:
restapi: restapi:
@@ -54,30 +49,29 @@ ingresses:
- restapi.chart-example.local - restapi.chart-example.local
paths: paths:
- path: / - path: /
pathType: ImplementationSpecific serviceName: ucentralfms
serviceName: owfms
servicePort: restapi servicePort: restapi
volumes: volumes:
owfms: ucentralfms:
- name: config - name: config
mountPath: /owfms-data/owfms.properties mountPath: /ucentralfms-data/ucentralfms.properties
subPath: owfms.properties subPath: ucentralfms.properties
# Template below will be rendered in template # Template below will be rendered in template
volumeDefinition: | volumeDefinition: |
secret: secret:
secretName: {{ include "owfms.fullname" . }}-config secretName: {{ include "ucentralfms.fullname" . }}-config
- name: certs - name: certs
mountPath: /owfms-data/certs mountPath: /ucentralfms-data/certs
volumeDefinition: | volumeDefinition: |
secret: secret:
secretName: {{ if .Values.existingCertsSecret }}{{ .Values.existingCertsSecret }}{{ else }}{{ include "owfms.fullname" . }}-certs{{ end }} secretName: {{ include "ucentralfms.fullname" . }}-certs
# Change this if you want to use another volume type # Change this if you want to use another volume type
- name: persist - name: persist
mountPath: /owfms-data/persist mountPath: /ucentralfms-data/persist
volumeDefinition: | volumeDefinition: |
persistentVolumeClaim: persistentVolumeClaim:
claimName: {{ template "owfms.fullname" . }}-pvc claimName: {{ template "ucentralfms.fullname" . }}-pvc
resources: {} resources: {}
# We usually recommend not to specify default resources and to leave this as a conscious # We usually recommend not to specify default resources and to leave this as a conscious
@@ -91,17 +85,12 @@ resources: {}
# cpu: 100m # cpu: 100m
# memory: 128Mi # memory: 128Mi
securityContext:
fsGroup: 1000
nodeSelector: {} nodeSelector: {}
tolerations: [] tolerations: []
affinity: {} affinity: {}
podAnnotations: {}
persistence: persistence:
enabled: true enabled: true
# storageClassName: "-" # storageClassName: "-"
@@ -112,59 +101,44 @@ persistence:
# Application # Application
public_env_variables: public_env_variables:
OWFMS_ROOT: /owfms-data UCENTRALSEC_ROOT: /ucentralfms-data
OWFMS_CONFIG: /owfms-data UCENTRALSEC_CONFIG: /ucentralfms-data
# Environment variables required for the readiness checks using script
FLAGS: "-s --connect-timeout 3"
# NOTE in order for readiness check to use system info you need to set READINESS_METHOD to "systeminfo" and set OWSEC to the OWSEC's REST API endpoint
#READINESS_METHOD: systeminfo
#OWSEC: gw-qa01.cicd.lab.wlan.tip.build:16001
secret_env_variables: secret_env_variables: {}
# NOTE in order for readiness check to use system info method you need to override these values to the real OWSEC credentials
OWSEC_USERNAME: tip@ucentral.com
OWSEC_PASSWORD: openwifi
configProperties: configProperties:
# -> Public part # -> Public part
# REST API # REST API
openwifi.restapi.host.0.backlog: 100 ucentralfws.restapi.host.0.backlog: 100
openwifi.restapi.host.0.security: relaxed ucentralfws.restapi.host.0.security: relaxed
openwifi.restapi.host.0.rootca: $OWFMS_ROOT/certs/restapi-ca.pem ucentralfws.restapi.host.0.rootca: $UCENTRALFMS_ROOT/certs/restapi-ca.pem
openwifi.restapi.host.0.address: "*" ucentralfws.restapi.host.0.address: "*"
openwifi.restapi.host.0.port: 16004 ucentralfws.restapi.host.0.port: 16004
openwifi.restapi.host.0.cert: $OWFMS_ROOT/certs/restapi-cert.pem ucentralfws.restapi.host.0.cert: $UCENTRALFMS_ROOT/certs/restapi-cert.pem
openwifi.restapi.host.0.key: $OWFMS_ROOT/certs/restapi-key.pem ucentralfws.restapi.host.0.key: $UCENTRALFMS_ROOT/certs/restapi-key.pem
openwifi.internal.restapi.host.0.backlog: 100 ucentral.internal.restapi.host.0.backlog: 100
openwifi.internal.restapi.host.0.security: relaxed ucentral.internal.restapi.host.0.security: relaxed
openwifi.internal.restapi.host.0.rootca: $OWFMS_ROOT/certs/restapi-ca.pem ucentral.internal.restapi.host.0.rootca: $UCENTRALFMS_ROOT/certs/restapi-ca.pem
openwifi.internal.restapi.host.0.address: "*" ucentral.internal.restapi.host.0.address: "*"
openwifi.internal.restapi.host.0.port: 17004 ucentral.internal.restapi.host.0.port: 17004
openwifi.internal.restapi.host.0.cert: $OWFMS_ROOT/certs/restapi-cert.pem ucentral.internal.restapi.host.0.cert: $UCENTRALFMS_ROOT/certs/restapi-cert.pem
openwifi.internal.restapi.host.0.key: $OWFMS_ROOT/certs/restapi-key.pem ucentral.internal.restapi.host.0.key: $UCENTRALFMS_ROOT/certs/restapi-key.pem
# Firmware Microservice Specific Section # Firmware Microservice Specific Section
s3.endpointOverride: ""
s3.useVirtualAdressing: true
s3.endpoint.https: true
s3.bucketname: ucentral-ap-firmware s3.bucketname: ucentral-ap-firmware
s3.region: us-east-1 s3.region: us-east-1
s3.retry: 60 s3.retry: 60
s3.bucket.uri: ucentral-ap-firmware.s3.amazonaws.com s3.bucket.uri: ucentral-ap-firmware.s3.amazonaws.com
firmwaredb.refresh: 86400 firmwaredb.refresh: 1800
# ALB # ALB
alb.enable: "true" alb.enable: "true"
alb.port: 16104 alb.port: 16104
# Kafka # Kafka
openwifi.kafka.enable: "false" ucentral.kafka.enable: "false"
openwifi.kafka.group.id: firmware ucentral.kafka.group.id: firmware
openwifi.kafka.client.id: firmware1 ucentral.kafka.client.id: firmware1
openwifi.kafka.brokerlist: localhost:9092 ucentral.kafka.brokerlist: localhost:9092
openwifi.kafka.auto.commit: false ucentral.kafka.auto.commit: false
openwifi.kafka.queue.buffering.max.ms: 50 ucentral.kafka.queue.buffering.max.ms: 50
openwifi.kafka.ssl.ca.location: ""
openwifi.kafka.ssl.certificate.location: ""
openwifi.kafka.ssl.key.location: ""
openwifi.kafka.ssl.key.password: ""
# Storage # Storage
storage.type: sqlite # (sqlite|postgresql|mysql|odbc) storage.type: sqlite # (sqlite|postgresql|mysql|odbc)
## SQLite ## SQLite
@@ -175,33 +149,46 @@ configProperties:
storage.type.postgresql.maxsessions: 64 storage.type.postgresql.maxsessions: 64
storage.type.postgresql.idletime: 60 storage.type.postgresql.idletime: 60
storage.type.postgresql.host: localhost storage.type.postgresql.host: localhost
storage.type.postgresql.database: owfms storage.type.postgresql.database: ucentral
storage.type.postgresql.port: 5432 storage.type.postgresql.port: 5432
storage.type.postgresql.connectiontimeout: 60 storage.type.postgresql.connectiontimeout: 60
## MySQL ## MySQL
storage.type.mysql.maxsessions: 64 storage.type.mysql.maxsessions: 64
storage.type.mysql.idletime: 60 storage.type.mysql.idletime: 60
storage.type.mysql.host: localhost storage.type.mysql.host: localhost
storage.type.mysql.database: owfms storage.type.mysql.database: ucentral
storage.type.mysql.port: 3306 storage.type.mysql.port: 3306
storage.type.mysql.connectiontimeout: 60 storage.type.mysql.connectiontimeout: 60
# System # System
openwifi.service.key: $OWFMS_ROOT/certs/restapi-key.pem ucentral.service.key: $UCENTRALFMS_ROOT/certs/restapi-key.pem
openwifi.system.data: $OWFMS_ROOT/persist ucentral.system.data: $UCENTRALFMS_ROOT/persist
openwifi.system.debug: "true" ucentral.system.debug: "true"
openwifi.system.uri.private: https://localhost:17004 ucentral.system.uri.private: https://localhost:17004
openwifi.system.uri.public: https://localhost:16004 ucentral.system.uri.public: https://localhost:16004
openwifi.system.uri.ui: https://localhost ucentral.system.uri.ui: https://localhost
openwifi.system.commandchannel: /tmp/app_owfms ucentral.system.commandchannel: /tmp/app_ucentralfms
# Logging # Logging
logging.type: console logging.formatters.f1.class: PatternFormatter
logging.path: $OWFMS_ROOT/logs logging.formatters.f1.pattern: "%Y-%m-%d %H:%M:%S %s: [%p] %t"
logging.level: debug logging.formatters.f1.times: UTC
logging.channels.c1.class: ConsoleChannel
logging.channels.c1.formatter: f1
logging.channels.c2.class: FileChannel
logging.channels.c2.path: /tmp/log_ucentralfms
logging.channels.c2.formatter.class: PatternFormatter
logging.channels.c2.formatter.pattern: "%Y-%m-%d %H:%M:%S %s: [%p] %t"
logging.channels.c2.rotation: "20 M"
logging.channels.c2.archive: timestamp
logging.channels.c2.purgeCount: 20
logging.channels.c3.class: ConsoleChannel
logging.channels.c3.pattern: "%s: [%p] %t"
logging.loggers.root.channel: c1
logging.loggers.root.level: debug
# -> Secret part # -> Secret part
# REST API # REST API
openwifi.restapi.host.0.key.password: mypassword ucentral.restapi.host.0.key.password: mypassword
openwifi.internal.restapi.host.0.key.password: mypassword ucentral.internal.restapi.host.0.key.password: mypassword
# Firmware Microservice Specific Section # Firmware Microservice Specific Section
s3.secret: TOFILL s3.secret: TOFILL
s3.key: TOFILL s3.key: TOFILL
@@ -213,9 +200,6 @@ configProperties:
storage.type.mysql.username: stephb storage.type.mysql.username: stephb
storage.type.mysql.password: snoopy99 storage.type.mysql.password: snoopy99
# NOTE: List of required certificates may be found in "certs" key. Alternative way to pass required certificates is to create external secret with all required certificates and set secret name in "existingCertsSecret" key. Details may be found in https://github.com/Telecominfraproject/wlan-cloud-ucentral-deploy/tree/main/chart#tldr
existingCertsSecret: ""
certs: certs:
# restapi-ca.pem: "" # restapi-ca.pem: ""
# restapi-cert.pem: "" # restapi-cert.pem: ""

Binary file not shown.

Before

Width:  |  Height:  |  Size: 104 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 80 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 80 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 75 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 75 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 218 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 158 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 140 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 121 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 44 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 192 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 197 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 50 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 59 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 59 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 51 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 72 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 72 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 34 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 98 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 89 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 89 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 204 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 159 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 159 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 103 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 103 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 103 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 59 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 80 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 80 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 4.8 KiB

View File

@@ -1,165 +0,0 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- Generator: Adobe Illustrator 24.2.3, SVG Export Plug-In . SVG Version: 6.00 Build 0) -->
<svg version="1.1" id="Layer_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
viewBox="0 0 141.5 185.6" style="enable-background:new 0 0 141.5 185.6;" xml:space="preserve">
<style type="text/css">
.st0{fill:#414141;}
.st1{fill:#FFFFFF;}
.st2{fill:#FED206;}
.st3{fill:#EB6F53;}
.st4{fill:#3BA9B6;}
</style>
<g>
<g>
<path class="st0" d="M120.7,183.9H21.5c-10.8,0-19.5-8.7-19.5-19.5V20.5c0-10.8,8.7-19.5,19.5-19.5h99.2
c10.8,0,19.5,8.7,19.5,19.5v143.9C140.2,175.2,131.5,183.9,120.7,183.9z"/>
<g>
<g>
<g>
<path class="st1" d="M46.3,166.2v-3.4h-1.2v-0.6h3.1v0.6H47v3.4H46.3z"/>
</g>
<g>
<path class="st1" d="M49,166.2v-4h2.7v0.6h-2v1h2v0.6h-2v1.1h2v0.6H49z"/>
</g>
<g>
<path class="st1" d="M52.6,166.2v-4h0.7v3.4h1.8v0.6H52.6z"/>
</g>
<g>
<path class="st1" d="M55.7,166.2v-4h2.7v0.6h-2v1h2v0.6h-2v1.1h2v0.6H55.7z"/>
</g>
<g>
<path class="st1" d="M59.1,164.2c0-1.2,0.9-2.1,2.1-2.1c0.8,0,1.3,0.4,1.6,0.9l-0.6,0.3c-0.2-0.3-0.6-0.6-1-0.6
c-0.8,0-1.4,0.6-1.4,1.4c0,0.8,0.6,1.4,1.4,1.4c0.4,0,0.8-0.3,1-0.6l0.6,0.3c-0.3,0.5-0.8,0.9-1.6,0.9
C60,166.3,59.1,165.5,59.1,164.2z"/>
</g>
<g>
<path class="st1" d="M63.2,164.2c0-1.2,0.8-2.1,2-2.1c1.2,0,2,0.9,2,2.1c0,1.2-0.8,2.1-2,2.1C64,166.3,63.2,165.4,63.2,164.2z
M66.5,164.2c0-0.8-0.5-1.4-1.3-1.4c-0.8,0-1.3,0.6-1.3,1.4c0,0.8,0.5,1.4,1.3,1.4C66,165.7,66.5,165,66.5,164.2z"/>
</g>
<g>
<path class="st1" d="M71.3,166.2v-3.1l-1.2,3.1h-0.3l-1.2-3.1v3.1h-0.7v-4h1l1.1,2.7l1.1-2.7h1v4H71.3z"/>
</g>
<g>
<path class="st1" d="M75.7,166.2v-4h0.7v4H75.7z"/>
</g>
<g>
<path class="st1" d="M80.4,166.2l-2.1-2.8v2.8h-0.7v-4h0.7l2,2.8v-2.8h0.7v4H80.4z"/>
</g>
<g>
<path class="st1" d="M82.3,166.2v-4H85v0.6h-2v1h2v0.6h-2v1.7H82.3z"/>
</g>
<g>
<path class="st1" d="M87.9,166.2l-0.9-1.5h-0.7v1.5h-0.7v-4h1.7c0.8,0,1.3,0.5,1.3,1.2c0,0.7-0.5,1.1-0.9,1.2l1,1.6H87.9z
M88,163.5c0-0.4-0.3-0.6-0.7-0.6h-1v1.3h1C87.7,164.1,88,163.9,88,163.5z"/>
</g>
<g>
<path class="st1" d="M92.4,166.2l-0.3-0.8h-1.8l-0.3,0.8h-0.8l1.6-4h0.9l1.6,4H92.4z M91.2,162.9l-0.7,1.9h1.4L91.2,162.9z"/>
</g>
<g>
<path class="st1" d="M95.8,166.2v-4h1.5c0.8,0,1.2,0.5,1.2,1.2c0,0.6-0.4,1.2-1.2,1.2h-1.2v1.7H95.8z M98.2,163.4
c0-0.5-0.3-0.9-0.9-0.9h-1.1v1.7h1.1C97.8,164.3,98.2,163.9,98.2,163.4z"/>
</g>
<g>
<path class="st1" d="M101.5,166.2l-1.1-1.6h-0.9v1.6h-0.3v-4h1.5c0.7,0,1.2,0.4,1.2,1.2c0,0.7-0.5,1.1-1.1,1.1l1.2,1.7H101.5z
M101.6,163.4c0-0.5-0.4-0.9-0.9-0.9h-1.1v1.7h1.1C101.2,164.3,101.6,163.9,101.6,163.4z"/>
</g>
<g>
<path class="st1" d="M102.8,164.2c0-1.2,0.8-2.1,1.9-2.1c1.2,0,1.9,0.9,1.9,2.1c0,1.2-0.8,2.1-1.9,2.1
C103.6,166.3,102.8,165.4,102.8,164.2z M106.3,164.2c0-1-0.6-1.7-1.6-1.7c-1,0-1.6,0.7-1.6,1.7c0,1,0.6,1.7,1.6,1.7
C105.7,166,106.3,165.2,106.3,164.2z"/>
</g>
<g>
<path class="st1" d="M106.9,165.8l0.2-0.3c0.2,0.2,0.4,0.4,0.8,0.4c0.5,0,0.9-0.4,0.9-0.9v-2.8h0.3v2.8c0,0.8-0.5,1.2-1.2,1.2
C107.5,166.3,107.2,166.1,106.9,165.8z"/>
</g>
<g>
<path class="st1" d="M110.4,166.2v-4h2.5v0.3h-2.2v1.5h2.1v0.3h-2.1v1.6h2.2v0.3H110.4z"/>
</g>
<g>
<path class="st1" d="M113.5,164.2c0-1.2,0.9-2.1,2-2.1c0.6,0,1.1,0.3,1.5,0.7l-0.3,0.2c-0.3-0.3-0.7-0.6-1.2-0.6
c-0.9,0-1.7,0.7-1.7,1.7c0,1,0.7,1.7,1.7,1.7c0.5,0,0.9-0.2,1.2-0.6l0.3,0.2c-0.4,0.4-0.8,0.7-1.5,0.7
C114.4,166.3,113.5,165.5,113.5,164.2z"/>
</g>
<g>
<path class="st1" d="M118.7,166.2v-3.7h-1.3v-0.3h2.9v0.3H119v3.7H118.7z"/>
</g>
</g>
<g>
<polygon class="st1" points="26.3,163.8 31.6,158.5 36.9,163.8 37.7,163.8 31.6,157.6 25.5,163.8 "/>
<polygon class="st1" points="36.9,164.7 31.6,170 26.3,164.7 25.5,164.7 31.6,170.8 37.7,164.7 "/>
<polygon class="st1" points="31,163.8 36.3,158.5 41.6,163.8 42.5,163.8 36.3,157.6 30.2,163.8 "/>
<polygon class="st1" points="41.6,164.7 36.3,170 31,164.7 30.2,164.7 36.3,170.8 42.5,164.7 "/>
</g>
</g>
<g>
<path class="st1" d="M33.2,100.7c-4.6,0-8.3,3.7-8.3,8.3s3.7,8.3,8.3,8.3s8.3-3.7,8.3-8.3S37.8,100.7,33.2,100.7z"/>
</g>
<g>
<g>
<g>
<path class="st2" d="M33.2,35.2c40.7,0,73.8,33.1,73.8,73.8c0,0.7,0,1.4,0,2.1c0,1.7,0.6,3.3,1.7,4.6c1.2,1.2,2.8,1.9,4.5,2
l0.2,0c3.5,0,6.3-2.7,6.4-6.2c0-0.8,0-1.7,0-2.5c0-47.7-38.8-86.6-86.6-86.6c-0.8,0-1.7,0-2.5,0c-1.7,0-3.3,0.8-4.5,2
c-1.2,1.2-1.8,2.9-1.7,4.6c0.1,3.5,3,6.3,6.6,6.2C31.8,35.2,32.5,35.2,33.2,35.2z"/>
</g>
</g>
</g>
<g>
<g>
<g>
<path class="st3" d="M33.2,60.5c26.7,0,48.5,21.7,48.5,48.5c0,0.6,0,1.3,0,2c-0.1,1.7,0.5,3.3,1.7,4.6c1.2,1.3,2.7,2,4.4,2.1
c1.7,0.1,3.3-0.5,4.6-1.7c1.2-1.2,2-2.7,2-4.4c0-0.9,0.1-1.8,0.1-2.6c0-33.8-27.5-61.2-61.2-61.2c-0.8,0-1.6,0-2.6,0.1
c-1.7,0.1-3.3,0.8-4.4,2.1c-1.2,1.3-1.8,2.9-1.7,4.6s0.8,3.3,2.1,4.4c1.3,1.2,2.9,1.8,4.6,1.7C31.9,60.5,32.6,60.5,33.2,60.5z"
/>
</g>
</g>
</g>
<g>
<g>
<g>
<path class="st4" d="M33.2,86.7c12.3,0,22.3,10,22.3,22.3c0,0.5,0,1.1-0.1,1.8c-0.3,3.5,2.3,6.6,5.8,6.9
c3.5,0.3,6.6-2.3,6.9-5.8c0.1-1,0.1-1.9,0.1-2.8c0-19.3-15.7-35.1-35.1-35.1c-0.9,0-1.8,0-2.8,0.1c-1.7,0.1-3.2,0.9-4.3,2.2
c-1.1,1.3-1.6,2.9-1.5,4.6c0.1,1.7,0.9,3.2,2.2,4.3c1.3,1.1,2.9,1.6,4.6,1.5C32.1,86.7,32.7,86.7,33.2,86.7z"/>
</g>
</g>
</g>
</g>
<g>
<path class="st1" d="M35.8,130.4c1.1,0.6,2.1,1.5,2.7,2.6c0.7,1.1,1,2.3,1,3.7s-0.3,2.6-1,3.7c-0.7,1.1-1.6,2-2.7,2.6
c-1.1,0.6-2.4,1-3.8,1s-2.7-0.3-3.8-1c-1.1-0.6-2.1-1.5-2.7-2.6c-0.7-1.1-1-2.3-1-3.7c0-1.3,0.3-2.6,1-3.7c0.7-1.1,1.6-2,2.7-2.6
c1.1-0.6,2.4-0.9,3.8-0.9C33.4,129.5,34.7,129.8,35.8,130.4z M29.9,132.9c-0.7,0.4-1.2,0.9-1.6,1.6s-0.6,1.4-0.6,2.2
c0,0.8,0.2,1.6,0.6,2.3c0.4,0.7,0.9,1.2,1.6,1.6c0.7,0.4,1.4,0.6,2.1,0.6c0.8,0,1.5-0.2,2.1-0.6c0.6-0.4,1.2-0.9,1.5-1.6
c0.4-0.7,0.6-1.4,0.6-2.3c0-0.8-0.2-1.6-0.6-2.2s-0.9-1.2-1.5-1.6c-0.6-0.4-1.4-0.6-2.1-0.6C31.3,132.3,30.6,132.5,29.9,132.9z"/>
<path class="st1" d="M50.6,133.6c0.8,0.5,1.4,1.1,1.8,2c0.4,0.8,0.6,1.8,0.6,2.9c0,1.1-0.2,2-0.6,2.8c-0.4,0.8-1,1.5-1.8,1.9
c-0.8,0.5-1.6,0.7-2.6,0.7c-0.7,0-1.4-0.1-2-0.4s-1.1-0.7-1.5-1.2v5.4h-3.1V133h3.1v1.6c0.4-0.5,0.9-1,1.4-1.2s1.2-0.4,2-0.4
C48.9,132.9,49.8,133.1,50.6,133.6z M49.1,140.5c0.5-0.6,0.7-1.3,0.7-2.2c0-0.9-0.2-1.6-0.7-2.1c-0.5-0.6-1.1-0.8-1.9-0.8
s-1.4,0.3-1.9,0.8c-0.5,0.6-0.8,1.3-0.8,2.1c0,0.9,0.2,1.6,0.8,2.2s1.1,0.8,1.9,0.8S48.6,141,49.1,140.5z"/>
<path class="st1" d="M63.4,134.4c0.9,1,1.4,2.4,1.4,4.2c0,0.3,0,0.6,0,0.7H57c0.2,0.7,0.5,1.2,1,1.6c0.5,0.4,1.1,0.6,1.8,0.6
c0.5,0,1-0.1,1.5-0.3s0.9-0.5,1.3-0.9l1.6,1.6c-0.5,0.6-1.2,1.1-2,1.4c-0.8,0.3-1.6,0.5-2.6,0.5c-1.1,0-2.1-0.2-3-0.7
s-1.5-1.1-2-1.9c-0.5-0.8-0.7-1.8-0.7-2.9c0-1.1,0.2-2.1,0.7-2.9s1.1-1.5,2-1.9c0.8-0.5,1.8-0.7,2.9-0.7
C61.2,132.9,62.5,133.4,63.4,134.4z M61.8,137.5c0-0.7-0.3-1.3-0.7-1.7s-1-0.6-1.7-0.6c-0.7,0-1.2,0.2-1.7,0.6
c-0.4,0.4-0.7,1-0.9,1.7H61.8z"/>
<path class="st1" d="M76.2,134c0.7,0.7,1.1,1.7,1.1,3v6.8h-3.1v-5.9c0-0.7-0.2-1.2-0.6-1.6s-0.9-0.6-1.5-0.6
c-0.8,0-1.4,0.3-1.8,0.8c-0.4,0.5-0.7,1.2-0.7,2v5.3h-3.1V133h3.1v1.9c0.7-1.3,2-2,3.7-2C74.6,132.8,75.5,133.2,76.2,134z"/>
<path class="st1" d="M96,129.7h3.3l-4.7,14h-3.3l-2.9-10.1l-3,10.1h-3.2l-4.7-14h3.4l3,10.7l3-10.7H90l3.1,10.7L96,129.7z"/>
<path class="st1" d="M103.3,128.7c0.3,0.3,0.5,0.7,0.5,1.2s-0.2,0.9-0.5,1.2c-0.3,0.3-0.7,0.5-1.2,0.5c-0.5,0-0.9-0.2-1.2-0.5
c-0.3-0.3-0.5-0.7-0.5-1.2c0-0.5,0.2-0.9,0.5-1.2c0.3-0.3,0.7-0.5,1.2-0.5C102.6,128.2,103,128.3,103.3,128.7z M100.6,133h3.1
v10.8h-3.1V133z"/>
<path class="st1" d="M106.5,129.7h10.1l0,2.6h-6.9v3.4h6.3v2.6h-6.3v5.3h-3.2V129.7z"/>
<path class="st1" d="M120.9,128.7c0.3,0.3,0.5,0.7,0.5,1.2s-0.2,0.9-0.5,1.2c-0.3,0.3-0.7,0.5-1.2,0.5c-0.5,0-0.9-0.2-1.2-0.5
c-0.3-0.3-0.5-0.7-0.5-1.2c0-0.5,0.2-0.9,0.5-1.2c0.3-0.3,0.7-0.5,1.2-0.5C120.1,128.2,120.5,128.3,120.9,128.7z M118.1,133h3.1
v10.8h-3.1V133z"/>
</g>
</g>
<g>
</g>
<g>
</g>
<g>
</g>
<g>
</g>
<g>
</g>
<g>
</g>
</svg>

Before

Width:  |  Height:  |  Size: 8.0 KiB

View File

@@ -2,7 +2,7 @@ openapi: 3.0.1
info: info:
title: uCentral Firmware Service API title: uCentral Firmware Service API
description: A process to manage new uCentral firmware distribution. description: A process to manage new uCentral firmware distribution.
version: 2.5.0 version: 2.0.0
license: license:
name: BSD3 name: BSD3
url: https://github.com/Telecominfraproject/wlan-cloud-ucentralgw/blob/master/LICENSE url: https://github.com/Telecominfraproject/wlan-cloud-ucentralgw/blob/master/LICENSE
@@ -30,13 +30,43 @@ components:
responses: responses:
NotFound: NotFound:
$ref: 'https://github.com/Telecominfraproject/wlan-cloud-ucentralsec/blob/main/openpapi/owsec.yaml#/components/responses/NotFound' description: The specified resource was not found.
content:
application/json:
schema:
properties:
ErrorCode:
type: integer
ErrorDetails:
type: string
ErrorDescription:
type: string
Unauthorized: Unauthorized:
$ref: 'https://github.com/Telecominfraproject/wlan-cloud-ucentralsec/blob/main/openpapi/owsec.yaml#/components/responses/Unauthorized' description: The requested does not have sufficient rights to perform the operation.
content:
application/json:
schema:
properties:
ErrorCode:
type: integer
ErrorDetails:
type: string
ErrorDescription:
type: string
Success: Success:
$ref: 'https://github.com/Telecominfraproject/wlan-cloud-ucentralsec/blob/main/openpapi/owsec.yaml#/components/responses/Success' description: The requested operation was performed.
BadRequest: content:
$ref: 'https://github.com/Telecominfraproject/wlan-cloud-ucentralsec/blob/main/openpapi/owsec.yaml#/components/responses/BadRequest' application/json:
schema:
properties:
Operation:
type: string
Details:
type: string
Code:
type: integer
schemas: schemas:
FirmwareDetails: FirmwareDetails:
@@ -95,25 +125,6 @@ components:
items: items:
$ref: '#/components/schemas/FirmwareDetails' $ref: '#/components/schemas/FirmwareDetails'
DeviceCurrentInfo:
type: object
properties:
serialNumber:
type: string
revision:
type: string
upgraded:
type: integer
format: int64
DeviceCurrentInfoList:
type: object
properties:
devices:
type: array
items:
$ref: '#/components/schemas/DeviceCurrentInfo'
RevisionHistoryEntry: RevisionHistoryEntry:
type: object type: object
properties: properties:
@@ -231,37 +242,6 @@ components:
totalSecondsOld: totalSecondsOld:
$ref: '#/components/schemas/TagIntPairList' $ref: '#/components/schemas/TagIntPairList'
DeviceInformation:
type: object
properties:
serialNumber:
type: string
history:
$ref: '#/components/schemas/RevisionHistoryEntryList'
currentFirmware:
type: string
currentFirmwareDate:
type: integer
format: int64
latestFirmware:
type: string
latestFirmwareDate:
type: integer
format: int64
latestFirmwareAvailable:
type: boolean
ExtraSystemConfiguration:
type: array
items:
type: object
properties:
parameterName:
type: string
parameterValue:
type: string
######################################################################################### #########################################################################################
## ##
## These are endpoints that all services in the uCentral stack must provide ## These are endpoints that all services in the uCentral stack must provide
@@ -314,6 +294,28 @@ components:
items: items:
$ref: '#/components/schemas/TagIntPair' $ref: '#/components/schemas/TagIntPair'
SystemCommandDetails:
type: object
properties:
command:
type: string
enum:
- setloglevels
- getloglevels
- getSubSystemNames
- getLogLevelNames
- stats
parameters:
oneOf:
- $ref: '#/components/schemas/StringList'
- $ref: '#/components/schemas/TagValuePairList'
SystemCommandResults:
type: object
oneOf:
- $ref: '#/components/schemas/StringList'
- $ref: '#/components/schemas/TagValuePairList'
NoteInfo: NoteInfo:
type: object type: object
properties: properties:
@@ -325,139 +327,12 @@ components:
note: note:
type: string type: string
SystemInfoResults:
type: object
properties:
version:
type: string
uptime:
type: integer
format: integer64
start:
type: integer
format: integer64
os:
type: string
processors:
type: integer
hostname:
type: string
certificates:
type: array
items:
type: object
properties:
filename:
type: string
expires:
type: integer
format: int64
SystemResources:
type: object
properties:
numberOfFileDescriptors:
type: integer
format: int64
currRealMem:
type: integer
format: int64
peakRealMem:
type: integer
format: int64
currVirtMem:
type: integer
format: int64
peakVirtMem:
type: integer
format: int64
SystemCommandResults:
type: object
oneOf:
- $ref: '#/components/schemas/SystemResources'
- $ref: '#/components/schemas/SystemInfoResults'
- $ref: '#/components/schemas/StringList'
- $ref: '#/components/schemas/TagValuePairList'
SystemCommandSetLogLevel:
type: object
properties:
command:
type: string
enum:
- setloglevel
subsystems:
type: array
items:
$ref: '#/components/schemas/TagValuePair'
SystemCommandReload:
type: object
properties:
command:
type: string
enum:
- reload
subsystems:
type: array
items:
type: string
example: these are the SubSystems names retrieve with the GetSubSystemsNamesResult.
SystemCommandGetLogLevels:
type: object
properties:
command:
type: string
enum:
- getloglevels
SystemGetLogLevelsResult:
type: object
properties:
taglist:
type: array
items:
$ref: '#/components/schemas/TagValuePair'
SystemCommandGetLogLevelNames:
type: object
properties:
command:
type: string
enum:
- getloglevelnames
SystemCommandGetSubsystemNames:
type: object
properties:
command:
type: string
enum:
- getsubsystemnames
SystemCommandGetLogLevelNamesResult:
type: object
properties:
list:
type: array
items:
type: string
SystemGetSubSystemNemesResult:
type: object
properties:
taglist:
type: array
items:
$ref: '#/components/schemas/TagValuePair'
######################################################################################### #########################################################################################
## ##
## End of uCentral system-wide values ## End of uCentral system wide values
## ##
######################################################################################### #########################################################################################
paths: paths:
/firmwares: /firmwares:
get: get:
@@ -487,10 +362,9 @@ paths:
required: false required: false
- in: query - in: query
name: latestOnly name: latestOnly
description: Return only the latest firmware description: Return only the latest firwares
schema: schema:
type: boolean type: boolean
default: false
required: false required: false
- in: query - in: query
name: deviceType name: deviceType
@@ -501,61 +375,19 @@ paths:
name: revisionSet name: revisionSet
schema: schema:
type: boolean type: boolean
default: false
required: false required: false
- in: query - in: query
name: deviceSet name: deviceSet
schema: schema:
type: boolean type: boolean
required: false required: false
- in: query
name: rcOnly
schema:
type: boolean
default: false
required: false
- in: query
name: updateTimeOnly
schema:
type: boolean
required: false
responses: responses:
200: 200:
description: List firmwares description: List firmwares
content: content:
application/json: application/json:
schema: schema:
oneOf: $ref: '#/components/schemas/FirmwareDetailsList'
- type: object
properties:
lastUpdateTime:
type: integer
format: int64
- $ref: '#/components/schemas/FirmwareDetailsList'
- $ref: '#/components/schemas/FirmwareDetails'
403:
$ref: '#/components/responses/Unauthorized'
404:
$ref: '#/components/responses/NotFound'
put:
tags:
- Firmware
summary: Force a DB refresh.
description: Force a DB refresh.
operationId: updateFirmwareList
parameters:
- in: query
description: Force the firmware DB update
name: update
schema:
type: boolean
required: false
responses:
200:
$ref: '#/components/responses/Success'
400:
$ref: '#/components/responses/BadRequest'
403: 403:
$ref: '#/components/responses/Unauthorized' $ref: '#/components/responses/Unauthorized'
404: 404:
@@ -702,31 +534,13 @@ paths:
schema: schema:
type: string type: string
required: false required: false
- in: query
description: Return current device list and current firmware
name: currentList
schema:
type: boolean
default: false
required: false
example: You must set {serialNumber} to 000000000000
- in: query
description: Return current device list and current firmware
name: unknownList
schema:
type: boolean
default: false
required: false
example: You must set {serialNumber} to 000000000000
responses: responses:
200: 200:
description: List of device history upgrade. description: List of device history upgrade.
content: content:
application/json: application/json:
schema: schema:
oneOf: $ref: '#/components/schemas/RevisionHistoryEntryList'
- $ref: '#/components/schemas/RevisionHistoryEntryList'
- $ref: '#/components/schemas/DeviceCurrentInfoList'
403: 403:
$ref: '#/components/responses/Unauthorized' $ref: '#/components/responses/Unauthorized'
404: 404:
@@ -770,19 +584,19 @@ paths:
operationId: getFirmwareAge operationId: getFirmwareAge
parameters: parameters:
- in: query - in: query
description: The exact current version of the firmware on that device. description: The exact current verion of the firmware on that device.
name: revision name: revision
schema: schema:
type: string type: string
required: true required: true
- in: query - in: query
description: The exact current version of the firmware on that device. description: The exact current verion of the firmware on that device.
name: deviceType name: deviceType
schema: schema:
type: string type: string
required: true required: true
- in: query - in: query
description: Specify list of serial numbers to retrieve age for description: Specify lits of serial numbers to retrive age for
name: select name: select
schema: schema:
type: string type: string
@@ -881,28 +695,6 @@ paths:
404: 404:
$ref: '#/components/responses/NotFound' $ref: '#/components/responses/NotFound'
/deviceInformation/{serialNumber}:
get:
tags:
- Device Information
summary: receive a repor on a single decide
parameters:
- in: path
name: serialNumber
schema:
type: string
example:
aabbccdd1234
required: true
responses:
200:
$ref: '#/components/schemas/DeviceInformation'
403:
$ref: '#/components/responses/Unauthorized'
404:
$ref: '#/components/responses/NotFound'
######################################################################################### #########################################################################################
## ##
## These are endpoints that all services in the uCentral stack must provide ## These are endpoints that all services in the uCentral stack must provide
@@ -912,29 +704,21 @@ paths:
post: post:
tags: tags:
- System Commands - System Commands
summary: Perform some system wide commands summary: Perform some systeme wide commands
operationId: systemCommand operationId: systemCommand
requestBody: requestBody:
description: Command details description: Command details
content: content:
application/json: application/json:
schema: schema:
oneOf: $ref: '#/components/schemas/SystemCommandDetails'
- $ref: '#/components/schemas/SystemCommandSetLogLevel'
- $ref: '#/components/schemas/SystemCommandReload'
- $ref: '#/components/schemas/SystemCommandGetLogLevels'
- $ref: '#/components/schemas/SystemCommandGetLogLevelNames'
- $ref: '#/components/schemas/SystemCommandGetSubsystemNames'
responses: responses:
200: 200:
description: Successfull command execution description: Successfull command execution
content: content:
application/json: application/json:
schema: schema:
oneOf: $ref: '#/components/schemas/SystemCommandResults'
- $ref: '#/components/schemas/SystemGetLogLevelsResult'
- $ref: '#/components/schemas/SystemCommandGetLogLevelNamesResult'
- $ref: '#/components/schemas/SystemGetSubSystemNemesResult'
403: 403:
$ref: '#/components/responses/Unauthorized' $ref: '#/components/responses/Unauthorized'
404: 404:
@@ -951,76 +735,17 @@ paths:
schema: schema:
type: string type: string
enum: enum:
- info - version
- extraConfiguration - times
- resources
required: true required: true
responses:
200:
$ref: '#/components/schemas/SystemCommandResults'
403:
$ref: '#/components/responses/Unauthorized'
404:
$ref: '#/components/responses/NotFound'
/systemConfiguration:
get:
tags:
- SystemConfiguration
summary: Retrieve system configuration items
operationId: getSystemConfiguration
parameters:
- in: query
description: Which parameters you want to retrieve
name: entries
schema:
type: string
example:
- element1
- element1,element2,element3
required: false
responses: responses:
200: 200:
description: List of configuration elements description: Successfull command execution
content: content:
application/json: application/json:
schema: schema:
type: array $ref: '#/components/schemas/TagValuePair'
items:
$ref: '#/components/schemas/ExtraSystemConfiguration'
403:
$ref: '#/components/responses/Unauthorized'
404:
$ref: '#/components/responses/NotFound'
put:
tags:
- SystemConfiguration
summary: Set some or all system configuration
operationId: setSystemConfiguration
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ExtraSystemConfiguration'
responses:
200:
$ref: '#/components/schemas/ExtraSystemConfiguration'
403:
$ref: '#/components/responses/Unauthorized'
404:
$ref: '#/components/responses/NotFound'
delete:
tags:
- SystemConfiguration
summary: Delete all additional system configuration
operationId: deleteSystemConfiguration
responses:
200:
$ref: '#/components/responses/Success'
403: 403:
$ref: '#/components/responses/Unauthorized' $ref: '#/components/responses/Unauthorized'
404: 404:

View File

@@ -1 +0,0 @@
set(VCPKG_POLICY_EMPTY_PACKAGE enabled)

View File

@@ -1,4 +0,0 @@
{
"name": "curl",
"version-string": "7.74.0-1.3+deb11u3"
}

View File

@@ -1 +0,0 @@
set(VCPKG_POLICY_EMPTY_PACKAGE enabled)

View File

@@ -1,4 +0,0 @@
{
"name": "openssl",
"version-string": "1.1.1n-0+deb11u3"
}

View File

@@ -1 +0,0 @@
set(VCPKG_POLICY_EMPTY_PACKAGE enabled)

View File

@@ -1,4 +0,0 @@
{
"name": "zlib",
"version-string": "1:1.2.11.dfsg-2+deb11u2"
}

View File

@@ -1,124 +0,0 @@
#
# uCentral protocol server for devices. This is where you point
# all your devices. You can replace the * for address by the specific
# address of one of your interfaces
#
#
# REST API access
#
openwifi.restapi.host.0.backlog = 100
openwifi.restapi.host.0.security = relaxed
openwifi.restapi.host.0.rootca = $OWFMS_ROOT/certs/restapi-ca.pem
openwifi.restapi.host.0.address = *
openwifi.restapi.host.0.port = 16004
openwifi.restapi.host.0.cert = $OWFMS_ROOT/certs/restapi-cert.pem
openwifi.restapi.host.0.key = $OWFMS_ROOT/certs/restapi-key.pem
openwifi.restapi.host.0.key.password = mypassword
openwifi.internal.restapi.host.0.backlog = 100
openwifi.internal.restapi.host.0.security = relaxed
openwifi.internal.restapi.host.0.rootca = $OWFMS_ROOT/certs/restapi-ca.pem
openwifi.internal.restapi.host.0.address = *
openwifi.internal.restapi.host.0.port = 17004
openwifi.internal.restapi.host.0.cert = $OWFMS_ROOT/certs/restapi-cert.pem
openwifi.internal.restapi.host.0.key = $OWFMS_ROOT/certs/restapi-key.pem
openwifi.internal.restapi.host.0.key.password = mypassword
#
# Generic section that all microservices must have
#
openwifi.service.key = $OWFMS_ROOT/certs/restapi-key.pem
openwifi.service.key.password = mypassword
openwifi.system.data = $OWFMS_ROOT/data
openwifi.system.debug = false
openwifi.system.uri.private = https://localhost:17004
openwifi.system.uri.public = https://ucentral.dpaas.arilia.com:16004
openwifi.system.commandchannel = /tmp/app.owfms
openwifi.system.uri.ui = ucentral-ui.arilia.com
openwifi.security.restapi.disable = false
firmwaredb.refresh = 1800
firmwaredb.maxage = 90
#
# Firmware Microservice Specific Section
#
s3.useVirtualAdressing = true
s3.endpoint.https = true
s3.bucketname = ucentral-ap-firmware
s3.region = us-east-1
s3.secret = *******************************************
s3.key = *******************************************
s3.retry = 60
s3.bucket.uri = ucentral-ap-firmware.s3.amazonaws.com
autoupdater.enabled = true
#############################
# Generic information for all micro services
#############################
#
# NLB Support
#
alb.enable = true
alb.port = 16104
#
# Kafka
#
openwifi.kafka.group.id = firmware
openwifi.kafka.client.id = firmware1
openwifi.kafka.enable = true
openwifi.kafka.brokerlist = a1.arilia.com:9092
openwifi.kafka.auto.commit = false
openwifi.kafka.queue.buffering.max.ms = 50
openwifi.kafka.ssl.ca.location =
openwifi.kafka.ssl.certificate.location =
openwifi.kafka.ssl.key.location =
openwifi.kafka.ssl.key.password =
#
# This section select which form of persistence you need
# Only one selected at a time. If you select multiple, this service will die if a horrible
# death and might make your beer flat.
#
storage.type = sqlite
#storage.type = postgresql
#storage.type = mysql
#storage.type = odbc
storage.type.sqlite.db = firmware.db
storage.type.sqlite.idletime = 120
storage.type.sqlite.maxsessions = 128
storage.type.postgresql.maxsessions = 64
storage.type.postgresql.idletime = 60
storage.type.postgresql.host = localhost
storage.type.postgresql.username = stephb
storage.type.postgresql.password = snoopy99
storage.type.postgresql.database = ucentral
storage.type.postgresql.port = 5432
storage.type.postgresql.connectiontimeout = 60
storage.type.mysql.maxsessions = 64
storage.type.mysql.idletime = 60
storage.type.mysql.host = localhost
storage.type.mysql.username = stephb
storage.type.mysql.password = snoopy99
storage.type.mysql.database = ucentral
storage.type.mysql.port = 3306
storage.type.mysql.connectiontimeout = 60
########################################################################
########################################################################
#
# Logging: please leave as is for now.
#
########################################################################
logging.type = file
logging.path = $OWFMS_ROOT/logs
logging.level = debug

View File

@@ -1,118 +0,0 @@
#
# uCentral protocol server for devices. This is where you point
# all your devices. You can replace the * for address by the specific
# address of one of your interfaces
#
#
# REST API access
#
openwifi.restapi.host.0.backlog = 100
openwifi.restapi.host.0.security = relaxed
openwifi.restapi.host.0.rootca = ${RESTAPI_HOST_ROOTCA}
openwifi.restapi.host.0.address = *
openwifi.restapi.host.0.port = ${RESTAPI_HOST_PORT}
openwifi.restapi.host.0.cert = ${RESTAPI_HOST_CERT}
openwifi.restapi.host.0.key = ${RESTAPI_HOST_KEY}
openwifi.restapi.host.0.key.password = ${RESTAPI_HOST_KEY_PASSWORD}
openwifi.internal.restapi.host.0.backlog = 100
openwifi.internal.restapi.host.0.security = relaxed
openwifi.internal.restapi.host.0.rootca = ${INTERNAL_RESTAPI_HOST_ROOTCA}
openwifi.internal.restapi.host.0.address = *
openwifi.internal.restapi.host.0.port = ${INTERNAL_RESTAPI_HOST_PORT}
openwifi.internal.restapi.host.0.cert = ${INTERNAL_RESTAPI_HOST_CERT}
openwifi.internal.restapi.host.0.key = ${INTERNAL_RESTAPI_HOST_KEY}
openwifi.internal.restapi.host.0.key.password = ${INTERNAL_RESTAPI_HOST_KEY_PASSWORD}
#
# Generic section that all microservices must have
#
openwifi.service.key = ${SERVICE_KEY}
openwifi.service.key.password = ${SERVICE_KEY_PASSWORD}
openwifi.system.data = ${SYSTEM_DATA}
openwifi.system.debug = false
openwifi.system.uri.private = ${SYSTEM_URI_PRIVATE}
openwifi.system.uri.public = ${SYSTEM_URI_PUBLIC}
openwifi.system.commandchannel = /tmp/app.ucentralfms
openwifi.system.uri.ui = ${SYSTEM_URI_UI}
openwifi.security.restapi.disable = ${SECURITY_RESTAPI_DISABLE}
firmwaredb.refresh = ${FIRMWAREDB_REFRESH}
firmwaredb.maxage = ${FIRMWAREDB_MAXAGE}
#
# Firmware Microservice Specific Section
#
s3.useVirtualAdressing = ${S3_VIRTUAL_ADRESSING}
s3.endpointOverride = ${S3_ENDPOINT}
s3.endpoint.https = ${S3_HTTPS}
s3.bucketname = ${S3_BUCKETNAME}
s3.region = ${S3_REGION}
s3.secret = ${S3_SECRET}
s3.key = ${S3_KEY}
s3.retry = 60
s3.bucket.uri = ${S3_BUCKET_URI}
#############################
# Generic information for all micro services
#############################
#
# NLB Support
#
alb.enable = true
alb.port = 16104
#
# Kafka
#
openwifi.kafka.group.id = firmware
openwifi.kafka.client.id = firmware1
openwifi.kafka.enable = ${KAFKA_ENABLE}
openwifi.kafka.brokerlist = ${KAFKA_BROKERLIST}
openwifi.kafka.auto.commit = false
openwifi.kafka.queue.buffering.max.ms = 50
openwifi.kafka.ssl.ca.location = ${KAFKA_SSL_CA_LOCATION}
openwifi.kafka.ssl.certificate.location = ${KAFKA_SSL_CERTIFICATE_LOCATION}
openwifi.kafka.ssl.key.location = ${KAFKA_SSL_KEY_LOCATION}
openwifi.kafka.ssl.key.password = ${KAFKA_SSL_KEY_PASSWORD}
#
# This section select which form of persistence you need
# Only one selected at a time. If you select multiple, this service will die if a horrible
# death and might make your beer flat.
#
storage.type = ${STORAGE_TYPE}
storage.type.sqlite.db = firmware.db
storage.type.sqlite.idletime = 120
storage.type.sqlite.maxsessions = 128
storage.type.postgresql.maxsessions = 64
storage.type.postgresql.idletime = 60
storage.type.postgresql.host = ${STORAGE_TYPE_POSTGRESQL_HOST}
storage.type.postgresql.username = ${STORAGE_TYPE_POSTGRESQL_USERNAME}
storage.type.postgresql.password = ${STORAGE_TYPE_POSTGRESQL_PASSWORD}
storage.type.postgresql.database = ${STORAGE_TYPE_POSTGRESQL_DATABASE}
storage.type.postgresql.port = ${STORAGE_TYPE_POSTGRESQL_PORT}
storage.type.postgresql.connectiontimeout = 60
storage.type.mysql.maxsessions = 64
storage.type.mysql.idletime = 60
storage.type.mysql.host = ${STORAGE_TYPE_MYSQL_HOST}
storage.type.mysql.username = ${STORAGE_TYPE_MYSQL_USERNAME}
storage.type.mysql.password = ${STORAGE_TYPE_MYSQL_PASSWORD}
storage.type.mysql.database = ${STORAGE_TYPE_MYSQL_DATABASE}
storage.type.mysql.port = ${STORAGE_TYPE_MYSQL_PORT}
storage.type.mysql.connectiontimeout = 60
########################################################################
########################################################################
#
# Logging: please leave as is for now.
#
########################################################################
logging.type = console
logging.path = $OWFMS_ROOT/logs
logging.level = debug

View File

@@ -1,65 +0,0 @@
#!/bin/bash
set -e
if [[ "$(which jq)" == "" ]]
then
echo "You need the package jq installed to use this script."
exit 1
fi
if [[ "$(which curl)" == "" ]]
then
echo "You need the package curl installed to use this script."
exit 1
fi
if [[ "${READINESS_METHOD}" == "systeminfo" ]]
then
if [[ "${OWSEC}" == "" ]]
then
echo "You must set the variable OWSEC in order to use this script. Something like"
echo "OWSEC=security.isp.com:16001"
exit 1
fi
if [[ "${OWSEC_USERNAME}" == "" ]]
then
echo "You must set the variable OWSEC_USERNAME in order to use this script. Something like"
echo "OWSEC_USERNAME=tip@ucentral.com"
exit 1
fi
if [[ "${OWSEC_PASSWORD}" == "" ]]
then
echo "You must set the variable OWSEC_PASSWORD in order to use this script. Something like"
echo "OWSEC_PASSWORD=openwifi"
exit 1
fi
# Get OAuth token from OWSEC and cache it or use cached one
payload="{ \"userId\" : \"$OWSEC_USERNAME\" , \"password\" : \"$OWSEC_PASSWORD\" }"
if [[ -f "/tmp/token" ]]
then
token=$(cat /tmp/token)
else
token=$(curl ${FLAGS} -X POST -H "Content-Type: application/json" -d "$payload" "https://${OWSEC}/api/v1/oauth2" | jq -r '.access_token')
fi
if [[ "${token}" == "" ]]
then
echo "Could not login. Please verify the host and username/password."
exit 13
fi
echo -n $token > /tmp/token
# Make systeminfo request to the local owfms instance
export RESTAPI_PORT=$(grep 'openwifi.restapi.host.0.port' $OWFMS_CONFIG/owfms.properties | awk -F '=' '{print $2}' | xargs | envsubst)
curl ${FLAGS} -k -X GET "https://localhost:$RESTAPI_PORT/api/v1/system?command=info" \
-H "accept: application/json" \
-H "Authorization: Bearer ${token}" > /tmp/result.json
exit_code=$?
jq < /tmp/result.json
exit $exit_code
else
export ALB_PORT=$(grep 'alb.port' $OWFMS_CONFIG/owfms.properties | awk -F '=' '{print $2}' | xargs | envsubst)
curl localhost:$ALB_PORT
fi

View File

@@ -1,4 +1,4 @@
#!/bin/bash #!/bin/bash
export OWFMS_CONFIG=`pwd` export UCENTRALFMS_CONFIG=`pwd`
export OWFMS_ROOT=`pwd` export UCENTRALFMS_ROOT=`pwd`

114
src/ALBHealthCheckServer.h Normal file
View File

@@ -0,0 +1,114 @@
//
// Created by stephane bourque on 2021-06-04.
//
#ifndef UCENTRALGW_ALBHEALTHCHECKSERVER_H
#define UCENTRALGW_ALBHEALTHCHECKSERVER_H
#include <memory>
#include <iostream>
#include <fstream>
#include <sstream>
#include "Poco/Thread.h"
#include "Poco/Net/HTTPServer.h"
#include "Poco/Net/HTTPServerRequest.h"
#include "Poco/Net/HTTPServerResponse.h"
#include "Poco/Net/HTTPRequestHandler.h"
#include "Poco/Logger.h"
#include "Daemon.h"
#include "SubSystemServer.h"
namespace OpenWifi {
class ALBRequestHandler: public Poco::Net::HTTPRequestHandler
/// Return a HTML document with the current date and time.
{
public:
ALBRequestHandler(Poco::Logger & L)
: Logger_(L)
{
}
void handleRequest(Poco::Net::HTTPServerRequest& Request, Poco::Net::HTTPServerResponse& Response)
{
Logger_.information(Poco::format("ALB-REQUEST(%s): New ALB request.",Request.clientAddress().toString()));
Response.setChunkedTransferEncoding(true);
Response.setContentType("text/html");
Response.setDate(Poco::Timestamp());
Response.setStatus(Poco::Net::HTTPResponse::HTTP_OK);
Response.setKeepAlive(true);
Response.set("Connection","keep-alive");
Response.setVersion(Poco::Net::HTTPMessage::HTTP_1_1);
std::ostream &Answer = Response.send();
Answer << "uCentralGW Alive and kicking!" ;
}
private:
Poco::Logger & Logger_;
};
class ALBRequestHandlerFactory: public Poco::Net::HTTPRequestHandlerFactory
{
public:
explicit ALBRequestHandlerFactory(Poco::Logger & L):
Logger_(L)
{
}
ALBRequestHandler* createRequestHandler(const Poco::Net::HTTPServerRequest& request) override
{
if (request.getURI() == "/")
return new ALBRequestHandler(Logger_);
else
return nullptr;
}
private:
Poco::Logger &Logger_;
};
class ALBHealthCheckServer : public SubSystemServer {
public:
ALBHealthCheckServer() noexcept:
SubSystemServer("ALBHealthCheckServer", "ALB-SVR", "alb")
{
}
static ALBHealthCheckServer *instance() {
if (instance_ == nullptr) {
instance_ = new ALBHealthCheckServer;
}
return instance_;
}
int Start() {
if(Daemon()->ConfigGetBool("alb.enable",false)) {
Port_ = (int)Daemon()->ConfigGetInt("alb.port",15015);
Socket_ = std::make_unique<Poco::Net::ServerSocket>(Port_);
auto Params = new Poco::Net::HTTPServerParams;
Server_ = std::make_unique<Poco::Net::HTTPServer>(new ALBRequestHandlerFactory(Logger_), *Socket_, Params);
Server_->start();
}
return 0;
}
void Stop() {
if(Server_)
Server_->stop();
}
private:
static ALBHealthCheckServer *instance_;
std::unique_ptr<Poco::Net::HTTPServer> Server_;
std::unique_ptr<Poco::Net::ServerSocket> Socket_;
int Port_ = 0;
};
inline ALBHealthCheckServer * ALBHealthCheckServer() { return ALBHealthCheckServer::instance(); }
inline class ALBHealthCheckServer * ALBHealthCheckServer::instance_ = nullptr;
}
#endif // UCENTRALGW_ALBHEALTHCHECKSERVER_H

88
src/AuthClient.cpp Normal file
View File

@@ -0,0 +1,88 @@
//
// Created by stephane bourque on 2021-06-30.
//
#include <utility>
#include "AuthClient.h"
#include "RESTAPI_SecurityObjects.h"
#include "Daemon.h"
#include "OpenAPIRequest.h"
namespace OpenWifi {
class AuthClient * AuthClient::instance_ = nullptr;
int AuthClient::Start() {
return 0;
}
void AuthClient::Stop() {
}
void AuthClient::RemovedCachedToken(const std::string &Token) {
SubMutexGuard G(Mutex_);
UserCache_.erase(Token);
}
bool IsTokenExpired(const SecurityObjects::WebToken &T) {
return ((T.expires_in_+T.created_)<std::time(nullptr));
}
bool AuthClient::IsAuthorized(Poco::Net::HTTPServerRequest & Request, std::string &SessionToken, SecurityObjects::UserInfoAndPolicy & UInfo ) {
SubMutexGuard G(Mutex_);
auto User = UserCache_.find(SessionToken);
if(User != UserCache_.end() && !IsTokenExpired(User->second.webtoken)) {
UInfo = User->second;
return true;
} else {
Types::StringPairVec QueryData;
QueryData.push_back(std::make_pair("token",SessionToken));
OpenAPIRequestGet Req( uSERVICE_SECURITY,
"/api/v1/validateToken",
QueryData,
5000);
Poco::JSON::Object::Ptr Response;
if(Req.Do(Response)==Poco::Net::HTTPResponse::HTTP_OK) {
if(Response->has("tokenInfo") && Response->has("userInfo")) {
SecurityObjects::UserInfoAndPolicy P;
P.from_json(Response);
UserCache_[SessionToken] = P;
UInfo = P;
}
return true;
}
}
return false;
}
bool AuthClient::IsTokenAuthorized(const std::string &SessionToken, SecurityObjects::UserInfoAndPolicy & UInfo) {
SubMutexGuard G(Mutex_);
auto User = UserCache_.find(SessionToken);
if(User != UserCache_.end() && !IsTokenExpired(User->second.webtoken)) {
UInfo = User->second;
return true;
} else {
Types::StringPairVec QueryData;
QueryData.push_back(std::make_pair("token",SessionToken));
OpenAPIRequestGet Req(uSERVICE_SECURITY,
"/api/v1/validateToken",
QueryData,
5000);
Poco::JSON::Object::Ptr Response;
if(Req.Do(Response)==Poco::Net::HTTPResponse::HTTP_OK) {
if(Response->has("tokenInfo") && Response->has("userInfo")) {
SecurityObjects::UserInfoAndPolicy P;
P.from_json(Response);
UserCache_[SessionToken] = P;
UInfo = P;
}
return true;
}
}
return false;
}
}

45
src/AuthClient.h Normal file
View File

@@ -0,0 +1,45 @@
//
// Created by stephane bourque on 2021-06-30.
//
#ifndef UCENTRALGW_AUTHCLIENT_H
#define UCENTRALGW_AUTHCLIENT_H
#include "Poco/JSON/Object.h"
#include "Poco/Net/HTTPServerRequest.h"
#include "Poco/Net/HTTPServerResponse.h"
#include "Poco/JWT/Signer.h"
#include "Poco/SHA2Engine.h"
#include "RESTAPI_SecurityObjects.h"
#include "SubSystemServer.h"
namespace OpenWifi {
class AuthClient : public SubSystemServer {
public:
explicit AuthClient() noexcept:
SubSystemServer("Authentication", "AUTH-CLNT", "authentication")
{
}
static AuthClient *instance() {
if (instance_ == nullptr) {
instance_ = new AuthClient;
}
return instance_;
}
int Start() override;
void Stop() override;
bool IsAuthorized(Poco::Net::HTTPServerRequest & Request, std::string &SessionToken, OpenWifi::SecurityObjects::UserInfoAndPolicy & UInfo );
void RemovedCachedToken(const std::string &Token);
bool IsTokenAuthorized(const std::string &Token, SecurityObjects::UserInfoAndPolicy & UInfo);
private:
static AuthClient *instance_;
OpenWifi::SecurityObjects::UserInfoCache UserCache_;
};
inline AuthClient * AuthClient() { return AuthClient::instance(); }
}
#endif // UCENTRALGW_AUTHCLIENT_H

View File

@@ -1,129 +0,0 @@
//
// Created by stephane bourque on 2021-10-04.
//
#include "AutoUpdater.h"
#include "LatestFirmwareCache.h"
#include "SDK/GW_SDK.h"
#include "SDK/Prov_SDK.h"
#include "StorageService.h"
#include "framework/MicroServiceFuncs.h"
#include "framework/utils.h"
#include "fmt/format.h"
namespace OpenWifi {
int AutoUpdater::Start() {
poco_information(Logger(), "Starting...");
AutoUpdaterEnabled_ = MicroServiceConfigGetBool("autoupdater.enabled", false);
if (AutoUpdaterEnabled_) {
Running_ = false;
AutoUpdaterFrequency_ = MicroServiceConfigGetInt("autoupdater.frequency", 600);
AutoUpdaterCallBack_ =
std::make_unique<Poco::TimerCallback<AutoUpdater>>(*this, &AutoUpdater::onTimer);
Timer_.setStartInterval(5 * 60 * 1000); // first run in 5 minutes
Timer_.setPeriodicInterval(AutoUpdaterFrequency_ * 1000);
Timer_.start(*AutoUpdaterCallBack_);
}
return 0;
}
void AutoUpdater::Stop() {
poco_information(Logger(), "Stopping...");
Running_ = false;
if (AutoUpdaterEnabled_) {
Timer_.stop();
}
poco_information(Logger(), "Stopped...");
}
void AutoUpdater::ToBeUpgraded(std::string serialNumber, std::string DeviceType) {
if (!AutoUpdaterEnabled_)
return;
std::lock_guard G(Mutex_);
Queue_.emplace_back(std::make_pair(std::move(serialNumber), std::move(DeviceType)));
}
void AutoUpdater::onTimer([[maybe_unused]] Poco::Timer &timer) {
Utils::SetThreadName("auto-updater");
Running_ = true;
std::unique_lock L(Mutex_);
while (!Queue_.empty() && Running_) {
auto Entry = Queue_.front();
Queue_.pop_front();
try {
poco_debug(Logger(), fmt::format("Preparing to upgrade {}", Entry.first));
auto CacheEntry = Cache_.find(Entry.first);
uint64_t now = Utils::Now();
std::string firmwareUpgrade;
if (CacheEntry == Cache_.end() || (CacheEntry->second.LastCheck - now) > 300) {
// get the firmware settings for that device.
SerialCache C;
C.LastCheck = now;
bool firmwareRCOnly;
if (OpenWifi::SDK::Prov::GetFirmwareOptions(Entry.first, firmwareUpgrade,
firmwareRCOnly)) {
poco_debug(Logger(),
fmt::format("Found firmware options for {}", Entry.first));
C.firmwareRCOnly = firmwareRCOnly;
C.firmwareUpgrade = firmwareUpgrade;
} else {
poco_debug(Logger(),
fmt::format("Found no firmware options for {}", Entry.first));
C.firmwareRCOnly = firmwareRCOnly;
C.firmwareUpgrade = firmwareUpgrade;
}
Cache_[Entry.first] = C;
} else {
}
if (firmwareUpgrade == "no") {
poco_information(
Logger(),
fmt::format("Device {} not upgradable. Provisioning service settings.",
Entry.first));
continue;
}
LatestFirmwareCacheEntry fwEntry;
FMSObjects::Firmware fwDetails;
auto LF = LatestFirmwareCache()->FindLatestFirmware(Entry.second, fwEntry);
if (LF) {
if (StorageService()->FirmwaresDB().GetFirmware(fwEntry.Id, fwDetails)) {
// send the command to upgrade this device...
poco_information(Logger(), fmt::format("Upgrading {} to version {}",
Entry.first, fwEntry.Revision));
if (OpenWifi::SDK::GW::SendFirmwareUpgradeCommand(Entry.first,
fwDetails.uri)) {
poco_information(
Logger(), fmt::format("Upgrade command sent for {}", Entry.first));
} else {
poco_information(
Logger(),
fmt::format("Upgrade command not sent for {}", Entry.first));
}
} else {
poco_information(Logger(),
fmt::format("Firmware for device {} ({}) cannot be found.",
Entry.first, Entry.second));
}
} else {
poco_information(Logger(),
fmt::format("Firmware for device {} ({}) cannot be found.",
Entry.first, Entry.second));
}
} catch (...) {
poco_information(
Logger(),
fmt::format("Exception during auto update for device {}.", Entry.first));
}
}
}
void AutoUpdater::reinitialize([[maybe_unused]] Poco::Util::Application &self) {
poco_information(Logger(), "Reinitializing.");
Reset();
}
} // namespace OpenWifi

View File

@@ -1,53 +0,0 @@
//
// Created by stephane bourque on 2021-10-04.
//
#pragma once
#include <deque>
#include "Poco/Timer.h"
#include "Poco/Util/Application.h"
#include "framework/SubSystemServer.h"
namespace OpenWifi {
class AutoUpdater : public SubSystemServer { // };, Poco::Runnable {
public:
struct SerialCache {
uint64_t LastCheck = 0;
std::string firmwareUpgrade;
bool firmwareRCOnly = false;
};
static auto instance() {
static auto instance_ = new AutoUpdater;
return instance_;
}
int Start() override;
void Stop() override;
void ToBeUpgraded(std::string serialNumber, std::string DeviceType);
inline void Reset() {
std::lock_guard G(Mutex_);
Cache_.clear();
Queue_.clear();
}
void reinitialize(Poco::Util::Application &self) final;
void onTimer(Poco::Timer &timer);
private:
std::atomic_bool Running_ = false;
std::map<std::string, SerialCache> Cache_;
std::deque<std::pair<std::string, std::string>> Queue_;
uint64_t AutoUpdaterFrequency_ = 600;
bool AutoUpdaterEnabled_ = true;
Poco::Timer Timer_;
std::unique_ptr<Poco::TimerCallback<AutoUpdater>> AutoUpdaterCallBack_;
explicit AutoUpdater() noexcept
: SubSystemServer("AutoUpdater", "AUTO-UPDATER", "autoupdater") {}
};
inline auto AutoUpdater() { return AutoUpdater::instance(); }
} // namespace OpenWifi

View File

@@ -2,63 +2,74 @@
// Created by Stephane Bourque on 2021-05-07. // Created by Stephane Bourque on 2021-05-07.
// //
#include <aws/core/Aws.h> #include <boost/algorithm/string.hpp>
#include <aws/s3/model/AccessControlPolicy.h>
#include <aws/s3/model/CreateBucketRequest.h> #include <aws/core/Aws.h>
#include <aws/s3/model/GetBucketAclRequest.h> #include <aws/s3/model/CreateBucketRequest.h>
#include <aws/s3/model/PutBucketAclRequest.h> #include <aws/s3/model/PutObjectRequest.h>
#include <aws/s3/model/PutObjectRequest.h> #include <aws/s3/model/AccessControlPolicy.h>
#include <aws/s3/model/PutBucketAclRequest.h>
#include <aws/s3/model/GetBucketAclRequest.h>
#include "Poco/Util/Application.h"
#include "Poco/Net/SSLManager.h"
#include "AutoUpdater.h"
#include "Daemon.h" #include "Daemon.h"
#include "StorageService.h"
#include "RESTAPI_server.h"
#include "RESTAPI_InternalServer.h"
#include "ManifestCreator.h"
#include "KafkaManager.h"
#include "NewConnectionHandler.h"
#include "LatestFirmwareCache.h"
#include "DeviceCache.h" #include "DeviceCache.h"
#include "FirmwareCache.h" #include "FirmwareCache.h"
#include "LatestFirmwareCache.h"
#include "ManifestCreator.h"
#include "NewCommandHandler.h"
#include "NewConnectionHandler.h"
#include "StorageService.h"
#include "framework/UI_WebSocketClientServer.h"
namespace OpenWifi { namespace OpenWifi {
class Daemon *Daemon::instance_ = nullptr; class Daemon *Daemon::instance_ = nullptr;
class Daemon *Daemon::instance() { class Daemon *Daemon::instance() {
if (instance_ == nullptr) { if (instance_ == nullptr) {
instance_ = new Daemon( instance_ = new Daemon(vDAEMON_PROPERTIES_FILENAME,
vDAEMON_PROPERTIES_FILENAME, vDAEMON_ROOT_ENV_VAR, vDAEMON_CONFIG_ENV_VAR, vDAEMON_ROOT_ENV_VAR,
vDAEMON_APP_NAME, vDAEMON_BUS_TIMER, vDAEMON_CONFIG_ENV_VAR,
SubSystemVec{StorageService(), FirmwareCache(), LatestFirmwareCache(), vDAEMON_APP_NAME,
DeviceCache(), NewConnectionHandler(), ManifestCreator(), vDAEMON_BUS_TIMER,
AutoUpdater(), NewCommandHandler(), UI_WebSocketClientServer()}); Types::SubSystemVec{Storage(),
} FirmwareCache(),
return instance_; LatestFirmwareCache(),
} DeviceCache(),
NewConnectionHandler(),
RESTAPI_server(),
RESTAPI_InternalServer(),
ManifestCreator()
});
}
return instance_;
}
void Daemon::PostInitialization([[maybe_unused]] Poco::Util::Application &self) {} void Daemon::initialize(Poco::Util::Application &self) {
MicroService::initialize(*this);
}
void DaemonPostInitialization(Poco::Util::Application &self) { }
Daemon()->PostInitialization(self);
}
} // namespace OpenWifi
int main(int argc, char **argv) { int main(int argc, char **argv) {
SSL_library_init(); SSL_library_init();
Aws::SDKOptions AwsOptions; Aws::SDKOptions AwsOptions;
AwsOptions.memoryManagementOptions.memoryManager = nullptr; AwsOptions.memoryManagementOptions.memoryManager = nullptr;
AwsOptions.cryptoOptions.initAndCleanupOpenSSL = false; AwsOptions.cryptoOptions.initAndCleanupOpenSSL = false;
AwsOptions.httpOptions.initAndCleanupCurl = true; AwsOptions.httpOptions.initAndCleanupCurl = true;
Aws::InitAPI(AwsOptions); Aws::InitAPI(AwsOptions);
int ExitCode = 0; int ExitCode=0;
{ {
auto App = OpenWifi::Daemon::instance(); auto App = OpenWifi::Daemon::instance();
ExitCode = App->run(argc, argv); ExitCode = App->run(argc, argv);
} }
ShutdownAPI(AwsOptions); ShutdownAPI(AwsOptions);
return ExitCode; return ExitCode;
} }

View File

@@ -2,41 +2,54 @@
// Created by stephane bourque on 2021-05-07. // Created by stephane bourque on 2021-05-07.
// //
#include <list>
#ifndef UCENTRALFWS_DAEMON_H #ifndef UCENTRALFWS_DAEMON_H
#define UCENTRALFWS_DAEMON_H #define UCENTRALFWS_DAEMON_H
#include "framework/MicroService.h" #include "Poco/Util/Application.h"
#include "framework/MicroServiceNames.h" #include "Poco/Util/ServerApplication.h"
#include "framework/OpenWifiTypes.h" #include "Poco/ErrorHandler.h"
#include "Poco/UUIDGenerator.h"
#include "Poco/Crypto/RSAKey.h"
#include "Poco/Crypto/CipherFactory.h"
#include "Poco/Crypto/Cipher.h"
#include "MicroService.h"
#include "OpenWifiTypes.h"
#include "RESTAPI_FMSObjects.h"
#include "Dashboard.h" #include "Dashboard.h"
#include "RESTObjects/RESTAPI_FMSObjects.h"
namespace OpenWifi { namespace OpenWifi {
[[maybe_unused]] static const char *vDAEMON_PROPERTIES_FILENAME = "owfms.properties"; static const char * vDAEMON_PROPERTIES_FILENAME = "ucentralfms.properties";
[[maybe_unused]] static const char *vDAEMON_ROOT_ENV_VAR = "OWFMS_ROOT"; static const char * vDAEMON_ROOT_ENV_VAR = "UCENTRALFMS_ROOT";
[[maybe_unused]] static const char *vDAEMON_CONFIG_ENV_VAR = "OWFMS_CONFIG"; static const char * vDAEMON_CONFIG_ENV_VAR = "UCENTRALFMS_CONFIG";
[[maybe_unused]] static const char *vDAEMON_APP_NAME = uSERVICE_FIRMWARE.c_str(); static const char * vDAEMON_APP_NAME = uSERVICE_FIRMWARE.c_str();
[[maybe_unused]] static const uint64_t vDAEMON_BUS_TIMER = 10000; static const uint64_t vDAEMON_BUS_TIMER = 10000;
class Daemon : public MicroService { class Daemon : public MicroService {
public: public:
explicit Daemon(const std::string &PropFile, const std::string &RootEnv, explicit Daemon(std::string PropFile,
const std::string &ConfigEnv, const std::string &AppName, uint64_t BusTimer, std::string RootEnv,
const SubSystemVec &SubSystems) std::string ConfigEnv,
: MicroService(PropFile, RootEnv, ConfigEnv, AppName, BusTimer, SubSystems){}; std::string AppName,
uint64_t BusTimer,
Types::SubSystemVec SubSystems) :
MicroService( PropFile, RootEnv, ConfigEnv, AppName, BusTimer, SubSystems) {};
void PostInitialization(Poco::Util::Application &self); void initialize(Poco::Util::Application &self);
static Daemon *instance(); static Daemon *instance();
inline DeviceDashboard &GetDashboard() { return DB_; } inline void ResetDashboard() { DB_.Reset(); }
inline void CreateDashboard() { DB_.Create(); }
inline const FMSObjects::DeviceReport & GetDashboard() { return DB_.Report(); }
private: private:
static Daemon *instance_; static Daemon *instance_;
DeviceDashboard DB_; DeviceDashboard DB_;
}; };
inline Daemon *Daemon() { return Daemon::instance(); } inline Daemon * Daemon() { return Daemon::instance(); }
} // namespace OpenWifi }
#endif // UCENTRALFWS_DAEMON_H #endif //UCENTRALFWS_DAEMON_H

View File

@@ -4,47 +4,15 @@
#include "Dashboard.h" #include "Dashboard.h"
#include "StorageService.h" #include "StorageService.h"
#include "framework/utils.h"
namespace OpenWifi { namespace OpenWifi {
void DeviceDashboard::Create() {
uint64_t Now = std::time(nullptr);
bool DeviceDashboard::Get(FMSObjects::DeviceReport &D, Poco::Logger &Logger) { if(LastRun_==0 || (Now-LastRun_)>120) {
uint64_t Now = Utils::Now(); DB_.reset();
if (!ValidDashboard_ || LastRun_ == 0 || (Now - LastRun_) > 120) { Storage()->GenerateDeviceReport(DB_);
Generate(D, Logger); LastRun_ = Now;
} else {
std::lock_guard G(DataMutex_);
D = DB_;
}
return ValidDashboard_;
};
void DeviceDashboard::Generate(FMSObjects::DeviceReport &D, Poco::Logger &Logger) {
if (GeneratingDashboard_.load()) {
// std::cout << "Trying to generate dashboard but already being generated" << std::endl;
while (GeneratingDashboard_.load()) {
Poco::Thread::trySleep(100);
}
std::lock_guard G(DataMutex_);
D = DB_;
} else {
GeneratingDashboard_ = true;
ValidDashboard_ = false;
try {
// std::cout << "Generating dashboard." << std::endl;
poco_information(Logger, "DASHBOARD: Generating a new dashboard.");
FMSObjects::DeviceReport NewData;
StorageService()->DevicesDB().GenerateDeviceReport(NewData);
LastRun_ = Utils::Now();
NewData.snapshot = LastRun_;
D = NewData;
std::lock_guard G(DataMutex_);
DB_ = NewData;
ValidDashboard_ = true;
} catch (...) {
}
GeneratingDashboard_ = false;
} }
} }
}
} // namespace OpenWifi

View File

@@ -2,26 +2,22 @@
// Created by stephane bourque on 2021-07-21. // Created by stephane bourque on 2021-07-21.
// //
#pragma once #ifndef UCENTRALGW_DASHBOARD_H
#define UCENTRALGW_DASHBOARD_H
#include <mutex> #include "OpenWifiTypes.h"
#include "RESTAPI_FMSObjects.h"
#include "Poco/Logger.h"
#include "RESTObjects/RESTAPI_FMSObjects.h"
#include "framework/OpenWifiTypes.h"
namespace OpenWifi { namespace OpenWifi {
class DeviceDashboard { class DeviceDashboard {
public: public:
bool Get(FMSObjects::DeviceReport &D, Poco::Logger &Logger); void Create();
const FMSObjects::DeviceReport & Report() const { return DB_;}
inline void Reset() { LastRun_=0; DB_.reset(); }
private: private:
std::mutex DataMutex_; FMSObjects::DeviceReport DB_;
volatile std::atomic_bool GeneratingDashboard_ = false; uint64_t LastRun_=0;
volatile bool ValidDashboard_ = false;
FMSObjects::DeviceReport DB_;
uint64_t LastRun_ = 0;
void Generate(FMSObjects::DeviceReport &D, Poco::Logger &Logger);
}; };
} // namespace OpenWifi }
#endif // UCENTRALGW_DASHBOARD_H

View File

@@ -5,40 +5,44 @@
#include "DeviceCache.h" #include "DeviceCache.h"
namespace OpenWifi { namespace OpenWifi {
class DeviceCache *DeviceCache::instance_ = nullptr;
int DeviceCache::Start() { int DeviceCache::Start() {
poco_information(Logger(), "Starting..."); return 0;
return 0; }
}
void DeviceCache::Stop() { void DeviceCache::Stop() {
poco_information(Logger(), "Stopping..."); }
poco_information(Logger(), "Stopped...");
}
void DeviceCache::AddToCache(const std::string &SerialNumber, const std::string &DeviceType, void DeviceCache::AddToCache(
const std::string &Host, const std::string &Revision) { const std::string &SerialNumber, const std::string & DeviceType,
std::lock_guard G(Mutex_); const std::string &Host, const std::string &Revision) {
auto Device = DeviceCache_.find(SerialNumber); SubMutexGuard G(Mutex_);
auto Device = DeviceCache_.find(SerialNumber);
if (Device == DeviceCache_.end()) { if(Device==DeviceCache_.end()) {
DeviceCache_[SerialNumber] = DeviceCache_[SerialNumber]=DeviceCacheEntry{
DeviceCacheEntry{.deviceType = DeviceType, .host = Host, .revision = Revision}; .deviceType=DeviceType,
} else { .host=Host,
Device->second.revision = Revision; .revision=Revision};
Device->second.host = Host; } else {
Device->second.deviceType = DeviceType; Device->second.revision=Revision;
} Device->second.host=Host;
} Device->second.deviceType=DeviceType;
}
}
bool DeviceCache::GetDevice(const std::string &SerialNumber, DeviceCacheEntry &E) { bool DeviceCache::GetDevice(const std::string &SerialNumber, DeviceCacheEntry & E) {
std::lock_guard G(Mutex_); SubMutexGuard G(Mutex_);
auto Device = DeviceCache_.find(SerialNumber); auto Device = DeviceCache_.find(SerialNumber);
if (Device == DeviceCache_.end()) if(Device==DeviceCache_.end())
return false; return false;
E = Device->second; E=Device->second;
return true; return true;
} }
void DeviceCache::DumpCache() {}
} // namespace OpenWifi void DeviceCache::DumpCache() {
}
}

View File

@@ -2,40 +2,51 @@
// Created by stephane bourque on 2021-07-13. // Created by stephane bourque on 2021-07-13.
// //
#pragma once #ifndef UCENTRALFMS_DEVICECACHE_H
#define UCENTRALFMS_DEVICECACHE_H
#include "framework/SubSystemServer.h"
#include <string> #include <string>
#include "SubSystemServer.h"
#include "OpenWifiTypes.h"
namespace OpenWifi { namespace OpenWifi {
struct DeviceCacheEntry { struct DeviceCacheEntry {
std::string deviceType; std::string deviceType;
std::string host; std::string host;
std::string revision; std::string revision;
}; };
typedef std::map<std::string, DeviceCacheEntry> DeviceCacheMap; typedef std::map<std::string, DeviceCacheEntry> DeviceCacheMap;
class DeviceCache : public SubSystemServer { class DeviceCache : public SubSystemServer {
public: public:
static auto instance() { static DeviceCache *instance() {
static auto instance_ = new DeviceCache; if (instance_ == nullptr) {
return instance_; instance_ = new DeviceCache;
} }
return instance_;
}
int Start() override; int Start() override;
void Stop() override; void Stop() override;
void AddToCache(const std::string &serialNumber, const std::string &DeviceType, void AddToCache(const std::string &serialNumber, const std::string & DeviceType,
const std::string &Host, const std::string &Revision); const std::string &Host, const std::string &Revision);
void DumpCache(); void DumpCache();
bool GetDevice(const std::string &SerialNumber, DeviceCacheEntry &E); bool GetDevice(const std::string &SerialNumber, DeviceCacheEntry & E);
private: private:
std::atomic_bool Running_ = false; static DeviceCache *instance_;
DeviceCacheMap DeviceCache_; std::atomic_bool Running_=false;
explicit DeviceCache() noexcept DeviceCacheMap DeviceCache_;
: SubSystemServer("DeviceCache", "DEVICE-CACHE", "devicecache") {} explicit DeviceCache() noexcept:
}; SubSystemServer("DeviceCache", "DEVICE-CACHE", "devicecache")
{
}
};
inline auto DeviceCache() { return DeviceCache::instance(); } inline DeviceCache * DeviceCache() { return DeviceCache::instance(); }
} // namespace OpenWifi }
#endif //UCENTRALFMS_DEVICECACHE_H

View File

@@ -5,26 +5,22 @@
#include "FirmwareCache.h" #include "FirmwareCache.h"
namespace OpenWifi { namespace OpenWifi {
class FirmwareCache *FirmwareCache::instance_ = nullptr;
int FirmwareCache::Start() { int FirmwareCache::Start() {
poco_information(Logger(), "Starting..."); return 0;
return 0; }
}
void FirmwareCache::Stop() { void FirmwareCache::Stop() {
poco_information(Logger(), "Stopping...");
poco_information(Logger(), "Stopped...");
}
std::shared_ptr<FMSObjects::Firmware> }
GetFirmware([[maybe_unused]] const std::string &DeviceType,
[[maybe_unused]] const std::string &Revision) {
return nullptr;
}
std::shared_ptr<FMSObjects::Firmware> std::shared_ptr<FMSObjects::Firmware> GetFirmware(const std::string & DeviceType, const std::string & Revision) {
AddFirmware([[maybe_unused]] const FMSObjects::Firmware &F) { return nullptr;
return nullptr; }
}
} // namespace OpenWifi std::shared_ptr<FMSObjects::Firmware> AddFirmware(const FMSObjects::Firmware &F) {
return nullptr;
}
}

View File

@@ -2,39 +2,48 @@
// Created by stephane bourque on 2021-07-26. // Created by stephane bourque on 2021-07-26.
// //
#pragma once #ifndef UCENTRALFMS_FIRMWARECACHE_H
#define UCENTRALFMS_FIRMWARECACHE_H
#include <map> #include <map>
#include <memory> #include <memory>
#include "RESTObjects/RESTAPI_FMSObjects.h" #include "RESTAPI_FMSObjects.h"
#include "framework/SubSystemServer.h" #include "SubSystemServer.h"
namespace OpenWifi { namespace OpenWifi {
typedef std::map<std::string, std::shared_ptr<FMSObjects::Firmware>> FirmwareCacheMap; typedef std::map<std::string,std::shared_ptr<FMSObjects::Firmware>> FirmwareCacheMap;
class FirmwareCache : public SubSystemServer { class FirmwareCache: public SubSystemServer {
public: public:
static auto instance() { static FirmwareCache *instance() {
static auto instance_ = new FirmwareCache; if (instance_ == nullptr) {
return instance_; instance_ = new FirmwareCache;
} }
return instance_;
}
int Start() override; int Start() override;
void Stop() override; void Stop() override;
std::shared_ptr<FMSObjects::Firmware> GetFirmware(const std::string &DeviceType, std::shared_ptr<FMSObjects::Firmware> GetFirmware(const std::string & DeviceType, const std::string & Revision);
const std::string &Revision); std::shared_ptr<FMSObjects::Firmware> AddFirmware(const FMSObjects::Firmware &F);
std::shared_ptr<FMSObjects::Firmware> AddFirmware(const FMSObjects::Firmware &F);
private:
std::atomic_bool Running_ = false;
FirmwareCacheMap Cache_;
explicit FirmwareCache() noexcept
: SubSystemServer("FirmwareCache", "FIRMWARE-CACHE", "firmwarecache") {}
};
inline auto FirmwareCache() { return FirmwareCache::instance(); } private:
static FirmwareCache *instance_;
std::atomic_bool Running_=false;
FirmwareCacheMap Cache_;
explicit FirmwareCache() noexcept:
SubSystemServer("FirmwareCache", "FIRMWARE-CACHE", "firmwarecache")
{
}
};
} // namespace OpenWifi inline FirmwareCache * FirmwareCache() { return FirmwareCache::instance(); }
}
#endif //UCENTRALFMS_FIRMWARECACHE_H

221
src/KafkaManager.cpp Normal file
View File

@@ -0,0 +1,221 @@
//
// License type: BSD 3-Clause License
// License copy: https://github.com/Telecominfraproject/wlan-cloud-ucentralgw/blob/master/LICENSE
//
// Created by Stephane Bourque on 2021-03-04.
// Arilia Wireless Inc.
//
#include <thread>
#include "KafkaManager.h"
#include "Daemon.h"
#include "Utils.h"
namespace OpenWifi {
class KafkaManager *KafkaManager::instance_ = nullptr;
KafkaManager::KafkaManager() noexcept:
SubSystemServer("KafkaManager", "KAFKA-SVR", "ucentral.kafka")
{
}
void KafkaManager::initialize(Poco::Util::Application & self) {
SubSystemServer::initialize(self);
KafkaEnabled_ = Daemon()->ConfigGetBool("ucentral.kafka.enable",false);
}
#ifdef SMALL_BUILD
int KafkaManager::Start() {
return 0;
}
void KafkaManager::Stop() {
}
#else
int KafkaManager::Start() {
if(!KafkaEnabled_)
return 0;
ProducerThr_ = std::make_unique<std::thread>([this]() { this->ProducerThr(); });
ConsumerThr_ = std::make_unique<std::thread>([this]() { this->ConsumerThr(); });
return 0;
}
void KafkaManager::Stop() {
if(KafkaEnabled_) {
ProducerRunning_ = ConsumerRunning_ = false;
ProducerThr_->join();
ConsumerThr_->join();
return;
}
}
void KafkaManager::ProducerThr() {
cppkafka::Configuration Config({
{ "client.id", Daemon()->ConfigGetString("ucentral.kafka.client.id") },
{ "metadata.broker.list", Daemon()->ConfigGetString("ucentral.kafka.brokerlist") }
});
SystemInfoWrapper_ = R"lit({ "system" : { "id" : )lit" +
std::to_string(Daemon()->ID()) +
R"lit( , "host" : ")lit" + Daemon()->PrivateEndPoint() +
R"lit(" } , "payload" : )lit" ;
cppkafka::Producer Producer(Config);
ProducerRunning_ = true;
while(ProducerRunning_) {
std::this_thread::sleep_for(std::chrono::milliseconds(200));
try
{
SubMutexGuard G(ProducerMutex_);
auto Num=0;
while (!Queue_.empty()) {
const auto M = Queue_.front();
Producer.produce(
cppkafka::MessageBuilder(M.Topic).key(M.Key).payload(M.PayLoad));
Queue_.pop();
Num++;
}
if(Num)
Producer.flush();
} catch (const cppkafka::HandleException &E ) {
Logger_.warning(Poco::format("Caught a Kafka exception (producer): %s",std::string{E.what()}));
} catch (const Poco::Exception &E) {
Logger_.log(E);
}
}
}
void KafkaManager::PartitionAssignment(const cppkafka::TopicPartitionList& partitions) {
Logger_.information(Poco::format("Partition assigned: %Lu...",(uint64_t )partitions.front().get_partition()));
}
void KafkaManager::PartitionRevocation(const cppkafka::TopicPartitionList& partitions) {
Logger_.information(Poco::format("Partition revocation: %Lu...",(uint64_t )partitions.front().get_partition()));
}
void KafkaManager::ConsumerThr() {
cppkafka::Configuration Config({
{ "client.id", Daemon()->ConfigGetString("ucentral.kafka.client.id") },
{ "metadata.broker.list", Daemon()->ConfigGetString("ucentral.kafka.brokerlist") },
{ "group.id", Daemon()->ConfigGetString("ucentral.kafka.group.id") },
{ "enable.auto.commit", Daemon()->ConfigGetBool("ucentral.kafka.auto.commit",false) },
{ "auto.offset.reset", "latest" } ,
{ "enable.partition.eof", false }
});
cppkafka::TopicConfiguration topic_config = {
{ "auto.offset.reset", "smallest" }
};
// Now configure it to be the default topic config
Config.set_default_topic_configuration(topic_config);
cppkafka::Consumer Consumer(Config);
Consumer.set_assignment_callback([this](cppkafka::TopicPartitionList& partitions) {
if(!partitions.empty()) {
Logger_.information(Poco::format("Partition assigned: %Lu...",
(uint64_t)partitions.front().get_partition()));
}
});
Consumer.set_revocation_callback([this](const cppkafka::TopicPartitionList& partitions) {
if(!partitions.empty()) {
Logger_.information(Poco::format("Partition revocation: %Lu...",
(uint64_t)partitions.front().get_partition()));
}
});
bool AutoCommit = Daemon()->ConfigGetBool("ucentral.kafka.auto.commit",false);
auto BatchSize = Daemon()->ConfigGetInt("ucentral.kafka.consumer.batchsize",20);
Types::StringVec Topics;
for(const auto &i:Notifiers_)
Topics.push_back(i.first);
Consumer.subscribe(Topics);
ConsumerRunning_ = true;
while(ConsumerRunning_) {
try {
std::vector<cppkafka::Message> MsgVec = Consumer.poll_batch(BatchSize, std::chrono::milliseconds(200));
for(auto const &Msg:MsgVec) {
if (!Msg)
continue;
if (Msg.get_error()) {
if (!Msg.is_eof()) {
Logger_.error(Poco::format("Error: %s", Msg.get_error().to_string()));
}if(!AutoCommit)
Consumer.async_commit(Msg);
continue;
}
SubMutexGuard G(ConsumerMutex_);
auto It = Notifiers_.find(Msg.get_topic());
if (It != Notifiers_.end()) {
Types::TopicNotifyFunctionList &FL = It->second;
std::string Key{Msg.get_key()};
std::string Payload{Msg.get_payload()};
for (auto &F : FL) {
std::thread T(F.first, Key, Payload);
T.detach();
}
}
if (!AutoCommit)
Consumer.async_commit(Msg);
}
} catch (const cppkafka::HandleException &E) {
Logger_.warning(Poco::format("Caught a Kafka exception (consumer): %s",std::string{E.what()}));
} catch (const Poco::Exception &E) {
Logger_.log(E);
}
}
}
std::string KafkaManager::WrapSystemId(const std::string & PayLoad) {
return std::move( SystemInfoWrapper_ + PayLoad + "}");
}
void KafkaManager::PostMessage(std::string topic, std::string key, std::string PayLoad, bool WrapMessage ) {
if(KafkaEnabled_) {
SubMutexGuard G(Mutex_);
KMessage M{
.Topic = topic,
.Key = key,
.PayLoad = WrapMessage ? WrapSystemId(PayLoad) : PayLoad };
Queue_.push(M);
}
}
int KafkaManager::RegisterTopicWatcher(const std::string &Topic, Types::TopicNotifyFunction &F) {
if(KafkaEnabled_) {
SubMutexGuard G(Mutex_);
auto It = Notifiers_.find(Topic);
if(It == Notifiers_.end()) {
Types::TopicNotifyFunctionList L;
L.emplace(L.end(),std::make_pair(F,FunctionId_));
Notifiers_[Topic] = std::move(L);
} else {
It->second.emplace(It->second.end(),std::make_pair(F,FunctionId_));
}
return FunctionId_++;
} else {
return 0;
}
}
void KafkaManager::UnregisterTopicWatcher(const std::string &Topic, int Id) {
if(KafkaEnabled_) {
SubMutexGuard G(Mutex_);
auto It = Notifiers_.find(Topic);
if(It != Notifiers_.end()) {
Types::TopicNotifyFunctionList & L = It->second;
for(auto it=L.begin(); it!=L.end(); it++)
if(it->second == Id) {
L.erase(it);
break;
}
}
}
}
#endif
} // namespace

74
src/KafkaManager.h Normal file
View File

@@ -0,0 +1,74 @@
//
// License type: BSD 3-Clause License
// License copy: https://github.com/Telecominfraproject/wlan-cloud-ucentralgw/blob/master/LICENSE
//
// Created by Stephane Bourque on 2021-03-04.
// Arilia Wireless Inc.
//
#ifndef UCENTRALGW_KAFKAMANAGER_H
#define UCENTRALGW_KAFKAMANAGER_H
#include <queue>
#include <thread>
#include "SubSystemServer.h"
#include "OpenWifiTypes.h"
#include "cppkafka/cppkafka.h"
namespace OpenWifi {
class KafkaManager : public SubSystemServer {
public:
struct KMessage {
std::string Topic,
Key,
PayLoad;
};
void initialize(Poco::Util::Application & self) override;
static KafkaManager *instance() {
if(instance_== nullptr)
instance_ = new KafkaManager;
return instance_;
}
void ProducerThr();
void ConsumerThr();
int Start() override;
void Stop() override;
void PostMessage(std::string topic, std::string key, std::string payload, bool WrapMessage = true);
[[nodiscard]] std::string WrapSystemId(const std::string & PayLoad);
[[nodiscard]] bool Enabled() { return KafkaEnabled_; }
int RegisterTopicWatcher(const std::string &Topic, Types::TopicNotifyFunction & F);
void UnregisterTopicWatcher(const std::string &Topic, int FunctionId);
void WakeUp();
void PartitionAssignment(const cppkafka::TopicPartitionList& partitions);
void PartitionRevocation(const cppkafka::TopicPartitionList& partitions);
private:
static KafkaManager *instance_;
SubMutex ProducerMutex_;
SubMutex ConsumerMutex_;
bool KafkaEnabled_ = false;
std::atomic_bool ProducerRunning_ = false;
std::atomic_bool ConsumerRunning_ = false;
std::queue<KMessage> Queue_;
std::string SystemInfoWrapper_;
std::unique_ptr<std::thread> ConsumerThr_;
std::unique_ptr<std::thread> ProducerThr_;
int FunctionId_=1;
Types::NotifyTable Notifiers_;
std::unique_ptr<cppkafka::Configuration> Config_;
KafkaManager() noexcept;
};
inline KafkaManager * KafkaManager() { return KafkaManager::instance(); }
} // NameSpace
#endif // UCENTRALGW_KAFKAMANAGER_H

37
src/Kafka_topics.h Normal file
View File

@@ -0,0 +1,37 @@
//
// Created by stephane bourque on 2021-06-07.
//
#ifndef UCENTRALGW_KAFKA_TOPICS_H
#define UCENTRALGW_KAFKA_TOPICS_H
namespace OpenWifi::KafkaTopics {
static const std::string HEALTHCHECK{"healthcheck"};
static const std::string STATE{"state"};
static const std::string CONNECTION{"connection"};
static const std::string WIFISCAN{"wifiscan"};
static const std::string ALERTS{"alerts"};
static const std::string COMMAND{"command"};
static const std::string SERVICE_EVENTS{"service_events"};
static const std::string DEVICE_EVENT_QUEUE{"device_event_queue"};
namespace ServiceEvents {
static const std::string EVENT_JOIN{"join"};
static const std::string EVENT_LEAVE{"leave"};
static const std::string EVENT_KEEP_ALIVE{"keep-alive"};
static const std::string EVENT_REMOVE_TOKEN{"remove-token"};
namespace Fields {
static const std::string EVENT{"event"};
static const std::string ID{"id"};
static const std::string TYPE{"type"};
static const std::string PUBLIC{"publicEndPoint"};
static const std::string PRIVATE{"privateEndPoint"};
static const std::string KEY{"key"};
static const std::string VRSN{"version"};
static const std::string TOKEN{"token"};
}
}
}
#endif // UCENTRALGW_KAFKA_TOPICS_H

View File

@@ -6,92 +6,60 @@
#include "StorageService.h" #include "StorageService.h"
namespace OpenWifi { namespace OpenWifi {
class LatestFirmwareCache *LatestFirmwareCache::instance_ = nullptr;
int LatestFirmwareCache::Start() { int LatestFirmwareCache::Start() {
poco_information(Logger(), "Starting..."); Storage()->PopulateLatestFirmwareCache();
StorageService()->FirmwaresDB().PopulateLatestFirmwareCache(); return 0;
return 0; }
}
void LatestFirmwareCache::Stop() { void LatestFirmwareCache::Stop() {
poco_information(Logger(), "Stopping..."); }
poco_information(Logger(), "Stopped...");
}
bool LatestFirmwareCache::AddToCache(const std::string &DeviceType, const std::string &Revision, bool LatestFirmwareCache::AddToCache(const std::string & DeviceType, const std::string &Revision, const std::string &Id, uint64_t TimeStamp) {
const std::string &Id, uint64_t TimeStamp) { SubMutexGuard G(Mutex_);
std::lock_guard G(Mutex_);
RevisionSet_.insert(Revision); RevisionSet_.insert(Revision);
DeviceSet_.insert(DeviceType); DeviceSet_.insert(DeviceType);
auto E = Cache_.find(DeviceType);
if((E==Cache_.end()) || (TimeStamp >= E->second.TimeStamp)) {
Cache_[DeviceType] = LatestFirmwareCacheEntry{ .Id=Id,
.TimeStamp=TimeStamp,
.Revision=Revision};
return true;
}
return false;
}
auto E = Cache_.find(DeviceType); bool LatestFirmwareCache::FindLatestFirmware(const std::string &DeviceType, LatestFirmwareCacheEntry &Entry ) {
if ((E == Cache_.end()) || (TimeStamp >= E->second.TimeStamp)) { SubMutexGuard G(Mutex_);
Cache_[DeviceType] =
LatestFirmwareCacheEntry{.Id = Id, .TimeStamp = TimeStamp, .Revision = Revision};
}
if (!IsRC(Revision)) auto E=Cache_.find(DeviceType);
return true; if(E!=Cache_.end()) {
Entry = E->second;
return true;
}
auto rcE = rcCache_.find(DeviceType); return false;
if ((rcE == rcCache_.end()) || (TimeStamp >= rcE->second.TimeStamp)) { }
rcCache_[DeviceType] =
LatestFirmwareCacheEntry{.Id = Id, .TimeStamp = TimeStamp, .Revision = Revision};
}
return true;
}
bool LatestFirmwareCache::FindLatestFirmware(const std::string &DeviceType, bool LatestFirmwareCache::IsLatest(const std::string &DeviceType, const std::string &Revision) {
LatestFirmwareCacheEntry &Entry) { SubMutexGuard G(Mutex_);
std::lock_guard G(Mutex_);
auto E = Cache_.find(DeviceType); auto E=Cache_.find(DeviceType);
if (E != Cache_.end()) { if(E!=Cache_.end()) {
Entry = E->second; return E->second.Revision==Revision;
return true; }
} return false;
return false; }
}
bool LatestFirmwareCache::FindLatestRCOnlyFirmware(const std::string &DeviceType,
LatestFirmwareCacheEntry &Entry) {
std::lock_guard G(Mutex_);
auto E = rcCache_.find(DeviceType); void LatestFirmwareCache::DumpCache() {
if (E != rcCache_.end()) { SubMutexGuard G(Mutex_);
Entry = E->second;
return true;
}
return false;
}
bool LatestFirmwareCache::IsLatest(const std::string &DeviceType, const std::string &Revision) { for( auto &[Id,E]:Cache_) {
std::lock_guard G(Mutex_); std::cout << "Device: " << Id << " ID:" << E.Id << std::endl;
}
auto E = Cache_.find(DeviceType); }
if (E != Cache_.end()) { }
return E->second.Revision == Revision;
}
return false;
}
bool LatestFirmwareCache::IsLatestRCOnly(const std::string &DeviceType,
const std::string &Revision) {
std::lock_guard G(Mutex_);
auto E = rcCache_.find(DeviceType);
if (E != rcCache_.end()) {
return E->second.Revision == Revision;
}
return false;
}
void LatestFirmwareCache::DumpCache() {
std::lock_guard G(Mutex_);
for (auto &[Id, E] : Cache_) {
std::cout << "Device: " << Id << " ID:" << E.Id << std::endl;
}
}
} // namespace OpenWifi

View File

@@ -2,73 +2,58 @@
// Created by stephane bourque on 2021-07-13. // Created by stephane bourque on 2021-07-13.
// //
#pragma once #ifndef UCENTRALFMS_LATESTFIRMWARECACHE_H
#define UCENTRALFMS_LATESTFIRMWARECACHE_H
#include "Poco/JSON/Object.h" #include "Poco/JSON/Object.h"
#include "Poco/JWT/Signer.h"
#include "Poco/Net/HTTPServerRequest.h" #include "Poco/Net/HTTPServerRequest.h"
#include "Poco/Net/HTTPServerResponse.h" #include "Poco/Net/HTTPServerResponse.h"
#include "Poco/JWT/Signer.h"
#include "Poco/SHA2Engine.h" #include "Poco/SHA2Engine.h"
#include "Poco/StringTokenizer.h" #include "RESTAPI_SecurityObjects.h"
#include "SubSystemServer.h"
#include "RESTObjects/RESTAPI_SecurityObjects.h"
#include "framework/SubSystemServer.h"
namespace OpenWifi { namespace OpenWifi {
struct LatestFirmwareCacheEntry { struct LatestFirmwareCacheEntry {
std::string Id; std::string Id;
uint64_t TimeStamp = 0; uint64_t TimeStamp=0;
std::string Revision; std::string Revision;
}; };
typedef std::map<std::string, LatestFirmwareCacheEntry> LatestFirmwareCacheMap; typedef std::map<std::string, LatestFirmwareCacheEntry> LatestFirmwareCacheMap;
typedef std::map<std::string, LatestFirmwareCacheEntry> rcOnlyLatestFirmwareCacheMap;
class LatestFirmwareCache : public SubSystemServer { class LatestFirmwareCache : public SubSystemServer {
public: public:
static auto instance() { static LatestFirmwareCache *instance() {
static auto instance_ = new LatestFirmwareCache; if (instance_ == nullptr) {
return instance_; instance_ = new LatestFirmwareCache;
} }
return instance_;
}
int Start() override; int Start() override;
void Stop() override; void Stop() override;
bool AddToCache(const std::string &DeviceType, const std::string &Revision, bool AddToCache(const std::string & DeviceType, const std::string & Revision, const std::string &Id, uint64_t TimeStamp);
const std::string &Id, uint64_t TimeStamp); // void AddRevision(const std::string &Revision);
// void AddRevision(const std::string &Revision); bool FindLatestFirmware(const std::string &DeviceType, LatestFirmwareCacheEntry &Entry );
bool FindLatestFirmware(const std::string &DeviceType, LatestFirmwareCacheEntry &Entry); void DumpCache();
bool FindLatestRCOnlyFirmware(const std::string &DeviceType, inline Types::StringSet GetRevisions() { SubMutexGuard G(Mutex_); return RevisionSet_; };
LatestFirmwareCacheEntry &Entry); inline Types::StringSet GetDevices() { SubMutexGuard G(Mutex_); return DeviceSet_; };
bool IsLatest(const std::string &DeviceType, const std::string &Revision);
inline static bool IsRC(const std::string &Revision) { private:
// OpenWrt 21.02-SNAPSHOT r16399+120-c67509efd7 / TIP-v2.5.0-36b5478 static LatestFirmwareCache *instance_;
auto Tokens = Poco::StringTokenizer(Revision, "/", Poco::StringTokenizer::TOK_TRIM); LatestFirmwareCacheMap Cache_;
if (Tokens.count() != 2) Types::StringSet RevisionSet_;
return false; Types::StringSet DeviceSet_;
return (Tokens[1].substr(0, 5) == "TIP-v"); explicit LatestFirmwareCache() noexcept:
} SubSystemServer("FirmwareCache", "FIRMWARE-CACHE", "FirmwareCache")
{
}
};
void DumpCache(); inline LatestFirmwareCache * LatestFirmwareCache() { return LatestFirmwareCache::instance(); }
inline Types::StringSet GetRevisions() { }
std::lock_guard G(Mutex_);
return RevisionSet_;
};
inline Types::StringSet GetDevices() {
std::lock_guard G(Mutex_);
return DeviceSet_;
};
bool IsLatest(const std::string &DeviceType, const std::string &Revision);
bool IsLatestRCOnly(const std::string &DeviceType, const std::string &Revision);
private:
LatestFirmwareCacheMap Cache_;
rcOnlyLatestFirmwareCacheMap rcCache_;
Types::StringSet RevisionSet_;
Types::StringSet DeviceSet_;
explicit LatestFirmwareCache() noexcept
: SubSystemServer("LatestFirmwareCache", "LATEST-FIRMWARE-CACHE",
"LatestFirmwareCache") {}
};
inline auto LatestFirmwareCache() { return LatestFirmwareCache::instance(); } #endif //UCENTRALFMS_LATESTFIRMWARECACHE_H
} // namespace OpenWifi

View File

@@ -6,355 +6,291 @@
#include "Poco/JSON/Parser.h" #include "Poco/JSON/Parser.h"
#include "Poco/JSON/Stringifier.h" #include "Poco/JSON/Stringifier.h"
#include <aws/s3/model/GetObjectRequest.h> #include "ManifestCreator.h"
#include "Utils.h"
#include <aws/s3/model/ListObjectsRequest.h> #include <aws/s3/model/ListObjectsRequest.h>
#include <aws/s3/model/ListObjectsV2Request.h> #include <aws/s3/model/ListObjectsV2Request.h>
#include <aws/s3/model/GetObjectRequest.h>
#include "LatestFirmwareCache.h" #include "Daemon.h"
#include "ManifestCreator.h"
#include "StorageService.h" #include "StorageService.h"
#include "LatestFirmwareCache.h"
#include "fmt/format.h"
#include "framework/utils.h"
namespace OpenWifi { namespace OpenWifi {
class ManifestCreator *ManifestCreator::instance_ = nullptr;
void ManifestCreator::onTimer([[maybe_unused]] Poco::Timer &timer) { void ManifestCreator::run() {
Utils::SetThreadName("manifest"); Running_ = true;
RunUpdateTask(); bool FirstRun = true;
}
bool ManifestCreator::RunUpdateTask() { while(Running_) {
if (!UpdateRunning_.test_and_set(std::memory_order_acquire)) { Poco::Thread::trySleep(FirstRun ? 10000 : DBRefresh_*1000);
poco_information(Logger(), "Performing DB refresh"); if(!Running_)
RunnerThread_.start(*this); break;
return true; FirstRun = false;
} else { Logger_.information("Performing DB refresh");
poco_information(Logger(), "DB refresh already in progress"); S3BucketContent BucketList;
return false; ReadBucket(BucketList);
} if(!Running_)
} break;
Logger_.information(Poco::format("Found %Lu firmware entries in S3 repository.",(uint64_t)BucketList.size()));
ComputeManifest(BucketList);
AddManifestToDB(BucketList);
}
}
void ManifestCreator::run() { bool ManifestCreator::ComputeManifest(S3BucketContent &BucketContent) {
S3BucketContent BucketList;
StorageService()->FirmwaresDB().RemoveOldFirmware();
ReadBucket(BucketList);
poco_information(Logger(), fmt::format("Found {} firmware entries in S3 repository.",
BucketList.size()));
ComputeManifest(BucketList);
AddManifestToDB(BucketList);
LastUpdate_ = Utils::Now();
UpdateRunning_.clear(std::memory_order_release);
}
bool ManifestCreator::ComputeManifest(S3BucketContent &BucketContent) { for(auto &[Name,Entry]:BucketContent) {
std::string C = Entry.S3ContentManifest;
uint64_t Limit = Utils::Now() - MaxAge_, Rejected = 0, Accepted = 0, BadFormat = 0, try {
MissingJson = 0; Poco::JSON::Parser P;
for (auto &[Name, Entry] : BucketContent) { auto ParsedContent = P.parse(Entry.S3ContentManifest).extract<Poco::JSON::Object::Ptr>();
std::string C = Entry.S3ContentManifest;
try { if( ParsedContent->has("image") &&
Poco::JSON::Parser P; ParsedContent->has("compatible") &&
auto ParsedContent = ParsedContent->has("revision") &&
P.parse(Entry.S3ContentManifest).extract<Poco::JSON::Object::Ptr>(); ParsedContent->has("timestamp"))
{
Entry.Timestamp = ParsedContent->get("timestamp");
Entry.Compatible = ParsedContent->get("compatible").toString();
Entry.Revision = ParsedContent->get("revision").toString();
Entry.Image = ParsedContent->get("image").toString();
auto FullNme = Name + "-upgrade.bin";
if(FullNme!=Entry.Image) {
Logger_.error(Poco::format("MANIFEST(%s): Image name does not match manifest name (%s).",Name,Entry.Image));
Entry.Valid = false;
continue;
}
Entry.Valid = true;
} else {
Logger_.error(Poco::format("MANIFEST(%s): Entry does not have a valid JSON manifest.",Name));
}
} catch (const Poco::Exception &E ) {
std::cout << "Exception parsing: " << C << std::endl;
Logger_.log(E);
}
}
return true;
}
if (ParsedContent->has("image") && ParsedContent->has("compatible") && bool ManifestCreator::AddManifestToDB(S3BucketContent & BucketContent) {
ParsedContent->has("revision") && ParsedContent->has("timestamp")) {
Entry.Timestamp = ParsedContent->get("timestamp");
if (Entry.Timestamp > Limit) {
Entry.Compatible = ParsedContent->get("compatible").toString();
Entry.Revision = ParsedContent->get("revision").toString();
Entry.Image = ParsedContent->get("image").toString();
auto FullNme = Name + "-upgrade.bin";
if (FullNme != Entry.Image) {
poco_error(
Logger(),
fmt::format(
"MANIFEST({}): Image name does not match manifest name ({}).",
Name, Entry.Image));
Entry.Valid = false;
BadFormat++;
continue;
}
Accepted++;
Entry.Valid = true;
} else {
Rejected++;
Entry.Valid = false;
}
} else {
poco_error(
Logger(),
fmt::format("MANIFEST({}): Entry does not have a valid JSON manifest.",
Name));
MissingJson++;
Entry.Valid = false;
}
} catch (const Poco::Exception &E) {
Logger().log(E);
}
}
poco_information(Logger(), fmt::format("Accepted {} firmwares.", Accepted)); for(auto &[Release,BucketEntry]:BucketContent) {
poco_information(Logger(), fmt::format("Rejected {} too old firmwares.", Rejected)); FMSObjects::Firmware F;
poco_information(Logger(), fmt::format("Rejected {} bad JSON.", BadFormat)); auto R = Release;
poco_information(Logger(), fmt::format("Rejected {} missing JSON.", MissingJson)); if(BucketEntry.Valid && !Storage()->GetFirmwareByName(R,BucketEntry.Compatible,F)) {
F.id = Daemon()->CreateUUID();
F.release = Release;
F.size = BucketEntry.S3Size;
F.created = std::time(nullptr);
F.imageDate = BucketEntry.S3TimeStamp;
F.image = BucketEntry.S3Name;
F.uri = BucketEntry.URI;
F.revision = BucketEntry.Revision;
F.deviceType = BucketEntry.Compatible;
if(Storage()->AddFirmware(F)) {
Logger_.information(Poco::format("Adding firmware '%s'",Release));
} else {
}
}
}
return true;
}
return true; int ManifestCreator::Start() {
} S3BucketName_ = Daemon()->ConfigGetString("s3.bucketname");
S3Region_ = Daemon()->ConfigGetString("s3.region");
S3Secret_ = Daemon()->ConfigGetString("s3.secret");
S3Key_ = Daemon()->ConfigGetString("s3.key");
S3Retry_ = Daemon()->ConfigGetInt("s3.retry",60);
bool ManifestCreator::AddManifestToDB(S3BucketContent &BucketContent) { DBRefresh_ = Daemon()->ConfigGetInt("firmwaredb.refresh",30*60);
// remove all staging names AwsConfig_.enableTcpKeepAlive = true;
for (auto it = BucketContent.begin(); it != end(BucketContent);) { AwsConfig_.enableEndpointDiscovery = true;
if (it->second.URI.find("-staging-") != std::string::npos) { AwsConfig_.useDualStack = true;
it = BucketContent.erase(it); if(!S3Region_.empty())
} else { AwsConfig_.region = S3Region_;
++it; AwsCreds_.SetAWSAccessKeyId(S3Key_);
} AwsCreds_.SetAWSSecretKey(S3Secret_);
}
// Now remove all DB entries that do not appear in the Latest manifest Worker_.start(*this);
auto RemovedEntries = return 0;
StorageService()->FirmwaresDB().RemoveOldDBEntriesNotInManifest(BucketContent); }
poco_information(Logger(), fmt::format("Removed {} DB entries that no longer are relevant.",
RemovedEntries));
for (auto &[Release, BucketEntry] : BucketContent) { void ManifestCreator::Stop() {
FMSObjects::Firmware F; if(Running_) {
auto R = Release; Running_ = false;
Worker_.wakeUp();
Worker_.join();
}
}
if (BucketEntry.Valid && bool ManifestCreator::Update() {
!StorageService()->FirmwaresDB().GetFirmwareByName(R, BucketEntry.Compatible, F)) { Worker_.wakeUp();
F.id = MicroServiceCreateUUID(); return true;
F.release = Release; }
F.size = BucketEntry.S3Size;
F.created = Utils::Now();
F.imageDate = BucketEntry.S3TimeStamp;
F.image = BucketEntry.Image;
F.uri = BucketEntry.URI;
F.revision = BucketEntry.Revision;
F.deviceType = BucketEntry.Compatible;
if (StorageService()->FirmwaresDB().AddFirmware(F)) {
poco_information(Logger(),
fmt::format("Adding firmware '{}', size={}", Release, F.size));
} else {
}
}
}
return true;
}
int ManifestCreator::Start() { void ManifestCreator::CloseBucket() {
Running_ = true; }
S3EndpointOverride_ = MicroServiceConfigGetString("s3.endpointOverride", "");
S3EndpointHttps_ = MicroServiceConfigGetBool("s3.endpoint.https", true);
S3UseVirtualAdressing_ = MicroServiceConfigGetBool("s3.useVirtualAdressing", true);
S3BucketName_ = MicroServiceConfigGetString("s3.bucketname", "");
S3Region_ = MicroServiceConfigGetString("s3.region", "");
S3Secret_ = MicroServiceConfigGetString("s3.secret", "");
S3Key_ = MicroServiceConfigGetString("s3.key", "");
S3Retry_ = MicroServiceConfigGetInt("s3.retry", 60);
DBRefresh_ = MicroServiceConfigGetInt("firmwaredb.refresh", 24 * 60 * 60); bool ManifestCreator::GetBucketObjectContent(Aws::S3::S3Client &S3Client, const std::string &ObjectName,
MaxAge_ = MicroServiceConfigGetInt("firmwaredb.maxage", 90) * 24 * 60 * 60; std::string &ObjectContent) {
Aws::S3::Model::GetObjectRequest Request;
Request.SetBucket(S3BucketName_.c_str());
Request.SetKey(ObjectName.c_str());
AwsConfig_.enableTcpKeepAlive = true; Aws::S3::Model::GetObjectOutcome get_object_outcome = S3Client.GetObject(Request);
AwsConfig_.enableEndpointDiscovery = true;
AwsConfig_.useDualStack = true;
if(!S3EndpointHttps_)
AwsConfig_.scheme = Aws::Http::Scheme::HTTP;
if(!S3EndpointOverride_.empty()) {
AwsConfig_.endpointOverride = Aws::String(S3EndpointOverride_);
AwsConfig_.useDualStack = false;
}
if (!S3Region_.empty())
AwsConfig_.region = S3Region_;
AwsCreds_.SetAWSAccessKeyId(S3Key_);
AwsCreds_.SetAWSSecretKey(S3Secret_);
ManifestCreatorCallBack_ = std::make_unique<Poco::TimerCallback<ManifestCreator>>( if (get_object_outcome.IsSuccess())
*this, &ManifestCreator::onTimer); {
Timer_.setStartInterval(1 * 60 * 1000); // first run in 1 hour auto & FileData = get_object_outcome.GetResultWithOwnership().GetBody();
Timer_.setPeriodicInterval((long)(DBRefresh_ * 1000)); std::string O;
Timer_.start(*ManifestCreatorCallBack_); std::ostringstream OS(O);
OS << FileData.rdbuf();
ObjectContent = OS.str();
return true;
}
return false;
}
return 0; bool ManifestCreator::ReadBucket(S3BucketContent & Bucket) {
} static const std::string JSON(".json");
static const std::string UPGRADE("-upgrade.bin");
void ManifestCreator::Stop() { std::string URIBase = "https://";
if (Running_) { URIBase += Daemon()->ConfigGetString("s3.bucket.uri");
Running_ = false;
Timer_.stop();
}
}
void ManifestCreator::CloseBucket() {} Bucket.clear();
bool ManifestCreator::GetBucketObjectContent(Aws::S3::S3Client &S3Client, Aws::S3::Model::ListObjectsV2Request Request;
const std::string &ObjectName, Request.WithBucket(S3BucketName_.c_str());
std::string &ObjectContent) { Aws::S3::S3Client S3Client(AwsCreds_,AwsConfig_);
Aws::S3::Model::GetObjectRequest Request; Request.SetMaxKeys(100);
Request.SetBucket(S3BucketName_.c_str()); Aws::S3::Model::ListObjectsV2Outcome Outcome;
Request.SetKey(ObjectName.c_str());
Aws::S3::Model::GetObjectOutcome get_object_outcome = S3Client.GetObject(Request); bool isDone=false;
int Count=0, Runs=0;
if (get_object_outcome.IsSuccess()) { while(!isDone) {
auto &FileData = get_object_outcome.GetResultWithOwnership().GetBody(); Outcome = S3Client.ListObjectsV2(Request);
std::string O; if(!Outcome.IsSuccess()) {
std::ostringstream OS(O); Logger_.error(Poco::format("Error while doing ListObjectsV2: %s, %s",
OS << FileData.rdbuf(); std::string{Outcome.GetError().GetExceptionName()},
ObjectContent = OS.str(); std::string{Outcome.GetError().GetMessage()}));
return true; return false;
} }
return false; Aws::Vector<Aws::S3::Model::Object> objects = Outcome.GetResult().GetContents();
} Runs++;
for (const auto &Object : objects) {
Count++;
// std::cout << "Run: " << Runs << " Count: " << Count << std::endl;
Poco::Path FileName(Object.GetKey().c_str());
if (!Running_)
return false;
if (FileName.getExtension() == "json") {
std::string Release = FileName.getBaseName();
std::string Content;
bool ManifestCreator::ReadBucket(S3BucketContent &Bucket) { if (GetBucketObjectContent(S3Client, FileName.getFileName(), Content)) {
static const std::string JSON(".json"); // std::cout << "Object: " << FileName.getFileName() << std::endl;
static const std::string UPGRADE("-upgrade.bin"); // std::cout << "Content: " << Content << std::endl;
Poco::JSON::Parser P;
auto ParsedContent = P.parse(Content).extract<Poco::JSON::Object::Ptr>();
if (ParsedContent->has("image") &&
ParsedContent->has("compatible") &&
ParsedContent->has("revision") &&
ParsedContent->has("timestamp")) {
auto It = Bucket.find(Release);
uint64_t TimeStamp = ParsedContent->get("timestamp");
auto Compatible = ParsedContent->get("compatible").toString();
auto Revision = ParsedContent->get("revision").toString();
// std::cout << "Revision from bucket in JSON" << Revision << std::endl;
auto Image = ParsedContent->get("image").toString();
if (It != Bucket.end()) {
It->second.Timestamp = TimeStamp;
It->second.Compatible = Compatible;
It->second.Revision = Revision;
It->second.Image = Image;
It->second.S3ContentManifest = Content;
} else {
Bucket.emplace(Release, S3BucketEntry{
.S3ContentManifest = Content,
.Revision = Revision,
.Image = Image,
.Compatible = Compatible,
.Timestamp = TimeStamp});
}
}
}
} else if (FileName.getExtension() == "bin") {
// we must remove -upgrade, so
const auto &ReleaseName = FileName.getBaseName().substr(0, FileName.getBaseName().size() - 8);
auto It = Bucket.find(ReleaseName);
auto S3TimeStamp = (uint64_t) (Object.GetLastModified().Millis() / 1000);
uint64_t S3Size = Object.GetSize();
std::string URI = URIBase + "/" + FileName.getFileName();
if (It != Bucket.end()) {
It->second.S3TimeStamp = S3TimeStamp;
It->second.S3Size = S3Size;
It->second.S3Name = ReleaseName;
It->second.URI = URI;
} else {
Bucket.emplace(ReleaseName, S3BucketEntry{
.S3Name = ReleaseName,
.S3TimeStamp = S3TimeStamp,
.S3Size = S3Size,
.URI = URI});
}
} else {
// std::cout << "Ignoring " << FileName.getFileName() << std::endl;
}
}
std::string URIBase = "https://"; isDone = !Outcome.GetResult().GetIsTruncated();
URIBase += MicroServiceConfigGetString("s3.bucket.uri", ""); if(!isDone) {
// std::cout << "Going for next run..." << std::endl;
// auto Token = Outcome.GetResult().GetContinuationToken();
auto Token = Outcome.GetResult().GetNextContinuationToken();
Request.SetContinuationToken(Token);
// std::cout << "Continuation set..." << std::endl;
}
}
Bucket.clear(); // std::cout << "Count:" << Count << " Runs:" << Runs << std::endl;
if(!Outcome.IsSuccess()) {
Logger_.error(Poco::format("Error while doing ListObjectsV2: %s, %s",
std::string{Outcome.GetError().GetExceptionName()},
std::string{Outcome.GetError().GetMessage()}));
return false;
}
return true;
}
Aws::S3::Model::ListObjectsV2Request Request; void S3BucketEntry::Print() const {
Request.WithBucket(S3BucketName_.c_str()); if(Valid) {
Aws::S3::S3Client S3Client(AwsCreds_, AwsConfig_, Aws::Client::AWSAuthV4Signer::PayloadSigningPolicy::Never, S3UseVirtualAdressing_); std::cout << " Name: " << S3Name << std::endl;
Request.SetMaxKeys(100); std::cout << " Size: " << S3Size << std::endl;
Aws::S3::Model::ListObjectsV2Outcome Outcome; std::cout << " Date: " << S3TimeStamp << std::endl;
std::cout << " Latest: " << S3ContentManifest << std::endl;
std::cout << " Image: " << Image << std::endl;
std::cout << " Revision: " << Revision << std::endl;
std::cout << " Compatible: " << Compatible << std::endl;
std::cout << " Timestamp: " << Timestamp << std::endl;
std::cout << " URI: " << URI << std::endl;
} else {
bool isDone = false; }
int Count = 0, Runs = 0; }
while (!isDone) { void Print(const S3BucketContent &B) {
Outcome = S3Client.ListObjectsV2(Request); for(const auto &[Name,Entry]:B) {
if (!Outcome.IsSuccess()) { std::cout << "Release:" << Name << std::endl;
poco_error(Logger(), fmt::format("Error while doing ListObjectsV2: {}, {}", Entry.Print();
std::string{Outcome.GetError().GetExceptionName()}, }
std::string{Outcome.GetError().GetMessage()})); }
return false;
}
Aws::Vector<Aws::S3::Model::Object> objects = Outcome.GetResult().GetContents();
Runs++;
for (const auto &Object : objects) {
Count++;
// std::cout << "Run: " << Runs << " Count: " << Count << std::endl;
Poco::Path FileName(Object.GetKey().c_str());
if (!Running_)
return false;
if (FileName.getExtension() == "json") {
std::string Release = FileName.getBaseName();
std::string Content;
if (GetBucketObjectContent(S3Client, FileName.getFileName(), Content)) { }
// std::cout << "Object: " << FileName.getFileName() << std::endl;
// std::cout << "Content: " << Content << std::endl;
Poco::JSON::Parser P;
auto ParsedContent = P.parse(Content).extract<Poco::JSON::Object::Ptr>();
if (ParsedContent->has("image") && ParsedContent->has("compatible") &&
ParsedContent->has("revision") && ParsedContent->has("timestamp")) {
auto It = Bucket.find(Release);
uint64_t TimeStamp = ParsedContent->get("timestamp");
auto Compatible = ParsedContent->get("compatible").toString();
auto Revision = ParsedContent->get("revision").toString();
// std::cout << "Revision from bucket in JSON" << Revision << std::endl;
auto Image = ParsedContent->get("image").toString();
if (It != Bucket.end()) {
It->second.Timestamp = TimeStamp;
It->second.Compatible = Compatible;
It->second.Revision = Revision;
It->second.Image = Image;
It->second.S3ContentManifest = Content;
} else {
Bucket.emplace(Release, S3BucketEntry{.Valid = false,
.S3Name = "",
.S3ContentManifest = Content,
.S3TimeStamp = 0,
.S3Size = 0,
.Revision = Revision,
.Image = Image,
.Compatible = Compatible,
.Timestamp = TimeStamp,
.URI = ""});
}
}
}
} else if (FileName.getExtension() == "bin") {
// we must remove -upgrade, so
const auto &ReleaseName =
FileName.getBaseName().substr(0, FileName.getBaseName().size() - 8);
auto It = Bucket.find(ReleaseName);
auto S3TimeStamp = (uint64_t)(Object.GetLastModified().Millis() / 1000);
uint64_t S3Size = Object.GetSize();
std::string URI = URIBase + "/" + FileName.getFileName();
if (It != Bucket.end()) {
It->second.S3TimeStamp = S3TimeStamp;
It->second.S3Size = S3Size;
It->second.S3Name = ReleaseName;
It->second.URI = URI;
} else {
Bucket.emplace(ReleaseName, S3BucketEntry{.Valid = false,
.S3Name = "",
.S3ContentManifest = "",
.S3TimeStamp = S3TimeStamp,
.S3Size = S3Size,
.Revision = "",
.Image = "",
.Compatible = "",
.Timestamp = 0,
.URI = URI});
}
} else {
// std::cout << "Ignoring " << FileName.getFileName() << std::endl;
}
}
isDone = !Outcome.GetResult().GetIsTruncated();
if (!isDone) {
// std::cout << "Going for next run..." << std::endl;
// auto Token = Outcome.GetResult().GetContinuationToken();
auto Token = Outcome.GetResult().GetNextContinuationToken();
Request.SetContinuationToken(Token);
// std::cout << "Continuation set..." << std::endl;
}
}
// std::cout << "Count:" << Count << " Runs:" << Runs << std::endl;
if (!Outcome.IsSuccess()) {
poco_error(Logger(), fmt::format("Run({},{}) Error while doing ListObjectsV2: {}, {}",
Runs, Count,
std::string{Outcome.GetError().GetExceptionName()},
std::string{Outcome.GetError().GetMessage()}));
return false;
}
return true;
}
void S3BucketEntry::Print() const {
if (Valid) {
std::cout << " Name: " << S3Name << std::endl;
std::cout << " Size: " << S3Size << std::endl;
std::cout << " Date: " << S3TimeStamp << std::endl;
std::cout << " Latest: " << S3ContentManifest << std::endl;
std::cout << " Image: " << Image << std::endl;
std::cout << " Revision: " << Revision << std::endl;
std::cout << " Compatible: " << Compatible << std::endl;
std::cout << " Timestamp: " << Timestamp << std::endl;
std::cout << " URI: " << URI << std::endl;
} else {
}
}
void Print(const S3BucketContent &B) {
for (const auto &[Name, Entry] : B) {
std::cout << "Release:" << Name << std::endl;
Entry.Print();
}
}
} // namespace OpenWifi

View File

@@ -2,80 +2,74 @@
// Created by stephane bourque on 2021-06-02. // Created by stephane bourque on 2021-06-02.
// //
#pragma once #ifndef UCENTRALFWS_MANIFESTCREATOR_H
#define UCENTRALFWS_MANIFESTCREATOR_H
#include <aws/core/Aws.h> #include <aws/core/Aws.h>
#include <aws/core/auth/AWSCredentials.h>
#include <aws/s3/S3Client.h> #include <aws/s3/S3Client.h>
#include <aws/core/auth/AWSCredentials.h>
#include "Poco/Timer.h" #include "SubSystemServer.h"
#include "framework/SubSystemServer.h"
namespace OpenWifi { namespace OpenWifi {
struct S3BucketEntry { struct S3BucketEntry {
bool Valid = false; bool Valid = false;
std::string S3Name; std::string S3Name;
std::string S3ContentManifest; std::string S3ContentManifest;
uint64_t S3TimeStamp = 0; uint64_t S3TimeStamp = 0;
uint64_t S3Size = 0; uint64_t S3Size = 0;
std::string Revision; std::string Revision;
std::string Image; std::string Image;
std::string Compatible; std::string Compatible;
uint64_t Timestamp = 0; uint64_t Timestamp = 0;
std::string URI; std::string URI;
void Print() const; void Print() const;
}; };
typedef std::map<const std::string, S3BucketEntry> S3BucketContent; typedef std::map<const std::string, S3BucketEntry> S3BucketContent;
class ManifestCreator : public SubSystemServer, Poco::Runnable { class ManifestCreator : public SubSystemServer, Poco::Runnable {
public: public:
static auto instance() { static ManifestCreator *instance() {
static auto instance_ = new ManifestCreator; if (instance_ == nullptr) {
return instance_; instance_ = new ManifestCreator;
} }
return instance_;
}
int Start() override; void run() override;
void Stop() override; int Start() override;
void Stop() override;
bool Update();
bool ComputeManifest(S3BucketContent &BucketContent); bool ComputeManifest(S3BucketContent & BucketContent);
bool AddManifestToDB(S3BucketContent &BucketContent); bool AddManifestToDB(S3BucketContent & BucketContent);
bool InitBucket(); bool InitBucket();
bool ReadBucket(S3BucketContent &Bucket); bool ReadBucket(S3BucketContent & Bucket);
bool GetBucketObjectContent(Aws::S3::S3Client &S3Client, const std::string &ObjectName, bool GetBucketObjectContent(Aws::S3::S3Client &S3Client, const std::string &ObjectName, std::string & ObjectContent);
std::string &ObjectContent); void CloseBucket();
void CloseBucket(); void Print(const S3BucketContent &B);
void Print(const S3BucketContent &B);
uint64_t MaxAge() const { return MaxAge_; }
void onTimer(Poco::Timer &timer);
bool RunUpdateTask();
void run() override;
std::uint64_t LastUpdate() const { return LastUpdate_; }
private: private:
std::atomic_bool Running_ = false; static ManifestCreator *instance_;
Aws::String S3EndpointOverride_; Poco::Thread Worker_;
bool S3EndpointHttps_; std::atomic_bool Running_ = false;
bool S3UseVirtualAdressing_; Aws::String S3BucketName_;
Aws::String S3BucketName_; Aws::String S3Region_;
Aws::String S3Region_; Aws::String S3Key_;
Aws::String S3Key_; Aws::String S3Secret_;
Aws::String S3Secret_; uint64_t S3Retry_;
uint64_t S3Retry_; Aws::Client::ClientConfiguration AwsConfig_{"ARILIA"};
Aws::Client::ClientConfiguration AwsConfig_{"ARILIA"}; Aws::Auth::AWSCredentials AwsCreds_;
Aws::Auth::AWSCredentials AwsCreds_; uint64_t DBRefresh_ = 30 * 60;
uint64_t DBRefresh_ = 30 * 60;
uint64_t MaxAge_ = 0;
Poco::Timer Timer_;
std::unique_ptr<Poco::TimerCallback<ManifestCreator>> ManifestCreatorCallBack_;
std::atomic_flag UpdateRunning_ = ATOMIC_FLAG_INIT;
Poco::Thread RunnerThread_;
std::uint64_t LastUpdate_ = 0;
ManifestCreator() noexcept ManifestCreator() noexcept:
: SubSystemServer("ManifestCreator", "MANIFEST-MGR", "manifestcreator") {} SubSystemServer("ManifestCreator", "MANIFEST-MGR", "manifestcreator") {
}; }
};
inline auto ManifestCreator() { return ManifestCreator::instance(); }; inline ManifestCreator * ManifestCreator() { return ManifestCreator::instance(); };
} // namespace OpenWifi }
#endif //UCENTRALFWS_MANIFESTCREATOR_H

501
src/MicroService.cpp Normal file
View File

@@ -0,0 +1,501 @@
//
// Created by stephane bourque on 2021-06-22.
//
#include <cstdlib>
#include <boost/algorithm/string.hpp>
#include "Poco/Util/Application.h"
#include "Poco/Util/ServerApplication.h"
#include "Poco/Util/Option.h"
#include "Poco/Util/OptionSet.h"
#include "Poco/Util/HelpFormatter.h"
#include "Poco/Environment.h"
#include "Poco/Net/HTTPSStreamFactory.h"
#include "Poco/Net/HTTPStreamFactory.h"
#include "Poco/Net/FTPSStreamFactory.h"
#include "Poco/Net/FTPStreamFactory.h"
#include "Poco/Path.h"
#include "Poco/File.h"
#include "Poco/String.h"
#include "Poco/JSON/Object.h"
#include "Poco/JSON/Parser.h"
#include "Poco/JSON/Stringifier.h"
#include "ALBHealthCheckServer.h"
#ifndef SMALL_BUILD
#include "KafkaManager.h"
#endif
#include "Kafka_topics.h"
#include "MicroService.h"
#include "Utils.h"
#ifndef TIP_SECURITY_SERVICE
#include "AuthClient.h"
#endif
namespace OpenWifi {
void MyErrorHandler::exception(const Poco::Exception & E) {
Poco::Thread * CurrentThread = Poco::Thread::current();
App_.logger().log(E);
App_.logger().error(Poco::format("Exception occurred in %s",CurrentThread->getName()));
}
void MyErrorHandler::exception(const std::exception & E) {
Poco::Thread * CurrentThread = Poco::Thread::current();
App_.logger().warning(Poco::format("std::exception on %s",CurrentThread->getName()));
}
void MyErrorHandler::exception() {
Poco::Thread * CurrentThread = Poco::Thread::current();
App_.logger().warning(Poco::format("exception on %s",CurrentThread->getName()));
}
void MicroService::Exit(int Reason) {
std::exit(Reason);
}
void MicroService::BusMessageReceived(const std::string &Key, const std::string & Message) {
SubMutexGuard G(InfraMutex_);
try {
Poco::JSON::Parser P;
auto Object = P.parse(Message).extract<Poco::JSON::Object::Ptr>();
if (Object->has(KafkaTopics::ServiceEvents::Fields::ID) &&
Object->has(KafkaTopics::ServiceEvents::Fields::EVENT)) {
uint64_t ID = Object->get(KafkaTopics::ServiceEvents::Fields::ID);
auto Event = Object->get(KafkaTopics::ServiceEvents::Fields::EVENT).toString();
if (ID != ID_) {
if( Event==KafkaTopics::ServiceEvents::EVENT_JOIN ||
Event==KafkaTopics::ServiceEvents::EVENT_KEEP_ALIVE ||
Event==KafkaTopics::ServiceEvents::EVENT_LEAVE ) {
if( Object->has(KafkaTopics::ServiceEvents::Fields::TYPE) &&
Object->has(KafkaTopics::ServiceEvents::Fields::PUBLIC) &&
Object->has(KafkaTopics::ServiceEvents::Fields::PRIVATE) &&
Object->has(KafkaTopics::ServiceEvents::Fields::VRSN) &&
Object->has(KafkaTopics::ServiceEvents::Fields::KEY)) {
if (Event == KafkaTopics::ServiceEvents::EVENT_KEEP_ALIVE && Services_.find(ID) != Services_.end()) {
Services_[ID].LastUpdate = std::time(nullptr);
} else if (Event == KafkaTopics::ServiceEvents::EVENT_LEAVE) {
Services_.erase(ID);
logger().information(Poco::format("Service %s ID=%Lu leaving system.",Object->get(KafkaTopics::ServiceEvents::Fields::PRIVATE).toString(),ID));
} else if (Event == KafkaTopics::ServiceEvents::EVENT_JOIN || Event == KafkaTopics::ServiceEvents::EVENT_KEEP_ALIVE) {
logger().information(Poco::format("Service %s ID=%Lu joining system.",Object->get(KafkaTopics::ServiceEvents::Fields::PRIVATE).toString(),ID));
Services_[ID] = MicroServiceMeta{
.Id = ID,
.Type = Poco::toLower(Object->get(KafkaTopics::ServiceEvents::Fields::TYPE).toString()),
.PrivateEndPoint = Object->get(KafkaTopics::ServiceEvents::Fields::PRIVATE).toString(),
.PublicEndPoint = Object->get(KafkaTopics::ServiceEvents::Fields::PUBLIC).toString(),
.AccessKey = Object->get(KafkaTopics::ServiceEvents::Fields::KEY).toString(),
.Version = Object->get(KafkaTopics::ServiceEvents::Fields::VRSN).toString(),
.LastUpdate = (uint64_t)std::time(nullptr)};
for (const auto &[Id, Svc] : Services_) {
logger().information(Poco::format("ID: %Lu Type: %s EndPoint: %s",Id,Svc.Type,Svc.PrivateEndPoint));
}
}
} else {
logger().error(Poco::format("KAFKA-MSG: invalid event '%s', missing a field.",Event));
}
} else if (Event==KafkaTopics::ServiceEvents::EVENT_REMOVE_TOKEN) {
if(Object->has(KafkaTopics::ServiceEvents::Fields::TOKEN)) {
#ifndef TIP_SECURITY_SERVICE
AuthClient()->RemovedCachedToken(Object->get(KafkaTopics::ServiceEvents::Fields::TOKEN).toString());
#endif
} else {
logger().error(Poco::format("KAFKA-MSG: invalid event '%s', missing token",Event));
}
} else {
logger().error(Poco::format("Unknown Event: %s Source: %Lu", Event, ID));
}
}
} else {
logger().error("Bad bus message.");
}
auto i=Services_.begin();
auto Now = (uint64_t )std::time(nullptr);
for(;i!=Services_.end();) {
if((Now - i->second.LastUpdate)>60) {
i = Services_.erase(i);
} else
++i;
}
} catch (const Poco::Exception &E) {
logger().log(E);
}
}
MicroServiceMetaVec MicroService::GetServices(const std::string & Type) {
SubMutexGuard G(InfraMutex_);
auto T = Poco::toLower(Type);
MicroServiceMetaVec Res;
for(const auto &[Id,ServiceRec]:Services_) {
if(ServiceRec.Type==T)
Res.push_back(ServiceRec);
}
return Res;
}
MicroServiceMetaVec MicroService::GetServices() {
SubMutexGuard G(InfraMutex_);
MicroServiceMetaVec Res;
for(const auto &[Id,ServiceRec]:Services_) {
Res.push_back(ServiceRec);
}
return Res;
}
void MicroService::initialize(Poco::Util::Application &self) {
// add the default services
SubSystems_.push_back(KafkaManager());
SubSystems_.push_back(ALBHealthCheckServer());
Poco::Net::initializeSSL();
Poco::Net::HTTPStreamFactory::registerFactory();
Poco::Net::HTTPSStreamFactory::registerFactory();
Poco::Net::FTPStreamFactory::registerFactory();
Poco::Net::FTPSStreamFactory::registerFactory();
std::string Location = Poco::Environment::get(DAEMON_CONFIG_ENV_VAR,".");
Poco::Path ConfigFile;
ConfigFile = ConfigFileName_.empty() ? Location + "/" + DAEMON_PROPERTIES_FILENAME : ConfigFileName_;
if(!ConfigFile.isFile())
{
std::cerr << DAEMON_APP_NAME << ": Configuration "
<< ConfigFile.toString() << " does not seem to exist. Please set " + DAEMON_CONFIG_ENV_VAR
+ " env variable the path of the " + DAEMON_PROPERTIES_FILENAME + " file." << std::endl;
std::exit(Poco::Util::Application::EXIT_CONFIG);
}
static const char * LogFilePathKey = "logging.channels.c2.path";
loadConfiguration(ConfigFile.toString());
if(LogDir_.empty()) {
std::string OriginalLogFileValue = ConfigPath(LogFilePathKey);
config().setString(LogFilePathKey, OriginalLogFileValue);
} else {
config().setString(LogFilePathKey, LogDir_);
}
Poco::File DataDir(ConfigPath("ucentral.system.data"));
DataDir_ = DataDir.path();
if(!DataDir.exists()) {
try {
DataDir.createDirectory();
} catch (const Poco::Exception &E) {
logger().log(E);
}
}
std::string KeyFile = ConfigPath("ucentral.service.key");
std::string KeyFilePassword = ConfigPath("ucentral.service.key.password" , "" );
AppKey_ = Poco::SharedPtr<Poco::Crypto::RSAKey>(new Poco::Crypto::RSAKey("", KeyFile, KeyFilePassword));
Cipher_ = CipherFactory_.createCipher(*AppKey_);
ID_ = Utils::GetSystemId();
if(!DebugMode_)
DebugMode_ = ConfigGetBool("ucentral.system.debug",false);
MyPrivateEndPoint_ = ConfigGetString("ucentral.system.uri.private");
MyPublicEndPoint_ = ConfigGetString("ucentral.system.uri.public");
UIURI_ = ConfigGetString("ucentral.system.uri.ui");
MyHash_ = CreateHash(MyPublicEndPoint_);
InitializeSubSystemServers();
ServerApplication::initialize(self);
Types::TopicNotifyFunction F = [this](std::string s1,std::string s2) { this->BusMessageReceived(s1,s2); };
KafkaManager()->RegisterTopicWatcher(KafkaTopics::SERVICE_EVENTS, F);
}
void MicroService::uninitialize() {
// add your own uninitialization code here
ServerApplication::uninitialize();
}
void MicroService::reinitialize(Poco::Util::Application &self) {
ServerApplication::reinitialize(self);
// add your own reinitialization code here
}
void MicroService::defineOptions(Poco::Util::OptionSet &options) {
ServerApplication::defineOptions(options);
options.addOption(
Poco::Util::Option("help", "", "display help information on command line arguments")
.required(false)
.repeatable(false)
.callback(Poco::Util::OptionCallback<MicroService>(this, &MicroService::handleHelp)));
options.addOption(
Poco::Util::Option("file", "", "specify the configuration file")
.required(false)
.repeatable(false)
.argument("file")
.callback(Poco::Util::OptionCallback<MicroService>(this, &MicroService::handleConfig)));
options.addOption(
Poco::Util::Option("debug", "", "to run in debug, set to true")
.required(false)
.repeatable(false)
.callback(Poco::Util::OptionCallback<MicroService>(this, &MicroService::handleDebug)));
options.addOption(
Poco::Util::Option("logs", "", "specify the log directory and file (i.e. dir/file.log)")
.required(false)
.repeatable(false)
.argument("dir")
.callback(Poco::Util::OptionCallback<MicroService>(this, &MicroService::handleLogs)));
options.addOption(
Poco::Util::Option("version", "", "get the version and quit.")
.required(false)
.repeatable(false)
.callback(Poco::Util::OptionCallback<MicroService>(this, &MicroService::handleVersion)));
}
void MicroService::handleHelp(const std::string &name, const std::string &value) {
HelpRequested_ = true;
displayHelp();
stopOptionsProcessing();
}
void MicroService::handleVersion(const std::string &name, const std::string &value) {
HelpRequested_ = true;
std::cout << Version() << std::endl;
stopOptionsProcessing();
}
void MicroService::handleDebug(const std::string &name, const std::string &value) {
if(value == "true")
DebugMode_ = true ;
}
void MicroService::handleLogs(const std::string &name, const std::string &value) {
LogDir_ = value;
}
void MicroService::handleConfig(const std::string &name, const std::string &value) {
ConfigFileName_ = value;
}
void MicroService::displayHelp() {
Poco::Util::HelpFormatter helpFormatter(options());
helpFormatter.setCommand(commandName());
helpFormatter.setUsage("OPTIONS");
helpFormatter.setHeader("A " + DAEMON_APP_NAME + " implementation for TIP.");
helpFormatter.format(std::cout);
}
void MicroService::InitializeSubSystemServers() {
for(auto i:SubSystems_)
addSubsystem(i);
}
void MicroService::StartSubSystemServers() {
for(auto i:SubSystems_) {
i->Start();
}
BusEventManager_.Start();
}
void MicroService::StopSubSystemServers() {
BusEventManager_.Stop();
for(auto i=SubSystems_.rbegin(); i!=SubSystems_.rend(); ++i)
(*i)->Stop();
}
std::string MicroService::CreateUUID() {
return UUIDGenerator_.create().toString();
}
bool MicroService::SetSubsystemLogLevel(const std::string &SubSystem, const std::string &Level) {
try {
auto P = Poco::Logger::parseLevel(Level);
auto Sub = Poco::toLower(SubSystem);
if (Sub == "all") {
for (auto i : SubSystems_) {
i->Logger().setLevel(P);
}
return true;
} else {
// std::cout << "Sub:" << SubSystem << " Level:" << Level << std::endl;
for (auto i : SubSystems_) {
if (Sub == Poco::toLower(i->Name())) {
i->Logger().setLevel(P);
return true;
}
}
}
} catch (const Poco::Exception & E) {
std::cout << "Exception" << std::endl;
}
return false;
}
Types::StringVec MicroService::GetSubSystems() const {
Types::StringVec Result;
for(auto i:SubSystems_)
Result.push_back(i->Name());
return Result;
}
Types::StringPairVec MicroService::GetLogLevels() const {
Types::StringPairVec Result;
for(auto &i:SubSystems_) {
auto P = std::make_pair( i->Name(), Utils::LogLevelToString(i->GetLoggingLevel()));
Result.push_back(P);
}
return Result;
}
const Types::StringVec & MicroService::GetLogLevelNames() const {
static Types::StringVec LevelNames{"none", "fatal", "critical", "error", "warning", "notice", "information", "debug", "trace" };
return LevelNames;
}
uint64_t MicroService::ConfigGetInt(const std::string &Key,uint64_t Default) {
return (uint64_t) config().getInt64(Key,Default);
}
uint64_t MicroService::ConfigGetInt(const std::string &Key) {
return config().getInt(Key);
}
uint64_t MicroService::ConfigGetBool(const std::string &Key,bool Default) {
return config().getBool(Key,Default);
}
uint64_t MicroService::ConfigGetBool(const std::string &Key) {
return config().getBool(Key);
}
std::string MicroService::ConfigGetString(const std::string &Key,const std::string & Default) {
return config().getString(Key, Default);
}
std::string MicroService::ConfigGetString(const std::string &Key) {
return config().getString(Key);
}
std::string MicroService::ConfigPath(const std::string &Key,const std::string & Default) {
std::string R = config().getString(Key, Default);
return Poco::Path::expand(R);
}
std::string MicroService::ConfigPath(const std::string &Key) {
std::string R = config().getString(Key);
return Poco::Path::expand(R);
}
std::string MicroService::Encrypt(const std::string &S) {
return Cipher_->encryptString(S, Poco::Crypto::Cipher::Cipher::ENC_BASE64);;
}
std::string MicroService::Decrypt(const std::string &S) {
return Cipher_->decryptString(S, Poco::Crypto::Cipher::Cipher::ENC_BASE64);;
}
std::string MicroService::CreateHash(const std::string &S) {
SHA2_.update(S);
return Utils::ToHex(SHA2_.digest());
}
std::string MicroService::MakeSystemEventMessage( const std::string & Type ) const {
Poco::JSON::Object Obj;
Obj.set(KafkaTopics::ServiceEvents::Fields::EVENT,Type);
Obj.set(KafkaTopics::ServiceEvents::Fields::ID,ID_);
Obj.set(KafkaTopics::ServiceEvents::Fields::TYPE,Poco::toLower(DAEMON_APP_NAME));
Obj.set(KafkaTopics::ServiceEvents::Fields::PUBLIC,MyPublicEndPoint_);
Obj.set(KafkaTopics::ServiceEvents::Fields::PRIVATE,MyPrivateEndPoint_);
Obj.set(KafkaTopics::ServiceEvents::Fields::KEY,MyHash_);
Obj.set(KafkaTopics::ServiceEvents::Fields::VRSN,Version_);
std::stringstream ResultText;
Poco::JSON::Stringifier::stringify(Obj, ResultText);
return ResultText.str();
}
void BusEventManager::run() {
Running_ = true;
auto Msg = Daemon()->MakeSystemEventMessage(KafkaTopics::ServiceEvents::EVENT_JOIN);
KafkaManager()->PostMessage(KafkaTopics::SERVICE_EVENTS,Daemon()->PrivateEndPoint(),Msg, false);
while(Running_) {
Poco::Thread::trySleep((unsigned long)Daemon()->DaemonBusTimer());
if(!Running_)
break;
auto Msg = Daemon()->MakeSystemEventMessage(KafkaTopics::ServiceEvents::EVENT_KEEP_ALIVE);
KafkaManager()->PostMessage(KafkaTopics::SERVICE_EVENTS,Daemon()->PrivateEndPoint(),Msg, false);
}
Msg = Daemon()->MakeSystemEventMessage(KafkaTopics::ServiceEvents::EVENT_LEAVE);
KafkaManager()->PostMessage(KafkaTopics::SERVICE_EVENTS,Daemon()->PrivateEndPoint(),Msg, false);
};
void BusEventManager::Start() {
if(KafkaManager()->Enabled()) {
Thread_.start(*this);
}
}
void BusEventManager::Stop() {
if(KafkaManager()->Enabled()) {
Running_ = false;
Thread_.wakeUp();
Thread_.join();
}
}
[[nodiscard]] bool MicroService::IsValidAPIKEY(const Poco::Net::HTTPServerRequest &Request) {
try {
auto APIKEY = Request.get("X-API-KEY");
return APIKEY == MyHash_;
} catch (const Poco::Exception &E) {
logger().log(E);
}
return false;
}
void MicroService::SavePID() {
try {
std::ofstream O;
O.open(Daemon()->DataDir() + "/pidfile",std::ios::binary | std::ios::trunc);
O << Poco::Process::id();
O.close();
} catch (...)
{
std::cout << "Could not save system ID" << std::endl;
}
}
int MicroService::main(const ArgVec &args) {
MyErrorHandler ErrorHandler(*this);
Poco::ErrorHandler::set(&ErrorHandler);
if (!HelpRequested_) {
SavePID();
Poco::Logger &logger = Poco::Logger::get(DAEMON_APP_NAME);
logger.notice(Poco::format("Starting %s version %s.",DAEMON_APP_NAME, Version()));
if(Poco::Net::Socket::supportsIPv6())
logger.information("System supports IPv6.");
else
logger.information("System does NOT support IPv6.");
if (config().getBool("application.runAsDaemon", false)) {
logger.information("Starting as a daemon.");
}
logger.information(Poco::format("System ID set to %Lu",ID_));
StartSubSystemServers();
waitForTerminationRequest();
StopSubSystemServers();
logger.notice(Poco::format("Stopped %s...",DAEMON_APP_NAME));
}
return Application::EXIT_OK;
}
}

174
src/MicroService.h Normal file
View File

@@ -0,0 +1,174 @@
//
// Created by stephane bourque on 2021-06-22.
//
#ifndef UCENTRALGW_MICROSERVICE_H
#define UCENTRALGW_MICROSERVICE_H
#include <array>
#include <iostream>
#include <cstdlib>
#include <vector>
#include <set>
#include "Poco/Util/Application.h"
#include "Poco/Util/ServerApplication.h"
#include "Poco/Util/Option.h"
#include "Poco/Util/OptionSet.h"
#include "Poco/UUIDGenerator.h"
#include "Poco/ErrorHandler.h"
#include "Poco/Crypto/RSAKey.h"
#include "Poco/Crypto/CipherFactory.h"
#include "Poco/Crypto/Cipher.h"
#include "Poco/SHA2Engine.h"
#include "Poco/Net/HTTPServerRequest.h"
#include "Poco/Process.h"
#include "OpenWifiTypes.h"
#include "SubSystemServer.h"
namespace OpenWifi {
static const std::string uSERVICE_SECURITY{"ucentralsec"};
static const std::string uSERVICE_GATEWAY{"ucentralgw"};
static const std::string uSERVICE_FIRMWARE{ "ucentralfms"};
static const std::string uSERVICE_TOPOLOGY{ "owtopo"};
static const std::string uSERVICE_PROVISIONING{ "owprov"};
class MyErrorHandler : public Poco::ErrorHandler {
public:
explicit MyErrorHandler(Poco::Util::Application &App) : App_(App) {}
void exception(const Poco::Exception & E) override;
void exception(const std::exception & E) override;
void exception() override;
private:
Poco::Util::Application &App_;
};
class BusEventManager : public Poco::Runnable {
public:
void run() override;
void Start();
void Stop();
private:
std::atomic_bool Running_ = false;
Poco::Thread Thread_;
};
struct MicroServiceMeta {
uint64_t Id=0;
std::string Type;
std::string PrivateEndPoint;
std::string PublicEndPoint;
std::string AccessKey;
std::string Version;
uint64_t LastUpdate=0;
};
typedef std::map<uint64_t, MicroServiceMeta> MicroServiceMetaMap;
typedef std::vector<MicroServiceMeta> MicroServiceMetaVec;
class MicroService : public Poco::Util::ServerApplication {
public:
explicit MicroService( std::string PropFile,
std::string RootEnv,
std::string ConfigVar,
std::string AppName,
uint64_t BusTimer,
Types::SubSystemVec Subsystems) :
DAEMON_PROPERTIES_FILENAME(std::move(PropFile)),
DAEMON_ROOT_ENV_VAR(std::move(RootEnv)),
DAEMON_CONFIG_ENV_VAR(std::move(ConfigVar)),
DAEMON_APP_NAME(std::move(AppName)),
DAEMON_BUS_TIMER(BusTimer),
SubSystems_(std::move(Subsystems)) {
std::string V{APP_VERSION};
std::string B{BUILD_NUMBER};
Version_ = V + "(" + B + ")";
}
int main(const ArgVec &args) override;
void initialize(Application &self) override;
void uninitialize() override;
void reinitialize(Application &self) override;
void defineOptions(Poco::Util::OptionSet &options) override;
void handleHelp(const std::string &name, const std::string &value);
void handleVersion(const std::string &name, const std::string &value);
void handleDebug(const std::string &name, const std::string &value);
void handleLogs(const std::string &name, const std::string &value);
void handleConfig(const std::string &name, const std::string &value);
void displayHelp();
void InitializeSubSystemServers();
void StartSubSystemServers();
void StopSubSystemServers();
void Exit(int Reason);
bool SetSubsystemLogLevel(const std::string & SubSystem, const std::string & Level);
[[nodiscard]] std::string Version() { return Version_; }
[[nodiscard]] const Poco::SharedPtr<Poco::Crypto::RSAKey> & Key() { return AppKey_; }
[[nodiscard]] inline const std::string & DataDir() { return DataDir_; }
[[nodiscard]] std::string CreateUUID();
[[nodiscard]] bool Debug() const { return DebugMode_; }
[[nodiscard]] uint64_t ID() const { return ID_; }
[[nodiscard]] Types::StringVec GetSubSystems() const;
[[nodiscard]] Types::StringPairVec GetLogLevels() const;
[[nodiscard]] const Types::StringVec & GetLogLevelNames() const;
[[nodiscard]] std::string ConfigGetString(const std::string &Key,const std::string & Default);
[[nodiscard]] std::string ConfigGetString(const std::string &Key);
[[nodiscard]] std::string ConfigPath(const std::string &Key,const std::string & Default);
[[nodiscard]] std::string ConfigPath(const std::string &Key);
[[nodiscard]] uint64_t ConfigGetInt(const std::string &Key,uint64_t Default);
[[nodiscard]] uint64_t ConfigGetInt(const std::string &Key);
[[nodiscard]] uint64_t ConfigGetBool(const std::string &Key,bool Default);
[[nodiscard]] uint64_t ConfigGetBool(const std::string &Key);
[[nodiscard]] std::string Encrypt(const std::string &S);
[[nodiscard]] std::string Decrypt(const std::string &S);
[[nodiscard]] std::string CreateHash(const std::string &S);
[[nodiscard]] std::string Hash() const { return MyHash_; };
[[nodiscard]] std::string ServiceType() const { return DAEMON_APP_NAME; };
[[nodiscard]] std::string PrivateEndPoint() const { return MyPrivateEndPoint_; };
[[nodiscard]] std::string PublicEndPoint() const { return MyPublicEndPoint_; };
[[nodiscard]] std::string MakeSystemEventMessage( const std::string & Type ) const ;
inline uint64_t DaemonBusTimer() const { return DAEMON_BUS_TIMER; };
void BusMessageReceived( const std::string & Key, const std::string & Message);
[[nodiscard]] MicroServiceMetaVec GetServices(const std::string & type);
[[nodiscard]] MicroServiceMetaVec GetServices();
[[nodiscard]] bool IsValidAPIKEY(const Poco::Net::HTTPServerRequest &Request);
void SavePID();
inline uint64_t GetPID() { return Poco::Process::id(); };
[[nodiscard]] inline const std::string GetPublicAPIEndPoint() const { return MyPublicEndPoint_ + "/api/v1"; };
[[nodiscard]] inline const std::string & GetUIURI() const { return UIURI_;};
private:
bool HelpRequested_ = false;
std::string LogDir_;
std::string ConfigFileName_;
Poco::UUIDGenerator UUIDGenerator_;
uint64_t ID_ = 1;
Poco::SharedPtr<Poco::Crypto::RSAKey> AppKey_ = nullptr;
bool DebugMode_ = false;
std::string DataDir_;
Types::SubSystemVec SubSystems_;
Poco::Crypto::CipherFactory & CipherFactory_ = Poco::Crypto::CipherFactory::defaultFactory();
Poco::Crypto::Cipher * Cipher_ = nullptr;
Poco::SHA2Engine SHA2_;
MicroServiceMetaMap Services_;
std::string MyHash_;
std::string MyPrivateEndPoint_;
std::string MyPublicEndPoint_;
std::string UIURI_;
std::string Version_;
BusEventManager BusEventManager_;
SubMutex InfraMutex_;
std::string DAEMON_PROPERTIES_FILENAME;
std::string DAEMON_ROOT_ENV_VAR;
std::string DAEMON_CONFIG_ENV_VAR;
std::string DAEMON_APP_NAME;
uint64_t DAEMON_BUS_TIMER;
};
}
#endif // UCENTRALGW_MICROSERVICE_H

View File

@@ -1,99 +0,0 @@
//
// Created by stephane bourque on 2021-11-21.
//
#include "NewCommandHandler.h"
#include "StorageService.h"
#include "fmt/format.h"
#include "framework/KafkaManager.h"
#include "nlohmann/json.hpp"
namespace OpenWifi {
void NewCommandHandler::run() {
Running_ = true;
Utils::SetThreadName("cmd-handler");
while (Running_) {
Poco::Thread::trySleep(2000);
if (!Running_)
break;
while (!NewCommands_.empty()) {
if (!Running_)
break;
Types::StringPair S;
{
std::lock_guard G(Mutex_);
S = NewCommands_.front();
NewCommands_.pop();
}
try {
auto SerialNumber = S.first;
auto M = nlohmann::json::parse(S.second);
std::string EndPoint;
if (M.contains(uCentralProtocol::SYSTEM)) {
auto SystemObj = M[uCentralProtocol::SYSTEM];
if (SystemObj.contains(uCentralProtocol::HOST))
EndPoint = SystemObj[uCentralProtocol::HOST];
}
if (M.contains(uCentralProtocol::PAYLOAD)) {
auto PayloadSection = M[uCentralProtocol::PAYLOAD];
if (PayloadSection.contains("command")) {
auto Command = PayloadSection["command"];
if (Command == "delete_device") {
auto pSerialNumber = PayloadSection["payload"]["serialNumber"];
if (pSerialNumber == SerialNumber) {
poco_debug(
Logger(),
fmt::format("Removing device '{}' from upgrade history.",
SerialNumber));
StorageService()->HistoryDB().DeleteHistory(SerialNumber);
poco_debug(
Logger(),
fmt::format("Removing device '{}' from device table.",
SerialNumber));
StorageService()->DevicesDB().DeleteDevice(SerialNumber);
}
}
}
}
} catch (const Poco::Exception &E) {
Logger().log(E);
}
}
}
};
int NewCommandHandler::Start() {
Types::TopicNotifyFunction F = [this](std::string s1, std::string s2) {
this->CommandReceived(s1, s2);
};
WatcherId_ = KafkaManager()->RegisterTopicWatcher(KafkaTopics::COMMAND, F);
Worker_.start(*this);
return 0;
};
void NewCommandHandler::Stop() {
KafkaManager()->UnregisterTopicWatcher(KafkaTopics::COMMAND, WatcherId_);
Running_ = false;
Worker_.wakeUp();
Worker_.join();
};
bool NewCommandHandler::Update() {
Worker_.wakeUp();
return true;
}
void NewCommandHandler::CommandReceived(const std::string &Key, const std::string &Message) {
std::lock_guard G(Mutex_);
NewCommands_.push(std::make_pair(Key, Message));
}
} // namespace OpenWifi

View File

@@ -1,36 +0,0 @@
//
// Created by stephane bourque on 2021-11-21.
//
#pragma once
#include "framework/OpenWifiTypes.h"
#include "framework/SubSystemServer.h"
namespace OpenWifi {
class NewCommandHandler : public SubSystemServer, Poco::Runnable {
public:
static auto instance() {
static auto instance_ = new NewCommandHandler;
return instance_;
}
void run() override;
int Start() override;
void Stop() override;
bool Update();
void CommandReceived(const std::string &Key, const std::string &Message);
private:
Poco::Thread Worker_;
std::atomic_bool Running_ = false;
int WatcherId_ = 0;
Types::StringPairQueue NewCommands_;
NewCommandHandler() noexcept
: SubSystemServer("NewCommandHandler", "NEWCOM-MGR", "commanmdhandler") {}
};
inline auto NewCommandHandler() { return NewCommandHandler::instance(); };
} // namespace OpenWifi

View File

@@ -3,178 +3,122 @@
// //
#include "NewConnectionHandler.h" #include "NewConnectionHandler.h"
#include "AutoUpdater.h" #include "Kafka_topics.h"
#include "DeviceCache.h" #include "KafkaManager.h"
#include "LatestFirmwareCache.h" #include "OpenWifiTypes.h"
#include "Poco/JSON/Object.h" #include "Poco/JSON/Object.h"
#include "Poco/JSON/Parser.h" #include "Poco/JSON/Parser.h"
#include "StorageService.h" #include "StorageService.h"
#include "framework/KafkaTopics.h" #include "LatestFirmwareCache.h"
#include "framework/OpenWifiTypes.h" #include "Utils.h"
#include "framework/ow_constants.h" #include "uCentralProtocol.h"
#include "DeviceCache.h"
#include "fmt/format.h"
#include "framework/KafkaManager.h"
/* /*
{ "system" : { "id" : 6715803232063 , "host" : "https://localhost:17002" } , { "system" : { "id" : 6715803232063 , "host" : "https://localhost:17002" } ,
"payload" : "{"capabilities":{"compatible":"linksys_ea8300","model":"Linksys EA8300 "payload" : "{"capabilities":{"compatible":"linksys_ea8300","model":"Linksys EA8300 (Dallas)","network":{"lan":["eth0"],"wan":["eth1"]},"platform":"ap","switch":{"switch0":{"enable":true,"ports":[{"device":"eth0","need_tag":false,"num":0,"want_untag":true},{"num":1,"role":"lan"},{"num":2,"role":"lan"},{"num":3,"role":"lan"},{"num":4,"role":"lan"}],"reset":true,"roles":[{"device":"eth0","ports":"1 2 3 4 0","role":"lan"}]}},"wifi":{"platform/soc/a000000.wifi":{"band":["2G"],"channels":[1,2,3,4,5,6,7,8,9,10,11],"frequencies":[2412,2417,2422,2427,2432,2437,2442,2447,2452,2457,2462],"ht_capa":6639,"htmode":["HT20","HT40","VHT20","VHT40","VHT80"],"rx_ant":3,"tx_ant":3,"vht_capa":865687986},"platform/soc/a800000.wifi":{"band":["5G"],"channels":[36,40,44,48,52,56,60,64],"frequencies":[5180,5200,5220,5240,5260,5280,5300,5320],"ht_capa":6639,"htmode":["HT20","HT40","VHT20","VHT40","VHT80"],"rx_ant":3,"tx_ant":3,"vht_capa":865687986},"soc/40000000.pci/pci0000:00/0000:00:00.0/0000:01:00.0":{"band":["5G"],"channels":[100,104,108,112,116,120,124,128,132,136,140,144,149,153,157,161,165],"frequencies":[5500,5520,5540,5560,5580,5600,5620,5640,5660,5680,5700,5720,5745,5765,5785,5805,5825],"ht_capa":6639,"htmode":["HT20","HT40","VHT20","VHT40","VHT80"],"rx_ant":3,"tx_ant":3,"vht_capa":865696178}}},"firmware":"OpenWrt 21.02-SNAPSHOT r16011+53-6fd65c6573 / TIP-devel-0825cb93","serial":"24f5a207a130","uuid":1623866223}}
(Dallas)","network":{"lan":["eth0"],"wan":["eth1"]},"platform":"ap","switch":{"switch0":{"enable":true,"ports":[{"device":"eth0","need_tag":false,"num":0,"want_untag":true},{"num":1,"role":"lan"},{"num":2,"role":"lan"},{"num":3,"role":"lan"},{"num":4,"role":"lan"}],"reset":true,"roles":[{"device":"eth0","ports":"1
2 3 4
0","role":"lan"}]}},"wifi":{"platform/soc/a000000.wifi":{"band":["2G"],"channels":[1,2,3,4,5,6,7,8,9,10,11],"frequencies":[2412,2417,2422,2427,2432,2437,2442,2447,2452,2457,2462],"ht_capa":6639,"htmode":["HT20","HT40","VHT20","VHT40","VHT80"],"rx_ant":3,"tx_ant":3,"vht_capa":865687986},"platform/soc/a800000.wifi":{"band":["5G"],"channels":[36,40,44,48,52,56,60,64],"frequencies":[5180,5200,5220,5240,5260,5280,5300,5320],"ht_capa":6639,"htmode":["HT20","HT40","VHT20","VHT40","VHT80"],"rx_ant":3,"tx_ant":3,"vht_capa":865687986},"soc/40000000.pci/pci0000:00/0000:00:00.0/0000:01:00.0":{"band":["5G"],"channels":[100,104,108,112,116,120,124,128,132,136,140,144,149,153,157,161,165],"frequencies":[5500,5520,5540,5560,5580,5600,5620,5640,5660,5680,5700,5720,5745,5765,5785,5805,5825],"ht_capa":6639,"htmode":["HT20","HT40","VHT20","VHT40","VHT80"],"rx_ant":3,"tx_ant":3,"vht_capa":865696178}}},"firmware":"OpenWrt
21.02-SNAPSHOT r16011+53-6fd65c6573 /
TIP-devel-0825cb93","serial":"24f5a207a130","uuid":1623866223}}
*/ */
namespace OpenWifi { namespace OpenWifi {
class NewConnectionHandler *NewConnectionHandler::instance_ = nullptr;
void NewConnectionHandler::run() { void NewConnectionHandler::run() {
Utils::SetThreadName("conn-handler"); Running_ = true ;
Running_ = true; while(Running_) {
while (Running_) { Poco::Thread::trySleep(2000);
Poco::Thread::trySleep(2000);
if (!Running_) if(!Running_)
break; break;
while (!NewConnections_.empty()) { while(!NewConnections_.empty()) {
if (!Running_) if(!Running_)
break; break;
Types::StringPair S; Types::StringPair S;
{ {
std::lock_guard G(Mutex_); SubMutexGuard G(Mutex_);
S = NewConnections_.front(); S = NewConnections_.front();
NewConnections_.pop(); NewConnections_.pop();
} }
auto SerialNumber = S.first;
Poco::JSON::Parser Parser;
auto Object = Parser.parse(S.second).extract<Poco::JSON::Object::Ptr>();
try { std::string EndPoint;
auto SerialNumber = S.first;
Poco::JSON::Parser Parser;
auto Object = Parser.parse(S.second).extract<Poco::JSON::Object::Ptr>();
std::string EndPoint; if(Object->has(uCentralProtocol::SYSTEM)) {
auto SystemObj = Object->getObject(uCentralProtocol::SYSTEM);
if(SystemObj->has(uCentralProtocol::HOST))
EndPoint = SystemObj->get(uCentralProtocol::HOST).toString();
}
if (Object->has(uCentralProtocol::SYSTEM)) { if(Object->has(uCentralProtocol::PAYLOAD)) {
auto SystemObj = Object->getObject(uCentralProtocol::SYSTEM); auto PayloadObj = Object->getObject(uCentralProtocol::PAYLOAD);
if (SystemObj->has(uCentralProtocol::HOST)) if(PayloadObj->has(uCentralProtocol::CAPABILITIES)) {
EndPoint = SystemObj->get(uCentralProtocol::HOST).toString(); // std::cout << "CAPABILITIES:" << SerialNumber << std::endl;
} auto CapObj = PayloadObj->getObject(uCentralProtocol::CAPABILITIES);
if(CapObj->has(uCentralProtocol::COMPATIBLE)) {
auto DeviceType = CapObj->get(uCentralProtocol::COMPATIBLE).toString();
auto Serial = PayloadObj->get(uCentralProtocol::SERIAL).toString();
auto Revision = Storage::TrimRevision(PayloadObj->get(uCentralProtocol::FIRMWARE).toString());
// std::cout << "ConnectionEvent: SerialNumber: " << SerialNumber << " DeviceType: " << DeviceType << " Revision:" << Revision << std::endl;
FMSObjects::FirmwareAgeDetails FA;
if(Storage()->ComputeFirmwareAge(DeviceType, Revision, FA)) {
Storage()->SetDeviceRevision(SerialNumber, Revision, DeviceType, EndPoint);
if(FA.age)
Logger_.information(Poco::format("Device %s connection. Firmware is %s older than latest",SerialNumber, Utils::SecondsToNiceText(FA.age)));
else
Logger_.information(Poco::format("Device %s connection. Firmware age cannot be determined",SerialNumber));
}
DeviceCache()->AddToCache(Serial, DeviceType, EndPoint, Revision);
}
} else if(PayloadObj->has(uCentralProtocol::DISCONNECTION)) {
auto DisconnectMessage = PayloadObj->getObject(uCentralProtocol::DISCONNECTION);
if(DisconnectMessage->has(uCentralProtocol::SERIALNUMBER) && DisconnectMessage->has(uCentralProtocol::TIMESTAMP)) {
auto SNum = DisconnectMessage->get(uCentralProtocol::SERIALNUMBER).toString();
auto Timestamp = DisconnectMessage->get(uCentralProtocol::TIMESTAMP);
Storage()->SetDeviceDisconnected(SNum,EndPoint);
// std::cout << "DISCONNECTION:" << SerialNumber << std::endl;
}
} else if(PayloadObj->has(uCentralProtocol::PING)) {
// std::cout << "PING:" << SerialNumber << std::endl;
auto PingMessage = PayloadObj->getObject(uCentralProtocol::PING);
if( PingMessage->has(uCentralProtocol::FIRMWARE) &&
PingMessage->has(uCentralProtocol::SERIALNUMBER) &&
PingMessage->has(uCentralProtocol::COMPATIBLE)) {
auto Revision = Storage::TrimRevision(PingMessage->get(uCentralProtocol::FIRMWARE).toString());
auto Serial = PingMessage->get( uCentralProtocol::SERIALNUMBER).toString();
auto DeviceType = PingMessage->get( uCentralProtocol::COMPATIBLE).toString();
Storage()->SetDeviceRevision(Serial, Revision, DeviceType, EndPoint);
DeviceCache()->AddToCache(Serial, DeviceType, EndPoint, Revision);
}
}
}
}
}
};
if (Object->has(uCentralProtocol::PAYLOAD)) { int NewConnectionHandler::Start() {
auto PayloadObj = Object->getObject(uCentralProtocol::PAYLOAD); Types::TopicNotifyFunction F = [this](std::string s1,std::string s2) { this->ConnectionReceived(s1,s2); };
if (PayloadObj->has(uCentralProtocol::CAPABILITIES)) { ConnectionWatcherId_ = KafkaManager()->RegisterTopicWatcher(KafkaTopics::CONNECTION, F);
// std::cout << "CAPABILITIES:" << SerialNumber << std::endl; Worker_.start(*this);
auto CapObj = PayloadObj->getObject(uCentralProtocol::CAPABILITIES); return 0;
if (CapObj->has(uCentralProtocol::COMPATIBLE)) { };
auto DeviceType =
CapObj->get(uCentralProtocol::COMPATIBLE).toString();
auto Serial = PayloadObj->get(uCentralProtocol::SERIAL).toString();
auto Revision = Storage::TrimRevision(
PayloadObj->get(uCentralProtocol::FIRMWARE).toString());
// std::cout << "ConnectionEvent: SerialNumber: " << SerialNumber <<
// " DeviceType: " << DeviceType << " Revision:" << Revision <<
// std::endl;
FMSObjects::FirmwareAgeDetails FA;
if (StorageService()->FirmwaresDB().ComputeFirmwareAge(
DeviceType, Revision, FA)) {
StorageService()->DevicesDB().SetDeviceRevision(
SerialNumber, Revision, DeviceType, EndPoint);
if (FA.age)
poco_information(
Logger(),
fmt::format("Device {} connection. Firmware is {} "
"older than latest.",
SerialNumber,
Utils::SecondsToNiceText(FA.age)));
else
poco_information(Logger(),
fmt::format("Device {} connection. Device "
"firmware is up to date.",
SerialNumber));
} else {
poco_information(Logger(),
fmt::format("Device {} connection. Firmware "
"age cannot be determined.",
SerialNumber));
}
if (!LatestFirmwareCache()->IsLatest(DeviceType, Revision)) { void NewConnectionHandler::Stop() {
// std::cout << "Device (connection): " << SerialNumber << " to KafkaManager()->UnregisterTopicWatcher(KafkaTopics::CONNECTION, ConnectionWatcherId_);
// be upgraded ... " << std::endl; Running_ = false;
AutoUpdater()->ToBeUpgraded(SerialNumber, DeviceType); Worker_.wakeUp();
} Worker_.join();
DeviceCache()->AddToCache(Serial, DeviceType, EndPoint, Revision); };
}
} else if (PayloadObj->has(uCentralProtocol::DISCONNECTION)) {
auto DisconnectMessage =
PayloadObj->getObject(uCentralProtocol::DISCONNECTION);
if (DisconnectMessage->has(uCentralProtocol::SERIALNUMBER) &&
DisconnectMessage->has(uCentralProtocol::TIMESTAMP)) {
auto SNum = DisconnectMessage->get(uCentralProtocol::SERIALNUMBER)
.toString();
auto Timestamp =
DisconnectMessage->get(uCentralProtocol::TIMESTAMP);
StorageService()->DevicesDB().SetDeviceDisconnected(SNum, EndPoint);
// std::cout << "DISCONNECTION:" << SerialNumber << std::endl;
}
} else if (PayloadObj->has(uCentralProtocol::PING)) {
// std::cout << "PING:" << SerialNumber << std::endl;
auto PingMessage = PayloadObj->getObject(uCentralProtocol::PING);
if (PingMessage->has(uCentralProtocol::FIRMWARE) &&
PingMessage->has(uCentralProtocol::SERIALNUMBER) &&
PingMessage->has(uCentralProtocol::COMPATIBLE)) {
auto Revision = Storage::TrimRevision(
PingMessage->get(uCentralProtocol::FIRMWARE).toString());
auto Serial =
PingMessage->get(uCentralProtocol::SERIALNUMBER).toString();
auto DeviceType =
PingMessage->get(uCentralProtocol::COMPATIBLE).toString();
StorageService()->DevicesDB().SetDeviceRevision(
Serial, Revision, DeviceType, EndPoint);
DeviceCache()->AddToCache(Serial, DeviceType, EndPoint, Revision);
if (!LatestFirmwareCache()->IsLatest(DeviceType, Revision)) {
// std::cout << "Device(ping): " << SerialNumber << " to be
// upgraded ... " << std::endl;
AutoUpdater()->ToBeUpgraded(SerialNumber, DeviceType);
}
}
}
}
} catch (const Poco::Exception &E) {
Logger().log(E);
}
}
}
};
int NewConnectionHandler::Start() { bool NewConnectionHandler::Update() {
poco_information(Logger(), "Starting..."); Worker_.wakeUp();
Types::TopicNotifyFunction F = [this](std::string s1, std::string s2) { return true;
this->ConnectionReceived(s1, s2); }
};
ConnectionWatcherId_ = KafkaManager()->RegisterTopicWatcher(KafkaTopics::CONNECTION, F);
Worker_.start(*this);
return 0;
};
void NewConnectionHandler::Stop() { void NewConnectionHandler::ConnectionReceived( const std::string & Key, const std::string & Message) {
poco_information(Logger(), "Stopping..."); SubMutexGuard G(Mutex_);
KafkaManager()->UnregisterTopicWatcher(KafkaTopics::CONNECTION, ConnectionWatcherId_); NewConnections_.push(std::make_pair(Key,Message));
Running_ = false; }
Worker_.wakeUp(); }
Worker_.join();
poco_information(Logger(), "Stopped...");
};
bool NewConnectionHandler::Update() {
Worker_.wakeUp();
return true;
}
void NewConnectionHandler::ConnectionReceived(const std::string &Key,
const std::string &Message) {
std::lock_guard G(Mutex_);
NewConnections_.push(std::make_pair(Key, Message));
}
} // namespace OpenWifi

View File

@@ -2,35 +2,46 @@
// Created by stephane bourque on 2021-07-13. // Created by stephane bourque on 2021-07-13.
// //
#pragma once #ifndef UCENTRALFMS_NEWCONNECTIONHANDLER_H
#define UCENTRALFMS_NEWCONNECTIONHANDLER_H
#include "framework/OpenWifiTypes.h"
#include "framework/SubSystemServer.h" #include "SubSystemServer.h"
#include "OpenWifiTypes.h"
namespace OpenWifi { namespace OpenWifi {
class NewConnectionHandler : public SubSystemServer, Poco::Runnable { class NewConnectionHandler : public SubSystemServer, Poco::Runnable {
public: public:
static auto instance() {
static auto instance_ = new NewConnectionHandler;
return instance_;
}
void run() override; static NewConnectionHandler *instance() {
int Start() override; if (instance_ == nullptr) {
void Stop() override; instance_ = new NewConnectionHandler;
bool Update(); }
return instance_;
}
void ConnectionReceived(const std::string &Key, const std::string &Message); void run() override;
int Start() override;
void Stop() override;
bool Update();
private: void ConnectionReceived( const std::string & Key, const std::string & Message);
Poco::Thread Worker_;
std::atomic_bool Running_ = false;
uint64_t ConnectionWatcherId_ = 0;
Types::StringPairQueue NewConnections_;
NewConnectionHandler() noexcept private:
: SubSystemServer("ConnectionHandler", "NEWCONN-MGR", "connectionhandler") {} static NewConnectionHandler *instance_;
}; Poco::Thread Worker_;
inline auto NewConnectionHandler() { return NewConnectionHandler::instance(); }; std::atomic_bool Running_ = false;
} // namespace OpenWifi int ConnectionWatcherId_=0;
int HealthcheckWatcherId_=0;
Types::StringPairQueue NewConnections_;
NewConnectionHandler() noexcept:
SubSystemServer("ConnectionHandler", "NEWCONN-MGR", "connectionhandler") {
}
};
inline NewConnectionHandler * NewConnectionHandler() { return NewConnectionHandler::instance(); };
}
#endif //UCENTRALFMS_NEWCONNECTIONHANDLER_H

Some files were not shown because too many files have changed in this diff Show More