docs/release-notes/projects/sxp.rst

   1 ==========================================
   2 Scalable-Group Tag eXchange Protocol (SXP)
   3 ==========================================
   4
   5 Major Features
   6 ==============
   7
   8 odl-sxp-api
   9 -----------
  10
  11 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=sxp.git;a=blob;f=features/odl-sxp-api/pom.xml;hb=refs/heads/stable/nitrogen
  12 * **Feature Description:**  This feature provides models based on
  13   `RFC <https://tools.ietf.org/pdf/draft-smith-kandula-sxp-05.pdf>`_.
  14 * **Top Level:** No
  15 * **User Facing:** No
  16 * **Experimental:** Yes
  17 * **CSIT Test:** N/A
  18
  19 odl-sxp-core
  20 ------------
  21
  22 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=sxp.git;a=blob;f=features/odl-sxp-core/pom.xml;hb=refs/heads/stable/nitrogen
  23 * **Feature Description:**  This feature performs tasks for managing SXP
  24   devices and provides the implementation of
  25   `RFC <https://tools.ietf.org/pdf/draft-smith-kandula-sxp-05.pdf>`_.
  26 * **Top Level:** No
  27 * **User Facing:** No
  28 * **Experimental:** Yes
  29 * **CSIT Test:** N/A
  30
  31 odl-sxp-controller
  32 ------------------
  33
  34 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=sxp.git;a=blob;f=features/odl-sxp-controller/pom.xml;hb=refs/heads/stable/nitrogen
  35 * **Feature Description:**  This feature performs tasks regarding managing SXP
  36   devices via RESTCONF.
  37 * **Top Level:** Yes
  38 * **User Facing:** Yes
  39 * **Experimental:** Yes
  40 * **CSIT Test:** https://jenkins.opendaylight.org/releng/view/sxp/job/sxp-csit-1node-basic-all-nitrogen/
  41 * **CSIT Test:** https://jenkins.opendaylight.org/releng/view/sxp/job/sxp-csit-1node-filtering-all-nitrogen/
  42 * **CSIT Test:** https://jenkins.opendaylight.org/releng/view/sxp/job/sxp-csit-1node-topology-all-nitrogen/
  43 * **CSIT Test:** https://jenkins.opendaylight.org/releng/view/sxp/job/sxp-csit-3node-periodic-clustering-all-nitrogen/
  44
  45 odl-sxp-robot
  46 -------------
  47
  48 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=sxp.git;a=blob;f=features/odl-sxp-robot/pom.xml;hb=refs/heads/stable/nitrogen
  49 * **Feature Description:**  This is a sample feature used in CSIT testing.
  50 * **Top Level:** No
  51 * **User Facing:** No
  52 * **Experimental:** Yes
  53 * **CSIT Test:** https://jenkins.opendaylight.org/releng/view/sxp/job/sxp-csit-1node-periodic-performance-all-nitrogen/
  54
  55 odl-sxp-routing
  56 -------------
  57
  58 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=sxp.git;a=blob;f=features/odl-sxp-routing/pom.xml;hb=refs/heads/stable/nitrogen
  59 * **Feature Description:**  This feature that performs managing of SXP devices
  60   in cluster environment.
  61 * **Top Level:** Yes
  62 * **User Facing:** Yes
  63 * **Experimental:** Yes
  64 * **CSIT Test:** https://jenkins.opendaylight.org/releng/view/sxp/job/sxp-csit-3node-periodic-routing-all-nitrogen/
  65
  66
  67 Documentation
  68 =============
  69
  70 * **Installation Guide(s):**
  71
  72   * `Installation Guide <https://wiki.opendaylight.org/view/SXP:Lithium:Installation_Guide>`_
  73
  74 * **User Guide(s):**
  75
  76   * :ref:`sxp-user-guide`
  77
  78 * **Developer Guide(s):**
  79
  80   * :ref:`sxp-dev-guide`
  81
  82 Security Considerations
  83 =======================
  84
  85 * Do you have any external interfaces other than RESTCONF?
  86
  87   * Yes on port 64999 based on `SXP RFC <https://tools.ietf.org/pdf/draft-smith-kandula-sxp-05.pdf>`_ secured by TCP-MD5, optionally also with SSL.
  88
  89 * Other security issues?
  90
  91   * TCP-MD5 security option is now deprecated, and in future will replaced by TCP-AO
  92
  93 Quality Assurance
  94 =================
  95
  96 * Link to `Sonar Report <https://sonar.opendaylight.org/overview?id=45270>`_ (80%)
  97
  98 * Link to CSIT Jobs
  99
 100   * `CSIT Job basic <https://jenkins.opendaylight.org/releng/view/sxp/job/sxp-csit-1node-basic-all-nitrogen/>`_
 101   * `CSIT Job filtering <https://jenkins.opendaylight.org/releng/view/sxp/job/sxp-csit-1node-filtering-all-nitrogen/>`_
 102   * `CSIT Job topology <https://jenkins.opendaylight.org/releng/view/sxp/job/sxp-csit-1node-topology-all-nitrogen/>`_
 103   * `CSIT Job clustering <https://jenkins.opendaylight.org/releng/view/sxp/job/sxp-csit-3node-periodic-clustering-all-nitrogen/>`_
 104   * `CSIT Job performance <https://jenkins.opendaylight.org/releng/view/sxp/job/sxp-csit-1node-periodic-performance-all-nitrogen/>`_
 105   * `CSIT Job routing <https://jenkins.opendaylight.org/releng/view/sxp/job/sxp-csit-3node-periodic-routing-all-nitrogen/>`_
 106
 107 * Other manual testing and QA information
 108
 109   * N/A
 110
 111 * Testing methodology. How extensive was it? What should be expected to work?
 112   What hasn't been tested as much?
 113
 114   * `CSIT Test document 1 <https://wiki.opendaylight.org/view/File:SXP_Automated_testing.pdf>`_
 115   * `CSIT Test document 2 <https://wiki.opendaylight.org/view/File:SXP_Automated_testing_filtering.pdf>`_
 116   * `CSIT Test document 3 <https://wiki.opendaylight.org/view/File:SXP_Automated_testing_cluster.pdf>`_
 117
 118 Migration
 119 ---------
 120
 121 * Is it possible to migrate from the previous release? If so, how?
 122
 123   * Yes, no data models were changed that would break the migration.
 124
 125 Compatibility
 126 -------------
 127
 128 * Is this release compatible with the previous release?
 129
 130   * Functionality is fully backwards compatible.
 131
 132 * Any API changes?
 133
 134   * N/A
 135
 136 * Any configuration changes?
 137
 138   * feature odl-sxp-route was renamed to odl-sxp-routing
 139
 140 Bugs Fixed
 141 ----------
 142
 143 * List of bugs fixed since the previous release
 144
 145   * `Fixed BUGS <https://bugs.opendaylight.org/buglist.cgi?chfieldfrom=2017-05-25&chfieldto=2017-08-09&list_id=78466&product=sxp&query_format=advanced&resolution=FIXED>`_
 146
 147 Known Issues
 148 ------------
 149
 150 * List key known issues with workarounds
 151
 152   * N/A
 153
 154 * `Open Bugs <https://bugs.opendaylight.org/buglist.cgi?chfieldfrom=2017-05-25&chfieldto=2017-08-09&list_id=84506&product=sxp&query_format=advanced&bug_status=__open__>`_
 155
 156 End-of-life
 157 ===========
 158
 159 * List of features/APIs which are EOLed, deprecated, and/or removed in this release
 160
 161   * N/A
 162
 163 Standards
 164 =========
 165
 166 * List of standards implemented and to what extent
 167
 168   * `SXP <https://tools.ietf.org/pdf/draft-smith-kandula-sxp-05.pdf>`_ Fully implemented
 169
 170 Release Mechanics
 171 =================
 172
 173 * `Release plan <https://wiki.opendaylight.org/view/SXP:Nitrogen:Release_Plan>`_
 174
 175 * Describe any major shifts in release schedule from the release plan
 176
 177   * N/A
 178