scottk/wlan-cloud-owprov
1
0
Fork 0
mirror of https://github.com/Telecominfraproject/wlan-cloud-owprov.git synced 2025-10-29 09:42:38 +00:00
Code Issues Packages Projects Releases 10 Wiki Activity

Update framework.

Browse Source
This commit is contained in:
stephb9959
2022-02-05 23:20:34 -08:00
parent d0bf94f7ef
commit 61a19b167a
2 changed files with 55 additions and 33 deletions
Download Patch File Download Diff File Expand all files Collapse all files

37
OPENWIFI.md Normal file
View File

@@ -0,0 +1,37 @@
# OpenWiFi integration flags
## Default Device Configuration from provisioning
In order to enable the GW to provide default configurations from the provisioning service,
the GW must have the following configuration:
```
autoprovisioning.process = prov,default
```
This will tell the GW to ask provisioning for the configuration file. If no file exists, it will use the default configuration file.
```
autoprovisioning.process = default
```
This will tell the GW to only use default file configurations. This is the default.
## Automatic Firmware Management
### FMS configuration
In order to have FMS update devices automatically or follow the update policy, the following must be set
in the FMS configuration file.
```
autoupdater.enabled = true
```
The default value is `false`
### Provisioning configuration
The default settings can be set in the Provisioning service configuration:
```
firmware.updater.upgrade = false
firmware.updater.releaseonly = false
```
#### firmware.updater.upgrade
This selects whether upgrades are allowed by default or not. The default is `false`.
#### firmware.updater.releaseonly
The selects whether upgrades should consider all released firmware or just firmware marked as release. The default is `false`.
### Firmware upgrade rules
Th default rules are only used when no rules are set at the entity, venue, or device level. These settings always supresede aany default values.

51
README.md
View File

@@ -46,39 +46,24 @@ You may modify the following fields in the POST
- You may include an array of devices UUIDs - You may include an array of devices UUIDs
- Topology and design cannot be set - Topology and design cannot be set
### Modification rules ## Geocoding
To support geocoding help, you need to configuration the following in the configuration file. Geocoding is used
when creating location and when reporting analytics.
```
## Management policy geocodeapi = google
google.apikey = **********************************
```json
{
"default" : [],
"acls" : [
{
"roles" : [ uuid1, uuid2, uuid3 ],
"access" : [ READ, WRITE, ... ]
} ,
{
"roles" : [ ... ],
"access" : [ ... ]
}
]
}
``` ```
Currently, only google Geocoding is supported. Additional methods may be added in the future.
## Management roles ## Default firmware management rules
Management roles can be created using UUIDs from the SEC service. SEC service may ask prov if deleting a user FMS is already integrated with OpenWifi. In order to allow it to upgrade devices automatically, you should
is OK. PROV should answer with username in use or something like this. set the following values.
```
Management roles are created by adding UUIDs into a group. Then that UUID may be used in any management firmware.updater.upgrade = <true/false>
policy. firmware.updater.releaseonly = <true/false>
```
Management roles must have a quick way to evaluate all the roles a user has. This is important for ### firmware.updater.upgrade
speed. Roles ddo not use subscribers. Should FMS attempt to upgrade devices by default.
So read all the roles, cross ref all the users sp you can apply access rules against a resource very quickly.
If a user is part of 2 roles, then the access will be agregate. if NONE is found, then NONE wins.
### firmware.updater.releaseonly
Should only RC software be used during upgrades.