+.. _topoprocessing-dev-guide:
+
Topology Processing Framework Developer Guide
=============================================
underlay topologies and underlay items from overlay items. The required
information for Link Computation is provided via the Link Computation
model in
-(`topology-link-computation.yang <https://git.opendaylight.org/gerrit/gitweb?p=topoprocessing.git;a=blob;f=topoprocessing-api/src/main/yang/topology-link-computation.yang;hb=refs/heads/stable/beryllium>`__).
+(`topology-link-computation.yang <https://git.opendaylight.org/gerrit/gitweb?p=topoprocessing.git;a=blob;f=topoprocessing-api/src/main/yang/topology-link-computation.yang;hb=refs/heads/stable/boron>`__).
Link Computation Functionality
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
- output model
-.. code:: yang
+.. code::
leaf output-model {
type identityref {
- overlay topology with new nodes
-.. code:: yang
+.. code::
container node-info {
leaf node-topology {
- underlay topologies with original links
-.. code:: yang
+.. code::
list link-info {
key "link-topology input-model";
Rendering to the inventory-rendering model
- **Important**
+.. important::
When implementing your version of the topology-rendering model in
the Topology Processing Framework, the source file of the model
add another identity item to topology-correlation.yang file. For our
inventory-rendering model identity looks like this:
-.. code:: yang
+.. code::
identity inventory-rendering-model {
description "inventory-rendering.yang";
Step2 - Module and Feature Creation
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
- **Important**
+.. important::
This and following steps are based on the `model specific
approach <#_model_specific_approach>`__ in the Topology Processing
Inventory Rendering). In the case of the provider class, we put the
abbreviation at the end.
- **Important**
+.. important::
- In the next sections, we use the terms TopologyRequestListener,
TopologyRequestHandler, etc. without a prepended or appended
the rendering operator just wraps each received UnderlayItem to
OverlayItem and sends them to write.
- **Important**
+.. important::
For purposes of topology rendering from inventory to
network-topology, there are misused fields in UnderlayItem as
You can find API examples on `this wiki
page <https://wiki.opendaylight.org/view/Topology_Processing_Framework:Developer_Guide:REST_API_Specification>`__.
-