odltools Documentation

odltools needs some documentation.

Introduction to odltools

A tool to troubleshoot the NetVirt OpenDaylight OpenStack integration.

The tool can fetch mdsal model dumps, openvswitch flow dumps and extract dumps from CSIT output.xml files.

Contents:

: _contribution:

Contributing to odltools

: _examples:

odltools examples

Building a new release of odltools

Note

An experimental Makefile option is available. Use the below commands to complete all the steps listed later in this document. The make release target will create a branch <BRANCH>, tag, build and push the pypi package to pypi. The user should run the tox tests against the current branch before calling the make target.

make release <TAG> <BRANCH>

make release TAG=0.1.19 BRANCH=rel

1. Update the Version

   vi odltools/__init__.py
   git add odltools/__init__.py
   git commit -s -m "release x.y.z"
   git tags -m "release x.y.z" -a x.y.z
   

2. Run the Tests

   tox (or detox)
   

3. Release on PyPi

   python setup.py check
   python setup.py clean
   python setup.py sdist bdist_wheel upload
   

   Note

   The above commands assume a .pypirc like below will be used

   [distutils]
   index-servers =
       pypi
       testpypi
   
   [pypi]
   username = cooldude
   password = coolpw
   
   [testpypi]
   repository: https://test.pypi.org/legacy/
   username = cooldude
   password = coolpw
   

4. Test the PyPi Install

   mkvirtualenv tmptest
   pip install odltools
   python -m odltools -V
   deactivate
   rmvirtualenv tmptest
   

5. Push the Code

   git push origin HEAD:refs/for/master
   git push origin x.y.z
   

6. Verify All is Good in the World

   Check the PyPi odltools page, README, release notes, etc.