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 Euphrates 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 Euphrates release of OPNFV.
  17
  18 The goal of the Euphrates 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 Euphrates 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 Euphrates. 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/euphrates                     |
  58 +--------------------------------------+--------------------------------------+
  59 | **Release designation**              | Euphrates release                    |
  60 |                                      |                                      |
  61 +--------------------------------------+--------------------------------------+
  62 | **Release date**                     | October 24 2017                      |
  63 |                                      |                                      |
  64 +--------------------------------------+--------------------------------------+
  65 | **Purpose of the delivery**          | Euphrates 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   - Euphrates release with the JOID deployment toolchain.
  90   - OpenStack (Ocata release)
  91   - Kubernetes 1.7
  92   - Ubuntu 16.04 LTS
  93
  94 Document version change
  95 ~~~~~~~~~~~~~~~~~~~~~~~
  96 - OPNFV Installation instructions for the Euphrates 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-100                       | MAAS 2.x support                     |
 112 +--------------------------------------+--------------------------------------+
 113 | JIRA: JOID-101                       | Juju 2.x support                     |
 114 +--------------------------------------+--------------------------------------+
 115 | JIRA: JOID-99                        | jumphost support for 16.04           |
 116 +--------------------------------------+--------------------------------------+
 117 | JIRA: JOID-106                       | Kubernetes on Baremetal              |
 118 +--------------------------------------+--------------------------------------+
 119 | JIRA: JOID-102                       | Enable OpenStack Ocata               |
 120 +--------------------------------------+--------------------------------------+
 121 |                                      | Enable OpenContrail                  |
 122 +--------------------------------------+--------------------------------------+
 123 |                                      | Enable OVN for Kubernetes            |
 124 +--------------------------------------+--------------------------------------+
 125
 126 Bug corrections
 127 ~~~~~~~~~~~~~~~
 128
 129 **JIRA TICKETS:**
 130
 131 +--------------------------------------+--------------------------------------+
 132 | **JIRA REFERENCE**                   | **SLOGAN**                           |
 133 |                                      |                                      |
 134 +--------------------------------------+--------------------------------------+
 135 | JIRA:                                |                                      |
 136 |                                      |                                      |
 137 +--------------------------------------+--------------------------------------+
 138
 139
 140 Known Limitations, Issues and Workarounds
 141 =========================================
 142
 143 System Limitations
 144 ------------------
 145 **Min jumphost requirements:** At least 16GB of RAM, 4 core cpu and 250 gb disk should support virtualization.
 146
 147
 148 Known issues
 149 ------------
 150
 151 **JIRA TICKETS:**
 152
 153 +--------------------------------------+--------------------------------------+
 154 | **JIRA REFERENCE**                   | **SLOGAN**                           |
 155 |                                      |                                      |
 156 +--------------------------------------+--------------------------------------+
 157 | JIRA: YARDSTICK-325                  | Provide raw format yardstick vm image|
 158 |                                      | for nova-lxd scenario(OPNFV)         |
 159 +--------------------------------------+--------------------------------------+
 160 | JIRA:                                | floating ip are not working for ODL. |
 161 +--------------------------------------+--------------------------------------+
 162 | JIRA:                                | No functest support for Kubernetes.  |
 163 +--------------------------------------+--------------------------------------+
 164
 165
 166 Workarounds
 167 -----------
 168 See JIRA: <link>
 169
 170
 171 Scenario Releases
 172 =================
 173 Name:      joid-os-nosdn-nofeature-ha
 174 Test Link: https://build.opnfv.org/ci/view/joid/job/joid-os-nosdn-nofeature-ha-baremetal-daily-euphrates/
 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-euphrates/
 179 Notes:
 180
 181 Name:      joid-os-nosdn-lxd-noha
 182 Test Link: https://build.opnfv.org/ci/view/joid/job/joid-os-nosdn-lxd-noha-baremetal-daily-euphrates/
 183 Notes:
 184
 185 Name:      joid-os-nosdn-nofeature-noha
 186 Test Link: https://build.opnfv.org/ci/view/joid/job/joid-os-nosdn-nofeature-noha-baremetal-daily-euphrates/
 187 Notes:
 188
 189 Name:      joid-k8-nosdn-lb-noha
 190 Test Link: https://build.opnfv.org/ci/view/joid/job/joid-k8-nosdn-lb-noha-baremetal-daily-euphrates/
 191 Notes:
 192
 193 Name:      joid-k8-ovn-lb-noha
 194 Test Link: https://build.opnfv.org/ci/view/joid/job/joid-k8-ovn-lb-noha-baremetal-daily-euphrates/
 195 Notes:
 196
 197 Name:      joid-os-ocl-nofeature-ha
 198 Test Link: https://build.opnfv.org/ci/view/joid/job/joid-os-ocl-nofeature-ha-baremetal-daily-euphrates/
 199 Notes:
 200
 201 Name:      joid-os-ocl-nofeature-noha
 202 Test Link: https://build.opnfv.org/ci/view/joid/job/joid-os-ocl-nofeature-noha-baremetal-daily-euphrates/
 203 Notes:
 204
 205 References
 206 ==========
 207 For more information on the OPNFV Euphrates release, please visit
 208 - `OPNFV Euphrates release <http://www.opnfv.org/euphrates>`_
 209
 210 Juju
 211 ----
 212 - `Juju Charm store <https://jujucharms.com/>`_
 213 - `Juju documents <https://jujucharms.com/docs/stable/getting-started>`_
 214
 215 MAAS
 216 ----
 217 - `Bare metal management (Metal-As-A-Service) <http://maas.io/get-started>`_
 218 - `MAAS API documents <http://maas.ubuntu.com/docs/>`_
 219
 220 JOID
 221 ----
 222 - `OPNFV JOID wiki <https://wiki.opnfv.org/joid>`_
 223 - `OPNFV Release Notes <http://docs.opnfv.org/en/stable-danube/submodules/joid/docs/release/release-notes/release-notes.html>`_
 224 - `OPNFV JOID Install Guide <http://docs.opnfv.org/en/latest/submodules/joid/docs/release/installation/index.html>`_
 225
 226 OpenStack
 227 ---------
 228 - `OpenStack Newton Release artifacts <http://www.openstack.org/software/ocata>`_
 229 - `OpenStack documentation <http://docs.openstack.org>`_
 230
 231 OpenDaylight
 232 ------------
 233 - `OpenDaylight artifacts <http://www.opendaylight.org/software/downloads>`_
 234
 235 Opencontrail
 236 ------------
 237 - `http://www.opencontrail.org/opencontrail-quick-start-guide/`_
 238
 239 Kubernetes
 240 ------------
 241 - `https://kubernetes.io/`_