docs/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 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/brahmaputra                   |
  62 +--------------------------------------+--------------------------------------+
  63 | **Release designation**              | Brahmaputra release                  |
  64 |                                      |                                      |
  65 +--------------------------------------+--------------------------------------+
  66 | **Release date**                     | February 25 2016                     |
  67 |                                      |                                      |
  68 +--------------------------------------+--------------------------------------+
  69 | **Purpose of the delivery**          | Brahmaputra 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 (Liberty release)
  95   - OpenDaylight (Beryllium release)
  96   - Ubuntu 14.04 LTS
  97
  98 Document version change
  99 ~~~~~~~~~~~~~~~~~~~~~~~
 100 - OPNFV Installation instructions for the Brahmaputra 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 +--------------------------------------+--------------------------------------+
 114 | JIRA: JOID-1                         | use Juju and Ubuntu to deploy OPNFV  |
 115 |                                      |                                      |
 116 +--------------------------------------+--------------------------------------+
 117 | JIRA: JOID-23                        | explain how to deploy OPNFV R2       |
 118 |                                      | using JOID                           |
 119 +--------------------------------------+--------------------------------------+
 120
 121 Bug corrections
 122 ~~~~~~~~~~~~~~~
 123
 124 **JIRA TICKETS:**
 125
 126 +--------------------------------------+--------------------------------------+
 127 | **JIRA REFERENCE**                   | **SLOGAN**                           |
 128 |                                      |                                      |
 129 +--------------------------------------+--------------------------------------+
 130 | JIRA:                                |                                      |
 131 |                                      |                                      |
 132 +--------------------------------------+--------------------------------------+
 133
 134
 135 Known Limitations, Issues and Workarounds
 136 =========================================
 137
 138 System Limitations
 139 ------------------
 140 **Min jumphost requirements:** At least 16GB of RAM, 4 core cpu and 250 gb disk should support virtualization.
 141
 142
 143 Known issues
 144 ------------
 145
 146 **JIRA TICKETS:**
 147
 148 +--------------------------------------+--------------------------------------+
 149 | **JIRA REFERENCE**                   | **SLOGAN**                           |
 150 |                                      |                                      |
 151 +--------------------------------------+--------------------------------------+
 152 | JIRA: JOID-19                        | juju(OPNFV) project integration with |
 153 |                                      | ONOSFW                               |
 154 +--------------------------------------+--------------------------------------+
 155 | JIRA:                                |                                      |
 156 +--------------------------------------+--------------------------------------+
 157
 158
 159 Workarounds
 160 -----------
 161 See JIRA: <link>
 162
 163
 164 Test Result
 165 ===========
 166 Brahmaputra test result using JOID as deployment tool.
 167 <link>
 168
 169 References
 170 ==========
 171 For more information on the OPNFV Brahmaputra release, please visit
 172 - `OPNFV Brahmaputra release <http://www.opnfv.org/brahmaputra>`_
 173
 174 Juju
 175 ----
 176 - `Juju Charm store <https://jujucharms.com/>`_
 177 - `Juju documents <https://jujucharms.com/docs/stable/getting-started>`_
 178
 179 MAAS
 180 ----
 181 - `Bare metal management (Metal-As-A-Service) <http://maas.io/get-started>`_
 182 - `MAAS API documents <http://maas.ubuntu.com/docs/>`_
 183
 184 JOID
 185 ----
 186 - `OPNFV JOID wiki <https://wiki.opnfv.org/joid>`_
 187 - `OPNFV JOID User Guide <https://wiki.opnfv.org/joid/b_userguide>`_
 188 - `OPNFV JOID Install Guide <https://wiki.opnfv.org/joid/b_installguide>`_
 189
 190 OpenStack
 191 ---------
 192 - `OpenStack Liberty Release artifacts <http://www.openstack.org/software/liberty>`_
 193 - `OpenStack documentation <http://docs.openstack.org>`_
 194
 195 OpenDaylight
 196 ------------
 197 - `OpenDaylight artifacts <http://www.opendaylight.org/software/downloads>`_
 198