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