docs/release/release-notes/release-notes.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. http://creativecommons.org/licenses/by/4.0
   3 .. (c) <optionally add copywriters name>
   4
   5
   6 Abstract
   7 ========
   8
   9 This document compiles the release notes for the Danube release of
  10 OPNFV when using JOID as a deployment tool.
  11
  12 Introduction
  13 ============
  14
  15 These notes provides release information for the use of joid as deployment
  16 tool for the Danube release of OPNFV.
  17
  18 The goal of the Danube release and this JOID based deployment process is
  19 to establish a lab ready platform accelerating further development
  20 of the OPNFV infrastructure.
  21
  22 Carefully follow the installation-instructions which guides a user to deploy
  23 OPNFV using JOID which is based on MAAS and Juju.
  24
  25 Summary
  26 =======
  27
  28 The Danube release with the JOID deployment toolchain will establish an OPNFV target system on a Pharos compliant lab infrastructure.
  29 The current definition of an OPNFV target system is and OpenStack Newton combined with OpenDaylight Boron.
  30
  31 The system is deployed with OpenStack High Availability (HA) for most OpenStack services.
  32 Ceph storage is used as Cinder backend, and is the only supported storage for Danube. Ceph is setup as 3 OSDs and 3 Monitors, one radosgw.
  33
  34     User has following choices to make to do the deployment.
  35
  36     - Openstack      -- Newton
  37     - Type           -- HA, nonHA, tip (stable git branch of respective openstack)
  38     - SDN controller -- OpenDaylight, nosdn(Openvswitch), Onos, OpenContrail
  39     - Feature        -- IPV6, DVR(distributed virtual routing), SFC(service function chaining odl only), BGPVPN(odl only), LB(Load Balancer for Kubernetes)
  40     - Distro         -- Xenial
  41     - Model          -- Openstack, Kubernetes
  42
  43 - Documentation is built by Jenkins
  44 - Jenkins deploys a Denbue release with the JOID deployment toolchain baremetal,
  45   which includes 3 control+network nodes, and 2 compute nodes.
  46
  47 NOTE: Detailed information on how to install in your lab can be find in installation guide
  48
  49 Release Data
  50 ============
  51
  52 +--------------------------------------+--------------------------------------+
  53 | **Project**                          | JOID                                 |
  54 |                                      |                                      |
  55 +--------------------------------------+--------------------------------------+
  56 | **Repo/tag**                         | gerrit.opnfv.org/gerrit/joid.git     |
  57 |                                      | stable/danube                      |
  58 +--------------------------------------+--------------------------------------+
  59 | **Release designation**              | Denbue release                     |
  60 |                                      |                                      |
  61 +--------------------------------------+--------------------------------------+
  62 | **Release date**                     | March 31 2017                      |
  63 |                                      |                                      |
  64 +--------------------------------------+--------------------------------------+
  65 | **Purpose of the delivery**          | Danube release                     |
  66 |                                      |                                      |
  67 +--------------------------------------+--------------------------------------+
  68
  69 Deliverables
  70 ------------
  71
  72 Software deliverables
  73 ~~~~~~~~~~~~~~~~~~~~~
  74 `JOID based installer script files <https://gerrit.opnfv.org/gerrit/gitweb?p=joid.git;a=summary>`_
  75
  76 Documentation deliverables
  77 ~~~~~~~~~~~~~~~~~~~~~~~~~~
  78
  79 - Installation instructions
  80 - Release notes (This document)
  81 - User guide
  82
  83 Version change
  84 --------------
  85 .. This section describes the changes made since the last version of this document.
  86
  87 Module version change
  88 ~~~~~~~~~~~~~~~~~~~~~
  89   - Danube release with the JOID deployment toolchain.
  90   - OpenStack (Newton release)
  91   - OpenDaylight (Boron release)
  92   - Ubuntu 16.04 LTS
  93
  94 Document version change
  95 ~~~~~~~~~~~~~~~~~~~~~~~
  96 - OPNFV Installation instructions for the Danube release using JOID deployment
  97   toolchain - ver. 1.0.0
  98 - OPNFV Release Notes with the JOID deployment toolchain - ver. 1.0.0 (this document)
  99
 100 Reason for new version
 101 ----------------------
 102
 103 Feature additions
 104 ~~~~~~~~~~~~~~~~~
 105
 106 +--------------------------------------+--------------------------------------+
 107 | **JIRA REFERENCE**                   | **SLOGAN**                           |
 108 +--------------------------------------+--------------------------------------+
 109 | JIRA: JOID-1                         | use Juju and Ubuntu to deploy OPNFV  |
 110 +--------------------------------------+--------------------------------------+
 111 | JIRA: JOID-103                       | OpenDaylight Carbon Support          |
 112 +--------------------------------------+--------------------------------------+
 113 | JIRA: JOID-100                       | MAAS 2.x support                     |
 114 +--------------------------------------+--------------------------------------+
 115 | JIRA: JOID-101                       | Juju 2.x support                     |
 116 +--------------------------------------+--------------------------------------+
 117 | JIRA: JOID-99                        | jumphost support for 16.04           |
 118 +--------------------------------------+--------------------------------------+
 119 | JIRA: JOID-106                       | Kubernetes on Baremetal              |
 120 +--------------------------------------+--------------------------------------+
 121 | JIRA: JOID-108                       | integrate load balancer              |
 122 |                                      | Kubernetes on Baremetal              |
 123 +--------------------------------------+--------------------------------------+
 124 | JIRA: JOID-110                       | Enable VM console in Horizon         |
 125 +--------------------------------------+--------------------------------------+
 126 | JIRA: JOID-102                       | Enable OpenStack Newton              |
 127 +--------------------------------------+--------------------------------------+
 128
 129 Bug corrections
 130 ~~~~~~~~~~~~~~~
 131
 132 **JIRA TICKETS:**
 133
 134 +--------------------------------------+--------------------------------------+
 135 | **JIRA REFERENCE**                   | **SLOGAN**                           |
 136 |                                      |                                      |
 137 +--------------------------------------+--------------------------------------+
 138 | JIRA:                                |                                      |
 139 |                                      |                                      |
 140 +--------------------------------------+--------------------------------------+
 141
 142
 143 Known Limitations, Issues and Workarounds
 144 =========================================
 145
 146 System Limitations
 147 ------------------
 148 **Min jumphost requirements:** At least 16GB of RAM, 4 core cpu and 250 gb disk should support virtualization.
 149
 150
 151 Known issues
 152 ------------
 153
 154 **JIRA TICKETS:**
 155
 156 +--------------------------------------+--------------------------------------+
 157 | **JIRA REFERENCE**                   | **SLOGAN**                           |
 158 |                                      |                                      |
 159 +--------------------------------------+--------------------------------------+
 160 | JIRA: YARDSTICK-325                  | Provide raw format yardstick vm image|
 161 |                                      | for nova-lxd scenario(OPNFV)         |
 162 +--------------------------------------+--------------------------------------+
 163 | JIRA:                                | floating ip are not working for ODL. |
 164 +--------------------------------------+--------------------------------------+
 165 | JIRA:                                | No functest and yardstick support.   |
 166 +--------------------------------------+--------------------------------------+
 167
 168
 169 Workarounds
 170 -----------
 171 See JIRA: <link>
 172
 173
 174 Test Result
 175 ===========
 176 Danube test result using JOID as deployment tool.
 177 - `https://build.opnfv.org/ci/view/joid/job/functest-joid-baremetal-daily-colorado/>`_
 178 - `https://build.opnfv.org/ci/view/joid/job/yardstick-joid-baremetal-daily-colorado/>`_
 179
 180 Scenario Releases
 181 =================
 182 Name:      joid-os-nosdn-nofeature-ha
 183 Test Link: https://build.opnfv.org/ci/view/joid/job/joid-os-nosdn-nofeature-ha-baremetal-daily-colorado/
 184 Notes:
 185
 186 Name:      joid-os-odl-nofeature-ha
 187 Test Link: https://build.opnfv.org/ci/view/joid/job/joid-os-odl_l2-nofeature-ha-baremetal-daily-colorado/
 188 Notes:
 189
 190 Name:      joid-os-nosdn-lxd-ha
 191 Test Link: https://build.opnfv.org/ci/view/joid/job/joid-os-nosdn-lxd-ha-baremetal-daily-colorado/
 192 Notes:
 193
 194 Name:      joid-os-onos-nofeature-ha
 195 Test Link: https://build.opnfv.org/ci/view/joid/job/joid-os-onos-nofeature-ha-baremetal-daily-colorado/
 196 Notes:
 197
 198 Name:      joid-os-onos-sfc-ha
 199 Test Link: https://build.opnfv.org/ci/view/joid/job/joid-os-onos-sfc-ha-baremetal-daily-colorado/
 200 Notes:
 201
 202 Name:      joid-os-nosdn-lxd-noha
 203 Test Link: https://build.opnfv.org/ci/user/narindergupta/my-views/view/joid/job/joid-os-nosdn-lxd-noha-baremetal-daily-colorado/
 204 Notes:
 205
 206 Name:      joid-os-nosdn-nofeature-noha
 207 Test Link: https://build.opnfv.org/ci/user/narindergupta/my-views/view/joid/job/joid-os-nosdn-nofeature-noha-baremetal-daily-colorado/
 208 Notes:
 209
 210 Name:      joid-k8-nosdn-nofeature-noha
 211 Test Link: https://build.opnfv.org/ci/user/narindergupta/my-views/view/joid/job/joid-deploy-baremetal-daily-master/1833/console/
 212 Notes:
 213
 214 Name:      joid-k8-nosdn-lb-noha
 215 Test Link: https://build.opnfv.org/ci/user/narindergupta/my-views/view/joid/job/joid-os-nosdn-nofeature-noha-baremetal-daily-colorado/
 216 Notes:
 217
 218 References
 219 ==========
 220 For more information on the OPNFV Danube release, please visit
 221 - `OPNFV Danube release <http://www.opnfv.org/danube>`_
 222
 223 Juju
 224 ----
 225 - `Juju Charm store <https://jujucharms.com/>`_
 226 - `Juju documents <https://jujucharms.com/docs/stable/getting-started>`_
 227
 228 MAAS
 229 ----
 230 - `Bare metal management (Metal-As-A-Service) <http://maas.io/get-started>`_
 231 - `MAAS API documents <http://maas.ubuntu.com/docs/>`_
 232
 233 JOID
 234 ----
 235 - `OPNFV JOID wiki <https://wiki.opnfv.org/joid>`_
 236 - `OPNFV JOID User Guide <https://wiki.opnfv.org/joid/b_userguide>`_
 237 - `OPNFV Release Notes <https://wiki.opnfv.org/display/joid/Danube+Release+Notes>`_
 238 - `OPNFV JOID Install Guide <https://wiki.opnfv.org/display/joid/Danube+installation+Guide>`_
 239
 240 OpenStack
 241 ---------
 242 - `OpenStack Newton Release artifacts <http://www.openstack.org/software/newton>`_
 243 - `OpenStack documentation <http://docs.openstack.org>`_
 244
 245 OpenDaylight
 246 ------------
 247 - `OpenDaylight artifacts <http://www.opendaylight.org/software/downloads>`_
 248