mirror of
https://github.com/Telecominfraproject/ols-ucentral-schema.git
synced 2026-01-27 10:21:47 +00:00
7bca1f897a
During our MCLAG feature development, we identified that the current mclag-group schema only considers the LACP-based use case. Since Edgecore switches only support MLAG on static trunk interfaces, we currently have no way to specify static trunk parameters within the existing schema. To address this limitation, we would like to propose adding a new field, trunk-id, to the mclag-group definition:
uCentral Schema
Collection of JSON schemas and ucode template (utpl) files used by uCentral for validating the data model and rendering incoming configuration JSON into UCI batch sequences.
This software is a part of the OpenWiFi AP NOS.
Building
Dependencies
In order to run the test cases you will need the following tools:
- ucode
- ucentral-jsonschema
- jsonlint-php
- pip3 install jsonschema2md
- pip3 install json-schema-for-humans
- pip3 install python-json2yaml
Unit testing
./run_tests.sh
Documentation
JSDoc is used to generate API documentation
with a ucode transpiler (ucode-transpiler.js), configured by jsdoc.conf.json.
Additional JSON schema docs are generated using
json-schema-for-humans via
the script generate.sh.
Developer Notes
Generated documentation
- JSDoc: https://ucentral.io/docs/
schemaobject: http://ucentral.io/docs/ucentral-schema.htmlstateobject: https://ucentral.io/docs/ucentral-state.html
Installed files
The following ucode scripts are installed to the AP:
schemareader.uc- autogenerated schema readerrenderer/*- renderer sources and templatescommand/*- predefined command implementations, e.g. invoked by ucentral-clientsystem/*- scripts to generate system information (e.g. state, telemetry, health, capabilities)