Merge "Proposal to move Promise shim-layer code to a new deprecated folder"
[promise.git] / docs / release / release-notes / releasenotes.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. http://creativecommons.org/licenses/by/4.0
3
4 =======================================
5 OPNFV Promise release notes (Euphrates)
6 =======================================
7
8 Version history
9 ===============
10
11 +------------+---------------+-----------------+-------------+
12 | **Date**   | **Ver.**      | **Author**      | **Comment** |
13 +============+===============+=================+=============+
14 | 2017-07-13 | Euphrates 1.0 | Gerald Kunzmann |             |
15 +------------+---------------+-----------------+-------------+
16
17 Important notes
18 ===============
19
20 **Attention:** Please be aware that the Promise shim-layer implementation is marked as DEPRECATED
21 in Euphrates and both implementation and related test cases may be removed from next release.
22
23 Abstract
24 ========
25
26 This document provides an overview of the Promise project in the OPNFV Euphrates
27 release. Promise is a resource reservation and management project to identify NFV related
28 requirements and realize resource reservation for future usage by capacity
29 management of resource pools regarding compute, network and storage.
30
31
32 Features
33 ========
34
35 The following features are provided by the Promise in the OPNFV Euphrates release:
36
37 * Capacity Management
38 * Reservation Management
39 * Allocation Management
40
41 The Euphrates implementation of Promise is built with the YangForge data modeling
42 framework [#f2]_ , using a shim-layer on top of OpenStack to provide
43 the Promise features.
44
45 In the OPNFV Euphrates release cycle most efforts have been spent to progress the upstream
46 implementation of a native resource reservation system for OpenStack as part of the Blazar project
47 [#f3]_.
48
49 Detailed information about Promise use cases, features, interface
50 specifications, work flows, and the underlying Promise YANG schema can be found
51 in the Promise requirement document [#f1]_ .
52
53 .. [#f1]_ http://docs.opnfv.org/en/stable-euphrates/submodules/promise/docs/development/requirements/index.html
54 .. [#f2]_ https://github.com/opnfv/yangforge
55 .. [#f3]_ https://launchpad.net/blazar/+milestone/0.3.0
56
57
58 Installer support and verification status
59 =========================================
60
61 Promise project is integrated in OPNFV through the Functest project (`FUNCTEST`_).
62
63 +-----------+----------------------------------------------+--------------+
64 | Installer | CI Job                                       | Status       |
65 +===========+==============================================+==============+
66 | Fuel      | functest-fuel-baremetal-daily-master         |              |
67 |           | functest-fuel-virtual-daily-master           |              |
68 |           | functest-fuel-armband-baremetal-daily-master |              |
69 +-----------+----------------------------------------------+--------------+
70 | Joid      | functest-joid-baremetal-daily-master         |              |
71 +-----------+----------------------------------------------+--------------+
72
73 .. _FUNCTEST: https://wiki.opnfv.org/display/functest
74
75
76 Thereby, the following test cases (`TEST_CASES`_) are executed:
77
78  - Add a new OpenStack provider to the reservation service
79  - Allocation of resources without prior reservation
80  - Reservation of a VM for immediate use followed by allocation
81  - Reservation of a VM for future use
82  - Update reservation
83  - Query reservation
84  - Cancel reservation
85  - Error case: try to create reservation with a conflict
86  - Capacity management - increase/decrease available capacity of a provider
87  - Capacity Management - query for available and used capacity
88
89
90 .. _TEST_CASES: https://git.opnfv.org/promise/tree/source/test/promise-intents.coffee
91
92
93 Open JIRA tickets
94 =================
95
96 +------------------+-----------------------------------------------+
97 |   JIRA           |         Description                           |
98 +==================+===============================================+
99 |                  |                                               |
100 |                  |                                               |
101 +------------------+-----------------------------------------------+
102
103 All the tickets that are not blocking have been fixed or postponed
104 the next release.
105
106 Promise Euphrates 1.0 is released without known bugs.
107
108
109
110 Useful links
111 ============
112
113  - Promise project page: https://wiki.opnfv.org/display/promise
114  - Promise requirements: http://docs.opnfv.org/en/stable-euphrates/submodules/promise/docs/development/requirements/index.html
115
116 Related Projects
117 ----------------
118
119  - OpenStack Blazar (Resource reservation for OpenStack): https://docs.openstack.org/blazar/latest/
120  - YangForge data modeling framework: - https://github.com/opnfv/yangforge
121
122 Related ETSI NFV specifications
123 -------------------------------
124
125  - ETSI NFV MANO GS: http://www.etsi.org/deliver/etsi_gs/NFV-MAN
126  - ETSI NFV INF GSs: http://www.etsi.org/deliver/etsi_gs/NFV-INF
127  - ETSI NFV IFA GSs: http://www.etsi.org/deliver/etsi_gs/NFV-IFA