docs/release-notes/projects/gbp.rst

   1 ======================
   2 Groupbasedpolicy (GBP)
   3 ======================
   4
   5 Major Features
   6 ==============
   7
   8 * GBP UI - Groupbasedpoilicy User Interface
   9 * Neutron Provider - maps neutron configuration to GBP service model
  10 * FaaS Renderer - maps GBP service model to the common abstraction logical network models of the Fabric As A Service
  11 * IOS-XE Renderer - maps GBP service model to IOS-XE based devices
  12 * IOvisor Renderer - maps GBP service model to agents of the IOVisor Linux Foundation project
  13 * Netconf Renderer - maps GBP service model to NETCONF based network elements
  14 * OpenFlow Overlay Renderer - enable network virtualization behavior using OpenFlow
  15 * SXP Distribution Service - enables SGT Exchange Protocol
  16 * VPP Renderer - enable network virtualization behavior for VPP devices
  17
  18 odl-groupbasedpolicy-ofoverlay
  19 ------------------------------
  20
  21 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=groupbasedpolicy.git;a=blob;f=features/odl-groupbasedpolicy-ofoverlay/src/main/feature/features.xml;h=cd8aa7f1c4a08cc4d197135674d29806f71a886e;hb=refs/heads/stable/nitrogen
  22 * **Feature Description:** Feature can be added to the base to enable a Network Virtualization behavior using OpenFlow
  23 * **Top Level:** Yes
  24 * **User Facing:** Yes
  25 * **Experimental:** Yes
  26 * **CSIT Test:** https://jenkins.opendaylight.org/releng/view/groupbasedpolicy/job/groupbasedpolicy-csit-1node-3-node-only-nitrogen/
  27 * **CSIT Test:** https://jenkins.opendaylight.org/releng/view/groupbasedpolicy/job/groupbasedpolicy-csit-1node-6node-only-nitrogen/
  28
  29 odl-groupbasedpolicy-iovisor
  30 ----------------------------
  31
  32 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=groupbasedpolicy.git;a=blob;f=features/odl-groupbasedpolicy-iovisor/src/main/feature/features.xml;h=9c3df4b13a08a90d6e9fb0d32adc1eea7520d4af;hb=refs/heads/stable/nitrogen
  33 * **Feature Description:**  This renderer maps GBP service model to agents of the IOVisor Linux Foundation project
  34 * **Top Level:** Yes
  35 * **User Facing:** Yes
  36 * **Experimental:** Yes
  37 * **CSIT Test:** N/A
  38
  39
  40 odl-groupbasedpolicy-neutronmapper
  41 ----------------------------------
  42
  43 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=groupbasedpolicy.git;a=blob;f=features/odl-groupbasedpolicy-neutronmapper/src/main/feature/features.xml;h=072eb849b39c4399863241818495ad460fb41663;hb=refs/heads/stable/nitrogen
  44 * **Feature Description:**  This renderer maps Neutron northbound configuration to GBP service model
  45 * **Top Level:** Yes
  46 * **User Facing:** Yes
  47 * **Experimental:** Yes
  48 * **CSIT Test:** https://jenkins.opendaylight.org/releng/view/groupbasedpolicy/job/groupbasedpolicy-csit-1node-openstack-liberty-openstack-nitrogen/
  49
  50 odl-groupbasedpolicy-neutron-and-ofoverlay
  51 ------------------------------------------
  52
  53 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=groupbasedpolicy.git;a=blob;f=features/odl-groupbasedpolicy-neutron-and-ofoverlay/src/main/feature/features.xml;h=57c0b759454d00aa97a18e82b31168b37b74908d;hb=refs/heads/stable/nitrogen
  54 * **Feature Description:**  Neutron and OpenFlow Overlay
  55 * **Top Level:** Yes
  56 * **User Facing:** Yes
  57 * **Experimental:** Yes
  58 * **CSIT Test:** https://jenkins.opendaylight.org/releng/view/groupbasedpolicy/job/groupbasedpolicy-csit-1node-3-node-only-nitrogen/
  59 * **CSIT Test:** https://jenkins.opendaylight.org/releng/view/groupbasedpolicy/job/groupbasedpolicy-csit-1node-6node-only-nitrogen/
  60 * **CSIT Test:** https://jenkins.opendaylight.org/releng/view/groupbasedpolicy/job/groupbasedpolicy-csit-1node-openstack-liberty-openstack-nitrogen/
  61
  62 odl-groupbasedpolicy-vpp
  63 ------------------------
  64
  65 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=groupbasedpolicy.git;a=blob;f=features/odl-groupbasedpolicy-vpp/src/main/feature/features.xml;h=05c6a72e95aa9f51c98f466da77569ffc4d9d012;hb=refs/heads/stable/nitrogen
  66 * **Feature Description:**  This renderer maps GBP service model to VPP devices
  67 * **Top Level:** Yes
  68 * **User Facing:** Yes
  69 * **Experimental:** Yes
  70 * **CSIT Test:** N/A
  71
  72 odl-groupbasedpolicy-neutron-vpp-mapper
  73 ---------------------------------------
  74
  75 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=groupbasedpolicy.git;a=blob;f=features/odl-groupbasedpolicy-neutron-vpp-mapper/src/main/feature/features.xml;h=394dd02b54093f4c8767889c3935cb1c4a18c45a;hb=refs/heads/stable/nitrogen
  76 * **Feature Description:**  Neutron Northbound services for VPP renderer
  77 * **Top Level:** Yes
  78 * **User Facing:** Yes
  79 * **Experimental:** Yes
  80 * **CSIT Test:** https://jenkins.opendaylight.org/releng/view/groupbasedpolicy/job/groupbasedpolicy-csit-1node-openstack-liberty-openstack-nitrogen/
  81
  82 odl-groupbasedpolicy-ui
  83 -----------------------
  84
  85 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=groupbasedpolicy.git;a=tree;f=features/odl-groupbasedpolicy-ui;h=af30b7c9fc6d20de755d071b2d2e3da556d7b4a5;hb=refs/heads/stable/nitrogen
  86 * **Feature Description:**  Groupbasedpolicy User Interface
  87 * **Top Level:** Yes
  88 * **User Facing:** Yes
  89 * **Experimental:** Yes
  90 * **CSIT Test:** N/A
  91
  92 odl-groupbasedpolicy-ip-sgt-distribution-service
  93 ------------------------------------------------
  94
  95 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=groupbasedpolicy.git;a=blob;f=features/odl-groupbasedpolicy-ip-sgt-distribution-service/src/main/feature/features.xml;h=f421db3463d86751dde6a161466db309bc7e33a7;hb=refs/heads/stable/nitrogen
  96 * **Feature Description:**  SXP Distribution Service
  97 * **Top Level:** Yes
  98 * **User Facing:** Yes
  99 * **Experimental:** Yes
 100 * **CSIT Test:** N/A
 101
 102 odl-groupbasedpolicy-ios-xe
 103 ---------------------------
 104
 105 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=groupbasedpolicy.git;a=blob;f=features/odl-groupbasedpolicy-ios-xe/src/main/feature/features.xml;h=b2498a4da528d8f43da84778516ba0677a0fbafe;hb=refs/heads/stable/nitrogen
 106 * **Feature Description:**  This renderer maps GBP service model to IOS-XE devices
 107 * **Top Level:** Yes
 108 * **User Facing:** Yes
 109 * **Experimental:** Yes
 110 * **CSIT Test:** N/A
 111
 112 odl-groupbasedpolicy-sxp-ep-provider
 113 ------------------------------------
 114
 115 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=groupbasedpolicy.git;a=blob;f=features/odl-groupbasedpolicy-sxp-ep-provider/src/main/feature/features.xml;h=4b3aa65f93776134d75e7c76305ca23300043f98;hb=refs/heads/stable/nitrogen
 116 * **Feature Description:**  SXP integration: Endpoint provider
 117 * **Top Level:** Yes
 118 * **User Facing:** Yes
 119 * **Experimental:** Yes
 120 * **CSIT Test:** N/A
 121
 122 odl-groupbasedpolicy-sxp-ise-adapter
 123 ------------------------------------
 124
 125 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=groupbasedpolicy.git;a=blob;f=features/odl-groupbasedpolicy-sxp-ise-adapter/src/main/feature/features.xml;h=14559f62741cee2809f92c43a27eb517a5fbef79;hb=refs/heads/stable/nitrogen
 126 * **Feature Description:**  SXP integration: ISE adapter
 127 * **Top Level:** Yes
 128 * **User Facing:** Yes
 129 * **Experimental:** Yes
 130 * **CSIT Test:** N/A
 131
 132 Documentation
 133 =============
 134
 135 * **Installation Guide(s):**
 136
 137   * `Groupbasedpolicy Installation Guide <https://wiki.opendaylight.org/view/Group_Based_Policy_(GBP)/Installation_guide>`_
 138
 139 * **User Guide(s):**
 140
 141   * :ref:`gbp-user-guide`
 142
 143 Security Considerations
 144 =======================
 145
 146 * No other external interfaces than RESTCONF
 147 * No known security issues
 148
 149 Quality Assurance
 150 =================
 151
 152 `Sonar report (64.2%) <https://sonar.opendaylight.org/overview?id=51201>`_
 153
 154 Groupbasedpolicy CSIT:
 155
 156 * https://jenkins.opendaylight.org/releng/view/groupbasedpolicy/job/groupbasedpolicy-csit-1node-3-node-all-nitrogen/
 157 * https://jenkins.opendaylight.org/releng/view/groupbasedpolicy/job/groupbasedpolicy-csit-1node-6node-all-nitrogen/
 158 * https://jenkins.opendaylight.org/releng/view/groupbasedpolicy/job/groupbasedpolicy-csit-1node-openstack-newton-openstack-nitrogen/
 159 * https://jenkins.opendaylight.org/releng/view/groupbasedpolicy/job/groupbasedpolicy-csit-3node-clustering-all-nitrogen/
 160
 161 Other manual testing and QA information
 162
 163 * GBP devstack demo
 164 * GBP-SFC demo
 165 * VPP demo
 166
 167 Guides about how to run demo can be found on GBP wiki under `Demo <https://wiki.opendaylight.org/view/Group_Based_Policy_(GBP)/Consumability/Demo>`_
 168
 169 Migration
 170 ---------
 171
 172 Migration from previous releases is not supported.
 173
 174 Compatibility
 175 -------------
 176 * Is this release compatible with the previous release?
 177
 178   Yes
 179
 180 * Any API changes?
 181
 182   N/A
 183
 184
 185 * Any configuration changes?
 186
 187   N/A
 188
 189 Bugs Fixed
 190 ----------
 191
 192 * `Fixed Bugs <https://bugs.opendaylight.org/buglist.cgi?bug_status=RESOLVED&chfield=%5BBug%20creation%5D&chfieldfrom=2017-05-25&chfieldto=2017-08-14&list_id=84715&product=groupbasedpolicy&query_format=advanced&resolution=FIXED>`_
 193
 194 Known Issues
 195 ------------
 196
 197 * List key known issues with workarounds
 198
 199   N/A
 200
 201 * `Open Bugs <https://bugs.opendaylight.org/buglist.cgi?bug_status=CONFIRMED&bug_status=OPEN&bug_status=IN_PROGRESS&chfield=%5BBug%20creation%5D&chfieldfrom=2017-05-25&chfieldto=2017-08-14&list_id=84718&product=groupbasedpolicy&query_format=advanced&resolution=--->`_
 202
 203 End-of-life
 204 ===========
 205
 206 * List of features/APIs which are EOLed, deprecated, and/or removed in this release
 207
 208   N/A
 209
 210 Standards
 211 =========
 212
 213 * List of standards implemented and to what extent
 214
 215   N/A
 216
 217 Release Mechanics
 218 =================
 219
 220 * `Release plan <https://wiki.opendaylight.org/view/Group_Based_Policy_(GBP)/Releases/Nitrogen/Release_plan>`_
 221
 222 * Describe any major shifts in release schedule from the release plan
 223
 224   N/A