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