docs/release-notes/projects/ttp.rst

   1 ===================
   2 Table Type Patterns
   3 ===================
   4
   5 Major Features
   6 ==============
   7
   8 odl-ttp-model
   9 -------------
  10
  11 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=ttp.git;a=blob;f=features/features-ttp/src/main/features/features.xml;hb=stable/nitrogen
  12 * **Feature Description:**  Provides a YANG model for describing
  13   `ONF TTP 1.0 <https://www.opennetworking.org/images/stories/downloads/sdn-resources/onf-specifications/openflow/OpenFlow%20Table%20Type%20Patterns%20v1.0.pdf>`_
  14   Table Type Patterns (TTPs) in JSON as well as a database of TTPs and an
  15   augmentation adding supported and active TTPs on OpenFlow nodes.
  16 * **Top Level:** Yes
  17 * **User Facing:** Yes
  18 * **Experimental:** Yes
  19 * **CSIT Test:** None.
  20
  21 TTP CLI Tools
  22 -------------
  23
  24 * **Feature URL:** The Nitrogen executable jar can be found here: https://nexus.opendaylight.org/content/repositories/public/org/opendaylight/ttp/parser/0.5.0-Nitrogen/parser-0.5.0-Nitrogen-jar-with-dependencies.jar
  25 * **Feature Description:**  Provides stand-alone command line tools to validate
  26   and interact with TTPs in XML or JSON.
  27 * **Top Level:** Yes
  28 * **User Facing:** Yes
  29 * **Experimental:** Yes
  30 * **CSIT Test:** None.
  31
  32 Documentation
  33 =============
  34
  35 Please provide the URL to each document at docs.opendaylight.org. If the
  36 document is under review, provide a link to the change in Gerrit.
  37
  38 * **User Guide(s):**
  39
  40   * :ref:`ttp_cli_tools_user_guide`
  41
  42 * **Developer Guide(s):**
  43
  44   * :ref:`ttp_cli_tools_dev_guide`
  45   * :ref:`ttp_model_dev_guide`
  46
  47 Security Considerations
  48 =======================
  49
  50 * Do you have any external interfaces other than RESTCONF?
  51
  52   * No.
  53
  54 * Other security issues?
  55
  56   * None.
  57
  58 Quality Assurance
  59 =================
  60
  61 * `Link to Sonar Report <https://sonar.opendaylight.org/overview?id=20096>`_ (43.3% Test Coverage)
  62 * No CSIT testing.
  63 * There was minimal manual testing in Nitrogen, but also there were no changes
  64   beyond keeping up-to-date with changes in upstream projects. Unit tests cover
  65   the basics of the model.
  66
  67 Migration
  68 ---------
  69
  70 * Is it possible to migrate from the previous release? If so, how?
  71
  72   While it should be possible to export all TTP-related information by doing
  73   RESTCONF GETs and then import it by doing RESTCONF PUTs after the fact, this
  74   has not been tested and isn't officially supported.
  75
  76 Compatibility
  77 -------------
  78
  79 * Is this release compatible with the previous release?
  80
  81   Yes. There have been no code changes except to tolerate changes in upstream
  82   projects.
  83
  84 * Any API changes?
  85
  86   No. No changes in models or APIs.
  87
  88 * Any configuration changes?
  89
  90   No. The TTP project has no configuration.
  91
  92 Bugs Fixed
  93 ----------
  94
  95 None fixed.
  96
  97 Known Issues
  98 ------------
  99
 100 The TTP YANG model does not match the ONF TTP JSON precisely. Exact details are
 101 documented in the `TTP model YANG
 102 <https://git.opendaylight.org/gerrit/gitweb?p=ttp.git;a=blob;f=ttp-model/src/main/yang/ttp.yang;hb=stable/nitrogen>`_
 103 file.
 104
 105 `Open Bugs <https://bugs.opendaylight.org/buglist.cgi?component=General&list_id=79056&product=ttp&resolution=--->`_
 106
 107 End-of-life
 108 ===========
 109
 110 None.
 111
 112 Standards
 113 =========
 114
 115 `ONF TTP 1.0
 116 <https://www.opennetworking.org/images/stories/downloads/sdn-resources/onf-specifications/openflow/OpenFlow%20Table%20Type%20Patterns%20v1.0.pdf>`_
 117
 118 Release Mechanics
 119 =================
 120
 121 * `Nitrogen Table Type Patterns Release Plan
 122   <https://wiki.opendaylight.org/view/Table_Type_Patterns/Nitrogen/Release_Plan>`_
 123
 124   * This was purely a maintenance release, so no changes were planned or happened.