aboutsummaryrefslogtreecommitdiffstats
path: root/docs/release/release-notes/release-notes.rst
blob: 73825062477a4d69e3d49d60330344303216dc0b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
.. (c) Weidong Shao (HUAWEI) and Justin Chi (HUAWEI)

Release Note for the Euphrates release of OPNFV when using Compass4nfv as a deployment tool.

Abstract
========

This document describes release notes of OPNFV when using Compass4nfv as a
deployment tool covering it's features, limitations and required system resources.

Introduction
============

Compass4nfv is an OPNFV installer project based on open source project Compass,
which provides automated deployment and management of OpenStack and other distributed systems.
Please carefully follow the Installation Instructions to deploy OPNFV using Compass4nfv
installer.

Release Data
============

+--------------------------------------+--------------------------------------+
| **Project**                          | Compass4nfv                          |
|                                      |                                      |
+--------------------------------------+--------------------------------------+
| **Repo/tag**                         | Compass4nfv/Euphrates.1.0            |
|                                      |                                      |
+--------------------------------------+--------------------------------------+
| **Release designation**              | Euphrates.1.0                        |
|                                      |                                      |
+--------------------------------------+--------------------------------------+
| **Release date**                     | October 2017                         |
|                                      |                                      |
+--------------------------------------+--------------------------------------+
| **Purpose of the delivery**          | OPNFV Euphrates release              |
|                                      |                                      |
+--------------------------------------+--------------------------------------+

Deliverables
------------

Software deliverables
~~~~~~~~~~~~~~~~~~~~~

 - Compass4nfv/Euphrates.1.0 tarball, please get it from `OPNFV software download page <https://www.opnfv.org/software/>`_

.. _document-label:

Documentation deliverables
~~~~~~~~~~~~~~~~~~~~~~~~~~

 - OPNFV(Euphrates) Compass4nfv installation instructions

 - OPNFV(Euphrates) Compass4nfv Release Notes

Version change
--------------
.. This section describes the changes made since the last version of this document.

Module version change
~~~~~~~~~~~~~~~~~~~~~

This is the Euphrates release of compass4nfv as a deployment toolchain in OPNFV, the following
upstream components supported with this release.

 - Ubuntu 16.04/Centos 7.3

 - Openstack (Ocata release)

 - Kubernates (1.7.3)

 - Opendaylight (Nitrogen release)


Reason for new version
----------------------

Feature additions
~~~~~~~~~~~~~~~~~

+--------------------------------------+-----------------------------------------+
| **JIRA REFERENCE**                   | **SLOGAN**                              |
|                                      |                                         |
+--------------------------------------+-----------------------------------------+
| COMPASS-549                          | Real Time KVM                           |
|                                      |                                         |
+--------------------------------------+-----------------------------------------+
|                                      | OpenDaylight Nitrogen Support           |
|                                      |                                         |
+--------------------------------------+-----------------------------------------+
| COMPASS-542                          | Support OpenStack Ocata                 |
|                                      |                                         |
+--------------------------------------+-----------------------------------------+
|                                      | Support ODL SFC                         |
|                                      |                                         |
+--------------------------------------+-----------------------------------------+
| COMPASS-550                          | Support OVS-DPDK                        |
|                                      |                                         |
+--------------------------------------+-----------------------------------------+
| COMPASS-495                          | Yardstick Integration into Compass4nfv  |
|                                      |                                         |
+--------------------------------------+-----------------------------------------+


Bug corrections
~~~~~~~~~~~~~~~

**JIRA TICKETS:**

+--------------------------------------+----------------------------------------+
| **JIRA REFERENCE**                   | **SLOGAN**                             |
|                                      |                                        |
+--------------------------------------+----------------------------------------+
|                                      | With no ceph, the cluster will heal    |
|                                      | itself after a power failure or reboot |
+--------------------------------------+----------------------------------------+


Known Limitations, Issues and Workarounds
=========================================

System Limitations
------------------

**Max number of blades:** 1 Jumphost, 3 Controllers, 20 Compute blades

**Min number of blades:** 1 Jumphost, 1 Controller, 1 Compute blade

**Storage:** Ceph is the only supported storage configuration

**Min Jumphost requirements:** At least 16GB of RAM, 16 core CPU

Scenario Limitations
--------------------

**ODL SFC:** In the Euphrates1.0, Compass doesn't integrate OpenStack Tacker
Project yet. However, the SFC related test cases in Functest always use Tacker
as NFVO to delivery VNFFG or SFC related requests to ODL via networking-sfc.
So the odl-sfc scenario of Compass cannot pass the SFC testcases in Functest.
But if you want to use verify SFC in the cluster deployed by Compass, you can
use neutron CLI to achieve the same effect.

Known issues
------------

+-----------------------+---------------------------------+-----------------------+
|   **Scenario**        | **Issue**                       |  **Workarounds**      |
+-----------------------+---------------------------------+-----------------------+
| Ceph Related Scenario | After a power failure or reboot,| Deploy without Ceph   |
|                       | the cluster cannot heal itself  |                       |
+-----------------------+---------------------------------+-----------------------+

Test Result
===========
The Euphrates release with the Compass4nfv deployment toolchain has undergone QA test
runs with the following results:

Functest: http://testresults.opnfv.org/reporting/euphrates/functest/status-compass.html