Skip to content

Latest commit

 

History

History
121 lines (108 loc) · 4.23 KB

Developer tutorial.md

File metadata and controls

121 lines (108 loc) · 4.23 KB

Developer Tutorial

Instructions and examples to help you get statrted.

Follow the step-by-step instructions, you can build a mediator project to translate the YANG-based messages to target form what you want.

Prerequisites

  • Python develop environment(python>=3.6)
  • Python IDE e.g. PyCharm (optional)
  • Be familiar with python coding

Pull sample code from github

$ git clone https://github.com/icanlab/mediator_example.git

Install requirement.txt

Execute the command below in root dir

$ pip install -r requirement.txt

Patch the pyangbind.patch in root directory

There are three files modified in pyangbind, including serialise.py yangtypes.py in lib dir and pybind.py in plugin dir

$ pacth -p1 < pyangbind.patch

Develop your own translation scripts

Take the ietf-interfaces translation to huawei-ifm for example

  • create translation_pack dir in your workspace
$ mkdir translation_pack
  • use pyangbind to transfer YANG model to pyangbind obj
$ export PYBINDPLUGIN=`/usr/bin/env python -c \
'import pyangbind; import os; print ("{}/plugin".format(os.path.dirname(pyangbind.__file__)))'`
$ $ pyang --plugindir $PYBINDPLUGIN -f pybind -o ietf_interfaces_binding.py yang_modules/ietf-interfaces.yang yang_modules/ietf-ip.yang
  • Parameters
    • $PYBINDPLUGIN is the location that was exported from the above command.
    • ietf_interfaces_binding.py is the desired output file.
    • yang_modules/ietf-interfaces.yang is the path to the YANG module that bindings are to be generated for.

  • above step will get two python files

    • ietf_interfaces_binding.py which defines the classes according to YANG model
    • _translate_ietf_interfaces_obj.py which provides the translation template

  • add mapping logic in translation template(take ietf-interfaces to huawei-ifm for example):

    • First, new hauwei_ifm() as translated_obj
    translated_yang_obj = huawei_ifm()

list, innerobj = _translate__interfaces(input_yang_obj.interfaces, translated_yang_obj)
    • Then, call through different child funtions to complete the translate logic
        for k, listInst in input_yang_obj.interface.iteritems():
    interface_obj = translated_yang_obj.ifm.interfaces.interface.add(name=k)
    inner_obj = _translate__interfaces_interface(listInst, interface_obj)
    # ipv4 = _translate__interfaces_interface_ipv4(listInst,interface_obj)
    list_obj.append(translated_yang_obj)

Build your register.yml and pack the translation files

  • register.yml example:
---
trans_info:
  vendor:
    huawei
  product:
    route
  type:
    huaweios
  version:
    v1
trans_point_path:
  /ietf-interfaces:interfaces
script_name:
  _translate_ietf_interfaces_obj
binding_name:
  ietf_interfaces_binding
module_name:
  ietf_interfaces
  • pack the translation files, including:
    • _translate_ietf_interfaces_obj.py
    • ietf_interfaces_binding.py
    • huawei_ifm_binding.py
    • register.yml

Use the translation scripts you developed in mediator framework

  • enter the mediator_server dir and execute the unpack.py
python unpack.py your_workspace/translation_pack.zip

where the your_workspace/translation_pcak.zip is the the direcoty of translation scripts you developed, unpack support zip and rar form.

  • start up the mediator server, then scan.py will be execute to copy your translation srcipts into target directory automatically, and generate the register.py
python -m mediator_server
  • you can check your translation script if works by constrcting the XML input like this:
<config xmlns:xc=\"urn:ietf:params:xml:ns:netconf:base:1.0\">
    <interfaces xmlns="urn:ietf:params:xml:ns:yang:ietf-interfaces">
        <interface xc:operation="merge">
            <name>GigabitEthernet 3/0/1</name>
            <type xmlns:ianaift="urn:ietf:params:xml:ns:yang:iana-if-type">ianaift:ethernetCsmacd</type>
            <ipv4 xmlns="urn:ietf:params:xml:ns:yang:ietf-ip">
                <address xmlns:nc="urn:ietf:params:xml:ns:netconf:base:1.0" xc:operation="create">
                <ip>192.0.3.1</ip>
                <prefix-length>32</prefix-length>
                </address>
            </ipv4>
        </interface>
    </interfaces>
</config>