Document Security section of the Release Notes
[vid.git] / docs / release-notes.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2
3 VID Release Notes
4 =================
5
6 Version: 2.0.0
7 --------------
8
9 :Release Date: 2018-06-07
10
11 New Features
12 ------------
13 1. VoLTE E2E services instantiation.
14 2. Change Management - invoking vNF In-Place SW Update without a scheduler.
15 3. Manual vNF Scale Out.
16
17 **Epics**
18 -  [`VID-101`_] - Port Mirroring
19 -  [`VID-106`_] - Cancel "Pending" workflows
20 -  [`VID-110`_] - Owning Entity
21 -  [`VID-114`_] - Preload Automation
22 -  [`VID-116`_] - Tenant Isolation
23 -  [`VID-120`_] - Active/Deactivate service type transport
24 -  [`VID-124`_] - Agnostic vNF In-Place SW Update
25 -  [`VID-127`_] - Agnostic vNF Configuration Update
26 -  [`VID-131`_] - Port mirroring - pProbe configuration
27 -  [`VID-136`_] - Support for pProbes
28 -  [`VID-139`_] - Refactor Scheduler
29 -  [`VID-148`_] - Non-Functional requirements - Resiliency
30 -  [`VID-154`_] - Non-Functional requirements - Stability
31 -  [`VID-157`_] - Non-Functional requirements - Performance
32 -  [`VID-158`_] - Non-Functional requirements - Usability
33 -  [`VID-160`_] - Non-Functional requirements - Scalability
34 -  [`VID-161`_] - Non-Functional requirements - Security (CII passing badge + 50% test coverage)
35 -  [`VID-162`_] - OOM integration
36 -  [`VID-179`_] - Change management - working without scheduler
37 -  [`VID-180`_] - Support manual scale out
38 -  [`VID-192`_] - Verify features merged from ECOMP 1802
39
40 .. _VID-101: https://jira.onap.org/browse/VID-101
41 .. _VID-106: https://jira.onap.org/browse/VID-106
42 .. _VID-110: https://jira.onap.org/browse/VID-110
43 .. _VID-114: https://jira.onap.org/browse/VID-114
44 .. _VID-116: https://jira.onap.org/browse/VID-116
45 .. _VID-120: https://jira.onap.org/browse/VID-120
46 .. _VID-124: https://jira.onap.org/browse/VID-124
47 .. _VID-127: https://jira.onap.org/browse/VID-127
48 .. _VID-131: https://jira.onap.org/browse/VID-131
49 .. _VID-136: https://jira.onap.org/browse/VID-136
50 .. _VID-139: https://jira.onap.org/browse/VID-139
51 .. _VID-148: https://jira.onap.org/browse/VID-148
52 .. _VID-154: https://jira.onap.org/browse/VID-154
53 .. _VID-157: https://jira.onap.org/browse/VID-157
54 .. _VID-158: https://jira.onap.org/browse/VID-158
55 .. _VID-160: https://jira.onap.org/browse/VID-160
56 .. _VID-161: https://jira.onap.org/browse/VID-161
57 .. _VID-162: https://jira.onap.org/browse/VID-162
58 .. _VID-179: https://jira.onap.org/browse/VID-179
59 .. _VID-180: https://jira.onap.org/browse/VID-180
60 .. _VID-192: https://jira.onap.org/browse/VID-192
61
62 **Stories**
63 -  [`VID-16`_] - Replace any remaining openecomp reference by onap
64 -  [`VID-86`_] - Migrate to org.onap
65 -  [`VID-102`_] - Create "Port mirror" configuration - Attach Source & collector VNFs
66 -  [`VID-103`_] - Create "Port mirror" configuration - General Required Fields
67 -  [`VID-104`_] - Configuration supporting actions
68 -  [`VID-105`_] - Create "Port mirror" configuration - Get model information
69 -  [`VID-107`_] - 3rd party simulator
70 -  [`VID-108`_] - Cancel Scheduled workflows
71 -  [`VID-109`_] - Change information of columns in the "Pending" section of the "dashboard"
72 -  [`VID-111`_] - New properties logic
73 -  [`VID-112`_] - Filter service instance by new properties
74 -  [`VID-113`_] - Implement new properties & their values
75 -  [`VID-115`_] - Resume VF- module (after pause)
76 -  [`VID-117`_] - Create Application ENV
77 -  [`VID-118`_] - Deploy Services on VID operational
78 -  [`VID-119`_] - Activate/Deactivate Application ENV
79 -  [`VID-121`_] - Deactivate a Transport service logic
80 -  [`VID-122`_] - Service Instance Deactivate - API MSO
81 -  [`VID-123`_] - "Activate" avilable only for service instance from type= transport
82 -  [`VID-125`_] - VNF In Place Software Update API - MSO
83 -  [`VID-126`_] - Support new workflow "Agnostic vNF In-Place SW Update"
84 -  [`VID-128`_] - Support workflow "vnf Config Update"
85 -  [`VID-129`_] - Rules For Converting Payload Spreadsheet To JSON
86 -  [`VID-130`_] - VNF Config Update - API MSO
87 -  [`VID-132`_] - Get pnf-fromModel-byRegion - A&AI API
88 -  [`VID-133`_] - pProbe config create request - MSO API
89 -  [`VID-134`_] - Associate PNF instance to port mirroring configuration by policy
90 -  [`VID-135`_] - Get Port Mirroring Configuration By Policy Node type
91 -  [`VID-137`_] - Associate PNF instance to service instance
92 -  [`VID-138`_] - Disassociate PNF instance from service instance
93 -  [`VID-140`_] - New function to support Scheduler in widget
94 -  [`VID-151`_] - ONAP Support
95 -  [`VID-174`_] - Change management: bypassing scheduler for immediate operations
96 -  [`VID-185`_] - UI changes for working without scheduler
97 -  [`VID-186`_] - docker alignment analyzes
98 -  [`VID-188`_] - UI for Scale Out workflow
99 -  [`VID-189`_] - VoLTE use case support
100 -  [`VID-191`_] - Changes to API to SO for Manual scale out use case
101 -  [`VID-197`_] - Reach 50% unit test coverage
102 -  [`VID-201`_] - User inteface for invoking upgrade workflow
103 -  [`VID-202`_] - Verify R1 and R2 features - integration and regression tests
104 -  [`VID-216`_] - Update ReadTheDocs docs folder
105             
106 .. _VID-16: https://jira.onap.org/browse/VID-16
107 .. _VID-86: https://jira.onap.org/browse/VID-86
108 .. _VID-102: https://jira.onap.org/browse/VID-102
109 .. _VID-103: https://jira.onap.org/browse/VID-103
110 .. _VID-104: https://jira.onap.org/browse/VID-104
111 .. _VID-105: https://jira.onap.org/browse/VID-105
112 .. _VID-107: https://jira.onap.org/browse/VID-107
113 .. _VID-108: https://jira.onap.org/browse/VID-108
114 .. _VID-109: https://jira.onap.org/browse/VID-109
115 .. _VID-111: https://jira.onap.org/browse/VID-111
116 .. _VID-112: https://jira.onap.org/browse/VID-112
117 .. _VID-113: https://jira.onap.org/browse/VID-113
118 .. _VID-115: https://jira.onap.org/browse/VID-115
119 .. _VID-117: https://jira.onap.org/browse/VID-117
120 .. _VID-118: https://jira.onap.org/browse/VID-118
121 .. _VID-119: https://jira.onap.org/browse/VID-119
122 .. _VID-121: https://jira.onap.org/browse/VID-121
123 .. _VID-122: https://jira.onap.org/browse/VID-122
124 .. _VID-123: https://jira.onap.org/browse/VID-123
125 .. _VID-125: https://jira.onap.org/browse/VID-125
126 .. _VID-126: https://jira.onap.org/browse/VID-126
127 .. _VID-128: https://jira.onap.org/browse/VID-128
128 .. _VID-129: https://jira.onap.org/browse/VID-129
129 .. _VID-130: https://jira.onap.org/browse/VID-130
130 .. _VID-132: https://jira.onap.org/browse/VID-132
131 .. _VID-133: https://jira.onap.org/browse/VID-133
132 .. _VID-134: https://jira.onap.org/browse/VID-134
133 .. _VID-135: https://jira.onap.org/browse/VID-135
134 .. _VID-137: https://jira.onap.org/browse/VID-137
135 .. _VID-138: https://jira.onap.org/browse/VID-138
136 .. _VID-140: https://jira.onap.org/browse/VID-140
137 .. _VID-151: https://jira.onap.org/browse/VID-151
138 .. _VID-174: https://jira.onap.org/browse/VID-174
139 .. _VID-185: https://jira.onap.org/browse/VID-185
140 .. _VID-186: https://jira.onap.org/browse/VID-186
141 .. _VID-188: https://jira.onap.org/browse/VID-188
142 .. _VID-189: https://jira.onap.org/browse/VID-189
143 .. _VID-191: https://jira.onap.org/browse/VID-191
144 .. _VID-197: https://jira.onap.org/browse/VID-197
145 .. _VID-201: https://jira.onap.org/browse/VID-201
146 .. _VID-202: https://jira.onap.org/browse/VID-202
147 .. _VID-216: https://jira.onap.org/browse/VID-216
148
149 **Security Notes**
150 VID code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities have been addressed, items that remain open have been assessed for risk and determined to be false positive. The VID open Critical security vulnerabilities and their risk assessment have been documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=28378623>`_.
151
152 Quick Links:
153 - `VID project page <https://wiki.onap.org/display/DW/Virtual+Infrastructure+Deployment+Project>`_
154 - `Passing Badge information for VID <https://bestpractices.coreinfrastructure.org/en/projects/1658>`_
155 - `Project Vulnerability Review Table for VID <https://wiki.onap.org/pages/viewpage.action?pageId=28378623>`_
156
157 **Other**
158 In order to work properly, VID needs a working instance of SDC, A&AI and SO.
159
160 Version: 1.1.1
161 --------------
162
163 :Release Date: 2017-11-16
164
165 New Features
166 ------------
167
168 1. Improved TOSCA parser.
169 2. Change Management - Provides the Operators a single tool for installing and maintaining the services as a self service activity. Provides the ability to schedule and execute change management workflows, Maintenance activities for vNFs that are already installed .
170 3. PNF Instantiation - PNFs are already installed on the edges of the cloud. In order to configure the PNF, the service needs to be connected to the PNF.
171
172 **Epics**
173 -  [`VID-25`_] - Role management: Global Read only role
174 -  [`VID-26`_] - Role management: Support VID specific Roles
175 -  [`VID-27`_] - Change management: Schedule workflow
176 -  [`VID-28`_] - Change management: Status of workflow
177 -  [`VID-29`_] - Change management: Manual intervention
178 -  [`VID-30`_] - PNF instantiation: Trigger PNF service information to SO
179 -  [`VID-31`_] - PNF Instantiation: support service type PNF & display new fields
180
181 .. _VID-25: https://jira.onap.org/browse/VID-25
182 .. _VID-26: https://jira.onap.org/browse/VID-26
183 .. _VID-27: https://jira.onap.org/browse/VID-27
184 .. _VID-28: https://jira.onap.org/browse/VID-28
185 .. _VID-29: https://jira.onap.org/browse/VID-29
186 .. _VID-30: https://jira.onap.org/browse/VID-30
187 .. _VID-31: https://jira.onap.org/browse/VID-31
188
189 **Stories**
190 -  [`VID-44`_] - Implement change management phase 1
191 -  [`VID-48`_] - Change management: Schedule workflow
192 -  [`VID-49`_] - Change management: Status of workflow
193 -  [`VID-50`_] - Change management: Manual intervention
194 -  [`VID-51`_] - Trigger PNF service information to MSO
195 -  [`VID-52`_] - support service type PNF & display new fields
196
197 .. _VID-44: https://jira.onap.org/browse/VID-44
198 .. _VID-48: https://jira.onap.org/browse/VID-48
199 .. _VID-49: https://jira.onap.org/browse/VID-49
200 .. _VID-50: https://jira.onap.org/browse/VID-50
201 .. _VID-51: https://jira.onap.org/browse/VID-51
202 .. _VID-52: https://jira.onap.org/browse/VID-52
203
204
205 Bug Fixes
206 ----------
207 -  [`VID-20`_] - Failed to get service models from ASDC in VID
208 -  [`VID-59`_] - VID Fails Robot Health Check
209 -  [`VID-62`_] - VID healthcheck failure in RS ORD ONAP 1.1.0
210 -  [`VID-64`_] - Got 500 from role/user API call
211 -  [`VID-79`_] - Not able to create service instance using VID portal
212 -  [`VID-82`_] - Create VF module with SDNC preload is throwing
213    exception
214
215 .. _VID-20: https://jira.onap.org/browse/VID-20
216 .. _VID-59: https://jira.onap.org/browse/VID-59
217 .. _VID-62: https://jira.onap.org/browse/VID-62
218 .. _VID-64: https://jira.onap.org/browse/VID-64
219 .. _VID-79: https://jira.onap.org/browse/VID-79
220 .. _VID-82: https://jira.onap.org/browse/VID-82
221
222
223 **Known Issues**
224 - `VID-78 <https://jira.onap.org/browse/VID-78>`_ VID shows the HTML code output whenever the customer list is empty (Cosmetic)
225
226 **Upgrade Notes**
227 A scheduler is needed for the change management feature to work (not included in the Amsterdam release).
228
229 **Other**
230 In order to work properly, VID needs a working instance of SDC, A&AI and SO.
231
232 ===========
233
234 End of Release Notes