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