X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=docs%2Frelease-notes.rst;h=70dc230672367002a55dfa0e825d8457aa9b9848;hb=c38dd39eeaf64deefec8f41b7ed5bfd2c60f34ef;hp=49e4b7aac923f0347c857f147bf54467b6e0360a;hpb=4ef2d899dfe6de651b9773f9dc402840bb332f2e;p=cli.git diff --git a/docs/release-notes.rst b/docs/release-notes.rst index 49e4b7aa..70dc2306 100644 --- a/docs/release-notes.rst +++ b/docs/release-notes.rst @@ -1,41 +1,89 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. + CLI Release Notes ================= -Version: 1.1.0 +Version: 2.0.4 -------------- -:Release Date: 2017-11-16 +:Release Date: 2018-11-15 + +**New Features** + +- Amsterdam support EOL +- Added gRPC to run the ONAP commands over gRPC protocol +- Added Command profile to support VTP(VNF Test Platform) requirements in VNFSDK and added new commands for supporting it +- VTP leverages OCLIP for providing the test center (discover the test cases) and test runner (run the test cases) + +Version: 2.0.0 +-------------- + +:Release Date: 2018-06-07 + +**New Features** + +In this release, CLI provides all those features supported in previous release. In addition, +following features are enabled: + +* Profile support (like Heat environment file) +* Batch support to run same command with different set of arguments feed from param-file) +* Policy management +* VNF/PNF management +* OCLIP SNMP profile support (get command) +* OCLIP CLI verification support (--verify) +* Portal CLI application is enabled for all users. + +Similar to earlier release, user can perform customer, subscription, cloud and tenant management only +by using CLI as portal does not support. -ONAP CLI helps user to perform any operations over ONAP from command line, Linux console and web-console. +In addition, it made following changes to OCS 1.0 -NOTE: ONAP portal does not support following features, so user is recommended to use them over CLI: +* http profile is enabled with service section to capture micro-service catalog and auth information +and body section could be customized using context. + +* New default parameters verify and context are added. + +**Bug Fixes** + +* `CLI-105 `_ Ignore those yamls which does not have open cli schema version +* `CLI-103 `_ Support HTTP delete with http body (SO, AAI requires) +* `CLI-101 `_ Add context parameter for ignoring empty json nodes in http body +* `CLI-99 `_ Optional parameter's default value is set to blank +* `CLI-95 `_ Add profile support for multiple sessions +* `CLI-94 `_ EOL openecomp CLIs +* `CLI-86 `_ Create documentation for end to end cli commands for onap +* `CLI-74 `_ Setup Mock environment for a command +* `CLI-61 `_ Add validation for results section in yaml + +**Security Notes** + +CLI code has been formally scanned during build time using NexusIQ and all Critical vulnerabilities +have been addressed, items that remain open have been assessed for risk and determined to be false +positive. The CLI open Critical security vulnerabilities and their risk assessment have been +documented as part of the `project `_. + +Quick Links: + - `CLI project page `_ + + - `Passing Badge information for CLI `_ + + - `Project Vulnerability Review Table for CLI `_ + +Version: 1.1.0 +-------------- + +:Release Date: 2017-11-16 -* Customer and subscription management -* VNF Cloud on-boarding -* VNF tenant on-boarding +:ref:`cli_index` helps user to operate ONAP from Linux command console and web command console. **New Features** -* ONAP CLI available as Nexus artifacts and docker images. - For more details, :ref:`cli_installation_guide`. -* It is delivered as part of portal installation during HEAT based installation. Also its supported in OOM as well. - For more details, :ref:`OOM_and_HEAT_based_deployment`. -* Released first version of **Open Command Line Interface Platform (OCLIP)**, industry first CLI platform for implementing CLI **just by texting (YAML) and no coding** . - For more details, :ref:`OCLIP`. -* It provides **Open Command Specification (OCS) 1.0** for defining the commands in YAML format, similar to Open API Specification (API). - For more details, :ref:`open_cli_schema_version_1_0`. -* All Onap commands are developed using OCLIP by authoring set of YAML files. - For more details, :ref:`cli_cmd_help`. -* All commands are tested completely and samples also provided for reference. - For more details, :ref:`_cli_cmd_sample`. -* User could develop new commands on-the-fly and deploy it and use. - For more details, :ref:`cli_developer_guide`. - -**Know Issues** - -* VF customizationUUID is not available over SDC REST API, so user is recommended to refer it from SDC portal -* CLI impersonate VID as source while creating service, vf and vf-modules, due to SO limitation (SO-272) -* vsp-add-artifact command sometime fails to upload the file, in that case, please use option -d to see the debug information +In ONAP Amsterdam release, CLI provides following ONAP operations as command: +* ONAP micro-service discovery +* External system on-boarding (VIM, VNFM, EMS & SDNC) +* Customer and Subscription management (Only available thru CLI) +* Cloud and Tenant on-boarding (Only available thru CLI) +* Design-time artifacts (VSP, VF, Service model) management +* Network-service (vFW, vLB, etc) life-cycle management