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/oxygen
  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-all-oxygen/
  27 * **CSIT Test:** https://jenkins.opendaylight.org/releng/view/groupbasedpolicy/job/groupbasedpolicy-csit-1node-6node-all-oxygen/
  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/oxygen
  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/oxygen
  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:** N/A
  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/oxygen
  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-all-oxygen/
  59 * **CSIT Test:** https://jenkins.opendaylight.org/releng/view/groupbasedpolicy/job/groupbasedpolicy-csit-1node-6node-all-oxygen/
  60
  61 odl-groupbasedpolicy-vpp
  62 ------------------------
  63
  64 * **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/oxygen
  65 * **Feature Description:**  This renderer maps GBP service model to VPP devices
  66 * **Top Level:** Yes
  67 * **User Facing:** Yes
  68 * **Experimental:** Yes
  69 * **CSIT Test:** N/A
  70
  71 odl-groupbasedpolicy-neutron-vpp-mapper
  72 ---------------------------------------
  73
  74 * **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/oxygen
  75 * **Feature Description:**  Neutron Northbound services for VPP renderer
  76 * **Top Level:** Yes
  77 * **User Facing:** Yes
  78 * **Experimental:** Yes
  79 * **CSIT Test:** N/A
  80
  81 odl-groupbasedpolicy-ui
  82 -----------------------
  83
  84 * **Feature URL:** https://git.opendaylight.org/gerrit/gitweb?p=groupbasedpolicy.git;a=tree;f=features/odl-groupbasedpolicy-ui;h=af30b7c9fc6d20de755d071b2d2e3da556d7b4a5;hb=refs/heads/stable/oxygen
  85 * **Feature Description:**  Groupbasedpolicy User Interface
  86 * **Top Level:** Yes
  87 * **User Facing:** Yes
  88 * **Experimental:** Yes
  89 * **CSIT Test:** N/A
  90
  91 odl-groupbasedpolicy-ip-sgt-distribution-service
  92 ------------------------------------------------
  93
  94 * **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/oxygen
  95 * **Feature Description:**  SXP Distribution Service
  96 * **Top Level:** Yes
  97 * **User Facing:** Yes
  98 * **Experimental:** Yes
  99 * **CSIT Test:** N/A
 100
 101 odl-groupbasedpolicy-ios-xe
 102 ---------------------------
 103
 104 * **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/oxygen
 105 * **Feature Description:**  This renderer maps GBP service model to IOS-XE devices
 106 * **Top Level:** Yes
 107 * **User Facing:** Yes
 108 * **Experimental:** Yes
 109 * **CSIT Test:** N/A
 110
 111 odl-groupbasedpolicy-sxp-ep-provider
 112 ------------------------------------
 113
 114 * **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/oxygen
 115 * **Feature Description:**  SXP integration: Endpoint provider
 116 * **Top Level:** Yes
 117 * **User Facing:** Yes
 118 * **Experimental:** Yes
 119 * **CSIT Test:** N/A
 120
 121 odl-groupbasedpolicy-sxp-ise-adapter
 122 ------------------------------------
 123
 124 * **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/oxygen
 125 * **Feature Description:**  SXP integration: ISE adapter
 126 * **Top Level:** Yes
 127 * **User Facing:** Yes
 128 * **Experimental:** Yes
 129 * **CSIT Test:** N/A
 130
 131 Documentation
 132 =============
 133
 134 * **Installation Guide(s):**
 135
 136   * `Groupbasedpolicy Installation Guide <https://wiki.opendaylight.org/view/Group_Based_Policy_(GBP)/Installation_guide>`_
 137
 138 * **User Guide(s):**
 139
 140   * :ref:`gbp-user-guide`
 141
 142 Security Considerations
 143 =======================
 144
 145 * No other external interfaces than RESTCONF
 146 * No known security issues
 147
 148 Quality Assurance
 149 =================
 150
 151 `Sonar report (64.3%) <https://sonar.opendaylight.org/dashboard?id=org.opendaylight.groupbasedpolicy%3Agroupbasedpolicy.project>`_
 152
 153 Groupbasedpolicy CSIT:
 154
 155 * https://jenkins.opendaylight.org/releng/view/groupbasedpolicy/job/groupbasedpolicy-csit-1node-3-node-all-oxygen/
 156 * https://jenkins.opendaylight.org/releng/view/groupbasedpolicy/job/groupbasedpolicy-csit-1node-6node-all-oxygen/
 157 * https://jenkins.opendaylight.org/releng/view/groupbasedpolicy/job/groupbasedpolicy-csit-3node-clustering-all-oxygen/
 158
 159 Other manual testing and QA information
 160
 161 * GBP devstack demo
 162 * GBP-SFC demo
 163 * VPP demo
 164
 165 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>`_
 166
 167 Migration
 168 ---------
 169
 170 Migration from previous releases is not supported.
 171
 172 Compatibility
 173 -------------
 174 * Is this release compatible with the previous release?
 175
 176   Yes
 177
 178 * Any API changes?
 179
 180   N/A
 181
 182
 183 * Any configuration changes?
 184
 185   N/A
 186
 187 Bugs Fixed
 188 ----------
 189
 190 * `Fixed Bugs <https://jira.opendaylight.org/issues/?jql=project%20%3D%20GBP%20AND%20issuetype%20%3D%20Bug%20AND%20status%20%3D%20Resolved%20AND%20created%20%3E%3D%202017-08-14%20AND%20created%20%3C%3D%202018-03-07>`_
 191
 192 Known Issues
 193 ------------
 194
 195 * List key known issues with workarounds
 196
 197   N/A
 198
 199 * `Open Bugs <https://jira.opendaylight.org/browse/GBP-289?jql=project%20%3D%20GBP%20AND%20issuetype%20%3D%20Bug%20AND%20status%20%3D%20Open>`_
 200
 201 End-of-life
 202 ===========
 203
 204 * List of features/APIs which are EOLed, deprecated, and/or removed in this release
 205
 206   N/A
 207
 208 Standards
 209 =========
 210
 211 * List of standards implemented and to what extent
 212
 213   N/A
 214
 215 Release Mechanics
 216 =================
 217
 218 * `Release plan <https://wiki.opendaylight.org/view/Group_Based_Policy_(GBP)/Releases/Oxygen/Release_plan>`_
 219
 220 * Describe any major shifts in release schedule from the release plan
 221
 222   N/A