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