diff options
| -rw-r--r-- | docs/OCLIP.rst | 4 | ||||
| -rw-r--r-- | docs/cmd_sample.rst | 9 | ||||
| -rw-r--r-- | docs/index.rst | 1 | ||||
| -rw-r--r-- | docs/release-notes.rst | 28 | ||||
| -rw-r--r-- | docs/user_guide.rst | 5 |
5 files changed, 41 insertions, 6 deletions
diff --git a/docs/OCLIP.rst b/docs/OCLIP.rst index d8e4a6cd..56d3b9d2 100644 --- a/docs/OCLIP.rst +++ b/docs/OCLIP.rst @@ -31,3 +31,7 @@ Advantages This platform defines Open Command Specification (OCS) for CLI, which is similar to the Open API specification (OAS) defined by swagger for REST API. It is like : **API for developers, CLI for admins/users/operators !** For more details of OCS :ref:`open_cli_schema_version_1_0` +.. toctree:: + :maxdepth: 1 + + open_cli_schema_version_1_0.rst diff --git a/docs/cmd_sample.rst b/docs/cmd_sample.rst new file mode 100644 index 00000000..505cd0ff --- /dev/null +++ b/docs/cmd_sample.rst @@ -0,0 +1,9 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. Copyright 2017 Huawei Technologies Co., Ltd. + +.. _cli_cmd_sample: + +CLI Samples +============== +TBD
\ No newline at end of file diff --git a/docs/index.rst b/docs/index.rst index f1b0f54f..7a53a0b0 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -33,7 +33,6 @@ ONAP CLI is developed using the industry first CLI platform called console.rst OCLIP.rst - open_cli_schema_version_1_0.rst architecture.rst developer_guide.rst user_guide.rst diff --git a/docs/release-notes.rst b/docs/release-notes.rst index 45d6a773..63b04422 100644 --- a/docs/release-notes.rst +++ b/docs/release-notes.rst @@ -6,14 +6,34 @@ CLI Release Notes Version: 1.1.0 -------------- -:Release Date: 2017-11-16 (DRAFT) +:Release Date: 2017-11-16 +ONAP CLI helps user to perform any operations over ONAP from command line, Linux console and web-console and following features are only +available over CLI and portal/vid does not support them: -**New Features** +* Customer and subscription management +* VNF Cloud on-boarding +* VNF tenant on-boarding -* Release first version of Open Command Line Interface Platform (OCLIP), an CLI platform for implementing CLI using YAML file without coding +**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). +* 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_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 +* diff --git a/docs/user_guide.rst b/docs/user_guide.rst index 3e9b7aca..37ac770d 100644 --- a/docs/user_guide.rst +++ b/docs/user_guide.rst @@ -53,7 +53,9 @@ Help Debug Mode ---------- To run in debug mode, set following environment variables: + 1. ONAP_CLI_DEBUG - By default its false, otherwise Set to true + 2. ONAP_CLI_DEBUG_PORT - By default it is 5005, otherwise set to new TCP port number More details @@ -62,9 +64,10 @@ https://wiki.onap.org Command usage guide ------------------- -Following document provides the help message for list of command's supported in this release. +Following document provides the help message and samples for commands supported in this release. .. toctree:: :maxdepth: 1 cmd_help.rst + cmd_sample.rst |