docs: Update release date
[armband.git] / 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) Open Platform for NFV Project, Inc. and its contributors
4
5 ========
6 Abstract
7 ========
8
9 This document compiles the release notes for the Danube release of
10 OPNFV when using Fuel as a deployment tool with an AArch64 (only) target
11 node pool.
12
13 ===============
14 Important Notes
15 ===============
16
17 These notes provides release information for the use of Fuel as deployment
18 tool for the AArch64 Danube release of OPNFV.
19
20 The goal of the AArch64 Danube release and this Fuel-based deployment process
21 is to establish a lab ready platform accelerating further development
22 of the OPNFV on AArch64 infrastructure.
23
24 Due to early docker and nodejs support on AArch64, we will still use an
25 x86_64 Fuel Master to build and deploy an AArch64 target pool.
26
27 Although not currently supported, mixing x86_64 and AArch64 architectures
28 inside the target pool will be possible later.
29
30 Carefully follow the installation-instructions provided in *Reference 13*.
31
32 =======
33 Summary
34 =======
35
36 For AArch64 Danube, the typical use of Fuel as an OpenStack installer is
37 supplemented with OPNFV unique components such as:
38
39 - `OpenDaylight <http://www.opendaylight.org/software>`_
40 - `Open vSwitch for NFV <https://wiki.opnfv.org/ovsnfv>`_
41 - `Tacker <https://wiki.openstack.org/wiki/Tacker>`_
42 - `Service Function Chaining <https://wiki.opnfv.org/service_function_chaining>`_
43
44 The following OPNFV plugins are not yet ported for AArch64:
45
46 - `BGPVPN <http://docs.openstack.org/developer/networking-bgpvpn>`_
47 - `SDN distributed routing and VPN <https://wiki.opnfv.org/sdnvpn>`_
48 - `NFV Hypervisors-KVM <https://wiki.opnfv.org/nfv-kvm>`_
49 - `VSPERF <https://wiki.opnfv.org/characterize_vswitch_performance_for_telco_nfv_use_cases>`_
50 - `Promise <https://wiki.opnfv.org/display/promise>`_
51 - `Parser <https://wiki.opnfv.org/display/parser>`_
52 - `Doctor <https://wiki.opnfv.org/display/doctor>`_
53
54 As well as OPNFV-unique configurations of the Hardware and Software stack.
55
56 This Danube artifact provides Fuel as the deployment stage tool in the
57 OPNFV CI pipeline including:
58
59 - Documentation built by Jenkins
60
61   - overall OPNFV documentation
62
63   - this document (release notes)
64
65   - installation instructions
66
67   - build-instructions
68
69 - The Danube Fuel installer image AArch64 (.iso) built by Jenkins
70
71 - Automated deployment of Danube with running on bare metal or a nested hypervisor environment (KVM)
72
73 - Automated validation of the Danube deployment
74
75 ============
76 Release Data
77 ============
78
79 +--------------------------------------+--------------------------------------+
80 | **Project**                          | armband                              |
81 |                                      |                                      |
82 +--------------------------------------+--------------------------------------+
83 | **Repo/tag**                         | danube.3.0                           |
84 |                                      |                                      |
85 +--------------------------------------+--------------------------------------+
86 | **Release designation**              | Danube 3.0                           |
87 |                                      |                                      |
88 +--------------------------------------+--------------------------------------+
89 | **Release date**                     | June 23 2017                         |
90 |                                      |                                      |
91 +--------------------------------------+--------------------------------------+
92 | **Purpose of the delivery**          | Danube alignment to Released         |
93 |                                      | Fuel 10.0 baseline + features and    |
94 |                                      | bug-fixes for the following          |
95 |                                      | feaures:                             |
96 |                                      | - Open vSwitch for NFV               |
97 |                                      | - OpenDaylight                       |
98 |                                      | - Tacker                             |
99 +--------------------------------------+--------------------------------------+
100
101 Version Change
102 ==============
103
104 Module Version Changes
105 ----------------------
106 This is the Danube 3.0 release.
107 It is based on following upstream versions:
108
109 - Fuel 10.0 Base Release
110
111 - OpenStack Newton Release
112
113 - OpenDaylight
114
115 Document Changes
116 ----------------
117 This is the Danube 3.0 release.
118 It comes with the following documentation:
119
120 - Installation instructions
121
122 - Build instructions
123
124 - Release notes (This document)
125
126 Reason for Version
127 ==================
128
129 Feature Additions
130 -----------------
131
132 **JIRA TICKETS:**
133
134
135 Bug Corrections
136 ---------------
137
138 **JIRA TICKETS:**
139
140 `Danube 3.0 bug fixes  <https://jira.opnfv.org/issues/?filter=11802>`_
141
142 (Also See respective Integrated feature project's bug tracking)
143
144 Deliverables
145 ============
146
147 Software Deliverables
148 ---------------------
149
150 AArch64 Fuel-based installer iso file found in `OPNFV Downloads <https://www.opnfv.org/software/download>`.
151
152 Documentation Deliverables
153 --------------------------
154
155 - Installation instructions
156
157 - Build instructions
158
159 - Release notes(This document)
160
161 =========================================
162 Known Limitations, Issues and Workarounds
163 =========================================
164
165 System Limitations
166 ==================
167
168 - **Max number of blades:** 1 Fuel master, 3 Controllers, 20 Compute blades
169
170 - **Min number of blades:** 1 Fuel master, 1 Controller, 1 Compute blade
171
172 - **Storage:** Ceph is the only supported storage configuration
173
174 - **Max number of networks:** 65k
175
176 - **Fuel master arch:** x86_64
177
178 - **Target node arch:** aarch64
179
180 Known Issues
181 ============
182
183 **JIRA TICKETS:**
184
185 `Known issues <https://jira.opnfv.org/issues/?filter=11803>`_
186
187 (Also See respective Integrated feature project's bug tracking)
188
189 Workarounds
190 ===========
191
192 **JIRA TICKETS:**
193
194 -
195
196 (Also See respective Integrated feature project's bug tracking)
197
198 ============
199 Test Results
200 ============
201 The Danube 3.0 release with the Fuel deployment tool has undergone QA test
202 runs, see separate test results.
203
204 ==========
205 References
206 ==========
207 For more information on the OPNFV Danube 3.0 release, please see:
208
209 OPNFV
210 =====
211
212 1) `OPNFV Home Page <http://www.opnfv.org>`_
213 2) `OPNFV Documentation - and Software Downloads <https://www.opnfv.org/software/download>`_
214
215 OpenStack
216 =========
217
218 3) `OpenStack Newton Release Artifacts <http://www.openstack.org/software/newton>`_
219
220 4) `OpenStack Documentation <http://docs.openstack.org>`_
221
222 OpenDaylight
223 ============
224
225 5) `OpenDaylight Artifacts <http://www.opendaylight.org/software/downloads>`_
226
227 Fuel
228 ====
229
230 6) `The Fuel OpenStack Project <https://wiki.openstack.org/wiki/Fuel>`_
231 7) `Fuel Documentation <http://docs.openstack.org/developer/fuel-docs>`_
232
233 Fuel in OPNFV
234 =============
235
236 13) `OPNFV Installation instruction for the AArch64 Danube release of OPNFV when using Fuel as a deployment tool <http://artifacts.opnfv.org/armband/docs/release_installation/index.html>`_
237
238 14) `OPNFV Build instruction for the AArch64 Danube release of OPNFV when using Fuel as a deployment tool <http://artifacts.opnfv.org/armband/docs/development_overview_build/index.html>`_
239
240 15) `OPNFV Release Note for the AArch64 Danube release of OPNFV when using Fuel as a deployment tool <http://artifacts.opnfv.org/armband/docs/release_release-notes/index.html>`_