Release notes update
[cli.git] / docs / release-notes.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. _release_notes:
3
4
5 CLI Release Notes
6 =================
7
8 Version: 10.0.0 (Jakarta)
9 --------------------------
10
11 :Release Date: 2022-06-09
12
13 no updates in this release
14
15 Version: 6.0.1
16 --------------
17
18 :Release Date: 2021-04-01
19
20 *New Features*
21
22 1. Metadata support is added in OCS YAML
23
24
25 *Security Notes*
26
27 Fixed Security Issues
28
29 Known Security Issues
30
31 Known Vulnerabilities in Used Modules
32
33
34 Version: 6.0.0
35 --------------
36
37 :Release Date: 2020-11-04
38
39 *New Features*
40
41 1. Enabled auto discover and registration of products functionalities as commands
42
43 2. Profile managment commands are added
44
45 *Security Notes*
46
47 Fixed Security Issues
48
49 Known Security Issues
50
51 Known Vulnerabilities in Used Modules
52
53
54 Version: 5.0.4
55 --------------
56
57 :Release Date: 2020-04-07
58
59 **New Features**
60
61 1. Improved HTTP timeout
62
63 2. Enable Non-Root user in docker container
64
65 3. Improved SDC and VFC commands under onap-dublin product
66
67 4. CLI web portal is made to run HTTPS 443 port and Web consoles at HTTPS 9090
68
69 5. Vulnerability is improved from previous release by using secured 3rd-party libraries
70
71 **Security Notes**
72
73 *Fixed Security Issues*
74
75 *Known Security Issues*
76
77 *Known Vulnerabilities in Used Modules*
78
79
80 Version: 4.0.0
81 --------------
82
83 :Release Date: 2019-10-24
84
85 **New Features**
86
87 1. ONAP CLI is used to end-end automation of VNF service provision and termination for both HEAT and TOSCA based VNF service.
88
89 2. Multi-level orchestration capability is made available to use and user could use python, or similar scripting/workflow engine for the same
90
91 3. VNF Test Platform(VTP) has used the Open Command Platform (OCOMP) - part of ONAP CLI project, for VNF life cycle testing (create and delete)
92
93 4. ONAP CLI for ONAP Dublin version is stabilized to use it for both service provisioning and testing purpose
94
95 5. ONAP CLI for el alto is enabled as experimental (dev) mode
96
97 **Security Notes**
98
99 *Fixed Security Issues*
100
101 *Known Security Issues*
102
103 - In default deployment CLI (cli) exposes HTTP port 30260 outside of cluster. [`OJSI-129 <https://jira.onap.org/browse/OJSI-129>`_]
104 - In default deployment CLI (cli) exposes HTTP port 30271 outside of cluster. [`OJSI-135 <https://jira.onap.org/browse/OJSI-135>`_]
105 - CVE-2019-12130 - CLI exposes unprotected APIs/UIs on port 30271. [`OJSI-205 <https://jira.onap.org/browse/OJSI-205>`_]
106
107 *Known Vulnerabilities in Used Modules*
108
109 Version: 3.0.0
110 --------------
111
112 :Release Date: 2019-05-31
113
114 **New Features**
115
116 - Beijing support EOL
117 - Enhanced schema management
118 - Added execution support for capturing the details of every execution includes parameters, results. This feature is used in VTP.
119 - End-end service creation using ONAP commands are provided. [`More details <https://github.com/onap/integration/tree/master/test/hpa_automation>`_]
120
121 **Security Notes**
122
123 *Fixed Security Issues*
124
125 *Known Security Issues*
126
127 - In default deployment CLI (cli) exposes HTTP port 30260 outside of cluster. [`OJSI-129 <https://jira.onap.org/browse/OJSI-129>`_]
128 - In default deployment CLI (cli) exposes HTTP port 30271 outside of cluster. [`OJSI-135 <https://jira.onap.org/browse/OJSI-135>`_]
129 - CVE-2019-12130 - CLI exposes unprotected APIs/UIs on port 30271. [`OJSI-205 <https://jira.onap.org/browse/OJSI-205>`_]
130
131 *Known Vulnerabilities in Used Modules*
132
133 Version: 2.0.5
134 --------------
135
136 :Release Date: 2018-11-30
137
138 **New Features**
139
140 - Amsterdam support EOL
141 - Added gRPC to run the ONAP commands remotely
142 - Added Command profile to support VTP (VNF Test Platform) requirements in VNFSDK and added new commands for supporting it
143 - VTP leverages OCLIP for providing the test center (discover the test cases) and test runner (run the test cases)
144
145 **Security Notes**
146
147 CLI code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities
148 have been addressed, items that remain open have been assessed for risk and determined to be false
149 positive. The CLI open Critical security vulnerabilities and their risk assessment have been
150 documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=45298770>`_.
151
152 Quick Links:
153     - `CLI project page <https://wiki.onap.org/display/DW/Command+Line+Interface+Project>`_
154
155     - `Passing Badge information for CLI <https://bestpractices.coreinfrastructure.org/en/projects/1540>`_
156
157     - `Project Vulnerability Review Table for CLI <https://wiki.onap.org/pages/viewpage.action?pageId=45298770>`_
158
159
160 Version: 2.0.0
161 --------------
162
163 :Release Date: 2018-06-07
164
165 **New Features**
166
167 In this release, CLI provides all those features supported in previous release. In addition,
168 following features are enabled:
169
170 * Profile support (like Heat environment file)
171 * Batch support to run same command with different set of arguments feed from param-file)
172 * Policy management
173 * VNF/PNF management
174 * OCLIP SNMP profile support (get command)
175 * OCLIP CLI verification support (--verify)
176 * Portal CLI application is enabled for all users.
177
178 Similar to earlier release, user can perform customer, subscription, cloud and tenant management only
179 by using CLI as portal does not support.
180
181 In addition, it made following changes to OCS 1.0
182
183 * http profile is enabled with service section to capture micro-service catalog and auth information
184 and body section could be customized using context.
185
186 * New default parameters verify and context are added.
187
188 **Bug Fixes**
189
190 * `CLI-105 <https://jira.onap.org/browse/CLI-105>`_   Ignore those yamls which does not have open cli schema version
191 * `CLI-103 <https://jira.onap.org/browse/CLI-103>`_   Support HTTP delete with http body (SO, AAI requires)
192 * `CLI-101 <https://jira.onap.org/browse/CLI-101>`_   Add context parameter for ignoring empty json nodes in http body
193 * `CLI-99 <https://jira.onap.org/browse/CLI-99>`_    Optional parameter's default value is set to blank
194 * `CLI-95 <https://jira.onap.org/browse/CLI-95>`_    Add profile support for multiple sessions
195 * `CLI-94 <https://jira.onap.org/browse/CLI-94>`_    EOL openecomp CLIs
196 * `CLI-86 <https://jira.onap.org/browse/CLI-86>`_    Create documentation for end to end cli commands for onap
197 * `CLI-74 <https://jira.onap.org/browse/CLI-74>`_    Setup Mock environment for a command
198 * `CLI-61 <https://jira.onap.org/browse/CLI-61>`_    Add validation for results section in yaml
199
200 **Security Notes**
201
202 CLI code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities
203 have been addressed, items that remain open have been assessed for risk and determined to be false
204 positive. The CLI open Critical security vulnerabilities and their risk assessment have been
205 documented as part of the `project <https://wiki.onap.org/pages/viewpage.action?pageId=28377287>`_.
206
207 Quick Links:
208     - `CLI project page <https://wiki.onap.org/display/DW/Command+Line+Interface+Project>`_
209
210     - `Passing Badge information for CLI <https://bestpractices.coreinfrastructure.org/en/projects/1540>`_
211
212     - `Project Vulnerability Review Table for CLI <https://wiki.onap.org/pages/viewpage.action?pageId=28377287>`_
213
214 Version: 1.1.0
215 --------------
216
217 :Release Date: 2017-11-16
218
219 :ref:`cli_index` helps user to operate ONAP from Linux command console and web command console.
220
221 **New Features**
222
223 In ONAP Amsterdam release, CLI provides following ONAP operations as command:
224
225 * ONAP micro-service discovery
226 * External system on-boarding (VIM, VNFM, EMS & SDNC)
227 * Customer and Subscription management (Only available thru CLI)
228 * Cloud and Tenant on-boarding (Only available thru CLI)
229 * Design-time artifacts (VSP, VF, Service model) management
230 * Network-service (vFW, vLB, etc)  life-cycle management