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