docs/getting-started-guide/project-release-notes/gbp-release-notes.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/features-groupedpolicy/src/main/features/features.xml;h=df5008a589f69302250b0a2450a2d262f239477f;hb=refs/heads/stable/carbon
  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-boron/
  27 * **CSIT Test:** https://jenkins.opendaylight.org/releng/view/groupbasedpolicy/job/groupbasedpolicy-csit-1node-6node-only-boron/
  28
  29 odl-groupbasedpolicy-ovssfc
  30 ---------------------------
  31
  32 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=groupbasedpolicy.git;a=blob;f=features/features-groupedpolicy/src/main/features/features.xml;h=df5008a589f69302250b0a2450a2d262f239477f;hb=refs/heads/stable/carbon
  33 * **Feature Description:** Feature can be added to the base to enable a Network Virtualization behavior using OpenFlow that integrates with the SFC project
  34 * **Top Level:** Yes
  35 * **User Facing:** Yes
  36 * **Experimental:** Yes
  37 * **CSIT Test:** https://jenkins.opendaylight.org/releng/view/groupbasedpolicy/job/groupbasedpolicy-csit-1node-3-node-only-boron/
  38 * **CSIT Test:** https://jenkins.opendaylight.org/releng/view/groupbasedpolicy/job/groupbasedpolicy-csit-1node-6node-only-boron/
  39
  40 odl-groupbasedpolicy-faas
  41 -------------------------
  42
  43 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=groupbasedpolicy.git;a=blob;f=features/features-groupedpolicy/src/main/features/features.xml;h=df5008a589f69302250b0a2450a2d262f239477f;hb=refs/heads/stable/carbon
  44 * **Feature Description:**  This renderer maps GBP service model to the common abstraction logical network models of the Fabric As A Service (FAAS). In turns, FAAS maps those abstraction models to the physical networks.
  45 * **Top Level:** Yes
  46 * **User Facing:** Yes
  47 * **Experimental:** Yes
  48 * **CSIT Test:** N/A
  49
  50 odl-groupbasedpolicy-iovisor
  51 ----------------------------
  52
  53 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=groupbasedpolicy.git;a=blob;f=features/features-groupedpolicy/src/main/features/features.xml;h=df5008a589f69302250b0a2450a2d262f239477f;hb=refs/heads/stable/carbon
  54 * **Feature Description:**  This renderer maps GBP service model to agents of the IOVisor Linux Foundation project
  55 * **Top Level:** Yes
  56 * **User Facing:** Yes
  57 * **Experimental:** Yes
  58 * **CSIT Test:** N/A
  59
  60 odl-groupbasedpolicy-netconf
  61 ----------------------------
  62
  63 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=groupbasedpolicy.git;a=blob;f=features/features-groupedpolicy/src/main/features/features.xml;h=df5008a589f69302250b0a2450a2d262f239477f;hb=refs/heads/stable/carbon
  64 * **Feature Description:**  This renderer maps GBP service model to NETCONF based network elements
  65 * **Top Level:** Yes
  66 * **User Facing:** Yes
  67 * **Experimental:** Yes
  68 * **CSIT Test:** N/A
  69
  70 odl-groupbasedpolicy-neutronmapper
  71 ----------------------------------
  72
  73 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=groupbasedpolicy.git;a=blob;f=features/features-groupedpolicy/src/main/features/features.xml;h=df5008a589f69302250b0a2450a2d262f239477f;hb=refs/heads/stable/carbon
  74 * **Feature Description:**  This renderer maps Neutron northbound configuration to GBP service model
  75 * **Top Level:** Yes
  76 * **User Facing:** Yes
  77 * **Experimental:** Yes
  78 * **CSIT Test:** https://jenkins.opendaylight.org/releng/view/groupbasedpolicy/job/groupbasedpolicy-csit-1node-openstack-liberty-openstack-boron/
  79
  80 odl-groupbasedpolicy-neutron-and-ofoverlay
  81 ------------------------------------------
  82
  83 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=groupbasedpolicy.git;a=blob;f=features/features-groupedpolicy/src/main/features/features.xml;h=df5008a589f69302250b0a2450a2d262f239477f;hb=refs/heads/stable/carbon
  84 * **Feature Description:**  Neutron and OpenFlow Overlay
  85 * **Top Level:** Yes
  86 * **User Facing:** Yes
  87 * **Experimental:** Yes
  88 * **CSIT Test:** https://jenkins.opendaylight.org/releng/view/groupbasedpolicy/job/groupbasedpolicy-csit-1node-3-node-only-boron/
  89 * **CSIT Test:** https://jenkins.opendaylight.org/releng/view/groupbasedpolicy/job/groupbasedpolicy-csit-1node-6node-only-boron/
  90 * **CSIT Test:** https://jenkins.opendaylight.org/releng/view/groupbasedpolicy/job/groupbasedpolicy-csit-1node-openstack-liberty-openstack-boron/
  91
  92 odl-groupbasedpolicy-vpp
  93 ------------------------
  94
  95 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=groupbasedpolicy.git;a=blob;f=features/features-groupedpolicy/src/main/features/features.xml;h=df5008a589f69302250b0a2450a2d262f239477f;hb=refs/heads/stable/carbon
  96 * **Feature Description:**  This renderer maps GBP service model to VPP devices
  97 * **Top Level:** Yes
  98 * **User Facing:** Yes
  99 * **Experimental:** Yes
 100 * **CSIT Test:** N/A
 101
 102 odl-groupbasedpolicy-neutron-vpp-mapper
 103 ---------------------------------------
 104
 105 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=groupbasedpolicy.git;a=blob;f=features/features-groupedpolicy/src/main/features/features.xml;h=df5008a589f69302250b0a2450a2d262f239477f;hb=refs/heads/stable/carbon
 106 * **Feature Description:**  Neutron Northbound services for VPP renderer
 107 * **Top Level:** Yes
 108 * **User Facing:** Yes
 109 * **Experimental:** Yes
 110 * **CSIT Test:** https://jenkins.opendaylight.org/releng/view/groupbasedpolicy/job/groupbasedpolicy-csit-1node-openstack-liberty-openstack-boron/
 111
 112 odl-groupbasedpolicy-ui
 113 -----------------------
 114
 115 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=groupbasedpolicy.git;a=blob;f=features/features-groupedpolicy/src/main/features/features.xml;h=df5008a589f69302250b0a2450a2d262f239477f;hb=refs/heads/stable/carbon
 116 * **Feature Description:**  Groupbasedpolicy User Interface
 117 * **Top Level:** Yes
 118 * **User Facing:** Yes
 119 * **Experimental:** Yes
 120 * **CSIT Test:** N/A
 121
 122 odl-groupbasedpolicy-ip-sgt-distribution-service
 123 ------------------------------------------------
 124
 125 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=groupbasedpolicy.git;a=blob;f=features/features-groupedpolicy/src/main/features/features.xml;h=df5008a589f69302250b0a2450a2d262f239477f;hb=refs/heads/stable/carbon
 126 * **Feature Description:**  SXP Distribution Service
 127 * **Top Level:** Yes
 128 * **User Facing:** Yes
 129 * **Experimental:** Yes
 130 * **CSIT Test:** N/A
 131
 132 odl-groupbasedpolicy-ios-xe
 133 ---------------------------
 134
 135 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=groupbasedpolicy.git;a=blob;f=features/features-groupedpolicy/src/main/features/features.xml;h=df5008a589f69302250b0a2450a2d262f239477f;hb=refs/heads/stable/carbon
 136 * **Feature Description:**  This renderer maps GBP service model to IOS-XE devices
 137 * **Top Level:** Yes
 138 * **User Facing:** Yes
 139 * **Experimental:** Yes
 140 * **CSIT Test:** N/A
 141
 142 odl-groupbasedpolicy-sxp-ep-provider
 143 ------------------------------------
 144
 145 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=groupbasedpolicy.git;a=blob;f=features/features-groupedpolicy/src/main/features/features.xml;h=df5008a589f69302250b0a2450a2d262f239477f;hb=refs/heads/stable/carbon
 146 * **Feature Description:**  SXP integration: Endpoint provider
 147 * **Top Level:** Yes
 148 * **User Facing:** Yes
 149 * **Experimental:** Yes
 150 * **CSIT Test:** N/A
 151
 152 odl-groupbasedpolicy-sxp-ise-adapter
 153 ------------------------------------
 154
 155 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=groupbasedpolicy.git;a=blob;f=features/features-groupedpolicy/src/main/features/features.xml;h=df5008a589f69302250b0a2450a2d262f239477f;hb=refs/heads/stable/carbon
 156 * **Feature Description:**  SXP integration: ISE adapter
 157 * **Top Level:** Yes
 158 * **User Facing:** Yes
 159 * **Experimental:** Yes
 160 * **CSIT Test:** N/A
 161
 162 Documentation
 163 =============
 164
 165 * **Installation Guide(s):**
 166
 167   * `Groupbasedpolicy Installation Guide <https://wiki.opendaylight.org/view/Group_Based_Policy_(GBP)/Installation_guide>`_
 168
 169 * **User Guide(s):**
 170
 171   * :ref:`gbp-user-guide`
 172
 173 Security Considerations
 174 =======================
 175
 176 * No other external interfaces than RESTCONF
 177 * No known security issues
 178
 179 Quality Assurance
 180 =================
 181
 182 `Sonar report (67%) <https://sonar.opendaylight.org/overview?id=51201>`_
 183
 184 Groupbasedpolicy CSIT:
 185
 186 * https://jenkins.opendaylight.org/releng/view/groupbasedpolicy/job/groupbasedpolicy-csit-1node-3-node-all-boron/
 187 * https://jenkins.opendaylight.org/releng/view/groupbasedpolicy/job/groupbasedpolicy-csit-1node-6node-all-boron/
 188 * https://jenkins.opendaylight.org/releng/view/groupbasedpolicy/job/groupbasedpolicy-csit-1node-openstack-liberty-openstack-boron/
 189 * https://jenkins.opendaylight.org/releng/view/groupbasedpolicy/job/groupbasedpolicy-csit-3node-clustering-all-boron/
 190
 191 Other manual testing and QA information
 192
 193 * GBP devstack demo
 194 * GBP-SFC demo
 195 * VPP demo
 196
 197 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>`_
 198
 199 Migration
 200 ---------
 201
 202 Migration from previous releases is not supported.
 203
 204 Compatibility
 205 -------------
 206 * Is this release compatible with the previous release?
 207
 208   Yes
 209
 210 * Any API changes?
 211
 212   Yes
 213
 214   https://git.opendaylight.org/gerrit/#/c/49041/ - Minor updates in names and descriptions for VPP renderer and adapter model to make it more readable.
 215
 216   https://git.opendaylight.org/gerrit/#/c/49190/ - Replacing InstanceIdentifier in VPP renderer model with NodeId.
 217
 218
 219 * Any configuration changes?
 220
 221   N/A
 222
 223 Bugs Fixed
 224 ----------
 225
 226 * `Fixed Bugs <https://bugs.opendaylight.org/buglist.cgi?bug_status=RESOLVED&chfield=[Bug%20creation]&chfieldfrom=2016-09-21&chfieldto=2017-05-25&list_id=78798&product=groupbasedpolicy&query_format=advanced&resolution=FIXED>`_
 227
 228 Known Issues
 229 ------------
 230
 231 * List key known issues with workarounds
 232
 233   N/A
 234
 235 * `Open Bugs <bugs.opendaylight.org/buglist.cgi?bug_status=CONFIRMED&bug_status=OPEN&bug_status=IN_PROGRESS&chfield=[Bug creation]&chfieldfrom=2016-09-21&chfieldto=2017-05-25&list_id=78797&product=groupbasedpolicy&query_format=advanced&resolution=--->`_
 236
 237 End-of-life
 238 ===========
 239
 240 * List of features/APIs which are EOLed, deprecated, and/or removed in this release
 241
 242   N/A
 243
 244 Standards
 245 =========
 246
 247 * List of standrads implemented and to what extent
 248
 249   N/A
 250
 251 Release Mechanics
 252 =================
 253
 254 * `Release plan <https://wiki.opendaylight.org/view/Group_Based_Policy_(GBP)/Releases/Carbon/Release_plan>`_
 255
 256 * Describe any major shifts in release schedule from the release plan
 257
 258   N/A