mirror of
https://github.com/Telecominfraproject/wlan-cloud-ucentralgw.git
synced 2025-10-29 18:02:27 +00:00
Signed-off-by: stephb9959 <stephane.bourque@gmail.com>
This commit is contained in:
stephb9959
463
CONFIGURATION.md
463
CONFIGURATION.md
@@ -1,6 +1,7 @@
|
||||
# Controller Configuration Parameters
|
||||
|
||||
## Websocket parameters
|
||||
## OWGW Specific Parameters
|
||||
### Websocket parameters
|
||||
This is the crucial section. I bet that 97.4% of all your problems will come from here, and it's boring. So put some good music on,
|
||||
give the kids the iPad, get a cup of coffee, and pay attention. Every field will be explained.
|
||||
|
||||
@@ -19,99 +20,33 @@ ucentral.websocket.host.0.key.password = mypassword
|
||||
ucentral.websocket.maxreactors = 20
|
||||
```
|
||||
|
||||
### This is the end point for the devices to connect with
|
||||
This is the crucial section. I bet that 97.4% of all your problems will come from here, and it's boring. So put some good music on,
|
||||
give the kids the iPad, get a cup of coffee, and pay attention. Every field will be explained.
|
||||
|
||||
### ucentral.websocket.host.0.backlog
|
||||
#### ucentral.websocket.host.0.backlog
|
||||
This is the number of concurrent devices you are expecting to call all at once. Not the current number of devices. This is how many will connect in the same exact second.
|
||||
Take the total number of devices you have and divide by 100. That's a good rule of thumb. Never go above 500.
|
||||
### ucentral.websocket.host.0.rootca
|
||||
#### ucentral.websocket.host.0.rootca
|
||||
This is the root file as supplied by Digicert. You can find it [here](https://github.com/Telecominfraproject/wlan-cloud-ucentralgw/blob/main/certificates/root.pem)
|
||||
### ucentral.websocket.host.0.issuer
|
||||
#### ucentral.websocket.host.0.issuer
|
||||
This is the issuer file as supplied by Digicert. You can find it [here](https://github.com/Telecominfraproject/wlan-cloud-ucentralgw/blob/main/certificates/issuer.pem)
|
||||
### ucentral.websocket.host.0.cert
|
||||
#### ucentral.websocket.host.0.cert
|
||||
This is a `pem` file that you will receive from Digicert for the gateway itself. This is the certificate for the gateway.
|
||||
### ucentral.websocket.host.0.key
|
||||
#### ucentral.websocket.host.0.key
|
||||
This is a `pem` file that you will receive from Digicert for the gateway itself. The is the private key for the gateway.
|
||||
### ucentral.websocket.host.0.clientcas
|
||||
#### ucentral.websocket.host.0.clientcas
|
||||
This is a `pem` file that contains both the issuer and the root CA certificates. You can find it You can find it [here](https://github.com/Telecominfraproject/wlan-cloud-ucentralgw/blob/main/certificates/clientcas.pem)
|
||||
### ucentral.websocket.host.0.cas
|
||||
#### ucentral.websocket.host.0.cas
|
||||
This is a directory where you will copy your own `cert.pem`, the `root.pem`, and the `issuer.pem` files.
|
||||
### ucentral.websocket.host.0.address
|
||||
#### ucentral.websocket.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.
|
||||
### ucentral.websocket.host.0.port
|
||||
#### ucentral.websocket.host.0.port
|
||||
Leave to 15002 for now.
|
||||
### ucentral.websocket.host.0.security
|
||||
#### ucentral.websocket.host.0.security
|
||||
Leave this as strict for now for devices.
|
||||
### ucentral.websocket.host.0.key.password
|
||||
#### ucentral.websocket.host.0.key.password
|
||||
If you key file uses a password, please enter it here.
|
||||
### ucentral.websocket.maxreactors
|
||||
#### ucentral.websocket.maxreactors
|
||||
A single reactor can handle between 1000-2000 devices. Never leave this smaller than 5 or larger than 50.
|
||||
|
||||
## 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 = $OWGW_ROOT/certs/restapi-ca.pem
|
||||
openwifi.restapi.host.0.address = *
|
||||
openwifi.restapi.host.0.port = 16002
|
||||
openwifi.restapi.host.0.cert = $OWGW_ROOT/certs/restapi-cert.pem
|
||||
openwifi.restapi.host.0.key = $OWGW_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 = $OWGW_ROOT/certs/restapi-ca.pem
|
||||
openwifi.internal.restapi.host.0.address = *
|
||||
openwifi.internal.restapi.host.0.port = 17002
|
||||
openwifi.internal.restapi.host.0.cert = $OWGW_ROOT/certs/restapi-cert.pem
|
||||
openwifi.internal.restapi.host.0.key = $OWGW_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.
|
||||
|
||||
## File uploader parameters
|
||||
### File uploader parameters
|
||||
Certain commands may require the Access Point to upload a file into the Controller. For this reason, there is a special embedded HTTP
|
||||
server to receive these files.
|
||||
|
||||
@@ -130,71 +65,37 @@ openwifi.fileuploader.maxsize = 10000
|
||||
openwifi.fileuploader.uri = https://ucentral.dpaas.arilia.com:16003
|
||||
```
|
||||
|
||||
### openwifi.fileuploader.host.0.backlog
|
||||
#### openwifi.fileuploader.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.fileuploader.host.0.rootca
|
||||
#### openwifi.fileuploader.host.0.rootca
|
||||
This is the root file of your own certificate CA in `pem` format.
|
||||
### openwifi.fileuploader.host.0.cert
|
||||
#### openwifi.fileuploader.host.0.cert
|
||||
This is your own server certificate in `pem` format..
|
||||
### openwifi.fileuploader.host.0.key
|
||||
#### openwifi.fileuploader.host.0.key
|
||||
This is the private key associated with your own certificate in `pem` format.
|
||||
### openwifi.intfileuploaderernal.host.0.address
|
||||
#### openwifi.intfileuploaderernal.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.fileuploader.host.0.port
|
||||
#### openwifi.fileuploader.host.0.port
|
||||
The port on which the REST API server is listening. By default, this is 16003.
|
||||
### openwifi.fileuploader.host.0.security
|
||||
#### openwifi.fileuploader.host.0.security
|
||||
Leave this as `relaxed` for now for devices.
|
||||
### openwifi.fileuploader.host.0.key.password
|
||||
#### openwifi.fileuploader.host.0.key.password
|
||||
If you key file uses a password, please enter it here.
|
||||
### openwifi.fileuploader.path
|
||||
#### openwifi.fileuploader.path
|
||||
This is the location where the files will be stored temporarily before processing. This `path` must exist.
|
||||
### openwifi.fileuploader.maxsize
|
||||
#### openwifi.fileuploader.maxsize
|
||||
This is the maximum uploaded file size. The default maximum size if 10MB. This size is in KB.
|
||||
### openwifi.fileuploader.uri
|
||||
#### openwifi.fileuploader.uri
|
||||
This is the URI that will be passed to the AP. You must make sure that the AP can resolve this URI.
|
||||
|
||||
## Microservice information
|
||||
These are different Microservie parameters. Following is a brief explanation.
|
||||
```properties
|
||||
openwifi.service.key = $OWGW_ROOT/certs/restapi-key.pem
|
||||
openwifi.service.key.password = mypassword
|
||||
openwifi.system.data = $OWGW_ROOT/data
|
||||
openwifi.system.uri.private = https://localhost:17002
|
||||
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.ucentralgw
|
||||
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.
|
||||
|
||||
## OUI Service
|
||||
### OUI Service
|
||||
The controller has a built-in OUI resolver for MAC addresses. The GW will periodically load this file to obtain the latest.
|
||||
This is ths URI for this file.
|
||||
```properties
|
||||
oui.download.uri = https://standards-oui.ieee.org/oui/oui.txt
|
||||
```
|
||||
|
||||
## Data-model Source
|
||||
### Data-model Source
|
||||
The gateway can make use of the latest uCentral data-model or use the built-in model. These 2 parameters allow you to
|
||||
choose which method you want. If you select the internal method, the URI is ignored. If for some reason you choose
|
||||
the on-line data-model from the URI and the URI is not reachable, the system will fall back on the internal model.
|
||||
@@ -203,7 +104,7 @@ ucentral.datamodel.internal = true
|
||||
ucentral.datamodel.uri = https://raw.githubusercontent.com/Telecominfraproject/wlan-ucentral-schema/main/ucentral.schema.json
|
||||
```
|
||||
|
||||
## Command Manager
|
||||
### Command Manager
|
||||
The command manager is responsible for managing command sent and responses received with the APs. Several parameters allow you
|
||||
to fine tune its behaviour. Unless you have some particular reasons to change tem the defaults are usually just fine.
|
||||
```properties
|
||||
@@ -212,27 +113,26 @@ command.retry = 120
|
||||
command.janitor = 120
|
||||
command.queue = 30
|
||||
```
|
||||
### command.timeout
|
||||
#### command.timeout
|
||||
How long will the GW wait in seconds before considering a commands has timed out.
|
||||
|
||||
### command.retry
|
||||
#### command.retry
|
||||
How long between command retries.
|
||||
|
||||
### command.janitor
|
||||
#### command.janitor
|
||||
How long between outstanding RPC clean-ups.
|
||||
|
||||
### command.queue
|
||||
#### command.queue
|
||||
How long should te gateway wait between running its queue.
|
||||
|
||||
## IP to Country Parameters
|
||||
### IP to Country Parameters
|
||||
The controller has the ability to find the location of the IP of each Access Points. This uses an external IP location service. Currently,
|
||||
the controller supports 3 services. Please not that these services will require to obtain an API key or token, and these may cause you to incur
|
||||
the controller supports 3 services. Please note that these services will require to obtain an API key or token, and these may cause you to incur
|
||||
additional fees. Here is the list of the services supported:
|
||||
- ip2location: ip2location.com
|
||||
- ipdata: ipdata.co
|
||||
- ipinfo: ipinfo.io
|
||||
|
||||
|
||||
```properties
|
||||
iptocountry.default = US
|
||||
iptocountry.provider = ipinfo
|
||||
@@ -243,20 +143,20 @@ iptocountry.ipdata.apikey =
|
||||
iptocountry.ip2location.apikey =
|
||||
```
|
||||
|
||||
### iptocountry.default
|
||||
#### iptocountry.default
|
||||
This is the country code to be used if no information can be found at one of the providers or you have not configured any of the providers.
|
||||
|
||||
### iprocountry.provider
|
||||
#### iptocountry.provider
|
||||
You must select onf of the possible services and the fill the appropriate token or api key parameter.
|
||||
|
||||
## Provisioning link
|
||||
### Provisioning link
|
||||
This parameter tells the controller how to behave when it receives a request from a device for the first time. In this case, we tell
|
||||
the controller to look at the provisioning service first, then apply any local configurations.
|
||||
```properties
|
||||
autoprovisioning.process = prov,default
|
||||
```
|
||||
|
||||
## Restricted Device Signature Manager
|
||||
### Restricted Device Signature Manager
|
||||
If are using restricted devices, then you can include different keys for each vendor who provided
|
||||
you with their information. This allows the controller to automatically sign requests to the device. You can have as many vendors
|
||||
as it is necessary.
|
||||
@@ -270,14 +170,14 @@ signature.manager.1.key.private = $OWGW_ROOT/certs/signatures/test2-private-key.
|
||||
signature.manager.1.vendor = test2
|
||||
```
|
||||
|
||||
## OWLS Simulator ID
|
||||
### OWLS Simulator ID
|
||||
If you plan on using OWLS (OpenWifi Load Simulator), then you will need to put your Simulator ID right here.
|
||||
This ID must be obtained from TIP.
|
||||
```properties
|
||||
simulatorid = 53494dFFEEDD
|
||||
```
|
||||
|
||||
## RTTY Service
|
||||
### RTTY Service
|
||||
The controller comes with the ability to run an RTTY service. The service can either be internal (the prefered choice)
|
||||
or external. If you decide to use the internal RTTY, the you only need to specify `rtty.internal = true`. If you choose
|
||||
to use an external RTTY, you must specify the remainder of the parameters.
|
||||
@@ -293,7 +193,7 @@ rtty.viewport = 5913
|
||||
rtty.assets = $OWGW_ROOT/rtty_ui
|
||||
```
|
||||
|
||||
## RADIUS proxy config
|
||||
### RADIUS proxy config
|
||||
If you are going to use the buil-in RADIUS proxy service, you need to enable this parameter and provide
|
||||
the ports for you PROXY.
|
||||
```properties
|
||||
@@ -303,94 +203,7 @@ radius.proxy.authentication.port = 1812
|
||||
radius.proxy.coa.port = 3799
|
||||
```
|
||||
|
||||
## 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 = 16102
|
||||
```
|
||||
|
||||
## 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 = gateway
|
||||
openwifi.kafka.client.id = gateway1
|
||||
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 tunning. In the case `gateway`
|
||||
### 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 = devices.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 = gateway
|
||||
storage.type.postgresql.password = gateway_password
|
||||
storage.type.postgresql.database = gateway
|
||||
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 = gateway
|
||||
storage.type.postgresql.password = gateway_password
|
||||
storage.type.postgresql.database = gateway
|
||||
storage.type.mysql.port = 3306
|
||||
storage.type.mysql.connectiontimeout = 60
|
||||
```
|
||||
|
||||
## Auto Archiver Parameters
|
||||
### Auto Archiver Parameters
|
||||
The auto archiver is responsible for removing all stale data. The default is to remove old data after 7 days.
|
||||
```properties
|
||||
archiver.enabled = true
|
||||
@@ -405,10 +218,192 @@ archiver.db.3.name = commandlist
|
||||
archiver.db.3.keep = 7
|
||||
```
|
||||
|
||||
## Logging Parameters
|
||||
The controller 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.
|
||||
## 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 = $OWGW_ROOT/certs/restapi-ca.pem
|
||||
openwifi.restapi.host.0.address = *
|
||||
openwifi.restapi.host.0.port = 16004
|
||||
openwifi.restapi.host.0.cert = $OWGW_ROOT/certs/restapi-cert.pem
|
||||
openwifi.restapi.host.0.key = $OWGW_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 = $OWGW_ROOT/certs/restapi-ca.pem
|
||||
openwifi.internal.restapi.host.0.address = *
|
||||
openwifi.internal.restapi.host.0.port = 17004
|
||||
openwifi.internal.restapi.host.0.cert = $OWGW_ROOT/certs/restapi-cert.pem
|
||||
openwifi.internal.restapi.host.0.key = $OWGW_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 = $OWGW_ROOT/certs/restapi-key.pem
|
||||
openwifi.service.key.password = mypassword
|
||||
openwifi.system.data = $OWGW_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 = 16102
|
||||
```
|
||||
|
||||
### 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 = gateway
|
||||
openwifi.kafka.client.id = gateway1
|
||||
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 `gateway`
|
||||
### 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 = gateway.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 = gateway
|
||||
storage.type.postgresql.password = gateway
|
||||
storage.type.postgresql.database = gateway
|
||||
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 = gateway
|
||||
storage.type.postgresql.password = gateway
|
||||
storage.type.postgresql.database = gateway
|
||||
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
|
||||
|
||||
12
README.md
12
README.md
@@ -346,12 +346,12 @@ or [python](https://github.com/Telecominfraproject/wlan-cloud-ucentralgw/blob/ma
|
||||
More scripts will be added in the future.
|
||||
|
||||
## Firewall Considerations
|
||||
| Port | Description | Configuratble |
|
||||
| :--- | :--- | :---: |
|
||||
| 15002 | Default port from the devices to the OWGW | yes |
|
||||
| 16002 | Default port for REST API Access to the OWGW | yes |
|
||||
| 5912 | Default port for RTTY connection | yes |
|
||||
| 5913 | Defailt port for RTTY connection | yes |
|
||||
| Port | Description | Configurable |
|
||||
| :--- | :--- |:------------:|
|
||||
| 15002 | Default port from the devices to the OWGW | yes |
|
||||
| 16002 | Default port for REST API Access to the OWGW | yes |
|
||||
| 5912 | Default port for RTTY connection | yes |
|
||||
| 5913 | Defailt port for RTTY connection | yes |
|
||||
|
||||
## Kafka topics
|
||||
Toe read more about Kafka, follow the [document](https://github.com/Telecominfraproject/wlan-cloud-ucentralgw/blob/main/KAFKA.md)
|
||||
|
||||
Reference in New Issue
Block a user