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