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