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