Merge "Includes fixes that remove need for interface hardcoding and adds support...
[genesis.git] / foreman / docs / src / release-notes.rst
1 :Authors: Tim Rozet (trozet@redhat.com)
2 :Version: 0.1
3
4 ================================================================
5 OPNFV Release Note for "Arno-RC2 release candidate" - Foreman/QuickStack@OPNFV
6 ================================================================
7
8 Abstract
9 ========
10
11 This document provides the release notes for ARNO-RC2 release candidate of Foreman/QuickStack@OPNFV.
12
13 License
14 =======
15 All Foreman/QuickStack and "common" entities are protected by the Apache License ( http://www.apache.org/licenses/ )
16
17 **Contents**
18
19 1  Version History
20
21 2  Important notes
22
23 3  Summary
24
25 4  Delivery Data
26
27 5 Known Limitations, Issues and Workarounds
28
29 6 Test Result
30
31 7 References
32
33 1   Version history
34 ===================
35
36 +--------------------+--------------------+--------------------+--------------------+
37 | **Date**           | **Ver.**           | **Author**         | **Comment**        |
38 |                    |                    |                    |                    |
39 +--------------------+--------------------+--------------------+--------------------+
40 | 2015-04-16         | 0.1.0              | Tim Rozet          | First draft        |
41 |                    |                    |                    |                    |
42 +--------------------+--------------------+--------------------+--------------------+
43
44 2   Important notes
45 ===================
46
47 This is the first OPNFV Arno pre-release that implements the deploy stage of the OPNFV CI pipeline.
48
49 Carefully follow the installation-instructions which guide a user on how to deploy OPNFV using Foreman/QuickStack installer.
50
51 3   Summary
52 ===========
53
54 Arno Foreman/QuickStack@OPNFV is an installer capable of setting up an OPNFV target system.  The current definition of an OPNFV target system is OpenStack Juno upstream project versioncombined with OpenDaylight version: Helium.  The system is deployed with OpenStack High Availability (HA) for most OpenStack services.  OpenDaylight is deployed in non-HA form as HA is not availble for Arno release.  Ceph storage is used as Cinder backend, and is the only supported storage for Arno.  Ceph is setup as 3 OSDs and 3 Monitors, one OSD+Mon per Controller node.
55
56 This Arno pre-release of Foreman/QuickStack@OPNFV adds the deploy stage of the OPNFV CI pipeline
57
58 - Documentation is built by Jenkins
59 - .iso image is built by Jenkins
60 - Jenkins deploys an Foreman/QuickStack@OPNFV stack to baremetal, which includes 3 control+network nodes, and 2 compute nodes.
61
62 Automatic test of the deployed system is not part of this pre-release.
63
64 4   Release Data
65 ================
66
67 +--------------------------------------+--------------------------------------+
68 | **Project**                          | Arno/genesis/bgs                    |
69 |                                      |                                      |
70 +--------------------------------------+--------------------------------------+
71 | **Repo/tag**                         | genesis/arno-rc2                     |
72 |                                      |                                      |
73 +--------------------------------------+--------------------------------------+
74 | **Release designation**              | Arno RC2                             |
75 |                                      |                                      |
76 +--------------------------------------+--------------------------------------+
77 | **Release date**                     | 2015-04-23                           |
78 |                                      |                                      |
79 +--------------------------------------+--------------------------------------+
80 | **Purpose of the delivery**          | OPNFV Internal quality assurance     |
81 |                                      | and CI Pipline dry-run               |
82 |                                      |                                      |
83 +--------------------------------------+--------------------------------------+
84
85 4.1 Version change
86 ------------------
87
88 4.1.1   Module version changes
89 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
90 This is the first tracked version of genesis-Foreman/QuickStack. It is based on following upstream versions:
91
92 - OpenStack (Juno release)
93
94 - OpenDaylight Helium-SR2
95
96 - CentOS 7
97
98 4.1.2   Document version changes
99 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
100 This is the first tracked version of genesis-Foreman/QuickStack. It comes with the following documentation:
101
102 - OPNFV Installation instructions for - Foreman/QuickStack@OPNFV - ver. 0.0.1
103 - OPNFV Release Note for "Arno-RC2 release candidate" - Foreman/QuickStack@OPNFV - ver. 0.1 (this document)
104
105 4.2 Reason for version
106 ----------------------
107 4.2.1 Feature additions
108 ~~~~~~~~~~~~~~~~~~~~~~~
109
110 +--------------------------------------+--------------------------------------+
111 | **JIRA REFERENCE**                   | **SLOGAN**                           |
112 |                                      |                                      |
113 +--------------------------------------+--------------------------------------+
114 | JIRA: BGS-4                          | OPNFV base system install            |
115 |                                      | using Foreman/Quickstack.            |
116 +--------------------------------------+--------------------------------------+
117
118 4.2.2 Bug corrections
119 ~~~~~~~~~~~~~~~~~~~~~
120
121 **JIRA TICKETS:**
122
123 +--------------------------------------+--------------------------------------+
124 | **JIRA REFERENCE**                   | **SLOGAN**                           |
125 |                                      |                                      |
126 +--------------------------------------+--------------------------------------+
127 |                                      |                                      |
128 |                                      |                                      |
129 +--------------------------------------+--------------------------------------+
130
131 4.3 Deliverables
132 ----------------
133
134 4.3.1   Software deliverables
135 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
136 Foreman/QuickStack@OPNFV .iso file
137 deploy.sh - Automatically deploys Target OPNFV System to Bare Metal
138
139 4.3.2   Documentation deliverables
140 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
141 - OPNFV Installation instructions for - Foreman/QuickStack@OPNFV - ver. 0.0.1
142 - OPNFV Release Note for "Arno-RC2 release candidate" - Foreman/QuickStack@OPNFV - ver. 0.1 (this document)
143
144 5  Known Limitations, Issues and Workarounds
145 ============================================
146
147 5.1    System Limitations
148 -------------------------
149
150 **Max number of blades:**   1 Foreman/QuickStack master, 3 Controllers, 20 Compute blades
151
152 **Min number of blades:**   1 Foreman/QuickStack master, 1 Controller, 1 Compute blade
153
154 **Storage:**    Ceph is the only supported storage configuration.
155
156 **Min master requirements:** At least 2048 MB of RAM
157
158
159 5.2    Known issues
160 -------------------
161
162 **JIRA TICKETS:**
163
164 +--------------------------------------+--------------------------------------+
165 | **JIRA REFERENCE**                   | **SLOGAN**                           |
166 |                                      |                                      |
167 +--------------------------------------+--------------------------------------+
168 | JIRA: BGS-13                         | bridge br-ex is not auto configured  |
169 |                                      | by puppet                            |
170 +--------------------------------------+--------------------------------------+
171
172 5.3    Workarounds
173 ------------------
174 **-**
175
176
177 6  Test Result
178 ==============
179
180 Foreman/QuickStack@OPNFV Arno RC2 has undergone QA test runs with the following results:
181
182 +--------------------------------------+--------------------------------------+
183 | **TEST-SUITE**                       | **Results:**                         |
184 |                                      |                                      |
185 +--------------------------------------+--------------------------------------+
186 | **-**                                | **-**                                |
187 +--------------------------------------+--------------------------------------+
188
189
190 7  References
191 =============
192
193 For more information on the OPNFV Arno release, please see:
194
195 http://wiki.opnfv.org/release/arno