Hi all,
Dushani and I are working on Config Assist for ESB and IS. The basic
objective of the tool is to validate the configurations done by a user when
handling support issues.
Based on the implementation of the current tool[1],[2] done for APIM by
Sewmini and Nipun, we came up with the following design for the generalized
version to support ESB and IS (and other products in the future).
We initially support a selected set of configuration files which can be
extended later. And we are also planning on conducting an incident analysis
to prioritize the files and configurations. Please refer Mail thread: *Config
Assist for ESB and IS *for more information.
The knowledge base consists of the parameters that are checked against
during the validation process[3],[4].
The KB model used is as follows. The previous KB model was used with minor
modifications to the dependencies and cross references.
1.
xpath - xpath to obtain the value from the config file
2.
default - default value defined in the config file
3.
mandatory - in which nodes the configuration is mandatory
4.
parsableValues - array of acceptable values
[<valueOne>, <valueTwo>]
5.
regex - regex to be validated against
6.
dependencies - If current node is available, the dependencies should
also be available
7.
crossReferences- where the value should be duplicated
[ {file: <fileName>, xpath: <xpath>} ]
An example json:
"/Server/OAuth/RefreshTokenValidityPeriod": {
"xpath": "/Server/OAuth/RefreshTokenValidityPeriod",
"default": 84600,
"mandatory": ["IS"],
"passableValues": [],
"regex": "^[1-9]\\d*$",
"dependencies": [
"/Server/OAuth/TimestampSkew"
],
"crossReferences": [
{
"file": "conf/identity/abc.xml",
"xpath": "/Server/OAuth/TimestampSkew"
}
]
}
The current output is a set of log records which can be updated with
suggestions.
We appreciate any comments and suggestions for this.
[1] - Config Assist for APIM - https://docs.google.com/docume
nt/d/1wINIoJmXrsFCeeEBTHNtqRnkiA8vd8tcxhiGNdSPJ5E/edit
[2] - Implementation of Config Assist for APIM - https://github.com/wso2/
internal-apps/tree/master/apps/support-tools/apim-config-validator
[2] - KB for ESB - https://docs.google.com/spreadsheets/d/1GY8XO03_
FGNuhLieC0US1nZ7fmB3UyBBY2OMMAxJzio/edit?usp=sharing
[3] - KB for IS -
https://docs.google.com/spreadsheets/d/19Etf0aTXGc8SGZvsx8Oo_HDt-S0YdzvxsL0Ml9GQgnc/edit?usp=sharing
Thanks,
Best Regards,
--
*Sachithra Dangalla*
Software Engineer | WSO2
Mobile : +94 71 3700 656 <%2B%2094%2071%203700656>
_______________________________________________
Architecture mailing list
[email protected]
https://mail.wso2.org/cgi-bin/mailman/listinfo/architecture
