Package: sdxdatamodel
Table of ContentsHow to ContributeAW-SDX Data ModelHow to test and useAW-SDX Accompanying ProjectslHow to ContributeEnsure you're able to run the existing code in your owndevelopment environment.Create a descriptiveGitHub issuethat outlines what feature you plan to contribute.Clone the repository, and start from the most recent version of thedevelop branch.Name your branch using the Github issue number as a prefix along with a brief name that corresponds to your feature (e.g.,8-how-to-contribute).Once satisfied with your completed and tested work, submit apull requestagainst thedevelopbranch so that your code can be reviewed by the team.Notes:Do not create a pull request against themasterbranch. Themasterbranch is considered the production branch and must always remain stable. Themasterbranch is periodically updated from the contents of thedevelopbranch at the conclusion of a development cycle.Do not put any content (css, js, images, etc.) in the mainstaticdirectory, instead create a directory namedstaticin your app that can be imported into the mainstaticdirectory using themanage.py collectstaticcall.Use clear and concise naming conventions for apps, classes, functions, variables, etc. Ideally others will be able to reuse your work, and the more clear and concise your code is, the easier it is to reuse it.Include easy to understand documentation and complete unit/functional tests for each new feature being introduced to the project. (pytestis the recommended framework to use for testing).AW-SDX Data ModelSystemEach domain, proxied by the customized SDX-LC who communicates between the SDX-controller and the domain (1) provisioning system (eg, Kytos) and (2) monitoring system (BAPM).Topology ModelsIn the whole SDX system, two types of topology models are needed:Domain substrate description modelIt's used by the intra-domain prvisioning system.Domain declaration/advertisement modelBased on the information from the domain provisioning system, tt's abstracted/generated/passed by the SDX-LC to the SDX-controller for inter-domain topology assembly to support (a) inter-domain path computation; and (b) inter-domain path monitoring and reconfiguration. It would consist of three types of information: (1) Topology abstraction; (2) network resources available for inter-domain connections and their QoS metrics (eg, bw, latency, packet loss, vlan ranges, etc); (3) switching capability (eg, vlan, Q-in-Q, etc).There is aserviceattribute in the topology object, which is an object that describes domain service meta information like owner, provisiong system, and security features.Domain topology and state updateTopology update:On the events of addition, removal, and/or maintenance of ports, nodes, links, an updated domain topology with version and timestamp needs to be sent to the LC and subsequently the SDX controller. A new topology object is supposed to be generated and passed on to the SDX controller.Topology link state updateThis set of updates mainly come from the domain monitoring system which is supposed to stream periodical measurement information on the links, like bandwidth, latency, and packet loss. A new link object is supposed to generated and pass on to the SDX controller.Topology description schemasThere are defined in theschemasubfolder. Some attributes of each objects are requied (Can be found in the API definition) while some are optional. Two attributes are worth of mentioning: (1) In theserviceobject, there is avenderattribute for the domain to list device vendors that are NOT in its domain, (2) in the topology, link, node, and port objects, there is anprivateattibute for the domain to list attributes that need to kept private.:wqUsageRunning testsRun tests with:python -m pip install -r test-requirements.txt
python -m unittestIf you want to run some specific tests:python -m unittest -v tests.test_topology_handler
python -m unittest -v tests.test_topology_validatorInstallpip install -r requirements.txtpip install -e .Accompanying AW-SDX Projects