docs/release-notes/projects/coe.rst

   1 ====================================
   2 COE (Container Orchestration Engine)
   3 ====================================
   4
   5 COE(Container Orchestration Engine) project aims at developing a framework for
   6 integrating Container Orchestration Engine (like Kuberenetes) and OpenDaylight.
   7 OpendayLight Oxygen Coe provides following modules --
   8
   9 * **odlovs-cni plugin** A custom Kubernetes CNI Plugin developed for OpenDaylight.
  10 * **watcher** A Kubernetes API watcher module which can communicate Kubernetes events to OpenDaylight.
  11 * **coe-northbound** Module that provides the models necessary for consuming the Kubernetes events.
  12
  13 Major Features
  14 ==============
  15
  16 * **Features URL:** https://git.opendaylight.org/gerrit/gitweb?p=coe.git;a=blob;f=features/pom.xml;hb=stable/oxygen
  17
  18 odl-coe-api
  19 -----------
  20
  21 * **Feature Description:**  This feature provides all APIs provided by
  22   COE project for downstream consumers.
  23
  24 * **Top Level:** Yes
  25 * **User Facing:** Yes
  26 * **Experimental:** Yes
  27 * **CSIT Tests:**
  28   * WIP CSIT patch- https://git.opendaylight.org/gerrit/#/c/68920/
  29   * Jenkins Job Patch - https://git.opendaylight.org/gerrit/#/c/67227/
  30   * Patches to enable Vagrant for CSIT VMs - https://git.opendaylight.org/gerrit/#/c/68856/
  31
  32
  33 New capabilities and enhancements added in Oxygen
  34 =================================================
  35
  36 Planned new capability added
  37 ----------------------------
  38
  39 * :doc:`/submodules/netvirt/docs/specs/coe-integration`
  40
  41
  42 Enhancements added to project
  43 -----------------------------
  44
  45 #. L2 support for PODs
  46 #. L3 support for PODs
  47
  48
  49 Documentation
  50 =============
  51
  52 * **Installation Guide(s):**
  53
  54   * N/A
  55
  56 * **User Guide(s):**
  57
  58   * N/A
  59
  60 * **Developer Guide(s):**
  61
  62   * :doc:`Developer Guide </submodules/coe/docs/index>`
  63
  64 Security Considerations
  65 =======================
  66
  67 * Do you have any external interfaces other than RESTCONF?
  68
  69   * No
  70
  71 * Other security issues?
  72
  73   * N/A
  74
  75 Quality Assurance
  76 =================
  77
  78 * `Sonar Report <https://sonar.opendaylight.org/projects?search=coe&sort=-analysis_date>`_
  79
  80 * Other manual testing and QA information
  81
  82   * CSIT activities are all in progress.
  83   * Manual testing is done with integrating with 3 node Kubernetes cluster on stable\oxygen distribution.
  84
  85 * Testing methodology. How extensive was it? What should be expected to work?
  86   What hasn't been tested as much?
  87
  88   * Functionality and System Tests with moderate scale is only tested
  89   * Scale tests yet to start
  90
  91 Migration
  92 ---------
  93
  94 * N/A
  95
  96 Compatibility
  97 -------------
  98
  99 * Is this release compatible with the previous release?
 100
 101   * Functionality is fully backwards compatible.
 102
 103 * Any API changes?
 104
 105   * No
 106
 107 * Any configuration changes?
 108
 109   * No
 110
 111 Bugs Fixed
 112 ----------
 113
 114 * COE was in basic development phase in Oxygen, and hence no external bugs have been filed.
 115
 116
 117 Known Issues
 118 ------------
 119
 120 * List key known issues with workarounds
 121
 122   * None
 123
 124
 125 End-of-life
 126 ===========
 127
 128 * List of features/APIs which are EOLed, deprecated, and/or removed in this
 129   release
 130
 131   * N/A
 132
 133 Standards
 134 =========
 135
 136 * List of standards implemented and to what extent
 137
 138   * N/A
 139
 140 Release Mechanics
 141 =================
 142
 143 * `Release plan <https://wiki.opendaylight.org/view/Coe:Oxygen:Release_Plan>`_
 144
 145 * Describe any major shifts in release schedule from the release plan
 146
 147   * N/A