-
Notifications
You must be signed in to change notification settings - Fork 10
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
https://telecominfraproject.atlassian.net/browse/WIFI-12068
Signed-off-by: stephb9959 <[email protected]>
- Loading branch information
1 parent
d3639cf
commit d431e77
Showing
2 changed files
with
274 additions
and
22 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,243 @@ | ||
| # OWPROV Configuration | ||
| Here is the list of parameters you can configure in the `owprov.properties` file. | ||
|
|
||
| ## OWPROV Specific Parameters | ||
| ### Default firmware management rules | ||
| FMS is already integrated with OpenWifi. In order to allow it to upgrade devices automatically, you should | ||
| set the following values. | ||
| ```properties | ||
| firmware.updater.upgrade = <true/false> | ||
| firmware.updater.releaseonly = <true/false> | ||
| ``` | ||
| #### firmware.updater.upgrade | ||
| Should FMS attempt to upgrade devices by default. | ||
|
|
||
| #### firmware.updater.releaseonly | ||
| Should only RC software be used during upgrades. | ||
|
|
||
| ### Google Map API Key | ||
| To support geocoding help, you need to configuration the following in the configuration file. Geocoding is used | ||
| when creating location and when reporting analytics. | ||
| ```properties | ||
| geocodeapi = google | ||
| google.apikey = ******************************** | ||
| ``` | ||
|
|
||
| ### 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 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 | ||
| #iptocountry.provider = ipdata | ||
| #iptocountry.provider = ip2location | ||
| iptocountry.ipinfo.token = | ||
| iptocountry.ipdata.apikey = | ||
| iptocountry.ip2location.apikey = | ||
| ``` | ||
|
|
||
| #### 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. | ||
|
|
||
| #### iptocountry.provider | ||
| You must select onf of the possible services and the fill the appropriate token or api key parameter. | ||
|
|
||
| ## 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 = $OWPROV_ROOT/certs/restapi-ca.pem | ||
| openwifi.restapi.host.0.address = * | ||
| openwifi.restapi.host.0.port = 16004 | ||
| openwifi.restapi.host.0.cert = $OWPROV_ROOT/certs/restapi-cert.pem | ||
| openwifi.restapi.host.0.key = $OWPROV_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 = $OWPROV_ROOT/certs/restapi-ca.pem | ||
| openwifi.internal.restapi.host.0.address = * | ||
| openwifi.internal.restapi.host.0.port = 17004 | ||
| openwifi.internal.restapi.host.0.cert = $OWPROV_ROOT/certs/restapi-cert.pem | ||
| openwifi.internal.restapi.host.0.key = $OWPROV_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 = $OWPROV_ROOT/certs/restapi-key.pem | ||
| openwifi.service.key.password = mypassword | ||
| openwifi.system.data = $OWPROV_ROOT/data | ||
| openwifi.system.uri.private = https://localhost:17004 | ||
| openwifi.system.uri.public = https://ucentral.example.com:16004 | ||
| openwifi.system.uri.ui = https://provisionins-ui.example.com | ||
| openwifi.security.restapi.disable = false | ||
| openwifi.system.commandchannel = /tmp/app.ucentralprov | ||
| 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 = provisioning | ||
| openwifi.kafka.client.id = provisioning1 | ||
| 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 `provisioning` | ||
| ### 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 = provisioning.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 = provisioning | ||
| storage.type.postgresql.password = provisioning | ||
| storage.type.postgresql.database = provisioning | ||
| 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 = provisioning | ||
| storage.type.postgresql.password = provisioning | ||
| storage.type.postgresql.database = provisioning | ||
| 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 = $OWPROV_ROOT/logs | ||
| logging.level = information | ||
| logging.asynch = true | ||
| logging.websocket = false | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters